Class SpriteSheet.Builder (0.4.3)

publicstaticfinalclass SpriteSheet.BuilderextendsGeneratedMessageV3.Builder<SpriteSheet.Builder>implementsSpriteSheetOrBuilder

Sprite sheet configuration.

Protobuf type google.cloud.video.transcoder.v1beta1.SpriteSheet

Inherited Members

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

publicSpriteSheet.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
value Object
Returns
Type Description
Overrides

build()

publicSpriteSheetbuild()
Returns
Type Description

buildPartial()

publicSpriteSheetbuildPartial()
Returns
Type Description

clear()

publicSpriteSheet.Builderclear()
Returns
Type Description
Overrides

clearColumnCount()

publicSpriteSheet.BuilderclearColumnCount()

The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit.

int32 column_count = 5;

Returns
Type Description
SpriteSheet.Builder

This builder for chaining.

clearEndTimeOffset()

publicSpriteSheet.BuilderclearEndTimeOffset()

End time in seconds, relative to the output file timeline. When end_time_offset is not specified, the sprites are generated until the end of the output file.

.google.protobuf.Duration end_time_offset = 8;

Returns
Type Description

clearExtractionStrategy()

publicSpriteSheet.BuilderclearExtractionStrategy()
Returns
Type Description

clearField(Descriptors.FieldDescriptor field)

publicSpriteSheet.BuilderclearField(Descriptors.FieldDescriptorfield)
Parameter
Name Description
Returns
Type Description
Overrides

clearFilePrefix()

publicSpriteSheet.BuilderclearFilePrefix()

Required. File name prefix for the generated sprite sheets. 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()

publicSpriteSheet.BuilderclearFormat()

Format type. The default is "jpeg". Supported formats:

  • 'jpeg'

string format = 1;

Returns
Type Description
SpriteSheet.Builder

This builder for chaining.

clearInterval()

publicSpriteSheet.BuilderclearInterval()

Starting from 0s, create sprites at regular intervals. Specify the interval value in seconds.

.google.protobuf.Duration interval = 10;

Returns
Type Description

clearOneof(Descriptors.OneofDescriptor oneof)

publicSpriteSheet.BuilderclearOneof(Descriptors.OneofDescriptoroneof)
Parameter
Name Description
Returns
Type Description
Overrides

clearQuality()

publicSpriteSheet.BuilderclearQuality()

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 = 11;

Returns
Type Description
SpriteSheet.Builder

This builder for chaining.

clearRowCount()

publicSpriteSheet.BuilderclearRowCount()

The maximum number of rows per sprite sheet. When the sprite sheet is full, a new sprite sheet is created. The default is 0, which indicates no maximum limit.

int32 row_count = 6;

Returns
Type Description
SpriteSheet.Builder

This builder for chaining.

clearSpriteHeightPixels()

publicSpriteSheet.BuilderclearSpriteHeightPixels()

Required. The height of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_height_pixels field or the SpriteSheet.sprite_width_pixels field, but not both (the API will automatically calculate the missing field).

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

Returns
Type Description
SpriteSheet.Builder

This builder for chaining.

clearSpriteWidthPixels()

publicSpriteSheet.BuilderclearSpriteWidthPixels()

Required. The width of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_width_pixels field or the SpriteSheet.sprite_height_pixels field, but not both (the API will automatically calculate the missing field).

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

Returns
Type Description
SpriteSheet.Builder

This builder for chaining.

clearStartTimeOffset()

publicSpriteSheet.BuilderclearStartTimeOffset()

Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is 0s.

.google.protobuf.Duration start_time_offset = 7;

Returns
Type Description

clearTotalCount()

publicSpriteSheet.BuilderclearTotalCount()

Total number of sprites. Create the specified number of sprites distributed evenly across the timeline of the output media. The default is 100.

int32 total_count = 9;

Returns
Type Description
SpriteSheet.Builder

This builder for chaining.

clone()

publicSpriteSheet.Builderclone()
Returns
Type Description
Overrides

getColumnCount()

publicintgetColumnCount()

The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit.

int32 column_count = 5;

Returns
Type Description
int

The columnCount.

getDefaultInstanceForType()

publicSpriteSheetgetDefaultInstanceForType()
Returns
Type Description

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description

getDescriptorForType()

publicDescriptors.DescriptorgetDescriptorForType()
Returns
Type Description
Overrides

getEndTimeOffset()

publicDurationgetEndTimeOffset()

End time in seconds, relative to the output file timeline. When end_time_offset is not specified, the sprites are generated until the end of the output file.

.google.protobuf.Duration end_time_offset = 8;

Returns
Type Description
Duration

The endTimeOffset.

getEndTimeOffsetBuilder()

publicDuration.BuildergetEndTimeOffsetBuilder()

End time in seconds, relative to the output file timeline. When end_time_offset is not specified, the sprites are generated until the end of the output file.

.google.protobuf.Duration end_time_offset = 8;

Returns
Type Description

getEndTimeOffsetOrBuilder()

publicDurationOrBuildergetEndTimeOffsetOrBuilder()

End time in seconds, relative to the output file timeline. When end_time_offset is not specified, the sprites are generated until the end of the output file.

.google.protobuf.Duration end_time_offset = 8;

Returns
Type Description

getExtractionStrategyCase()

publicSpriteSheet.ExtractionStrategyCasegetExtractionStrategyCase()
Returns
Type Description

getFilePrefix()

publicStringgetFilePrefix()

Required. File name prefix for the generated sprite sheets. 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()

publicByteStringgetFilePrefixBytes()

Required. File name prefix for the generated sprite sheets. 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()

publicStringgetFormat()

Format type. The default is "jpeg". Supported formats:

  • 'jpeg'

string format = 1;

Returns
Type Description
String

The format.

getFormatBytes()

publicByteStringgetFormatBytes()

Format type. The default is "jpeg". Supported formats:

  • 'jpeg'

string format = 1;

Returns
Type Description
ByteString

The bytes for format.

getInterval()

publicDurationgetInterval()

Starting from 0s, create sprites at regular intervals. Specify the interval value in seconds.

.google.protobuf.Duration interval = 10;

Returns
Type Description
Duration

The interval.

getIntervalBuilder()

publicDuration.BuildergetIntervalBuilder()

Starting from 0s, create sprites at regular intervals. Specify the interval value in seconds.

.google.protobuf.Duration interval = 10;

Returns
Type Description

getIntervalOrBuilder()

publicDurationOrBuildergetIntervalOrBuilder()

Starting from 0s, create sprites at regular intervals. Specify the interval value in seconds.

.google.protobuf.Duration interval = 10;

Returns
Type Description

getQuality()

publicintgetQuality()

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 = 11;

Returns
Type Description
int

The quality.

getRowCount()

publicintgetRowCount()

The maximum number of rows per sprite sheet. When the sprite sheet is full, a new sprite sheet is created. The default is 0, which indicates no maximum limit.

int32 row_count = 6;

Returns
Type Description
int

The rowCount.

getSpriteHeightPixels()

publicintgetSpriteHeightPixels()

Required. The height of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_height_pixels field or the SpriteSheet.sprite_width_pixels field, but not both (the API will automatically calculate the missing field).

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

Returns
Type Description
int

The spriteHeightPixels.

getSpriteWidthPixels()

publicintgetSpriteWidthPixels()

Required. The width of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_width_pixels field or the SpriteSheet.sprite_height_pixels field, but not both (the API will automatically calculate the missing field).

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

Returns
Type Description
int

The spriteWidthPixels.

getStartTimeOffset()

publicDurationgetStartTimeOffset()

Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is 0s.

.google.protobuf.Duration start_time_offset = 7;

Returns
Type Description
Duration

The startTimeOffset.

getStartTimeOffsetBuilder()

publicDuration.BuildergetStartTimeOffsetBuilder()

Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is 0s.

.google.protobuf.Duration start_time_offset = 7;

Returns
Type Description

getStartTimeOffsetOrBuilder()

publicDurationOrBuildergetStartTimeOffsetOrBuilder()

Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is 0s.

.google.protobuf.Duration start_time_offset = 7;

Returns
Type Description

getTotalCount()

publicintgetTotalCount()

Total number of sprites. Create the specified number of sprites distributed evenly across the timeline of the output media. The default is 100.

int32 total_count = 9;

Returns
Type Description
int

The totalCount.

hasEndTimeOffset()

publicbooleanhasEndTimeOffset()

End time in seconds, relative to the output file timeline. When end_time_offset is not specified, the sprites are generated until the end of the output file.

.google.protobuf.Duration end_time_offset = 8;

Returns
Type Description
boolean

Whether the endTimeOffset field is set.

hasInterval()

publicbooleanhasInterval()

Starting from 0s, create sprites at regular intervals. Specify the interval value in seconds.

.google.protobuf.Duration interval = 10;

Returns
Type Description
boolean

Whether the interval field is set.

hasStartTimeOffset()

publicbooleanhasStartTimeOffset()

Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is 0s.

.google.protobuf.Duration start_time_offset = 7;

Returns
Type Description
boolean

Whether the startTimeOffset field is set.

hasTotalCount()

publicbooleanhasTotalCount()

Total number of sprites. Create the specified number of sprites distributed evenly across the timeline of the output media. The default is 100.

int32 total_count = 9;

Returns
Type Description
boolean

Whether the totalCount field is set.

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
Overrides

mergeEndTimeOffset(Duration value)

publicSpriteSheet.BuildermergeEndTimeOffset(Durationvalue)

End time in seconds, relative to the output file timeline. When end_time_offset is not specified, the sprites are generated until the end of the output file.

.google.protobuf.Duration end_time_offset = 8;

Parameter
Name Description
value Duration
Returns
Type Description

mergeFrom(SpriteSheet other)

publicSpriteSheet.BuildermergeFrom(SpriteSheetother)
Parameter
Name Description
other SpriteSheet
Returns
Type Description

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicSpriteSheet.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Overrides Exceptions
Type Description

mergeFrom(Message other)

publicSpriteSheet.BuildermergeFrom(Messageother)
Parameter
Name Description
other Message
Returns
Type Description
Overrides

mergeInterval(Duration value)

publicSpriteSheet.BuildermergeInterval(Durationvalue)

Starting from 0s, create sprites at regular intervals. Specify the interval value in seconds.

.google.protobuf.Duration interval = 10;

Parameter
Name Description
value Duration
Returns
Type Description

mergeStartTimeOffset(Duration value)

publicSpriteSheet.BuildermergeStartTimeOffset(Durationvalue)

Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is 0s.

.google.protobuf.Duration start_time_offset = 7;

Parameter
Name Description
value Duration
Returns
Type Description

mergeUnknownFields(UnknownFieldSet unknownFields)

publicfinalSpriteSheet.BuildermergeUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Overrides

setColumnCount(int value)

publicSpriteSheet.BuildersetColumnCount(intvalue)

The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit.

int32 column_count = 5;

Parameter
Name Description
value int

The columnCount to set.

Returns
Type Description
SpriteSheet.Builder

This builder for chaining.

setEndTimeOffset(Duration value)

publicSpriteSheet.BuildersetEndTimeOffset(Durationvalue)

End time in seconds, relative to the output file timeline. When end_time_offset is not specified, the sprites are generated until the end of the output file.

.google.protobuf.Duration end_time_offset = 8;

Parameter
Name Description
value Duration
Returns
Type Description

setEndTimeOffset(Duration.Builder builderForValue)

publicSpriteSheet.BuildersetEndTimeOffset(Duration.BuilderbuilderForValue)

End time in seconds, relative to the output file timeline. When end_time_offset is not specified, the sprites are generated until the end of the output file.

.google.protobuf.Duration end_time_offset = 8;

Parameter
Name Description
builderForValue Builder
Returns
Type Description

setField(Descriptors.FieldDescriptor field, Object value)

publicSpriteSheet.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
value Object
Returns
Type Description
Overrides

setFilePrefix(String value)

publicSpriteSheet.BuildersetFilePrefix(Stringvalue)

Required. File name prefix for the generated sprite sheets. 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)

publicSpriteSheet.BuildersetFilePrefixBytes(ByteStringvalue)

Required. File name prefix for the generated sprite sheets. 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)

publicSpriteSheet.BuildersetFormat(Stringvalue)

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)

publicSpriteSheet.BuildersetFormatBytes(ByteStringvalue)

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)

publicSpriteSheet.BuildersetInterval(Durationvalue)

Starting from 0s, create sprites at regular intervals. Specify the interval value in seconds.

.google.protobuf.Duration interval = 10;

Parameter
Name Description
value Duration
Returns
Type Description

setInterval(Duration.Builder builderForValue)

publicSpriteSheet.BuildersetInterval(Duration.BuilderbuilderForValue)

Starting from 0s, create sprites at regular intervals. Specify the interval value in seconds.

.google.protobuf.Duration interval = 10;

Parameter
Name Description
builderForValue Builder
Returns
Type Description

setQuality(int value)

publicSpriteSheet.BuildersetQuality(intvalue)

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 = 11;

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)

publicSpriteSheet.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)
Parameters
Name Description
index int
value Object
Returns
Type Description
Overrides

setRowCount(int value)

publicSpriteSheet.BuildersetRowCount(intvalue)

The maximum number of rows per sprite sheet. When the sprite sheet is full, a new sprite sheet is created. The default is 0, which indicates no maximum limit.

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)

publicSpriteSheet.BuildersetSpriteHeightPixels(intvalue)

Required. The height of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_height_pixels field or the SpriteSheet.sprite_width_pixels field, but not both (the API will automatically calculate the missing field).

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)

publicSpriteSheet.BuildersetSpriteWidthPixels(intvalue)

Required. The width of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_width_pixels field or the SpriteSheet.sprite_height_pixels field, but not both (the API will automatically calculate the missing field).

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.

setStartTimeOffset(Duration value)

publicSpriteSheet.BuildersetStartTimeOffset(Durationvalue)

Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is 0s.

.google.protobuf.Duration start_time_offset = 7;

Parameter
Name Description
value Duration
Returns
Type Description

setStartTimeOffset(Duration.Builder builderForValue)

publicSpriteSheet.BuildersetStartTimeOffset(Duration.BuilderbuilderForValue)

Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is 0s.

.google.protobuf.Duration start_time_offset = 7;

Parameter
Name Description
builderForValue Builder
Returns
Type Description

setTotalCount(int value)

publicSpriteSheet.BuildersetTotalCount(intvalue)

Total number of sprites. Create the specified number of sprites distributed evenly across the timeline of the output media. The default is 100.

int32 total_count = 9;

Parameter
Name Description
value int

The totalCount to set.

Returns
Type Description
SpriteSheet.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

publicfinalSpriteSheet.BuildersetUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Overrides

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年11月19日 UTC.