Class SpriteSheet
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
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
@Generated
public final class SpriteSheet
extends com.google.protobuf.GeneratedMessage
implements SpriteSheetOrBuilder
Sprite sheet configuration.Protobuf type
google.cloud.video.transcoder.v1.SpriteSheet- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classSprite sheet configuration.static enumNested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanintThe maximum number of sprites per row in a sprite sheet.static SpriteSheetstatic final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.DurationEnd time in seconds, relative to the output file timeline.com.google.protobuf.DurationOrBuilderEnd time in seconds, relative to the output file timeline.Required.com.google.protobuf.ByteStringRequired.Format type.com.google.protobuf.ByteStringFormat type.com.google.protobuf.DurationStarting from `0s`, create sprites at regular intervals.com.google.protobuf.DurationOrBuilderStarting from `0s`, create sprites at regular intervals.com.google.protobuf.Parser<SpriteSheet>intThe quality of the generated sprite sheet.intThe maximum number of rows per sprite sheet.intintRequired.intRequired.com.google.protobuf.DurationStart time in seconds, relative to the output file timeline.com.google.protobuf.DurationOrBuilderStart time in seconds, relative to the output file timeline.intTotal number of sprites.booleanEnd time in seconds, relative to the output file timeline.inthashCode()booleanStarting from `0s`, create sprites at regular intervals.booleanStart time in seconds, relative to the output file timeline.booleanTotal number of sprites.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanstatic SpriteSheet.Builderstatic SpriteSheet.BuildernewBuilder(SpriteSheet prototype) protected SpriteSheet.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static SpriteSheetparseDelimitedFrom(InputStream input) static SpriteSheetparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static SpriteSheetparseFrom(byte[] data) static SpriteSheetparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static SpriteSheetparseFrom(com.google.protobuf.ByteString data) static SpriteSheetparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static SpriteSheetparseFrom(com.google.protobuf.CodedInputStream input) static SpriteSheetparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static SpriteSheetparseFrom(InputStream input) static SpriteSheetparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static SpriteSheetparseFrom(ByteBuffer data) static SpriteSheetparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<SpriteSheet>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
FORMAT_FIELD_NUMBER
public static final int FORMAT_FIELD_NUMBER- See Also:
-
FILE_PREFIX_FIELD_NUMBER
public static final int FILE_PREFIX_FIELD_NUMBER- See Also:
-
SPRITE_WIDTH_PIXELS_FIELD_NUMBER
public static final int SPRITE_WIDTH_PIXELS_FIELD_NUMBER- See Also:
-
SPRITE_HEIGHT_PIXELS_FIELD_NUMBER
public static final int SPRITE_HEIGHT_PIXELS_FIELD_NUMBER- See Also:
-
COLUMN_COUNT_FIELD_NUMBER
public static final int COLUMN_COUNT_FIELD_NUMBER- See Also:
-
ROW_COUNT_FIELD_NUMBER
public static final int ROW_COUNT_FIELD_NUMBER- See Also:
-
START_TIME_OFFSET_FIELD_NUMBER
public static final int START_TIME_OFFSET_FIELD_NUMBER- See Also:
-
END_TIME_OFFSET_FIELD_NUMBER
public static final int END_TIME_OFFSET_FIELD_NUMBER- See Also:
-
TOTAL_COUNT_FIELD_NUMBER
public static final int TOTAL_COUNT_FIELD_NUMBER- See Also:
-
INTERVAL_FIELD_NUMBER
public static final int INTERVAL_FIELD_NUMBER- See Also:
-
QUALITY_FIELD_NUMBER
public static final int QUALITY_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
getExtractionStrategyCase
- Specified by:
getExtractionStrategyCasein interfaceSpriteSheetOrBuilder
-
getFormat
Format type. The default is `jpeg`. Supported formats: - `jpeg`
string format = 1;- Specified by:
getFormatin interfaceSpriteSheetOrBuilder- Returns:
- The format.
-
getFormatBytes
public com.google.protobuf.ByteString getFormatBytes()Format type. The default is `jpeg`. Supported formats: - `jpeg`
string format = 1;- Specified by:
getFormatBytesin interfaceSpriteSheetOrBuilder- Returns:
- The bytes for format.
-
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:
getFilePrefixin interfaceSpriteSheetOrBuilder- 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:
getFilePrefixBytesin interfaceSpriteSheetOrBuilder- 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). 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 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getSpriteWidthPixelsin interfaceSpriteSheetOrBuilder- 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). 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 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getSpriteHeightPixelsin interfaceSpriteSheetOrBuilder- 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:
getColumnCountin interfaceSpriteSheetOrBuilder- 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:
getRowCountin interfaceSpriteSheetOrBuilder- 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:
hasStartTimeOffsetin interfaceSpriteSheetOrBuilder- 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:
getStartTimeOffsetin interfaceSpriteSheetOrBuilder- 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:
getStartTimeOffsetOrBuilderin interfaceSpriteSheetOrBuilder
-
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:
hasEndTimeOffsetin interfaceSpriteSheetOrBuilder- 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:
getEndTimeOffsetin interfaceSpriteSheetOrBuilder- 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:
getEndTimeOffsetOrBuilderin interfaceSpriteSheetOrBuilder
-
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:
hasTotalCountin interfaceSpriteSheetOrBuilder- 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:
getTotalCountin interfaceSpriteSheetOrBuilder- 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:
hasIntervalin interfaceSpriteSheetOrBuilder- 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:
getIntervalin interfaceSpriteSheetOrBuilder- 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:
getIntervalOrBuilderin interfaceSpriteSheetOrBuilder
-
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:
getQualityin interfaceSpriteSheetOrBuilder- Returns:
- The quality.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.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
- Throws:
IOException
-
parseFrom
public static SpriteSheet parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static SpriteSheet parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static SpriteSheet parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected SpriteSheet.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-