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.



1695
1696
1697
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1695

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) 


1618
1619
1620
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1618

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) 


1625
1626
1627
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1625

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) 


1632
1633
1634
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1632

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) 


1637
1638
1639
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1637

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) 


1643
1644
1645
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1643

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) 


1650
1651
1652
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1650

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) 


1657
1658
1659
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1657

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). For portrait videos that contain horizontal ASR and rotation metadata, provide the height, in pixels, per the horizontal ASR. The API calculates the width per the horizontal ASR. The API detects any rotation metadata and swaps the requested height and width for the output. Corresponds to the JSON property spriteHeightPixels

Returns:

  • (Fixnum) 


1669
1670
1671
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1669

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). For portrait videos that contain horizontal ASR and rotation metadata, provide the width, in pixels, per the horizontal ASR. The API calculates the height per the horizontal ASR. The API detects any rotation metadata and swaps the requested height and width for the output. Corresponds to the JSON property spriteWidthPixels

Returns:

  • (Fixnum) 


1681
1682
1683
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1681

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) 


1687
1688
1689
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1687

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) 


1693
1694
1695
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1693

def total_count
  @total_count
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
 
# File 'lib/google/apis/transcoder_v1/classes.rb', line 1700

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