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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/transcoder_v1beta1/classes.rb,
lib/google/apis/transcoder_v1beta1/representations.rb,
lib/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.



1468
1469
1470
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1468

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) 


1412
1413
1414
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1412

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) 


1419
1420
1421
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1419

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) 


1426
1427
1428
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1426

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) 


1431
1432
1433
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1431

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) 


1437
1438
1439
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1437

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) 


1444
1445
1446
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1444

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) 


1449
1450
1451
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1449

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) 


1454
1455
1456
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1454

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) 


1460
1461
1462
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1460

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) 


1466
1467
1468
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1466

def total_count
  @total_count
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
 
# File 'lib/google/apis/transcoder_v1beta1/classes.rb', line 1473

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