Class Overlay.Image (1.42.0)

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

Overlaid image.

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

Static Fields

ALPHA_FIELD_NUMBER

public static final int ALPHA_FIELD_NUMBER
Field Value
Type Description
int

RESOLUTION_FIELD_NUMBER

public static final int RESOLUTION_FIELD_NUMBER
Field Value
Type Description
int

URI_FIELD_NUMBER

public static final int URI_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Overlay.Image getDefaultInstance()
Returns
Type Description
Overlay.Image

getDescriptor()

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

newBuilder()

public static Overlay.Image.Builder newBuilder()
Returns
Type Description
Overlay.Image.Builder

newBuilder(Overlay.Image prototype)

public static Overlay.Image.Builder newBuilder(Overlay.Image prototype)
Parameter
Name Description
prototype Overlay.Image
Returns
Type Description
Overlay.Image.Builder

parseDelimitedFrom(InputStream input)

public static Overlay.Image parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Overlay.Image
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Overlay.Image parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Overlay.Image
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Overlay.Image parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Overlay.Image
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Overlay.Image parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Overlay.Image
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Overlay.Image parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Overlay.Image
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Overlay.Image parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Overlay.Image
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Overlay.Image parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Overlay.Image
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Overlay.Image parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Overlay.Image
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Overlay.Image parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Overlay.Image
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Overlay.Image parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Overlay.Image
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Overlay.Image parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Overlay.Image
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Overlay.Image parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Overlay.Image
Exceptions
Type Description
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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
Type Description
double

The alpha.

getDefaultInstanceForType()

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

getParserForType()

public Parser<Overlay.Image> getParserForType()
Returns
Type Description
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
Type Description
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
Type Description
Overlay.NormalizedCoordinateOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Overlay.Image.Builder newBuilderForType()
Returns
Type Description
Overlay.Image.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Overlay.Image.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Overlay.Image.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Overlay.Image.Builder toBuilder()
Returns
Type Description
Overlay.Image.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException