Interface SpriteSheetOrBuilder (1.5.0)

Version 1.5.0

• 1.52.0 (latest)
• 1.51.0
• 1.50.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.5
• 1.0.4
• 0.4.3

public interface SpriteSheetOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

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 [(.google.api.field_behavior) = REQUIRED];

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 [(.google.api.field_behavior) = REQUIRED];

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).

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

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).

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

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.