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 Classes
    Modifier and Type
    Class
    Description
    static final class 
    Sprite sheet configuration.
    static enum 
     

    Nested 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.BuilderParent

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, 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
    Description
    boolean
     
    int
    The maximum number of sprites per row in a sprite sheet.
     
     
    static final com.google.protobuf.Descriptors.Descriptor
     
    com.google.protobuf.Duration
    End time in seconds, relative to the output file timeline.
    com.google.protobuf.DurationOrBuilder
    End time in seconds, relative to the output file timeline.
     
    Required.
    com.google.protobuf.ByteString
    Required.
    Format type.
    com.google.protobuf.ByteString
    Format type.
    com.google.protobuf.Duration
    Starting from `0s`, create sprites at regular intervals.
    com.google.protobuf.DurationOrBuilder
    Starting from `0s`, create sprites at regular intervals.
    com.google.protobuf.Parser<SpriteSheet>
     
    int
    The quality of the generated sprite sheet.
    int
    The maximum number of rows per sprite sheet.
    int
     
    int
    Required.
    int
    Required.
    com.google.protobuf.Duration
    Start time in seconds, relative to the output file timeline.
    com.google.protobuf.DurationOrBuilder
    Start time in seconds, relative to the output file timeline.
    int
    Total number of sprites.
    boolean
    End time in seconds, relative to the output file timeline.
    int
     
    boolean
    Starting from `0s`, create sprites at regular intervals.
    boolean
    Start time in seconds, relative to the output file timeline.
    boolean
    Total number of sprites.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
     
    final boolean
     
     
     
     
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
     
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(byte[] data)
     
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(com.google.protobuf.ByteString data)
     
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
     
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
     
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<SpriteSheet>
     
     
    void
    writeTo(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, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

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

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods 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:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • 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).
      
       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:
      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).
      
       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:
      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.GeneratedMessage
    • 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.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • 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.GeneratedMessage
    • getDefaultInstanceForType

      public SpriteSheet getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder