com.google.cloud.video.transcoder.v1

Class SpriteSheet

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.video.transcoder.v1.SpriteSheet

All Implemented Interfaces:

SpriteSheetOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class SpriteSheet
extends com.google.protobuf.GeneratedMessageV3
implements SpriteSheetOrBuilder

 Sprite sheet configuration.
 

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpriteSheet.Builder Sprite sheet configuration.
static class	SpriteSheet.ExtractionStrategyCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	COLUMN_COUNT_FIELD_NUMBER
static int	END_TIME_OFFSET_FIELD_NUMBER
static int	FILE_PREFIX_FIELD_NUMBER
static int	FORMAT_FIELD_NUMBER
static int	INTERVAL_FIELD_NUMBER
static int	QUALITY_FIELD_NUMBER
static int	ROW_COUNT_FIELD_NUMBER
static int	SPRITE_HEIGHT_PIXELS_FIELD_NUMBER
static int	SPRITE_WIDTH_PIXELS_FIELD_NUMBER
static int	START_TIME_OFFSET_FIELD_NUMBER
static int	TOTAL_COUNT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	getColumnCount() The maximum number of sprites per row in a sprite sheet.
static SpriteSheet	getDefaultInstance()
SpriteSheet	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Duration	getEndTimeOffset() End time in seconds, relative to the output file timeline.
com.google.protobuf.DurationOrBuilder	getEndTimeOffsetOrBuilder() End time in seconds, relative to the output file timeline.
SpriteSheet.ExtractionStrategyCase	getExtractionStrategyCase()
String	getFilePrefix() Required.
com.google.protobuf.ByteString	getFilePrefixBytes() Required.
String	getFormat() Format type.
com.google.protobuf.ByteString	getFormatBytes() Format type.
com.google.protobuf.Duration	getInterval() Starting from `0s`, create sprites at regular intervals.
com.google.protobuf.DurationOrBuilder	getIntervalOrBuilder() Starting from `0s`, create sprites at regular intervals.
com.google.protobuf.Parser<SpriteSheet>	getParserForType()
int	getQuality() The quality of the generated sprite sheet.
int	getRowCount() The maximum number of rows per sprite sheet.
int	getSerializedSize()
int	getSpriteHeightPixels() Required.
int	getSpriteWidthPixels() Required.
com.google.protobuf.Duration	getStartTimeOffset() Start time in seconds, relative to the output file timeline.
com.google.protobuf.DurationOrBuilder	getStartTimeOffsetOrBuilder() Start time in seconds, relative to the output file timeline.
int	getTotalCount() Total number of sprites.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasEndTimeOffset() End time in seconds, relative to the output file timeline.
int	hashCode()
boolean	hasInterval() Starting from `0s`, create sprites at regular intervals.
boolean	hasStartTimeOffset() Start time in seconds, relative to the output file timeline.
boolean	hasTotalCount() Total number of sprites.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static SpriteSheet.Builder	newBuilder()
static SpriteSheet.Builder	newBuilder(SpriteSheet prototype)
SpriteSheet.Builder	newBuilderForType()
protected SpriteSheet.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static SpriteSheet	parseDelimitedFrom(InputStream input)
static SpriteSheet	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SpriteSheet	parseFrom(byte[] data)
static SpriteSheet	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SpriteSheet	parseFrom(ByteBuffer data)
static SpriteSheet	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SpriteSheet	parseFrom(com.google.protobuf.ByteString data)
static SpriteSheet	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SpriteSheet	parseFrom(com.google.protobuf.CodedInputStream input)
static SpriteSheet	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SpriteSheet	parseFrom(InputStream input)
static SpriteSheet	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SpriteSheet>	parser()
SpriteSheet.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

FORMAT_FIELD_NUMBER

public static final int FORMAT_FIELD_NUMBER

See Also:

Constant Field Values

FILE_PREFIX_FIELD_NUMBER

public static final int FILE_PREFIX_FIELD_NUMBER

See Also:

Constant Field Values

SPRITE_WIDTH_PIXELS_FIELD_NUMBER

public static final int SPRITE_WIDTH_PIXELS_FIELD_NUMBER

See Also:

Constant Field Values

SPRITE_HEIGHT_PIXELS_FIELD_NUMBER

public static final int SPRITE_HEIGHT_PIXELS_FIELD_NUMBER

See Also:

Constant Field Values

COLUMN_COUNT_FIELD_NUMBER

public static final int COLUMN_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

ROW_COUNT_FIELD_NUMBER

public static final int ROW_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

START_TIME_OFFSET_FIELD_NUMBER

public static final int START_TIME_OFFSET_FIELD_NUMBER

See Also:

Constant Field Values

END_TIME_OFFSET_FIELD_NUMBER

public static final int END_TIME_OFFSET_FIELD_NUMBER

See Also:

Constant Field Values

TOTAL_COUNT_FIELD_NUMBER

public static final int TOTAL_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

INTERVAL_FIELD_NUMBER

public static final int INTERVAL_FIELD_NUMBER

See Also:

Constant Field Values

QUALITY_FIELD_NUMBER

public static final int QUALITY_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getExtractionStrategyCase

