Class SpriteSheet.Builder (1.2.3)

Stay organized with collections Save and categorize content based on your preferences.
public static final class SpriteSheet.Builder extends GeneratedMessageV3.Builder<SpriteSheet.Builder> implements SpriteSheetOrBuilder

Sprite sheet configuration.

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SpriteSheet.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SpriteSheet.Builder
Overrides

build()

public SpriteSheet build()
Returns
TypeDescription
SpriteSheet

buildPartial()

public SpriteSheet buildPartial()
Returns
TypeDescription
SpriteSheet

clear()

public SpriteSheet.Builder clear()
Returns
TypeDescription
SpriteSheet.Builder
Overrides

clearColumnCount()

public SpriteSheet.Builder clearColumnCount()

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

This builder for chaining.

clearEndTimeOffset()

public SpriteSheet.Builder clearEndTimeOffset()

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

clearExtractionStrategy()

public SpriteSheet.Builder clearExtractionStrategy()
Returns
TypeDescription
SpriteSheet.Builder

clearField(Descriptors.FieldDescriptor field)

public SpriteSheet.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
SpriteSheet.Builder
Overrides

clearFilePrefix()

public SpriteSheet.Builder clearFilePrefix()

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

This builder for chaining.

clearFormat()

public SpriteSheet.Builder clearFormat()

Format type. The default is jpeg. Supported formats:

  • jpeg

string format = 1;

Returns
TypeDescription
SpriteSheet.Builder

This builder for chaining.

clearInterval()

public SpriteSheet.Builder clearInterval()

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

.google.protobuf.Duration interval = 10;

Returns
TypeDescription
SpriteSheet.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public SpriteSheet.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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 = 11;

Returns
TypeDescription
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. The default is 0, which indicates no maximum limit.

int32 row_count = 6;

Returns
TypeDescription
SpriteSheet.Builder

This builder for chaining.

clearSpriteHeightPixels()

public SpriteSheet.Builder clearSpriteHeightPixels()

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

This builder for chaining.

clearSpriteWidthPixels()

public SpriteSheet.Builder clearSpriteWidthPixels()

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

This builder for chaining.

clearStartTimeOffset()

public SpriteSheet.Builder clearStartTimeOffset()

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

clearTotalCount()

public SpriteSheet.Builder clearTotalCount()

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

This builder for chaining.

clone()

public SpriteSheet.Builder clone()
Returns
TypeDescription
SpriteSheet.Builder
Overrides

getColumnCount()

public int getColumnCount()

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
TypeDescription
int

The columnCount.

getDefaultInstanceForType()

public SpriteSheet getDefaultInstanceForType()
Returns
TypeDescription
SpriteSheet

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEndTimeOffset()

public Duration getEndTimeOffset()

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
TypeDescription
Duration

The endTimeOffset.

getEndTimeOffsetBuilder()

public Duration.Builder getEndTimeOffsetBuilder()

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
TypeDescription
Builder

getEndTimeOffsetOrBuilder()

public DurationOrBuilder getEndTimeOffsetOrBuilder()

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
TypeDescription
DurationOrBuilder

getExtractionStrategyCase()

public SpriteSheet.ExtractionStrategyCase getExtractionStrategyCase()
Returns
TypeDescription
SpriteSheet.ExtractionStrategyCase

getFilePrefix()

public String getFilePrefix()

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
TypeDescription
String

The filePrefix.

getFilePrefixBytes()

public ByteString getFilePrefixBytes()

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
TypeDescription
ByteString

The bytes for filePrefix.

getFormat()

public String getFormat()

Format type. The default is jpeg. Supported formats:

  • jpeg

string format = 1;

Returns
TypeDescription
String

The format.

getFormatBytes()

public ByteString getFormatBytes()

Format type. The default is jpeg. Supported formats:

  • jpeg

string format = 1;

Returns
TypeDescription
ByteString

The bytes for format.

getInterval()

public Duration getInterval()

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

.google.protobuf.Duration interval = 10;

Returns
TypeDescription
Duration

The interval.

getIntervalBuilder()

public Duration.Builder getIntervalBuilder()

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

.google.protobuf.Duration interval = 10;

Returns
TypeDescription
Builder

getIntervalOrBuilder()

public DurationOrBuilder getIntervalOrBuilder()

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

.google.protobuf.Duration interval = 10;

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

Returns
TypeDescription
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. The default is 0, which indicates no maximum limit.

int32 row_count = 6;

Returns
TypeDescription
int

The rowCount.

getSpriteHeightPixels()

public int getSpriteHeightPixels()

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
TypeDescription
int

The spriteHeightPixels.

getSpriteWidthPixels()

public int getSpriteWidthPixels()

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
TypeDescription
int

The spriteWidthPixels.

getStartTimeOffset()

public Duration getStartTimeOffset()

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
TypeDescription
Duration

The startTimeOffset.

getStartTimeOffsetBuilder()

public Duration.Builder getStartTimeOffsetBuilder()

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
TypeDescription
Builder

