Class Overlay.Image (1.59.0)

publicstaticfinalclassOverlay.ImageextendsGeneratedMessageV3implementsOverlay.ImageOrBuilder

Overlaid image.

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

Static Fields

ALPHA_FIELD_NUMBER

publicstaticfinalintALPHA_FIELD_NUMBER
Field Value
TypeDescription
int

RESOLUTION_FIELD_NUMBER

publicstaticfinalintRESOLUTION_FIELD_NUMBER
Field Value
TypeDescription
int

URI_FIELD_NUMBER

publicstaticfinalintURI_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

publicstaticOverlay.ImagegetDefaultInstance()
Returns
TypeDescription
Overlay.Image

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

publicstaticOverlay.Image.BuildernewBuilder()
Returns
TypeDescription
Overlay.Image.Builder

newBuilder(Overlay.Image prototype)

publicstaticOverlay.Image.BuildernewBuilder(Overlay.Imageprototype)
Parameter
NameDescription
prototypeOverlay.Image
Returns
TypeDescription
Overlay.Image.Builder

parseDelimitedFrom(InputStream input)

publicstaticOverlay.ImageparseDelimitedFrom(InputStreaminput)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Overlay.Image
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticOverlay.ImageparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Overlay.Image
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

publicstaticOverlay.ImageparseFrom(byte[]data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Overlay.Image
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticOverlay.ImageparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Overlay.Image
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticOverlay.ImageparseFrom(ByteStringdata)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Overlay.Image
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticOverlay.ImageparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Overlay.Image
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticOverlay.ImageparseFrom(CodedInputStreaminput)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Overlay.Image
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticOverlay.ImageparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Overlay.Image
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

publicstaticOverlay.ImageparseFrom(InputStreaminput)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Overlay.Image
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticOverlay.ImageparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Overlay.Image
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

publicstaticOverlay.ImageparseFrom(ByteBufferdata)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Overlay.Image
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticOverlay.ImageparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Overlay.Image
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

publicstaticParser<Overlay.Image>parser()
Returns
TypeDescription
Parser<Image>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAlpha()

publicdoublegetAlpha()

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()

publicOverlay.ImagegetDefaultInstanceForType()
Returns
TypeDescription
Overlay.Image

getParserForType()

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

getResolution()

publicOverlay.NormalizedCoordinategetResolution()

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()

publicOverlay.NormalizedCoordinateOrBuildergetResolutionOrBuilder()

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()

publicintgetSerializedSize()
Returns
TypeDescription
int
Overrides

getUri()

publicStringgetUri()

Required. URI of the image in Cloud Storage. For example, gs://bucket/inputs/image.png. Only PNG and JPEG images are supported.

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

Returns
TypeDescription
String

The uri.

getUriBytes()

publicByteStringgetUriBytes()

Required. URI of the image in Cloud Storage. For example, gs://bucket/inputs/image.png. Only PNG and JPEG images are supported.

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

Returns
TypeDescription
ByteString

The bytes for uri.

hasResolution()

publicbooleanhasResolution()

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()

publicinthashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

publicOverlay.Image.BuildernewBuilderForType()
Returns
TypeDescription
Overlay.Image.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedOverlay.Image.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Overlay.Image.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

publicOverlay.Image.BuildertoBuilder()
Returns
TypeDescription
Overlay.Image.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException