Class SpriteSheet (0.14.1)

public final class SpriteSheet extends GeneratedMessageV3 implements SpriteSheetOrBuilder

Sprite sheet configuration.

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

Static Fields

COLUMN_COUNT_FIELD_NUMBER

public static final int COLUMN_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

END_TIME_OFFSET_FIELD_NUMBER

public static final int END_TIME_OFFSET_FIELD_NUMBER
Field Value
TypeDescription
int

FILE_PREFIX_FIELD_NUMBER

public static final int FILE_PREFIX_FIELD_NUMBER
Field Value
TypeDescription
int

FORMAT_FIELD_NUMBER

public static final int FORMAT_FIELD_NUMBER
Field Value
TypeDescription
int

INTERVAL_FIELD_NUMBER

public static final int INTERVAL_FIELD_NUMBER
Field Value
TypeDescription
int

QUALITY_FIELD_NUMBER

public static final int QUALITY_FIELD_NUMBER
Field Value
TypeDescription
int

ROW_COUNT_FIELD_NUMBER

public static final int ROW_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

SPRITE_HEIGHT_PIXELS_FIELD_NUMBER

public static final int SPRITE_HEIGHT_PIXELS_FIELD_NUMBER
Field Value
TypeDescription
int

SPRITE_WIDTH_PIXELS_FIELD_NUMBER

public static final int SPRITE_WIDTH_PIXELS_FIELD_NUMBER
Field Value
TypeDescription
int

START_TIME_OFFSET_FIELD_NUMBER

public static final int START_TIME_OFFSET_FIELD_NUMBER
Field Value
TypeDescription
int

TOTAL_COUNT_FIELD_NUMBER

public static final int TOTAL_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SpriteSheet getDefaultInstance()
Returns
TypeDescription
SpriteSheet

getDescriptor()

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

newBuilder()

public static SpriteSheet.Builder newBuilder()
Returns
TypeDescription
SpriteSheet.Builder

newBuilder(SpriteSheet prototype)

public static SpriteSheet.Builder newBuilder(SpriteSheet prototype)
Parameter
NameDescription
prototypeSpriteSheet
Returns
TypeDescription
SpriteSheet.Builder

parseDelimitedFrom(InputStream input)

public static SpriteSheet parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SpriteSheet
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SpriteSheet parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SpriteSheet
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SpriteSheet parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SpriteSheet
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SpriteSheet parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SpriteSheet
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SpriteSheet parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SpriteSheet
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SpriteSheet parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SpriteSheet
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SpriteSheet parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SpriteSheet
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SpriteSheet parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SpriteSheet
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SpriteSheet parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SpriteSheet
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SpriteSheet parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SpriteSheet
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SpriteSheet parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SpriteSheet
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SpriteSheet parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SpriteSheet
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SpriteSheet> parser()
Returns
TypeDescription
Parser<SpriteSheet>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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

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.

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;

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;

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.

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

getParserForType()

public Parser<SpriteSheet> getParserForType()
Returns
TypeDescription
Parser<SpriteSheet>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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

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.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SpriteSheet.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SpriteSheet.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException