Struct SpriteSheet

pub struct SpriteSheet {
    pub column_count: Option<i32>,
    pub end_time_offset: Option<Duration>,
    pub file_prefix: Option<String>,
    pub format: Option<String>,
    pub interval: Option<Duration>,
    pub quality: Option<i32>,
    pub row_count: Option<i32>,
    pub sprite_height_pixels: Option<i32>,
    pub sprite_width_pixels: Option<i32>,
    pub start_time_offset: Option<Duration>,
    pub total_count: Option<i32>,
}

Sprite sheet configuration.

This type is not used in any activity, and only used as part of another schema.

Fields

column_count: Option<i32>

The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit.

end_time_offset: Option<Duration>

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.

file_prefix: Option<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.

format: Option<String>

Format type. The default is jpeg. Supported formats: - jpeg

interval: Option<Duration>

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

quality: Option<i32>

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.

row_count: Option<i32>

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.

sprite_height_pixels: Option<i32>

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.

sprite_width_pixels: Option<i32>

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.

start_time_offset: Option<Duration>

Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is 0s.

total_count: Option<i32>

Total number of sprites. Create the specified number of sprites distributed evenly across the timeline of the output media. The default is 100.

Trait Implementations

impl Clone for SpriteSheet

fn clone(&self) -> SpriteSheet

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SpriteSheet

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SpriteSheet

fn default() -> SpriteSheet

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SpriteSheet

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SpriteSheet

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Part for SpriteSheet