Reference documentation and code samples for the Live Stream V1 API class Google::Cloud::Video::LiveStream::V1::SpriteSheet.
Sprite sheet configuration.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#column_count
def column_count() -> ::Integer
Returns
- (::Integer) — The maximum number of sprites per row in a sprite sheet. Valid range is [1, 10] and the default value is 1.
#column_count=
def column_count=(value) -> ::Integer
Parameter
- value (::Integer) — 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_prefix
def file_prefix() -> ::String
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_prefix=
def file_prefix=(value) -> ::String
Parameter
-
value (::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.
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.
#format
def format() -> ::String
Returns
-
(::String) —
Format type. The default is
jpeg.Supported formats:
jpeg
#format=
def format=(value) -> ::String
Parameter
-
value (::String) —
Format type. The default is
jpeg.Supported formats:
jpeg
Returns
-
(::String) —
Format type. The default is
jpeg.Supported formats:
jpeg
#interval
def interval() -> ::Google::Protobuf::Duration
Returns
-
(::Google::Protobuf::Duration) — Create sprites at regular intervals. Valid range is [1 second, 1 hour] and
the default value is
10s.
#interval=
def interval=(value) -> ::Google::Protobuf::Duration
Parameter
-
value (::Google::Protobuf::Duration) — 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.
#quality
def quality() -> ::Integer
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.
#quality=
def quality=(value) -> ::Integer
Parameter
- value (::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.
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.
#row_count
def row_count() -> ::Integer
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.
#row_count=
def row_count=(value) -> ::Integer
Parameter
- value (::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.
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.
#sprite_height_pixels
def sprite_height_pixels() -> ::Integer
Returns
- (::Integer) — Required. The height of the sprite in pixels. Must be an even integer.
#sprite_height_pixels=
def sprite_height_pixels=(value) -> ::Integer
Parameter
- value (::Integer) — 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.
#sprite_width_pixels
def sprite_width_pixels() -> ::Integer
Returns
- (::Integer) — Required. The width of the sprite in pixels. Must be an even integer.
#sprite_width_pixels=
def sprite_width_pixels=(value) -> ::Integer
Parameter
- value (::Integer) — 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.