Live Stream V1 API - Class Google::Cloud::Video::LiveStream::V1::StaticOverlay (v2.0.1)

Reference documentation and code samples for the Live Stream V1 API class Google::Cloud::Video::LiveStream::V1::StaticOverlay.

Configuration for the static overlay.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#asset

def asset() -> ::String
Returns
  • (::String) — 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.

#asset=

def asset=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#opacity

def opacity() -> ::Float
Returns
  • (::Float) — 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.

#opacity=

def opacity=(value) -> ::Float
Parameter
  • value (::Float) — 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.
Returns
  • (::Float) — 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.

#position

def position() -> ::Google::Cloud::Video::LiveStream::V1::NormalizedCoordinate
Returns
  • (::Google::Cloud::Video::LiveStream::V1::NormalizedCoordinate) — 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.

#position=

def position=(value) -> ::Google::Cloud::Video::LiveStream::V1::NormalizedCoordinate
Parameter
  • value (::Google::Cloud::Video::LiveStream::V1::NormalizedCoordinate) — 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.
Returns
  • (::Google::Cloud::Video::LiveStream::V1::NormalizedCoordinate) — 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.

#resolution

def resolution() -> ::Google::Cloud::Video::LiveStream::V1::NormalizedResolution
Returns
  • (::Google::Cloud::Video::LiveStream::V1::NormalizedResolution) — 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}.

#resolution=

def resolution=(value) -> ::Google::Cloud::Video::LiveStream::V1::NormalizedResolution
Parameter
  • value (::Google::Cloud::Video::LiveStream::V1::NormalizedResolution) — 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}.
Returns
  • (::Google::Cloud::Video::LiveStream::V1::NormalizedResolution) — 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}.