Class SpriteSheet.Builder (0.49.0)

public static final class SpriteSheet.Builder extends GeneratedMessageV3.Builder<SpriteSheet.Builder> implements SpriteSheetOrBuilder

Sprite sheet configuration.

Protobuf type google.cloud.video.livestream.v1.SpriteSheet

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SpriteSheet.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SpriteSheet.Builder
Overrides

build()

public SpriteSheet build()
Returns
Type Description
SpriteSheet

buildPartial()

public SpriteSheet buildPartial()
Returns
Type Description
SpriteSheet

clear()

public SpriteSheet.Builder clear()
Returns
Type Description
SpriteSheet.Builder
Overrides

clearColumnCount()

public SpriteSheet.Builder clearColumnCount()

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
SpriteSheet.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SpriteSheet.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SpriteSheet.Builder
Overrides

clearFilePrefix()

public SpriteSheet.Builder clearFilePrefix()

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
SpriteSheet.Builder

This builder for chaining.

clearFormat()

public SpriteSheet.Builder clearFormat()

Format type. The default is jpeg.

Supported formats:

  • jpeg

string format = 1;

Returns
Type Description
SpriteSheet.Builder

This builder for chaining.

clearInterval()

public SpriteSheet.Builder clearInterval()

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
SpriteSheet.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public SpriteSheet.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SpriteSheet.Builder
Overrides

clearQuality()

public SpriteSheet.Builder clearQuality()

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
SpriteSheet.Builder

This builder for chaining.

clearRowCount()

public SpriteSheet.Builder clearRowCount()

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
SpriteSheet.Builder

This builder for chaining.

clearSpriteHeightPixels()

public SpriteSheet.Builder clearSpriteHeightPixels()

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
SpriteSheet.Builder

This builder for chaining.

clearSpriteWidthPixels()

public SpriteSheet.Builder clearSpriteWidthPixels()

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
SpriteSheet.Builder

This builder for chaining.

clone()

public SpriteSheet.Builder clone()
Returns
Type Description
SpriteSheet.Builder
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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getIntervalBuilder()

public Duration.Builder getIntervalBuilder()

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
Builder

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

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SpriteSheet other)

public SpriteSheet.Builder mergeFrom(SpriteSheet other)
Parameter
Name Description
other SpriteSheet
Returns
Type Description
SpriteSheet.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SpriteSheet.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SpriteSheet.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SpriteSheet.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SpriteSheet.Builder
Overrides

mergeInterval(Duration value)

public SpriteSheet.Builder mergeInterval(Duration value)

Create sprites at regular intervals. Valid range is [1 second, 1 hour] and the default value is 10s.

.google.protobuf.Duration interval = 7;

Parameter
Name Description
value Duration
Returns
Type Description
SpriteSheet.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SpriteSheet.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SpriteSheet.Builder
Overrides

setColumnCount(int value)

public SpriteSheet.Builder setColumnCount(int value)

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;

Parameter
Name Description
value int

The columnCount to set.

Returns
Type Description
SpriteSheet.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public SpriteSheet.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SpriteSheet.Builder
Overrides

setFilePrefix(String value)

public SpriteSheet.Builder setFilePrefix(String value)

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];

Parameter
Name Description
value String

The filePrefix to set.

Returns
Type Description
SpriteSheet.Builder

This builder for chaining.

setFilePrefixBytes(ByteString value)

public SpriteSheet.Builder setFilePrefixBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for filePrefix to set.

Returns
Type Description
SpriteSheet.Builder

This builder for chaining.

setFormat(String value)

public SpriteSheet.Builder setFormat(String value)

Format type. The default is jpeg.

Supported formats:

  • jpeg

string format = 1;

Parameter
Name Description
value String

The format to set.

Returns
Type Description
SpriteSheet.Builder

This builder for chaining.

setFormatBytes(ByteString value)

public SpriteSheet.Builder setFormatBytes(ByteString value)

Format type. The default is jpeg.

Supported formats:

  • jpeg

string format = 1;

Parameter
Name Description
value ByteString

The bytes for format to set.

Returns
Type Description
SpriteSheet.Builder

This builder for chaining.

setInterval(Duration value)

public SpriteSheet.Builder setInterval(Duration value)

Create sprites at regular intervals. Valid range is [1 second, 1 hour] and the default value is 10s.

.google.protobuf.Duration interval = 7;

Parameter
Name Description
value Duration
Returns
Type Description
SpriteSheet.Builder

setInterval(Duration.Builder builderForValue)

public SpriteSheet.Builder setInterval(Duration.Builder builderForValue)

Create sprites at regular intervals. Valid range is [1 second, 1 hour] and the default value is 10s.

.google.protobuf.Duration interval = 7;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
SpriteSheet.Builder

setQuality(int value)

public SpriteSheet.Builder setQuality(int value)

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;

Parameter
Name Description
value int

The quality to set.

Returns
Type Description
SpriteSheet.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SpriteSheet.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
SpriteSheet.Builder
Overrides

setRowCount(int value)

public SpriteSheet.Builder setRowCount(int value)

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;

Parameter
Name Description
value int

The rowCount to set.

Returns
Type Description
SpriteSheet.Builder

This builder for chaining.

setSpriteHeightPixels(int value)

public SpriteSheet.Builder setSpriteHeightPixels(int value)

Required. The height of the sprite in pixels. Must be an even integer.

int32 sprite_height_pixels = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

The spriteHeightPixels to set.

Returns
Type Description
SpriteSheet.Builder

This builder for chaining.

setSpriteWidthPixels(int value)

public SpriteSheet.Builder setSpriteWidthPixels(int value)

Required. The width of the sprite in pixels. Must be an even integer.

int32 sprite_width_pixels = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

The spriteWidthPixels to set.

Returns
Type Description
SpriteSheet.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SpriteSheet.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SpriteSheet.Builder
Overrides