Class: Google::Apis::TranscoderV1::SpriteSheet

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



1602
1603
1604
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1602

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) 


1533
1534
1535
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1533

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) 


1540
1541
1542
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1540

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) 


1547
1548
1549
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1547

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) 


1552
1553
1554
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1552

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) 


1558
1559
1560
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1558

def interval
  @interval
end

#quality ⇒ Fixnum

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

Returns:

  • (Fixnum) 


1565
1566
1567
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1565

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


1572
1573
1574
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1572

def row_count
  @row_count
end

#sprite_height_pixels ⇒ Fixnum

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

Returns:

  • (Fixnum) 


1580
1581
1582
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1580

def sprite_height_pixels
  @sprite_height_pixels
end

#sprite_width_pixels ⇒ Fixnum

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

Returns:

  • (Fixnum) 


1588
1589
1590
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1588

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) 


1594
1595
1596
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1594

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) 


1600
1601
1602
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1600

def total_count
  @total_count
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1607

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