Class SpriteSheet (0.4.3)

publicfinalclass SpriteSheetextendsGeneratedMessageV3implementsSpriteSheetOrBuilder

Sprite sheet configuration.

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

Inherited Members

Fields

COLUMN_COUNT_FIELD_NUMBER

publicstaticfinalintCOLUMN_COUNT_FIELD_NUMBER
Field Value
Type Description
int

END_TIME_OFFSET_FIELD_NUMBER

publicstaticfinalintEND_TIME_OFFSET_FIELD_NUMBER
Field Value
Type Description
int

FILE_PREFIX_FIELD_NUMBER

publicstaticfinalintFILE_PREFIX_FIELD_NUMBER
Field Value
Type Description
int

FORMAT_FIELD_NUMBER

publicstaticfinalintFORMAT_FIELD_NUMBER
Field Value
Type Description
int

INTERVAL_FIELD_NUMBER

publicstaticfinalintINTERVAL_FIELD_NUMBER
Field Value
Type Description
int

QUALITY_FIELD_NUMBER

publicstaticfinalintQUALITY_FIELD_NUMBER
Field Value
Type Description
int

ROW_COUNT_FIELD_NUMBER

publicstaticfinalintROW_COUNT_FIELD_NUMBER
Field Value
Type Description
int

SPRITE_HEIGHT_PIXELS_FIELD_NUMBER

publicstaticfinalintSPRITE_HEIGHT_PIXELS_FIELD_NUMBER
Field Value
Type Description
int

SPRITE_WIDTH_PIXELS_FIELD_NUMBER

publicstaticfinalintSPRITE_WIDTH_PIXELS_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_OFFSET_FIELD_NUMBER

publicstaticfinalintSTART_TIME_OFFSET_FIELD_NUMBER
Field Value
Type Description
int

TOTAL_COUNT_FIELD_NUMBER

publicstaticfinalintTOTAL_COUNT_FIELD_NUMBER
Field Value
Type Description
int

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
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.

getDefaultInstance()

publicstaticSpriteSheetgetDefaultInstance()
Returns
Type Description

getDefaultInstanceForType()

publicSpriteSheetgetDefaultInstanceForType()
Returns
Type Description

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description

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.

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.

getIntervalOrBuilder()

publicDurationOrBuildergetIntervalOrBuilder()

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

.google.protobuf.Duration interval = 10;

Returns
Type Description

getParserForType()

publicParser<SpriteSheet>getParserForType()
Returns
Type Description
Overrides

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.

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

getUnknownFields()

publicfinalUnknownFieldSetgetUnknownFields()
Returns
Type Description
Overrides

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.

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
Overrides

newBuilder()

publicstaticSpriteSheet.BuildernewBuilder()
Returns
Type Description

newBuilder(SpriteSheet prototype)

publicstaticSpriteSheet.BuildernewBuilder(SpriteSheetprototype)
Parameter
Name Description
prototype SpriteSheet
Returns
Type Description

newBuilderForType()

publicSpriteSheet.BuildernewBuilderForType()
Returns
Type Description

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedSpriteSheet.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
Returns
Type Description
Overrides

parseDelimitedFrom(InputStream input)

publicstaticSpriteSheetparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
Exceptions
Type Description

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticSpriteSheetparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Exceptions
Type Description

parseFrom(byte[] data)

publicstaticSpriteSheetparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
Exceptions
Type Description

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticSpriteSheetparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Exceptions
Type Description

parseFrom(ByteString data)

publicstaticSpriteSheetparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
Exceptions
Type Description

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticSpriteSheetparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Exceptions
Type Description

parseFrom(CodedInputStream input)

publicstaticSpriteSheetparseFrom(CodedInputStreaminput)
Parameter
Name Description
Returns
Type Description
Exceptions
Type Description

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticSpriteSheetparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Exceptions
Type Description

parseFrom(InputStream input)

publicstaticSpriteSheetparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
Exceptions
Type Description

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticSpriteSheetparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Exceptions
Type Description

parseFrom(ByteBuffer data)

publicstaticSpriteSheetparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Exceptions
Type Description

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticSpriteSheetparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Exceptions
Type Description

parser()

publicstaticParser<SpriteSheet>parser()
Returns
Type Description

toBuilder()

publicSpriteSheet.BuildertoBuilder()
Returns
Type Description

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
Overrides Exceptions
Type Description

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.