Class Overlay.Image.Builder (1.56.0) 

publicstaticfinalclass Overlay.Image.BuilderextendsGeneratedMessageV3.Builder<Overlay.Image.Builder>implementsOverlay.ImageOrBuilder

Overlaid image.

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

Inherited Members

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

Static Methods

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

publicOverlay.Image.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Overlay.Image.Builder
Overrides

build()

publicOverlay.Imagebuild()
Returns
Type Description
Overlay.Image

buildPartial()

publicOverlay.ImagebuildPartial()
Returns
Type Description
Overlay.Image

clear()

publicOverlay.Image.Builderclear()
Returns
Type Description
Overlay.Image.Builder
Overrides

clearAlpha()

publicOverlay.Image.BuilderclearAlpha()

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
Type Description
Overlay.Image.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

publicOverlay.Image.BuilderclearField(Descriptors.FieldDescriptorfield)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Overlay.Image.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

publicOverlay.Image.BuilderclearOneof(Descriptors.OneofDescriptoroneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Overlay.Image.Builder
Overrides

clearResolution()

publicOverlay.Image.BuilderclearResolution()

Normalized image resolution, based on output video resolution. Valid values: 0.0–1.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
Type Description
Overlay.Image.Builder

clearUri()

publicOverlay.Image.BuilderclearUri()

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
Type Description
Overlay.Image.Builder

This builder for chaining.

clone()

publicOverlay.Image.Builderclone()
Returns
Type Description
Overlay.Image.Builder
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
Type Description
double

The alpha.

getDefaultInstanceForType()

publicOverlay.ImagegetDefaultInstanceForType()
Returns
Type Description
Overlay.Image

getDescriptorForType()

publicDescriptors.DescriptorgetDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getResolution()

publicOverlay.NormalizedCoordinategetResolution()

Normalized image resolution, based on output video resolution. Valid values: 0.0–1.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
Type Description
Overlay.NormalizedCoordinate

The resolution.

getResolutionBuilder()

publicOverlay.NormalizedCoordinate.BuildergetResolutionBuilder()

Normalized image resolution, based on output video resolution. Valid values: 0.0–1.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
Type Description
Overlay.NormalizedCoordinate.Builder

getResolutionOrBuilder()

publicOverlay.NormalizedCoordinateOrBuildergetResolutionOrBuilder()

Normalized image resolution, based on output video resolution. Valid values: 0.0–1.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
Type Description
Overlay.NormalizedCoordinateOrBuilder

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
Type Description
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
Type Description
ByteString

The bytes for uri.

hasResolution()

publicbooleanhasResolution()

Normalized image resolution, based on output video resolution. Valid values: 0.0–1.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
Type Description
boolean

Whether the resolution field is set.

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Overlay.Image other)

publicOverlay.Image.BuildermergeFrom(Overlay.Imageother)
Parameter
Name Description
other Overlay.Image
Returns
Type Description
Overlay.Image.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicOverlay.Image.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Overlay.Image.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

publicOverlay.Image.BuildermergeFrom(Messageother)
Parameter
Name Description
other Message
Returns
Type Description
Overlay.Image.Builder
Overrides

mergeResolution(Overlay.NormalizedCoordinate value)

publicOverlay.Image.BuildermergeResolution(Overlay.NormalizedCoordinatevalue)

Normalized image resolution, based on output video resolution. Valid values: 0.0–1.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;

Parameter
Name Description
value Overlay.NormalizedCoordinate
Returns
Type Description
Overlay.Image.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

publicfinalOverlay.Image.BuildermergeUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Overlay.Image.Builder
Overrides

setAlpha(double value)

publicOverlay.Image.BuildersetAlpha(doublevalue)

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;

Parameter
Name Description
value double

The alpha to set.
Returns
Type Description
Overlay.Image.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

publicOverlay.Image.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Overlay.Image.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

publicOverlay.Image.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Overlay.Image.Builder
Overrides

setResolution(Overlay.NormalizedCoordinate value)

publicOverlay.Image.BuildersetResolution(Overlay.NormalizedCoordinatevalue)

Normalized image resolution, based on output video resolution. Valid values: 0.0–1.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;

Parameter
Name Description
value Overlay.NormalizedCoordinate
Returns
Type Description
Overlay.Image.Builder

setResolution(Overlay.NormalizedCoordinate.Builder builderForValue)

publicOverlay.Image.BuildersetResolution(Overlay.NormalizedCoordinate.BuilderbuilderForValue)

Normalized image resolution, based on output video resolution. Valid values: 0.0–1.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;

Parameter
Name Description
builderForValue Overlay.NormalizedCoordinate.Builder
Returns
Type Description
Overlay.Image.Builder

setUnknownFields(UnknownFieldSet unknownFields)

publicfinalOverlay.Image.BuildersetUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Overlay.Image.Builder
Overrides

setUri(String value)

publicOverlay.Image.BuildersetUri(Stringvalue)

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];

Parameter
Name Description
value String

The uri to set.
Returns
Type Description
Overlay.Image.Builder

This builder for chaining.

setUriBytes(ByteString value)

publicOverlay.Image.BuildersetUriBytes(ByteStringvalue)

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];

Parameter
Name Description
value ByteString

The bytes for uri to set.
Returns
Type Description
Overlay.Image.Builder

This builder for chaining.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.