Class: Google::Apis::TranscoderV1beta1::SpriteSheet

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/transcoder_v1beta1/classes.rb,
generated/google/apis/transcoder_v1beta1/representations.rb,
generated/google/apis/transcoder_v1beta1/representations.rb

Overview

Sprite sheet configuration.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SpriteSheet

Returns a new instance of SpriteSheet.



1405
1406
1407
 
# File 'generated/google/apis/transcoder_v1beta1/classes.rb', line 1405

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#column_count ⇒ Fixnum

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

Returns:

  • (Fixnum) 


1349
1350
1351
 
# File 'generated/google/apis/transcoder_v1beta1/classes.rb', line 1349

def column_count
  @column_count
end

#end_time_offset ⇒ String

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

Returns:

  • (String) 


1356
1357
1358
 
# File 'generated/google/apis/transcoder_v1beta1/classes.rb', line 1356

def end_time_offset
  @end_time_offset
end

#file_prefix ⇒ 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". Corresponds to the JSON property filePrefix

Returns:

  • (String) 


1363
1364
1365
 
# File 'generated/google/apis/transcoder_v1beta1/classes.rb', line 1363

def file_prefix
  @file_prefix
end

#format ⇒ String

Format type. The default is "jpeg". Supported formats: - 'jpeg' Corresponds to the JSON property format

Returns:

  • (String) 


1368
1369
1370
 
# File 'generated/google/apis/transcoder_v1beta1/classes.rb', line 1368

def format
  @format
end

#interval ⇒ String

Starting from 0s, create sprites at regular intervals. Specify the interval value in seconds. Corresponds to the JSON property interval

Returns:

  • (String) 


1374
1375
1376
 
# File 'generated/google/apis/transcoder_v1beta1/classes.rb', line 1374

def interval
  @interval
end

#row_count ⇒ Fixnum

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

Returns:

  • (Fixnum) 


1381
1382
1383
 
# File 'generated/google/apis/transcoder_v1beta1/classes.rb', line 1381

def row_count
  @row_count
end

#sprite_height_pixels ⇒ Fixnum

Required. The height of sprite in pixels. Must be an even integer. Corresponds to the JSON property spriteHeightPixels

Returns:

  • (Fixnum) 


1386
1387
1388
 
# File 'generated/google/apis/transcoder_v1beta1/classes.rb', line 1386

def sprite_height_pixels
  @sprite_height_pixels
end

#sprite_width_pixels ⇒ Fixnum

Required. The width of sprite in pixels. Must be an even integer. Corresponds to the JSON property spriteWidthPixels

Returns:

  • (Fixnum) 


1391
1392
1393
 
# File 'generated/google/apis/transcoder_v1beta1/classes.rb', line 1391

def sprite_width_pixels
  @sprite_width_pixels
end

#start_time_offset ⇒ String

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

Returns:

  • (String) 


1397
1398
1399
 
# File 'generated/google/apis/transcoder_v1beta1/classes.rb', line 1397

def start_time_offset
  @start_time_offset
end

#total_count ⇒ Fixnum

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

Returns:

  • (Fixnum) 


1403
1404
1405
 
# File 'generated/google/apis/transcoder_v1beta1/classes.rb', line 1403

def total_count
  @total_count
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
 
# File 'generated/google/apis/transcoder_v1beta1/classes.rb', line 1410

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)
  @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