Reference documentation and code samples for the Google Cloud Video Live Stream V1 Client class SpriteSheet.
Sprite sheet configuration.
Generated from protobuf message google.cloud.video.livestream.v1.SpriteSheet
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ format |
string
Format type. The default is |
↳ file_prefix |
string
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_width_pixels |
int
Required. The width of the sprite in pixels. Must be an even integer. |
↳ sprite_height_pixels |
int
Required. The height of the sprite in pixels. Must be an even integer. |
↳ column_count |
int
The maximum number of sprites per row in a sprite sheet. Valid range is [1, 10] and the default value is 1. |
↳ row_count |
int
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. |
↳ interval |
Google\Protobuf\Duration
Create sprites at regular intervals. Valid range is [1 second, 1 hour] and the default value is |
↳ quality |
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. |
getFormat
Format type. The default is jpeg.
Supported formats:
jpeg
| Returns | |
|---|---|
| Type | Description |
string | |
setFormat
Format type. The default is jpeg.
Supported formats:
jpeg
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFilePrefix
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.
| Returns | |
|---|---|
| Type | Description |
string | |
setFilePrefix
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSpriteWidthPixels
Required. The width of the sprite in pixels. Must be an even integer.
| Returns | |
|---|---|
| Type | Description |
int | |
setSpriteWidthPixels
Required. The width of the sprite in pixels. Must be an even integer.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSpriteHeightPixels
Required. The height of the sprite in pixels. Must be an even integer.
| Returns | |
|---|---|
| Type | Description |
int | |
setSpriteHeightPixels
Required. The height of the sprite in pixels. Must be an even integer.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getColumnCount
The maximum number of sprites per row in a sprite sheet. Valid range is [1, 10] and the default value is 1.
| Returns | |
|---|---|
| Type | Description |
int | |
setColumnCount
The maximum number of sprites per row in a sprite sheet. Valid range is [1, 10] and the default value is 1.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRowCount
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.
| Returns | |
|---|---|
| Type | Description |
int | |
setRowCount
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getInterval
Create sprites at regular intervals. Valid range is [1 second, 1 hour] and
the default value is 10s.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null | |
hasInterval
clearInterval
setInterval
Create sprites at regular intervals. Valid range is [1 second, 1 hour] and
the default value is 10s.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getQuality
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.
| Returns | |
|---|---|
| Type | Description |
int | |
setQuality
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |