Transcoder V1 API - Class Google::Cloud::Video::Transcoder::V1::SpriteSheet (v0.8.0)

Version 0.8.0

• 0.13.0 (latest)
• 0.12.2
• 0.11.0
• 0.10.0
• 0.9.1
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.2

Reference documentation and code samples for the Transcoder V1 API class Google::Cloud::Video::Transcoder::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. The default is 0, which indicates no maximum limit.

#column_count=

def column_count=(value) -> ::Integer

Parameter

• value (::Integer) — The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit.

Returns

• (::Integer) — The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit.

#end_time_offset

def end_time_offset() -> ::Google::Protobuf::Duration

Returns

• (::Google::Protobuf::Duration) — End time in seconds, relative to the output file timeline. When end_time_offset is not specified, the sprites are generated until the end of the output file.

#end_time_offset=

def end_time_offset=(value) -> ::Google::Protobuf::Duration

Parameter

• value (::Google::Protobuf::Duration) — End time in seconds, relative to the output file timeline. When end_time_offset is not specified, the sprites are generated until the end of the output file.

Returns

• (::Google::Protobuf::Duration) — End time in seconds, relative to the output file timeline. When end_time_offset is not specified, the sprites are generated until the end of the output file.

#file_prefix

def file_prefix() -> ::String

Returns

• (::String) — Required. File name prefix for the generated sprite sheets.

  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.

  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.

  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) — Starting from 0s, create sprites at regular intervals. Specify the interval value in seconds.

#interval=

def interval=(value) -> ::Google::Protobuf::Duration

Parameter

• value (::Google::Protobuf::Duration) — Starting from 0s, create sprites at regular intervals. Specify the interval value in seconds.

Returns

• (::Google::Protobuf::Duration) — Starting from 0s, create sprites at regular intervals. Specify the interval value in seconds.

#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. The default is 0, which indicates no maximum limit.

#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. The default is 0, which indicates no maximum limit.

Returns

• (::Integer) — The maximum number of rows per sprite sheet. When the sprite sheet is full, a new sprite sheet is created. The default is 0, which indicates no maximum limit.

#sprite_height_pixels

def sprite_height_pixels() -> ::Integer

Returns

• (::Integer) — Required. The height of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_height_pixels field or the SpriteSheet.sprite_width_pixels field, but not both (the API will automatically calculate the missing field).

  For portrait videos that contain horizontal ASR and rotation metadata, provide the height, in pixels, per the horizontal ASR. The API calculates the width per the horizontal ASR. The API detects any rotation metadata and swaps the requested height and width for the output.

#sprite_height_pixels=

def sprite_height_pixels=(value) -> ::Integer

Parameter

• value (::Integer) — Required. The height of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_height_pixels field or the SpriteSheet.sprite_width_pixels field, but not both (the API will automatically calculate the missing field).

  For portrait videos that contain horizontal ASR and rotation metadata, provide the height, in pixels, per the horizontal ASR. The API calculates the width per the horizontal ASR. The API detects any rotation metadata and swaps the requested height and width for the output.

Returns

• (::Integer) — Required. The height of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_height_pixels field or the SpriteSheet.sprite_width_pixels field, but not both (the API will automatically calculate the missing field).

  For portrait videos that contain horizontal ASR and rotation metadata, provide the height, in pixels, per the horizontal ASR. The API calculates the width per the horizontal ASR. The API detects any rotation metadata and swaps the requested height and width for the output.

#sprite_width_pixels

def sprite_width_pixels() -> ::Integer

Returns

• (::Integer) — Required. The width of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_width_pixels field or the SpriteSheet.sprite_height_pixels field, but not both (the API will automatically calculate the missing field).

  For portrait videos that contain horizontal ASR and rotation metadata, provide the width, in pixels, per the horizontal ASR. The API calculates the height per the horizontal ASR. The API detects any rotation metadata and swaps the requested height and width for the output.

#sprite_width_pixels=

def sprite_width_pixels=(value) -> ::Integer

Parameter

• value (::Integer) — Required. The width of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_width_pixels field or the SpriteSheet.sprite_height_pixels field, but not both (the API will automatically calculate the missing field).

  For portrait videos that contain horizontal ASR and rotation metadata, provide the width, in pixels, per the horizontal ASR. The API calculates the height per the horizontal ASR. The API detects any rotation metadata and swaps the requested height and width for the output.

Returns

• (::Integer) — Required. The width of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_width_pixels field or the SpriteSheet.sprite_height_pixels field, but not both (the API will automatically calculate the missing field).

  For portrait videos that contain horizontal ASR and rotation metadata, provide the width, in pixels, per the horizontal ASR. The API calculates the height per the horizontal ASR. The API detects any rotation metadata and swaps the requested height and width for the output.

#start_time_offset

def start_time_offset() -> ::Google::Protobuf::Duration

Returns

• (::Google::Protobuf::Duration) — Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is 0s.

#start_time_offset=

def start_time_offset=(value) -> ::Google::Protobuf::Duration

Parameter

• value (::Google::Protobuf::Duration) — Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is 0s.

Returns

• (::Google::Protobuf::Duration) — Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is 0s.

#total_count

def total_count() -> ::Integer

Returns

• (::Integer) — Total number of sprites. Create the specified number of sprites distributed evenly across the timeline of the output media. The default is 100.

#total_count=

def total_count=(value) -> ::Integer

Parameter

• value (::Integer) — Total number of sprites. Create the specified number of sprites distributed evenly across the timeline of the output media. The default is 100.

Returns

• (::Integer) — Total number of sprites. Create the specified number of sprites distributed evenly across the timeline of the output media. The default is 100.