Live Stream v1 API - Class StaticOverlay (1.8.0)

public sealed class StaticOverlay : IMessage<StaticOverlay>, IEquatable<StaticOverlay>, IDeepCloneable<StaticOverlay>, IBufferMessage, IMessage

Reference documentation and code samples for the Live Stream v1 API class StaticOverlay.

Configuration for the static overlay.

Inheritance

object > StaticOverlay

Namespace

Google.Cloud.Video.LiveStream.V1

Assembly

Google.Cloud.Video.LiveStream.V1.dll

Constructors

StaticOverlay()

public StaticOverlay()

StaticOverlay(StaticOverlay)

public StaticOverlay(StaticOverlay other)
Parameter
Name Description
other StaticOverlay

Properties

Asset

public string Asset { get; set; }

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.

Property Value
Type Description
string

AssetAsAssetName

public AssetName AssetAsAssetName { get; set; }

AssetName-typed view over the Asset resource name property.

Property Value
Type Description
AssetName

Opacity

public double Opacity { get; set; }

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.

Property Value
Type Description
double

Position

public NormalizedCoordinate Position { get; set; }

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.

Property Value
Type Description
NormalizedCoordinate

Resolution

public NormalizedResolution Resolution { get; set; }

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}.

Property Value
Type Description
NormalizedResolution