Class SpriteSheet (1.0.0)

public sealed class SpriteSheet : IMessage<SpriteSheet>, IEquatable<SpriteSheet>, IDeepCloneable<SpriteSheet>, IBufferMessage, IMessage

Sprite sheet configuration.

Inheritance

Object > SpriteSheet

Implements

IMessage<SpriteSheet>, IEquatable<SpriteSheet>, IDeepCloneable<SpriteSheet>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Video.Transcoder.V1

Assembly

Google.Cloud.Video.Transcoder.V1.dll

Constructors

SpriteSheet()

public SpriteSheet()

SpriteSheet(SpriteSheet)

public SpriteSheet(SpriteSheet other)

Parameter
Name	Description
`other`	`SpriteSheet`

Properties

ColumnCount

public int ColumnCount { get; set; }

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

Property Value
Type	Description
`Int32`

EndTimeOffset

public Duration EndTimeOffset { get; set; }

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.

Property Value
Type	Description
`Duration`

ExtractionStrategyCase

public SpriteSheet.ExtractionStrategyOneofCase ExtractionStrategyCase { get; }

Property Value
Type	Description
`SpriteSheet.ExtractionStrategyOneofCase`

FilePrefix

public string FilePrefix { get; set; }

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.

Property Value
Type	Description
`String`

Format

public string Format { get; set; }

Format type. The default is jpeg.

Supported formats:

jpeg

Property Value
Type	Description
`String`

Interval

public Duration Interval { get; set; }

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

Property Value
Type	Description
`Duration`

Quality

public int Quality { get; set; }

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.

Property Value
Type	Description
`Int32`

RowCount

public int RowCount { get; set; }

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.

Property Value
Type	Description
`Int32`

SpriteHeightPixels

public int SpriteHeightPixels { get; set; }

Required. The height of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the [SpriteSheet.sprite_height_pixels][google.cloud.video.transcoder.v1.SpriteSheet.sprite_height_pixels] field or the [SpriteSheet.sprite_width_pixels][google.cloud.video.transcoder.v1.SpriteSheet.sprite_width_pixels] field, but not both (the API will automatically calculate the missing field).

Property Value
Type	Description
`Int32`

SpriteWidthPixels

public int SpriteWidthPixels { get; set; }

Required. The width of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the [SpriteSheet.sprite_width_pixels][google.cloud.video.transcoder.v1.SpriteSheet.sprite_width_pixels] field or the [SpriteSheet.sprite_height_pixels][google.cloud.video.transcoder.v1.SpriteSheet.sprite_height_pixels] field, but not both (the API will automatically calculate the missing field).

Property Value
Type	Description
`Int32`

StartTimeOffset

public Duration StartTimeOffset { get; set; }

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

Property Value
Type	Description
`Duration`

TotalCount

public int TotalCount { get; set; }

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

Property Value
Type	Description
`Int32`