Class SpriteSheet (0.50.0)

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
Type Description
int

FILE_PREFIX_FIELD_NUMBER

public static final int FILE_PREFIX_FIELD_NUMBER
Field Value
Type Description
int

FORMAT_FIELD_NUMBER

public static final int FORMAT_FIELD_NUMBER
Field Value
Type Description
int

INTERVAL_FIELD_NUMBER

public static final int INTERVAL_FIELD_NUMBER
Field Value
Type Description
int

QUALITY_FIELD_NUMBER

public static final int QUALITY_FIELD_NUMBER
Field Value
Type Description
int

ROW_COUNT_FIELD_NUMBER

public static final int ROW_COUNT_FIELD_NUMBER
Field Value
Type Description
int

SPRITE_HEIGHT_PIXELS_FIELD_NUMBER

public static final int SPRITE_HEIGHT_PIXELS_FIELD_NUMBER
Field Value
Type Description
int

SPRITE_WIDTH_PIXELS_FIELD_NUMBER

public static final int SPRITE_WIDTH_PIXELS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SpriteSheet getDefaultInstance()
Returns
Type Description
SpriteSheet

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SpriteSheet.Builder newBuilder()
Returns
Type Description
SpriteSheet.Builder

newBuilder(SpriteSheet prototype)

public static SpriteSheet.Builder newBuilder(SpriteSheet prototype)
Parameter
Name Description
prototype SpriteSheet
Returns
Type Description
SpriteSheet.Builder

parseDelimitedFrom(InputStream input)

public static SpriteSheet parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SpriteSheet
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SpriteSheet parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpriteSheet
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SpriteSheet parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SpriteSheet
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SpriteSheet parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpriteSheet
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SpriteSheet parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SpriteSheet
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SpriteSheet parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpriteSheet
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SpriteSheet parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SpriteSheet
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SpriteSheet parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpriteSheet
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SpriteSheet parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SpriteSheet
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SpriteSheet parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpriteSheet
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SpriteSheet parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SpriteSheet
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SpriteSheet parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpriteSheet
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SpriteSheet> parser()
Returns
Type Description
Parser<SpriteSheet>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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
Type Description
SpriteSheet

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.

getFormat()

public String getFormat()

Format type. The default is jpeg.

Supported formats:

  • jpeg

string format = 1;

Returns
Type Description
String

The format.

getFormatBytes()

public ByteString getFormatBytes()

Format type. The default is jpeg.

Supported formats:

  • jpeg

string format = 1;

Returns
Type Description
ByteString

The bytes for format.

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
Type Description
Duration

The interval.

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
Type Description
DurationOrBuilder

getParserForType()

public Parser<SpriteSheet> getParserForType()
Returns
Type Description
Parser<SpriteSheet>
Overrides

getQuality()

public int 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()

public int 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
Type Description
int
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.

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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SpriteSheet.Builder newBuilderForType()
Returns
Type Description
SpriteSheet.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SpriteSheet.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SpriteSheet.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SpriteSheet.Builder toBuilder()
Returns
Type Description
SpriteSheet.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException