Class SpriteSheet (0.9.0)
Version 0.9.0keyboard_arrow_down
public final class SpriteSheet extends GeneratedMessageV3 implements SpriteSheetOrBuilder
Sprite sheet configuration.
Protobuf type google.cloud.video.livestream.v1.SpriteSheet
Static Fields
COLUMN_COUNT_FIELD_NUMBER
public static final int COLUMN_COUNT_FIELD_NUMBER
Field Value
FILE_PREFIX_FIELD_NUMBER
public static final int FILE_PREFIX_FIELD_NUMBER
Field Value
public static final int FORMAT_FIELD_NUMBER
Field Value
INTERVAL_FIELD_NUMBER
public static final int INTERVAL_FIELD_NUMBER
Field Value
QUALITY_FIELD_NUMBER
public static final int QUALITY_FIELD_NUMBER
Field Value
ROW_COUNT_FIELD_NUMBER
public static final int ROW_COUNT_FIELD_NUMBER
Field Value
SPRITE_HEIGHT_PIXELS_FIELD_NUMBER
public static final int SPRITE_HEIGHT_PIXELS_FIELD_NUMBER
Field Value
SPRITE_WIDTH_PIXELS_FIELD_NUMBER
public static final int SPRITE_WIDTH_PIXELS_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static SpriteSheet getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static SpriteSheet . Builder newBuilder ()
Returns
newBuilder(SpriteSheet prototype)
public static SpriteSheet . Builder newBuilder ( SpriteSheet prototype )
Parameter
Returns
public static SpriteSheet parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static SpriteSheet parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static SpriteSheet parseFrom ( byte [] data )
Parameter
Name Description
data byte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SpriteSheet parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static SpriteSheet parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SpriteSheet parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static SpriteSheet parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static SpriteSheet parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static SpriteSheet parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static SpriteSheet parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static SpriteSheet parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SpriteSheet parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<SpriteSheet> parser ()
Returns
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
Overrides
getColumnCount()
public int getColumnCount ()
The maximum number of sprites per row in a sprite sheet. Valid range is
[1, 10] and the default value is 1.
int32 column_count = 5;
Returns
Type Description
int The columnCount.
getDefaultInstanceForType()
public SpriteSheet getDefaultInstanceForType ()
Returns
getFilePrefix()
public String 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.
string file_prefix = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
String The filePrefix.
getFilePrefixBytes()
public ByteString getFilePrefixBytes ()
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.
string file_prefix = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
ByteString The bytes for filePrefix.
public String getFormat ()
Format type. The default is jpeg.
Supported formats:
string format = 1;
Returns
Type Description
String The format.
public ByteString getFormatBytes ()
Format type. The default is jpeg.
Supported formats:
string format = 1;
Returns
getInterval()
public Duration getInterval ()
Create sprites at regular intervals. Valid range is [1 second, 1 hour] and
the default value is 10s.
.google.protobuf.Duration interval = 7;
Returns
getIntervalOrBuilder()
public DurationOrBuilder getIntervalOrBuilder ()
Create sprites at regular intervals. Valid range is [1 second, 1 hour] and
the default value is 10s.
.google.protobuf.Duration interval = 7;
Returns
getParserForType()
public Parser<SpriteSheet> getParserForType ()
Returns
Overrides
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.
int32 quality = 8;
Returns
Type Description
int The quality.
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.
int32 row_count = 6;
Returns
Type Description
int The rowCount.
getSerializedSize()
public int getSerializedSize ()
Returns
Overrides
getSpriteHeightPixels()
public int getSpriteHeightPixels ()
Required. The height of the sprite in pixels. Must be an even integer.
int32 sprite_height_pixels = 4 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
int The spriteHeightPixels.
getSpriteWidthPixels()
public int getSpriteWidthPixels ()
Required. The width of the sprite in pixels. Must be an even integer.
int32 sprite_width_pixels = 3 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
int The spriteWidthPixels.
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
hasInterval()
public boolean hasInterval ()
Create sprites at regular intervals. Valid range is [1 second, 1 hour] and
the default value is 10s.
.google.protobuf.Duration interval = 7;
Returns
Type Description
boolean Whether the interval field is set.
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public SpriteSheet . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SpriteSheet . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public SpriteSheet . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-30 UTC."],[],[]]
