Class Overlay.Image (1.5.0)

public static final class Overlay.Image extends GeneratedMessageV3 implements Overlay.ImageOrBuilder

Overlaid jpeg image.

Protobuf type google.cloud.video.transcoder.v1.Overlay.Image

Static Fields

ALPHA_FIELD_NUMBER

public static final int ALPHA_FIELD_NUMBER
Field Value
TypeDescription
int

RESOLUTION_FIELD_NUMBER

public static final int RESOLUTION_FIELD_NUMBER
Field Value
TypeDescription
int

URI_FIELD_NUMBER

public static final int URI_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Overlay.Image getDefaultInstance()
Returns
TypeDescription
Overlay.Image

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Overlay.Image.Builder newBuilder()
Returns
TypeDescription
Overlay.Image.Builder

newBuilder(Overlay.Image prototype)

public static Overlay.Image.Builder newBuilder(Overlay.Image prototype)
Parameter
NameDescription
prototypeOverlay.Image
Returns
TypeDescription
Overlay.Image.Builder

parseDelimitedFrom(InputStream input)

public static Overlay.Image parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Overlay.Image
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Overlay.Image parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Overlay.Image
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Overlay.Image parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Overlay.Image
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Overlay.Image parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Overlay.Image
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Overlay.Image parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Overlay.Image
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Overlay.Image parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Overlay.Image
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Overlay.Image parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Overlay.Image
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Overlay.Image parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Overlay.Image
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Overlay.Image parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Overlay.Image
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Overlay.Image parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Overlay.Image
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Overlay.Image parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Overlay.Image
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Overlay.Image parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Overlay.Image
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Overlay.Image> parser()
Returns
TypeDescription
Parser<Image>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAlpha()

public double getAlpha()

Target image opacity. Valid values are from 1.0 (solid, default) to 0.0 (transparent), exclusive. Set this to a value greater than 0.0.

double alpha = 3;

Returns
TypeDescription
double

The alpha.

getDefaultInstanceForType()

public Overlay.Image getDefaultInstanceForType()
Returns
TypeDescription
Overlay.Image

getParserForType()

public Parser<Overlay.Image> getParserForType()
Returns
TypeDescription
Parser<Image>
Overrides

getResolution()

public Overlay.NormalizedCoordinate getResolution()

Normalized image resolution, based on output video resolution. Valid values: 0.01.0. To respect the original image aspect ratio, set either x or y to 0.0. To use the original image resolution, set both x and y to 0.0.

.google.cloud.video.transcoder.v1.Overlay.NormalizedCoordinate resolution = 2;

Returns
TypeDescription
Overlay.NormalizedCoordinate

The resolution.

getResolutionOrBuilder()

public Overlay.NormalizedCoordinateOrBuilder getResolutionOrBuilder()

Normalized image resolution, based on output video resolution. Valid values: 0.01.0. To respect the original image aspect ratio, set either x or y to 0.0. To use the original image resolution, set both x and y to 0.0.

.google.cloud.video.transcoder.v1.Overlay.NormalizedCoordinate resolution = 2;

Returns
TypeDescription
Overlay.NormalizedCoordinateOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getUri()

public String getUri()

Required. URI of the JPEG image in Cloud Storage. For example, gs://bucket/inputs/image.jpeg. JPEG is the only supported image type.

string uri = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The uri.

getUriBytes()

public ByteString getUriBytes()

Required. URI of the JPEG image in Cloud Storage. For example, gs://bucket/inputs/image.jpeg. JPEG is the only supported image type.

string uri = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for uri.

hasResolution()

public boolean hasResolution()

Normalized image resolution, based on output video resolution. Valid values: 0.01.0. To respect the original image aspect ratio, set either x or y to 0.0. To use the original image resolution, set both x and y to 0.0.

.google.cloud.video.transcoder.v1.Overlay.NormalizedCoordinate resolution = 2;

Returns
TypeDescription
boolean

Whether the resolution field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Overlay.Image.Builder newBuilderForType()
Returns
TypeDescription
Overlay.Image.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Overlay.Image.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Overlay.Image.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Overlay.Image.Builder toBuilder()
Returns
TypeDescription
Overlay.Image.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException