Package com.google.cloud.video.livestream.v1

Interface SpriteSheetOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SpriteSheet, SpriteSheet.Builder
@Generated public interface SpriteSheetOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getColumnCount()
    The maximum number of sprites per row in a sprite sheet.
    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()
    Create sprites at regular intervals.
    com.google.protobuf.DurationOrBuilder
    getIntervalOrBuilder()
    Create sprites at regular intervals.
    int
    getQuality()
    The quality of the generated sprite sheet.
    int
    getRowCount()
    The maximum number of rows per sprite sheet.
    int
    getSpriteHeightPixels()
    Required.
    int
    getSpriteWidthPixels()
    Required.
    boolean
    hasInterval()
    Create sprites at regular intervals.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getFormat

      String getFormat()
       Format type. The default is `jpeg`.

 Supported formats:

 - `jpeg`
      string format = 1;
      Returns:
      The format.

    • getFormatBytes

      com.google.protobuf.ByteString getFormatBytes()
       Format type. The default is `jpeg`.

 Supported formats:

 - `jpeg`
      string format = 1;
      Returns:
      The bytes for format.

    • getFilePrefix

      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];
      Returns:
      The filePrefix.

    • getFilePrefixBytes

      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];
      Returns:
      The bytes for filePrefix.

    • getSpriteWidthPixels

      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];
      Returns:
      The spriteWidthPixels.

    • getSpriteHeightPixels

      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];
      Returns:
      The spriteHeightPixels.

    • getColumnCount

      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;
      Returns:
      The columnCount.

    • getRowCount

      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;
      Returns:
      The rowCount.

    • hasInterval

      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;
      Returns:
      Whether the interval field is set.

    • getInterval

      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;
      Returns:
      The interval.

    • getIntervalOrBuilder

      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;

    • getQuality

      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;
      Returns:
      The quality.