Class StaticOverlay (0.51.0)

public final class StaticOverlay extends GeneratedMessageV3 implements StaticOverlayOrBuilder

Configuration for the static overlay.

Protobuf type google.cloud.video.livestream.v1.StaticOverlay

Static Fields

ASSET_FIELD_NUMBER

public static final int ASSET_FIELD_NUMBER
Field Value
Type Description
int

OPACITY_FIELD_NUMBER

public static final int OPACITY_FIELD_NUMBER
Field Value
Type Description
int

POSITION_FIELD_NUMBER

public static final int POSITION_FIELD_NUMBER
Field Value
Type Description
int

RESOLUTION_FIELD_NUMBER

public static final int RESOLUTION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static StaticOverlay getDefaultInstance()
Returns
Type Description
StaticOverlay

getDescriptor()

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

newBuilder()

public static StaticOverlay.Builder newBuilder()
Returns
Type Description
StaticOverlay.Builder

newBuilder(StaticOverlay prototype)

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

parseDelimitedFrom(InputStream input)

public static StaticOverlay parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StaticOverlay
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static StaticOverlay parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
StaticOverlay
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static StaticOverlay parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
StaticOverlay
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static StaticOverlay parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StaticOverlay
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static StaticOverlay parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
StaticOverlay
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<StaticOverlay> parser()
Returns
Type Description
Parser<StaticOverlay>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAsset()

public String getAsset()

Required. Asset to use for the overlaid image. The asset must be represented in the form of: projects/{project}/locations/{location}/assets/{assetId}. The asset's resource type must be image.

string asset = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The asset.

getAssetBytes()

public ByteString getAssetBytes()

Required. Asset to use for the overlaid image. The asset must be represented in the form of: projects/{project}/locations/{location}/assets/{assetId}. The asset's resource type must be image.

string asset = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for asset.

getDefaultInstanceForType()

public StaticOverlay getDefaultInstanceForType()
Returns
Type Description
StaticOverlay

getOpacity()

public double getOpacity()

Optional. 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 opacity = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
double

The opacity.

getParserForType()

public Parser<StaticOverlay> getParserForType()
Returns
Type Description
Parser<StaticOverlay>
Overrides

getPosition()

public NormalizedCoordinate getPosition()

Optional. Position of the image in terms of normalized coordinates of the upper-left corner of the image, based on output video resolution. For example, use the x and y coordinates {0, 0} to position the top-left corner of the overlay animation in the top-left corner of the output video.

.google.cloud.video.livestream.v1.NormalizedCoordinate position = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
NormalizedCoordinate

The position.

getPositionOrBuilder()

public NormalizedCoordinateOrBuilder getPositionOrBuilder()

Optional. Position of the image in terms of normalized coordinates of the upper-left corner of the image, based on output video resolution. For example, use the x and y coordinates {0, 0} to position the top-left corner of the overlay animation in the top-left corner of the output video.

.google.cloud.video.livestream.v1.NormalizedCoordinate position = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
NormalizedCoordinateOrBuilder

getResolution()

public NormalizedResolution getResolution()

Optional. Normalized image resolution, based on output video resolution. Valid values are [0.0, 1.0]. To respect the original image aspect ratio, set either w or h to 0. To use the original image resolution, set both w and h to 0. The default is {0, 0}.

.google.cloud.video.livestream.v1.NormalizedResolution resolution = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
NormalizedResolution

The resolution.

getResolutionOrBuilder()

public NormalizedResolutionOrBuilder getResolutionOrBuilder()

Optional. Normalized image resolution, based on output video resolution. Valid values are [0.0, 1.0]. To respect the original image aspect ratio, set either w or h to 0. To use the original image resolution, set both w and h to 0. The default is {0, 0}.

.google.cloud.video.livestream.v1.NormalizedResolution resolution = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
NormalizedResolutionOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasPosition()

public boolean hasPosition()

Optional. Position of the image in terms of normalized coordinates of the upper-left corner of the image, based on output video resolution. For example, use the x and y coordinates {0, 0} to position the top-left corner of the overlay animation in the top-left corner of the output video.

.google.cloud.video.livestream.v1.NormalizedCoordinate position = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the position field is set.

hasResolution()

public boolean hasResolution()

Optional. Normalized image resolution, based on output video resolution. Valid values are [0.0, 1.0]. To respect the original image aspect ratio, set either w or h to 0. To use the original image resolution, set both w and h to 0. The default is {0, 0}.

.google.cloud.video.livestream.v1.NormalizedResolution resolution = 2 [(.google.api.field_behavior) = OPTIONAL];

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 StaticOverlay.Builder newBuilderForType()
Returns
Type Description
StaticOverlay.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public StaticOverlay.Builder toBuilder()
Returns
Type Description
StaticOverlay.Builder

writeTo(CodedOutputStream output)

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