public interface SpriteSheetOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getColumnCount()
public abstract 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 | |
|---|---|
| Type | Description |
int |
The columnCount. |
getEndTimeOffset()
public abstract 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 | |
|---|---|
| Type | Description |
Duration |
The endTimeOffset. |
getEndTimeOffsetOrBuilder()
public abstract 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 | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getExtractionStrategyCase()
public abstract SpriteSheet.ExtractionStrategyCase getExtractionStrategyCase()| Returns | |
|---|---|
| Type | Description |
SpriteSheet.ExtractionStrategyCase |
|
getFilePrefix()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
String |
The filePrefix. |
getFilePrefixBytes()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for filePrefix. |
getFormat()
public abstract String getFormat() Format type. The default is jpeg.
Supported formats:
jpeg
string format = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The format. |
getFormatBytes()
public abstract ByteString getFormatBytes() Format type. The default is jpeg.
Supported formats:
jpeg
string format = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for format. |
getInterval()
public abstract Duration getInterval() 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()
public abstract DurationOrBuilder getIntervalOrBuilder() Starting from 0s, create sprites at regular intervals. Specify the
interval value in seconds.
.google.protobuf.Duration interval = 10;
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getQuality()
public abstract 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 | |
|---|---|
| Type | Description |
int |
The quality. |
getRowCount()
public abstract 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 | |
|---|---|
| Type | Description |
int |
The rowCount. |
getSpriteHeightPixels()
public abstract 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). For portrait videos that contain horizontal ASR and rotation metadata, provide the height, in pixels, per the horizontal ASR. The API calculates the width per the horizontal ASR. The API detects any rotation metadata and swaps the requested height and width for the output.
int32 sprite_height_pixels = 4;
| Returns | |
|---|---|
| Type | Description |
int |
The spriteHeightPixels. |
getSpriteWidthPixels()
public abstract 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). For portrait videos that contain horizontal ASR and rotation metadata, provide the width, in pixels, per the horizontal ASR. The API calculates the height per the horizontal ASR. The API detects any rotation metadata and swaps the requested height and width for the output.
int32 sprite_width_pixels = 3;
| Returns | |
|---|---|
| Type | Description |
int |
The spriteWidthPixels. |
getStartTimeOffset()
public abstract 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 | |
|---|---|
| Type | Description |
Duration |
The startTimeOffset. |
getStartTimeOffsetOrBuilder()
public abstract 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 | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getTotalCount()
public abstract 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 | |
|---|---|
| Type | Description |
int |
The totalCount. |
hasEndTimeOffset()
public abstract 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 | |
|---|---|
| Type | Description |
boolean |
Whether the endTimeOffset field is set. |
hasInterval()
public abstract boolean hasInterval() 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()
public abstract 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 | |
|---|---|
| Type | Description |
boolean |
Whether the startTimeOffset field is set. |
hasTotalCount()
public abstract 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 | |
|---|---|
| Type | Description |
boolean |
Whether the totalCount field is set. |