Class SpriteSheet.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<SpriteSheet.Builder>
com.google.cloud.video.livestream.v1.SpriteSheet.Builder
All Implemented Interfaces:
SpriteSheetOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
SpriteSheet

public static final class SpriteSheet.Builder extends com.google.protobuf.GeneratedMessage.Builder<SpriteSheet.Builder> implements SpriteSheetOrBuilder
 Sprite sheet configuration.
 
Protobuf type google.cloud.video.livestream.v1.SpriteSheet
  • 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.Builder<SpriteSheet.Builder>
    • clear

      public SpriteSheet.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<SpriteSheet.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<SpriteSheet.Builder>
    • getDefaultInstanceForType

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

      public SpriteSheet build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder
    • buildPartial

      public SpriteSheet buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder
    • mergeFrom

      public SpriteSheet.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SpriteSheet.Builder>
    • mergeFrom

      public SpriteSheet.Builder mergeFrom(SpriteSheet other)
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<SpriteSheet.Builder>
    • mergeFrom

      public SpriteSheet.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SpriteSheet.Builder>
      Throws:
      IOException
    • 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.
    • setFormat

      public SpriteSheet.Builder setFormat(String value)
       Format type. The default is `jpeg`.
      
       Supported formats:
      
       - `jpeg`
       
      string format = 1;
      Parameters:
      value - The format to set.
      Returns:
      This builder for chaining.
    • clearFormat

      public SpriteSheet.Builder clearFormat()
       Format type. The default is `jpeg`.
      
       Supported formats:
      
       - `jpeg`
       
      string format = 1;
      Returns:
      This builder for chaining.
    • setFormatBytes

      public SpriteSheet.Builder setFormatBytes(com.google.protobuf.ByteString value)
       Format type. The default is `jpeg`.
      
       Supported formats:
      
       - `jpeg`
       
      string format = 1;
      Parameters:
      value - The bytes for format to set.
      Returns:
      This builder for chaining.
    • getFilePrefix

      public String getFilePrefix()
       Required. File name prefix for the generated sprite sheets. If multiple
       sprite sheets are added to the channel, each must have a unique file
       prefix.
       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. If multiple
       sprite sheets are added to the channel, each must have a unique file
       prefix.
       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.
    • setFilePrefix

      public SpriteSheet.Builder setFilePrefix(String value)
       Required. File name prefix for the generated sprite sheets. If multiple
       sprite sheets are added to the channel, each must have a unique file
       prefix.
       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];
      Parameters:
      value - The filePrefix to set.
      Returns:
      This builder for chaining.
    • clearFilePrefix

      public SpriteSheet.Builder clearFilePrefix()
       Required. File name prefix for the generated sprite sheets. If multiple
       sprite sheets are added to the channel, each must have a unique file
       prefix.
       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:
      This builder for chaining.
    • setFilePrefixBytes

      public SpriteSheet.Builder setFilePrefixBytes(com.google.protobuf.ByteString value)
       Required. File name prefix for the generated sprite sheets. If multiple
       sprite sheets are added to the channel, each must have a unique file
       prefix.
       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];
      Parameters:
      value - The bytes for filePrefix to set.
      Returns:
      This builder for chaining.
    • getSpriteWidthPixels

      public int getSpriteWidthPixels()
       Required. The width of the sprite in pixels. Must be an even integer.
       
      int32 sprite_width_pixels = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getSpriteWidthPixels in interface SpriteSheetOrBuilder
      Returns:
      The spriteWidthPixels.
    • setSpriteWidthPixels

      public SpriteSheet.Builder setSpriteWidthPixels(int value)
       Required. The width of the sprite in pixels. Must be an even integer.
       
      int32 sprite_width_pixels = 3 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The spriteWidthPixels to set.
      Returns:
      This builder for chaining.
    • clearSpriteWidthPixels

      public SpriteSheet.Builder clearSpriteWidthPixels()
       Required. The width of the sprite in pixels. Must be an even integer.
       
      int32 sprite_width_pixels = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.
    • getSpriteHeightPixels

      public int getSpriteHeightPixels()
       Required. The height of the sprite in pixels. Must be an even integer.
       
      int32 sprite_height_pixels = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getSpriteHeightPixels in interface SpriteSheetOrBuilder
      Returns:
      The spriteHeightPixels.
    • setSpriteHeightPixels

      public SpriteSheet.Builder setSpriteHeightPixels(int value)
       Required. The height of the sprite in pixels. Must be an even integer.
       
      int32 sprite_height_pixels = 4 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The spriteHeightPixels to set.
      Returns:
      This builder for chaining.
    • clearSpriteHeightPixels

      public SpriteSheet.Builder clearSpriteHeightPixels()
       Required. The height of the sprite in pixels. Must be an even integer.
       
      int32 sprite_height_pixels = 4 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.
    • getColumnCount

      public int getColumnCount()
       The maximum number of sprites per row in a sprite sheet. Valid range is
       [1, 10] and the default value is 1.
       
      int32 column_count = 5;
      Specified by:
      getColumnCount in interface SpriteSheetOrBuilder
      Returns:
      The columnCount.
    • setColumnCount

      public SpriteSheet.Builder setColumnCount(int value)
       The maximum number of sprites per row in a sprite sheet. Valid range is
       [1, 10] and the default value is 1.
       
      int32 column_count = 5;
      Parameters:
      value - The columnCount to set.
      Returns:
      This builder for chaining.
    • clearColumnCount

      public SpriteSheet.Builder clearColumnCount()
       The maximum number of sprites per row in a sprite sheet. Valid range is
       [1, 10] and the default value is 1.
       
      int32 column_count = 5;
      Returns:
      This builder for chaining.
    • getRowCount

      public int getRowCount()
       The maximum number of rows per sprite sheet. When the sprite sheet is full,
       a new sprite sheet is created. Valid range is [1, 10] and the default value
       is 1.
       
      int32 row_count = 6;
      Specified by:
      getRowCount in interface SpriteSheetOrBuilder
      Returns:
      The rowCount.
    • setRowCount

      public SpriteSheet.Builder setRowCount(int value)
       The maximum number of rows per sprite sheet. When the sprite sheet is full,
       a new sprite sheet is created. Valid range is [1, 10] and the default value
       is 1.
       
      int32 row_count = 6;
      Parameters:
      value - The rowCount to set.
      Returns:
      This builder for chaining.
    • clearRowCount

      public SpriteSheet.Builder clearRowCount()
       The maximum number of rows per sprite sheet. When the sprite sheet is full,
       a new sprite sheet is created. Valid range is [1, 10] and the default value
       is 1.
       
      int32 row_count = 6;
      Returns:
      This builder for chaining.
    • hasInterval

      public boolean hasInterval()
       Create sprites at regular intervals. Valid range is [1 second, 1 hour] and
       the default value is `10s`.
       
      .google.protobuf.Duration interval = 7;
      Specified by:
      hasInterval in interface SpriteSheetOrBuilder
      Returns:
      Whether the interval field is set.
    • getInterval

      public com.google.protobuf.Duration getInterval()
       Create sprites at regular intervals. Valid range is [1 second, 1 hour] and
       the default value is `10s`.
       
      .google.protobuf.Duration interval = 7;
      Specified by:
      getInterval in interface SpriteSheetOrBuilder
      Returns:
      The interval.
    • setInterval

      public SpriteSheet.Builder setInterval(com.google.protobuf.Duration value)
       Create sprites at regular intervals. Valid range is [1 second, 1 hour] and
       the default value is `10s`.
       
      .google.protobuf.Duration interval = 7;
    • setInterval

      public SpriteSheet.Builder setInterval(com.google.protobuf.Duration.Builder builderForValue)
       Create sprites at regular intervals. Valid range is [1 second, 1 hour] and
       the default value is `10s`.
       
      .google.protobuf.Duration interval = 7;
    • mergeInterval

      public SpriteSheet.Builder mergeInterval(com.google.protobuf.Duration value)
       Create sprites at regular intervals. Valid range is [1 second, 1 hour] and
       the default value is `10s`.
       
      .google.protobuf.Duration interval = 7;
    • clearInterval

      public SpriteSheet.Builder clearInterval()
       Create sprites at regular intervals. Valid range is [1 second, 1 hour] and
       the default value is `10s`.
       
      .google.protobuf.Duration interval = 7;
    • getIntervalBuilder

      public com.google.protobuf.Duration.Builder getIntervalBuilder()
       Create sprites at regular intervals. Valid range is [1 second, 1 hour] and
       the default value is `10s`.
       
      .google.protobuf.Duration interval = 7;
    • getIntervalOrBuilder

      public com.google.protobuf.DurationOrBuilder getIntervalOrBuilder()
       Create sprites at regular intervals. Valid range is [1 second, 1 hour] and
       the default value is `10s`.
       
      .google.protobuf.Duration interval = 7;
      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 = 8;
      Specified by:
      getQuality in interface SpriteSheetOrBuilder
      Returns:
      The quality.
    • setQuality

      public SpriteSheet.Builder setQuality(int value)
       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 = 8;
      Parameters:
      value - The quality to set.
      Returns:
      This builder for chaining.
    • clearQuality

      public SpriteSheet.Builder clearQuality()
       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 = 8;
      Returns:
      This builder for chaining.