public SpriteSheet.ExtractionStrategyCase getExtractionStrategyCase()

Specified by:

getExtractionStrategyCase in interface SpriteSheetOrBuilder

getFormat

public String getFormat()

 Format type. The default is `jpeg`.
 Supported formats:
 - `jpeg`
 

string format = 1;

Specified by:

getFormat in interface SpriteSheetOrBuilder

Returns:

The format.

getFormatBytes

public com.google.protobuf.ByteString getFormatBytes()

 Format type. The default is `jpeg`.
 Supported formats:
 - `jpeg`
 

string format = 1;

Specified by:

getFormatBytes in interface SpriteSheetOrBuilder

Returns:

The bytes for format.

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];

Specified by:

getFilePrefix in interface SpriteSheetOrBuilder

Returns:

The filePrefix.

getFilePrefixBytes

public com.google.protobuf.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];

Specified by:

getFilePrefixBytes in interface SpriteSheetOrBuilder

Returns:

The bytes for filePrefix.

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][google.cloud.video.transcoder.v1.SpriteSheet.sprite_width_pixels] field or
 the [SpriteSheet.sprite_height_pixels][google.cloud.video.transcoder.v1.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];

Specified by:

getSpriteWidthPixels in interface SpriteSheetOrBuilder

Returns:

The spriteWidthPixels.

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][google.cloud.video.transcoder.v1.SpriteSheet.sprite_height_pixels] field or
 the [SpriteSheet.sprite_width_pixels][google.cloud.video.transcoder.v1.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];

Specified by:

getSpriteHeightPixels in interface SpriteSheetOrBuilder

Returns:

The spriteHeightPixels.

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;

Specified by:

getColumnCount in interface SpriteSheetOrBuilder

Returns:

The columnCount.

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;

Specified by:

getRowCount in interface SpriteSheetOrBuilder

Returns:

The rowCount.

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;

Specified by:

hasStartTimeOffset in interface SpriteSheetOrBuilder

Returns:

Whether the startTimeOffset field is set.

getStartTimeOffset

public com.google.protobuf.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;

Specified by:

getStartTimeOffset in interface SpriteSheetOrBuilder

Returns:

The startTimeOffset.

getStartTimeOffsetOrBuilder

public com.google.protobuf.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;

Specified by:

getStartTimeOffsetOrBuilder in interface SpriteSheetOrBuilder

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;

Specified by:

hasEndTimeOffset in interface SpriteSheetOrBuilder

Returns:

Whether the endTimeOffset field is set.

getEndTimeOffset

public com.google.protobuf.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;

Specified by:

getEndTimeOffset in interface SpriteSheetOrBuilder

Returns:

The endTimeOffset.

getEndTimeOffsetOrBuilder

public com.google.protobuf.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;

Specified by:

getEndTimeOffsetOrBuilder in interface SpriteSheetOrBuilder

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;

Specified by:

hasTotalCount in interface SpriteSheetOrBuilder

Returns:

Whether the totalCount field is set.

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;

Specified by:

getTotalCount in interface SpriteSheetOrBuilder

Returns:

The totalCount.

hasInterval

public boolean hasInterval()

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

.google.protobuf.Duration interval = 10;

Specified by:

hasInterval in interface SpriteSheetOrBuilder

Returns:

Whether the interval field is set.

getInterval

public com.google.protobuf.Duration getInterval()

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

.google.protobuf.Duration interval = 10;

Specified by:

getInterval in interface SpriteSheetOrBuilder

Returns:

The interval.

getIntervalOrBuilder

public com.google.protobuf.DurationOrBuilder getIntervalOrBuilder()

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

.google.protobuf.Duration interval = 10;

Specified by:

getIntervalOrBuilder in interface SpriteSheetOrBuilder

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;

Specified by:

getQuality in interface SpriteSheetOrBuilder

Returns:

The quality.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static SpriteSheet parseFrom(ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SpriteSheet parseFrom(ByteBuffer data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SpriteSheet parseFrom(com.google.protobuf.ByteString data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SpriteSheet parseFrom(com.google.protobuf.ByteString data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SpriteSheet parseFrom(byte[] data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SpriteSheet parseFrom(byte[] data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SpriteSheet parseFrom(InputStream input)
                             throws IOException

Throws:

IOException

parseFrom

public static SpriteSheet parseFrom(InputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static SpriteSheet parseDelimitedFrom(InputStream input)
                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static SpriteSheet parseDelimitedFrom(InputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Throws:

IOException

parseFrom

public static SpriteSheet parseFrom(com.google.protobuf.CodedInputStream input)
                             throws IOException

Throws:

IOException

parseFrom

public static SpriteSheet parseFrom(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException

Throws:

IOException

newBuilderForType

public SpriteSheet.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static SpriteSheet.Builder newBuilder()

newBuilder

public static SpriteSheet.Builder newBuilder(SpriteSheet prototype)

toBuilder

public SpriteSheet.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected SpriteSheet.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static SpriteSheet getDefaultInstance()

parser

public static com.google.protobuf.Parser<SpriteSheet> parser()

getParserForType

public com.google.protobuf.Parser<SpriteSheet> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public SpriteSheet getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder