Class: Google::Cloud::Video::LiveStream::V1::StaticOverlay

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/video/livestream/v1/resources.rb

Overview

Configuration for the static overlay.

Instance Attribute Summary collapse

Instance Attribute Details

#asset ⇒ ::String

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



302
303
304
305
 
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 302

class StaticOverlay
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#opacity ⇒ ::Float

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



302
303
304
305
 
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 302

class StaticOverlay
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#position ⇒ ::Google::Cloud::Video::LiveStream::V1::NormalizedCoordinate

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



302
303
304
305
 
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 302

class StaticOverlay
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#resolution ⇒ ::Google::Cloud::Video::LiveStream::V1::NormalizedResolution

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



302
303
304
305
 
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 302

class StaticOverlay
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end