Class: Google::Cloud::Video::LiveStream::V1::SpriteSheet

Inherits:

Object

• Object
• Google::Cloud::Video::LiveStream::V1::SpriteSheet

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/video/livestream/v1/outputs.rb

Overview

Sprite sheet configuration.

Instance Attribute Summary

• #column_count ⇒ ::Integer

  The maximum number of sprites per row in a sprite sheet.

• #file_prefix ⇒ ::String

  Required.

• #format ⇒ ::String

  Format type.

• #interval ⇒ ::Google::Protobuf::Duration

  Create sprites at regular intervals.

• #quality ⇒ ::Integer

  The quality of the generated sprite sheet.

• #row_count ⇒ ::Integer

  The maximum number of rows per sprite sheet.

• #sprite_height_pixels ⇒ ::Integer

  Required.

• #sprite_width_pixels ⇒ ::Integer

  Required.

Instance Attribute Details

#column_count ⇒ ::Integer

Returns The maximum number of sprites per row in a sprite sheet. Valid range is [1, 10] and the default value is 1.

Returns:

• (::Integer) —

  The maximum number of sprites per row in a sprite sheet. Valid range is [1, 10] and the default value is 1.

# File 'proto_docs/google/cloud/video/livestream/v1/outputs.rb', line 190

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

#file_prefix ⇒ ::String

Returns Required. File name prefix for the generated sprite sheets. If multiple sprite sheets are added to the channel, each must have a unique file prefix. Each sprite sheet has an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as sprite_sheet0000000123.jpeg.

Returns:

• (::String) —

  Required. File name prefix for the generated sprite sheets. If multiple sprite sheets are added to the channel, each must have a unique file prefix. Each sprite sheet has an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as sprite_sheet0000000123.jpeg.

# File 'proto_docs/google/cloud/video/livestream/v1/outputs.rb', line 190

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

#format ⇒ ::String

Returns Format type. The default is jpeg.

Supported formats:

• jpeg.

Returns:

• (::String) —

  Format type. The default is jpeg.

  Supported formats:

  • jpeg

# File 'proto_docs/google/cloud/video/livestream/v1/outputs.rb', line 190

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

#interval ⇒ ::Google::Protobuf::Duration

Returns Create sprites at regular intervals. Valid range is [1 second, 1 hour] and the default value is 10s.

Returns:

• (::Google::Protobuf::Duration) —

  Create sprites at regular intervals. Valid range is [1 second, 1 hour] and the default value is 10s.

# File 'proto_docs/google/cloud/video/livestream/v1/outputs.rb', line 190

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

#quality ⇒ ::Integer

Returns The quality of the generated sprite sheet. Enter a value between 1 and 100, where 1 is the lowest quality and 100 is the highest quality. The default is 100. A high quality value corresponds to a low image data compression ratio.

Returns:

• (::Integer) —

  The quality of the generated sprite sheet. Enter a value between 1 and 100, where 1 is the lowest quality and 100 is the highest quality. The default is 100. A high quality value corresponds to a low image data compression ratio.

# File 'proto_docs/google/cloud/video/livestream/v1/outputs.rb', line 190

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

#row_count ⇒ ::Integer

Returns The maximum number of rows per sprite sheet. When the sprite sheet is full, a new sprite sheet is created. Valid range is [1, 10] and the default value is 1.

Returns:

• (::Integer) —

  The maximum number of rows per sprite sheet. When the sprite sheet is full, a new sprite sheet is created. Valid range is [1, 10] and the default value is 1.

# File 'proto_docs/google/cloud/video/livestream/v1/outputs.rb', line 190

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

#sprite_height_pixels ⇒ ::Integer

Returns Required. The height of the sprite in pixels. Must be an even integer.

Returns:

• (::Integer) —

  Required. The height of the sprite in pixels. Must be an even integer.

# File 'proto_docs/google/cloud/video/livestream/v1/outputs.rb', line 190

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

#sprite_width_pixels ⇒ ::Integer

Returns Required. The width of the sprite in pixels. Must be an even integer.

Returns:

• (::Integer) —

  Required. The width of the sprite in pixels. Must be an even integer.

# File 'proto_docs/google/cloud/video/livestream/v1/outputs.rb', line 190

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