SpriteSheet class

Sprite sheet configuration.

Constructors

SpriteSheet({Input<int>? columnCount, Input<String>? endTimeOffset, required Input<String> filePrefix, Input<String>? format, Input<String>? interval, Input<int>? quality, Input<int>? rowCount, required Input<int> spriteHeightPixels, required Input<int> spriteWidthPixels, Input<String>? startTimeOffset, Input<int>? totalCount})
Creates a new SpriteSheet. columnCount The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit. endTimeOffset 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. filePrefix 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. format Format type. The default is jpeg. Supported formats: - jpeg interval Starting from 0s, create sprites at regular intervals. Specify the interval value in seconds. quality 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 100. A high quality value corresponds to a low image data compression ratio. rowCount 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. spriteHeightPixels 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. spriteWidthPixels 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. startTimeOffset Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is 0s. totalCount Total number of sprites. Create the specified number of sprites distributed evenly across the timeline of the output media. The default is 100.
const
SpriteSheet.fromMap(Map<String, dynamic> map)
factory

Properties

columnCount → Input<int>?
The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit.
final
endTimeOffset → Input<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.
final
filePrefix → Input<String>
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.
final
format → Input<String>?
Format type. The default is jpeg. Supported formats: - jpeg
final
hashCode → int
The hash code for this object.
no setterinherited
interval → Input<String>?
Starting from 0s, create sprites at regular intervals. Specify the interval value in seconds.
final
quality → Input<int>?
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 100. A high quality value corresponds to a low image data compression ratio.
final
rowCount → Input<int>?
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.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
spriteHeightPixels → Input<int>
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.
final
spriteWidthPixels → Input<int>
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.
final
startTimeOffset → Input<String>?
Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is 0s.
final
totalCount → Input<int>?
Total number of sprites. Create the specified number of sprites distributed evenly across the timeline of the output media. The default is 100.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited