public sealed class SpriteSheet : IMessage<SpriteSheet>, IEquatable<SpriteSheet>, IDeepCloneable<SpriteSheet>, IBufferMessage, IMessageReference documentation and code samples for the Live Stream v1 API class SpriteSheet.
Sprite sheet configuration.
Implements
IMessageSpriteSheet, IEquatableSpriteSheet, IDeepCloneableSpriteSheet, IBufferMessage, IMessageNamespace
Google.Cloud.Video.LiveStream.V1Assembly
Google.Cloud.Video.LiveStream.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. Valid range is [1, 10] and the default value is 1.
| Property Value | |
|---|---|
| Type | Description |
int |
|
FilePrefix
public string FilePrefix { get; set; }Required. File name prefix for the generated sprite sheets. If multiple
sprite sheets are added to the channel, each must have a unique file
prefix.
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; }Create sprites at regular intervals. Valid range is [1 second, 1 hour] and
the default value is 10s.
| 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 |
int |
|
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. Valid range is [1, 10] and the default value is 1.
| Property Value | |
|---|---|
| Type | Description |
int |
|
SpriteHeightPixels
public int SpriteHeightPixels { get; set; }Required. The height of the sprite in pixels. Must be an even integer.
| Property Value | |
|---|---|
| Type | Description |
int |
|
SpriteWidthPixels
public int SpriteWidthPixels { get; set; }Required. The width of the sprite in pixels. Must be an even integer.
| Property Value | |
|---|---|
| Type | Description |
int |
|