Reference documentation and code samples for the Google Cloud Video Live Stream V1 Client class SpriteSheet.
Sprite sheet configuration.
Generated from protobuf messagegoogle.cloud.video.livestream.v1.SpriteSheet
Namespace
Google \ Cloud \ Video \ LiveStream \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ format
string
Format type. The default isjpeg. Supported formats: -jpeg
↳ 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 assprite_sheet0000000123.jpeg.
↳ 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.
Create sprites at regular intervals. Valid range is [1 second, 1 hour] and the default value is10s.
↳ 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 isjpeg.
Supported formats:
jpeg
Returns
Type
Description
string
setFormat
Format type. The default isjpeg.
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 assprite_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 assprite_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 is10s.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Video Live Stream V1 Client - Class SpriteSheet (1.2.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.2.1 (latest)](/php/docs/reference/cloud-video-live-stream/latest/V1.SpriteSheet)\n- [1.2.0](/php/docs/reference/cloud-video-live-stream/1.2.0/V1.SpriteSheet)\n- [1.1.3](/php/docs/reference/cloud-video-live-stream/1.1.3/V1.SpriteSheet)\n- [1.0.0](/php/docs/reference/cloud-video-live-stream/1.0.0/V1.SpriteSheet)\n- [0.7.5](/php/docs/reference/cloud-video-live-stream/0.7.5/V1.SpriteSheet)\n- [0.6.2](/php/docs/reference/cloud-video-live-stream/0.6.2/V1.SpriteSheet)\n- [0.5.0](/php/docs/reference/cloud-video-live-stream/0.5.0/V1.SpriteSheet)\n- [0.4.2](/php/docs/reference/cloud-video-live-stream/0.4.2/V1.SpriteSheet)\n- [0.3.2](/php/docs/reference/cloud-video-live-stream/0.3.2/V1.SpriteSheet)\n- [0.2.6](/php/docs/reference/cloud-video-live-stream/0.2.6/V1.SpriteSheet) \nReference documentation and code samples for the Google Cloud Video Live Stream V1 Client class SpriteSheet.\n\nSprite sheet configuration.\n\nGenerated from protobuf message `google.cloud.video.livestream.v1.SpriteSheet`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Video \\\\ LiveStream \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getFormat\n\nFormat type. The default is `jpeg`.\n\nSupported formats:\n\n- `jpeg`\n\n### setFormat\n\nFormat type. The default is `jpeg`.\n\nSupported formats:\n\n- `jpeg`\n\n### getFilePrefix\n\nRequired. File name prefix for the generated sprite sheets. If multiple\nsprite sheets are added to the channel, each must have a unique file\nprefix.\n\nEach sprite sheet has an incremental 10-digit zero-padded suffix starting\nfrom 0 before the extension, such as `sprite_sheet0000000123.jpeg`.\n\n### setFilePrefix\n\nRequired. File name prefix for the generated sprite sheets. If multiple\nsprite sheets are added to the channel, each must have a unique file\nprefix.\n\nEach sprite sheet has an incremental 10-digit zero-padded suffix starting\nfrom 0 before the extension, such as `sprite_sheet0000000123.jpeg`.\n\n### getSpriteWidthPixels\n\nRequired. The width of the sprite in pixels. Must be an even integer.\n\n### setSpriteWidthPixels\n\nRequired. The width of the sprite in pixels. Must be an even integer.\n\n### getSpriteHeightPixels\n\nRequired. The height of the sprite in pixels. Must be an even integer.\n\n### setSpriteHeightPixels\n\nRequired. The height of the sprite in pixels. Must be an even integer.\n\n### getColumnCount\n\nThe maximum number of sprites per row in a sprite sheet. Valid range is\n\\[1, 10\\] and the default value is 1.\n\n### setColumnCount\n\nThe maximum number of sprites per row in a sprite sheet. Valid range is\n\\[1, 10\\] and the default value is 1.\n\n### getRowCount\n\nThe maximum number of rows per sprite sheet. When the sprite sheet is full,\na new sprite sheet is created. Valid range is \\[1, 10\\] and the default value\nis 1.\n\n### setRowCount\n\nThe maximum number of rows per sprite sheet. When the sprite sheet is full,\na new sprite sheet is created. Valid range is \\[1, 10\\] and the default value\nis 1.\n\n### getInterval\n\nCreate sprites at regular intervals. Valid range is \\[1 second, 1 hour\\] and\nthe default value is `10s`.\n\n### hasInterval\n\n### clearInterval\n\n### setInterval\n\nCreate sprites at regular intervals. Valid range is \\[1 second, 1 hour\\] and\nthe default value is `10s`.\n\n### getQuality\n\nThe quality of the generated sprite sheet. Enter a value between 1\nand 100, where 1 is the lowest quality and 100 is the highest quality.\n\nThe default is 100. A high quality value corresponds to a low image data\ncompression ratio.\n\n### setQuality\n\nThe quality of the generated sprite sheet. Enter a value between 1\nand 100, where 1 is the lowest quality and 100 is the highest quality.\n\nThe default is 100. A high quality value corresponds to a low image data\ncompression ratio."]]
