class Google::Apis::TranscoderV1::SpriteSheet

Sprite sheet configuration.

Attributes

column_count[RW]

The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit. Corresponds to the JSON property ‘columnCount` @return [Fixnum]

end_time_offset[RW]

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. Corresponds to the JSON property `endTimeOffset` @return [String]

file_prefix[RW]

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`. Corresponds to the JSON property `filePrefix` @return [String]

format[RW]

Format type. The default is ‘jpeg`. Supported formats: - `jpeg` Corresponds to the JSON property `format` @return [String]

interval[RW]

Starting from ‘0s`, create sprites at regular intervals. Specify the interval value in seconds. Corresponds to the JSON property `interval` @return [String]

quality[RW]

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

  1. A high quality value corresponds to a low image data compression ratio.

Corresponds to the JSON property ‘quality` @return [Fixnum]

row_count[RW]

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. Corresponds to the JSON property ‘rowCount` @return [Fixnum]

sprite_height_pixels[RW]

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). Corresponds to the JSON property ‘spriteHeightPixels` @return [Fixnum]

sprite_width_pixels[RW]

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). Corresponds to the JSON property ‘spriteWidthPixels` @return [Fixnum]

start_time_offset[RW]

Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is ‘0s`. Corresponds to the JSON property `startTimeOffset` @return [String]

total_count[RW]

Total number of sprites. Create the specified number of sprites distributed evenly across the timeline of the output media. The default is 100. Corresponds to the JSON property ‘totalCount` @return [Fixnum]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/transcoder_v1/classes.rb, line 1587
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/transcoder_v1/classes.rb, line 1592
def update!(**args)
  @column_count = args[:column_count] if args.key?(:column_count)
  @end_time_offset = args[:end_time_offset] if args.key?(:end_time_offset)
  @file_prefix = args[:file_prefix] if args.key?(:file_prefix)
  @format = args[:format] if args.key?(:format)
  @interval = args[:interval] if args.key?(:interval)
  @quality = args[:quality] if args.key?(:quality)
  @row_count = args[:row_count] if args.key?(:row_count)
  @sprite_height_pixels = args[:sprite_height_pixels] if args.key?(:sprite_height_pixels)
  @sprite_width_pixels = args[:sprite_width_pixels] if args.key?(:sprite_width_pixels)
  @start_time_offset = args[:start_time_offset] if args.key?(:start_time_offset)
  @total_count = args[:total_count] if args.key?(:total_count)
end