Class: Google::Cloud::Video::Transcoder::V1beta1::SpriteSheet

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

Overview

Sprite sheet configuration.

Instance Attribute Summary collapse

Instance Attribute Details

#column_count ⇒ ::Integer

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



399
400
401
402
 
# File 'proto_docs/google/cloud/video/transcoder/v1beta1/resources.rb', line 399

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

#end_time_offset ⇒ ::Google::Protobuf::Duration

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



399
400
401
402
 
# File 'proto_docs/google/cloud/video/transcoder/v1beta1/resources.rb', line 399

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.

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



399
400
401
402
 
# File 'proto_docs/google/cloud/video/transcoder/v1beta1/resources.rb', line 399

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'


399
400
401
402
 
# File 'proto_docs/google/cloud/video/transcoder/v1beta1/resources.rb', line 399

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

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

Returns Starting from 0s, create sprites at regular intervals. Specify the interval value in seconds.

Returns:



399
400
401
402
 
# File 'proto_docs/google/cloud/video/transcoder/v1beta1/resources.rb', line 399

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.



399
400
401
402
 
# File 'proto_docs/google/cloud/video/transcoder/v1beta1/resources.rb', line 399

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



399
400
401
402
 
# File 'proto_docs/google/cloud/video/transcoder/v1beta1/resources.rb', line 399

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

#sprite_height_pixels ⇒ ::Integer

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

Returns:



399
400
401
402
 
# File 'proto_docs/google/cloud/video/transcoder/v1beta1/resources.rb', line 399

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

#sprite_width_pixels ⇒ ::Integer

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

Returns:



399
400
401
402
 
# File 'proto_docs/google/cloud/video/transcoder/v1beta1/resources.rb', line 399

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

#start_time_offset ⇒ ::Google::Protobuf::Duration

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



399
400
401
402
 
# File 'proto_docs/google/cloud/video/transcoder/v1beta1/resources.rb', line 399

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

#total_count ⇒ ::Integer

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



399
400
401
402
 
# File 'proto_docs/google/cloud/video/transcoder/v1beta1/resources.rb', line 399

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