Class Overlay.Image.Builder (1.2.0)

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

Overlaid jpeg image.

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Overlay.Image.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Overlay.Image.Builder
Overrides

build()

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

buildPartial()

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

clear()

public Overlay.Image.Builder clear()
Returns
TypeDescription
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
TypeDescription
Overlay.Image.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Overlay.Image.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Overlay.Image.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public Overlay.Image.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Overlay.Image.Builder
Overrides

clearResolution()

public Overlay.Image.Builder clearResolution()

Normalized image resolution, based on output video resolution. Valid values: 0.0\u20131.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.Image.Builder

clearUri()

public Overlay.Image.Builder clearUri()

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

This builder for chaining.

clone()

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

The alpha.

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getResolution()

public Overlay.NormalizedCoordinate getResolution()

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

getResolutionBuilder()

public Overlay.NormalizedCoordinate.Builder getResolutionBuilder()

Normalized image resolution, based on output video resolution. Valid values: 0.0\u20131.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.Builder

getResolutionOrBuilder()

public Overlay.NormalizedCoordinateOrBuilder getResolutionOrBuilder()

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

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.0\u20131.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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Overlay.Image other)

public Overlay.Image.Builder mergeFrom(Overlay.Image other)
Parameter
NameDescription
otherOverlay.Image
Returns
TypeDescription
Overlay.Image.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Overlay.Image.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Overlay.Image.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Overlay.Image.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
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.0\u20131.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
NameDescription
valueOverlay.NormalizedCoordinate
Returns
TypeDescription
Overlay.Image.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Overlay.Image.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valuedouble

The alpha to set.

Returns
TypeDescription
Overlay.Image.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Overlay.Image.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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.0\u20131.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
NameDescription
valueOverlay.NormalizedCoordinate
Returns
TypeDescription
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.0\u20131.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
NameDescription
builderForValueOverlay.NormalizedCoordinate.Builder
Returns
TypeDescription
Overlay.Image.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Overlay.Image.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Overlay.Image.Builder
Overrides

setUri(String value)

public Overlay.Image.Builder setUri(String value)

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

Parameter
NameDescription
valueString

The uri to set.

Returns
TypeDescription
Overlay.Image.Builder

This builder for chaining.

setUriBytes(ByteString value)

public Overlay.Image.Builder setUriBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for uri to set.

Returns
TypeDescription
Overlay.Image.Builder

This builder for chaining.