getStartTimeOffsetOrBuilder()

public DurationOrBuilder getStartTimeOffsetOrBuilder()

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
TypeDescription
DurationOrBuilder

getTotalCount()

public int getTotalCount()

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
TypeDescription
int

The totalCount.

hasEndTimeOffset()

public boolean hasEndTimeOffset()

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
TypeDescription
boolean

Whether the endTimeOffset field is set.

hasInterval()

public boolean hasInterval()

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

.google.protobuf.Duration interval = 10;

Returns
TypeDescription
boolean

Whether the interval field is set.

hasStartTimeOffset()

public boolean hasStartTimeOffset()

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
TypeDescription
boolean

Whether the startTimeOffset field is set.

hasTotalCount()

public boolean hasTotalCount()

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
TypeDescription
boolean

Whether the totalCount field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeEndTimeOffset(Duration value)

public SpriteSheet.Builder mergeEndTimeOffset(Duration value)

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
NameDescription
valueDuration
Returns
TypeDescription
SpriteSheet.Builder

mergeFrom(SpriteSheet other)

public SpriteSheet.Builder mergeFrom(SpriteSheet other)
Parameter
NameDescription
otherSpriteSheet
Returns
TypeDescription
SpriteSheet.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SpriteSheet.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SpriteSheet.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public SpriteSheet.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
SpriteSheet.Builder
Overrides

mergeInterval(Duration value)

public SpriteSheet.Builder mergeInterval(Duration value)

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

.google.protobuf.Duration interval = 10;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
SpriteSheet.Builder

mergeStartTimeOffset(Duration value)

public SpriteSheet.Builder mergeStartTimeOffset(Duration value)

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
NameDescription
valueDuration
Returns
TypeDescription
SpriteSheet.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SpriteSheet.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SpriteSheet.Builder
Overrides

setColumnCount(int value)

public SpriteSheet.Builder setColumnCount(int value)

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
NameDescription
valueint

The columnCount to set.

Returns
TypeDescription
SpriteSheet.Builder

This builder for chaining.

setEndTimeOffset(Duration value)

public SpriteSheet.Builder setEndTimeOffset(Duration value)

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
NameDescription
valueDuration
Returns
TypeDescription
SpriteSheet.Builder

setEndTimeOffset(Duration.Builder builderForValue)

public SpriteSheet.Builder setEndTimeOffset(Duration.Builder builderForValue)

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
NameDescription
builderForValueBuilder
Returns
TypeDescription
SpriteSheet.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public SpriteSheet.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SpriteSheet.Builder
Overrides

setFilePrefix(String value)

public SpriteSheet.Builder setFilePrefix(String value)

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
NameDescription
valueString

The filePrefix to set.

Returns
TypeDescription
SpriteSheet.Builder

This builder for chaining.

setFilePrefixBytes(ByteString value)

public SpriteSheet.Builder setFilePrefixBytes(ByteString value)

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
NameDescription
valueByteString

The bytes for filePrefix to set.

Returns
TypeDescription
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
NameDescription
valueString

The format to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for format to set.

Returns
TypeDescription
SpriteSheet.Builder

This builder for chaining.

setInterval(Duration value)

public SpriteSheet.Builder setInterval(Duration value)

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

.google.protobuf.Duration interval = 10;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
SpriteSheet.Builder

setInterval(Duration.Builder builderForValue)

public SpriteSheet.Builder setInterval(Duration.Builder builderForValue)

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

.google.protobuf.Duration interval = 10;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
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 = 11;

Parameter
NameDescription
valueint

The quality to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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. The default is 0, which indicates no maximum limit.

int32 row_count = 6;

Parameter
NameDescription
valueint

The rowCount to set.

Returns
TypeDescription
SpriteSheet.Builder

This builder for chaining.

setSpriteHeightPixels(int value)

public SpriteSheet.Builder setSpriteHeightPixels(int value)

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
NameDescription
valueint

The spriteHeightPixels to set.

Returns
TypeDescription
SpriteSheet.Builder

This builder for chaining.

setSpriteWidthPixels(int value)

public SpriteSheet.Builder setSpriteWidthPixels(int value)

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
NameDescription
valueint

The spriteWidthPixels to set.

Returns
TypeDescription
SpriteSheet.Builder

This builder for chaining.

setStartTimeOffset(Duration value)

public SpriteSheet.Builder setStartTimeOffset(Duration value)

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
NameDescription
valueDuration
Returns
TypeDescription
SpriteSheet.Builder

setStartTimeOffset(Duration.Builder builderForValue)

public SpriteSheet.Builder setStartTimeOffset(Duration.Builder builderForValue)

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
NameDescription
builderForValueBuilder
Returns
TypeDescription
SpriteSheet.Builder

setTotalCount(int value)

public SpriteSheet.Builder setTotalCount(int value)

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
NameDescription
valueint

The totalCount to set.

Returns
TypeDescription
SpriteSheet.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SpriteSheet.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SpriteSheet.Builder
Overrides