Interface StaticOverlayOrBuilder (0.56.0) 

public interface StaticOverlayOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAsset()

public abstract 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 abstract 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.

getOpacity()

public abstract 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.

getPosition()

public abstract 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 abstract 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 abstract 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 abstract 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

hasPosition()

public abstract 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 abstract 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.