Class Overlay.Image.Builder (1.41.0)

public static final class Overlay.Image.Builder extends GeneratedMessageV3.Builder<Overlay.Image.Builder> implements Overlay.ImageOrBuilder

Overlaid image.

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Overlay.Image.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Overlay.Image.Builder
Overrides

build()

public Overlay.Image build()
Returns
Type Description
Overlay.Image

buildPartial()

public Overlay.Image buildPartial()
Returns
Type Description
Overlay.Image

clear()

public Overlay.Image.Builder clear()
Returns
Type Description
Overlay.Image.Builder
Overrides

clearAlpha()

public Overlay.Image.Builder clearAlpha()

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)

public Overlay.Image.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Overlay.Image.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public Overlay.Image.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Overlay.Image.Builder
Overrides

clearResolution()

public Overlay.Image.Builder clearResolution()

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

clearUri()

public Overlay.Image.Builder clearUri()

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

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

The alpha.

getDefaultInstanceForType()

public Overlay.Image getDefaultInstanceForType()
Returns
Type Description
Overlay.Image

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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
Type Description
Overlay.NormalizedCoordinate

The resolution.

getResolutionBuilder()

public Overlay.NormalizedCoordinate.Builder getResolutionBuilder()

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

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

getUri()

public String getUri()

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

public ByteString getUriBytes()

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

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

Whether the resolution field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Overlay.Image other)

public Overlay.Image.Builder mergeFrom(Overlay.Image other)
Parameter
Name Description
other Overlay.Image
Returns
Type Description
Overlay.Image.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Overlay.Image.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Overlay.Image.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Overlay.Image.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Overlay.Image.Builder
Overrides

mergeResolution(Overlay.NormalizedCoordinate value)

public Overlay.Image.Builder mergeResolution(Overlay.NormalizedCoordinate value)

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;

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Overlay.Image.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Overlay.Image.Builder
Overrides

setAlpha(double value)

public Overlay.Image.Builder setAlpha(double value)

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)

public Overlay.Image.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Overlay.Image.Builder
Overrides

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

public Overlay.Image.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Overlay.Image.Builder
Overrides

setResolution(Overlay.NormalizedCoordinate value)

public Overlay.Image.Builder setResolution(Overlay.NormalizedCoordinate value)

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;

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

setResolution(Overlay.NormalizedCoordinate.Builder builderForValue)

public Overlay.Image.Builder setResolution(Overlay.NormalizedCoordinate.Builder builderForValue)

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;

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

setUnknownFields(UnknownFieldSet unknownFields)

public final Overlay.Image.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Overlay.Image.Builder
Overrides

setUri(String value)

public Overlay.Image.Builder setUri(String value)

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)

public Overlay.Image.Builder setUriBytes(ByteString value)

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.