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

Class VideoStream.H264CodecSettings

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.video.livestream.v1.VideoStream.H264CodecSettings
All Implemented Interfaces:
VideoStream.H264CodecSettingsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
VideoStream
public static final class VideoStream.H264CodecSettings extends com.google.protobuf.GeneratedMessage implements VideoStream.H264CodecSettingsOrBuilder
 H264 codec settings.
Protobuf type google.cloud.video.livestream.v1.VideoStream.H264CodecSettings
See Also:

  • Field Details

    • WIDTH_PIXELS_FIELD_NUMBER

      public static final int WIDTH_PIXELS_FIELD_NUMBER
      See Also:

    • HEIGHT_PIXELS_FIELD_NUMBER

      public static final int HEIGHT_PIXELS_FIELD_NUMBER
      See Also:

    • FRAME_RATE_FIELD_NUMBER

      public static final int FRAME_RATE_FIELD_NUMBER
      See Also:

    • BITRATE_BPS_FIELD_NUMBER

      public static final int BITRATE_BPS_FIELD_NUMBER
      See Also:

    • ALLOW_OPEN_GOP_FIELD_NUMBER

      public static final int ALLOW_OPEN_GOP_FIELD_NUMBER
      See Also:

    • GOP_FRAME_COUNT_FIELD_NUMBER

      public static final int GOP_FRAME_COUNT_FIELD_NUMBER
      See Also:

    • GOP_DURATION_FIELD_NUMBER

      public static final int GOP_DURATION_FIELD_NUMBER
      See Also:

    • VBV_SIZE_BITS_FIELD_NUMBER

      public static final int VBV_SIZE_BITS_FIELD_NUMBER
      See Also:

    • VBV_FULLNESS_BITS_FIELD_NUMBER

      public static final int VBV_FULLNESS_BITS_FIELD_NUMBER
      See Also:

    • ENTROPY_CODER_FIELD_NUMBER

      public static final int ENTROPY_CODER_FIELD_NUMBER
      See Also:

    • B_PYRAMID_FIELD_NUMBER

      public static final int B_PYRAMID_FIELD_NUMBER
      See Also:

    • B_FRAME_COUNT_FIELD_NUMBER

      public static final int B_FRAME_COUNT_FIELD_NUMBER
      See Also:

    • AQ_STRENGTH_FIELD_NUMBER

      public static final int AQ_STRENGTH_FIELD_NUMBER
      See Also:

    • PROFILE_FIELD_NUMBER

      public static final int PROFILE_FIELD_NUMBER
      See Also:

    • TUNE_FIELD_NUMBER

      public static final int TUNE_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

    • getGopModeCase

      public VideoStream.H264CodecSettings.GopModeCase getGopModeCase()
      Specified by:
      getGopModeCase in interface VideoStream.H264CodecSettingsOrBuilder

    • getWidthPixels

      public int getWidthPixels()
       Required. The width of the video in pixels. Must be an even integer.
 Valid range is [320, 4096].
      int32 width_pixels = 1;
      Specified by:
      getWidthPixels in interface VideoStream.H264CodecSettingsOrBuilder
      Returns:
      The widthPixels.

    • getHeightPixels

      public int getHeightPixels()
       Required. The height of the video in pixels. Must be an even integer.
 Valid range is [180, 2160].
      int32 height_pixels = 2;
      Specified by:
      getHeightPixels in interface VideoStream.H264CodecSettingsOrBuilder
      Returns:
      The heightPixels.

    • getFrameRate

      public double getFrameRate()
       Required. The target video frame rate in frames per second (FPS). Must be
 less than or equal to 60. Will default to the input frame rate if larger
 than the input frame rate. The API will generate an output FPS that is
 divisible by the input FPS, and smaller or equal to the target FPS. See
 [Calculating frame
 rate](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for
 more information.
      double frame_rate = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getFrameRate in interface VideoStream.H264CodecSettingsOrBuilder
      Returns:
      The frameRate.

    • getBitrateBps

      public int getBitrateBps()
       Required. The video bitrate in bits per second. Minimum value is 10,000.

 - For SD resolution (< 720p), must be <= 3,000,000 (3 Mbps).
 - For HD resolution (<= 1080p), must be <= 15,000,000 (15 Mbps).
 - For UHD resolution (<= 2160p), must be <= 25,000,000 (25 Mbps).
      int32 bitrate_bps = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getBitrateBps in interface VideoStream.H264CodecSettingsOrBuilder
      Returns:
      The bitrateBps.

    • getAllowOpenGop

      public boolean getAllowOpenGop()
       Specifies whether an open Group of Pictures (GOP) structure should be
 allowed or not. The default is `false`.
      bool allow_open_gop = 6;
      Specified by:
      getAllowOpenGop in interface VideoStream.H264CodecSettingsOrBuilder
      Returns:
      The allowOpenGop.

    • hasGopFrameCount

      public boolean hasGopFrameCount()
       Select the GOP size based on the specified frame count.
 If GOP frame count is set instead of GOP duration, GOP duration will be
 calculated by `gopFrameCount`/`frameRate`. The calculated GOP duration
 must satisfy the limitations on `gopDuration` as well.
 Valid range is [60, 600].
      int32 gop_frame_count = 7;
      Specified by:
      hasGopFrameCount in interface VideoStream.H264CodecSettingsOrBuilder
      Returns:
      Whether the gopFrameCount field is set.

    • getGopFrameCount

      public int getGopFrameCount()
       Select the GOP size based on the specified frame count.
 If GOP frame count is set instead of GOP duration, GOP duration will be
 calculated by `gopFrameCount`/`frameRate`. The calculated GOP duration
 must satisfy the limitations on `gopDuration` as well.
 Valid range is [60, 600].
      int32 gop_frame_count = 7;
      Specified by:
      getGopFrameCount in interface VideoStream.H264CodecSettingsOrBuilder
      Returns:
      The gopFrameCount.

    • hasGopDuration

      public boolean hasGopDuration()
       Select the GOP size based on the specified duration. The default is
 `2s`. Note that `gopDuration` must be less than or equal to
 [segment_duration][google.cloud.video.livestream.v1.SegmentSettings.segment_duration],
 and
 [segment_duration][google.cloud.video.livestream.v1.SegmentSettings.segment_duration]
 must be divisible by `gopDuration`. Valid range is [2s, 20s].

 All video streams in the same channel must have the same GOP size.
      .google.protobuf.Duration gop_duration = 8;
      Specified by:
      hasGopDuration in interface VideoStream.H264CodecSettingsOrBuilder
      Returns:
      Whether the gopDuration field is set.

    • getGopDuration

      public com.google.protobuf.Duration getGopDuration()
       Select the GOP size based on the specified duration. The default is
 `2s`. Note that `gopDuration` must be less than or equal to
 [segment_duration][google.cloud.video.livestream.v1.SegmentSettings.segment_duration],
 and
 [segment_duration][google.cloud.video.livestream.v1.SegmentSettings.segment_duration]
 must be divisible by `gopDuration`. Valid range is [2s, 20s].

 All video streams in the same channel must have the same GOP size.
      .google.protobuf.Duration gop_duration = 8;
      Specified by:
      getGopDuration in interface VideoStream.H264CodecSettingsOrBuilder
      Returns:
      The gopDuration.

    • getGopDurationOrBuilder

      public com.google.protobuf.DurationOrBuilder getGopDurationOrBuilder()
       Select the GOP size based on the specified duration. The default is
 `2s`. Note that `gopDuration` must be less than or equal to
 [segment_duration][google.cloud.video.livestream.v1.SegmentSettings.segment_duration],
 and
 [segment_duration][google.cloud.video.livestream.v1.SegmentSettings.segment_duration]
 must be divisible by `gopDuration`. Valid range is [2s, 20s].

 All video streams in the same channel must have the same GOP size.
      .google.protobuf.Duration gop_duration = 8;
      Specified by:
      getGopDurationOrBuilder in interface VideoStream.H264CodecSettingsOrBuilder

    • getVbvSizeBits

      public int getVbvSizeBits()
       Size of the Video Buffering Verifier (VBV) buffer in bits. Must be
 greater than zero. The default is equal to
 [bitrate_bps][google.cloud.video.livestream.v1.VideoStream.H264CodecSettings.bitrate_bps].
      int32 vbv_size_bits = 9;
      Specified by:
      getVbvSizeBits in interface VideoStream.H264CodecSettingsOrBuilder
      Returns:
      The vbvSizeBits.

    • getVbvFullnessBits

      public int getVbvFullnessBits()
       Initial fullness of the Video Buffering Verifier (VBV) buffer in bits.
 Must be greater than zero. The default is equal to 90% of
 [vbv_size_bits][google.cloud.video.livestream.v1.VideoStream.H264CodecSettings.vbv_size_bits].
      int32 vbv_fullness_bits = 10;
      Specified by:
      getVbvFullnessBits in interface VideoStream.H264CodecSettingsOrBuilder
      Returns:
      The vbvFullnessBits.

    • getEntropyCoder

      public String getEntropyCoder()
       The entropy coder to use. The default is `cabac`.

 Supported entropy coders:

 - `cavlc`
 - `cabac`
      string entropy_coder = 11;
      Specified by:
      getEntropyCoder in interface VideoStream.H264CodecSettingsOrBuilder
      Returns:
      The entropyCoder.

    • getEntropyCoderBytes

      public com.google.protobuf.ByteString getEntropyCoderBytes()
       The entropy coder to use. The default is `cabac`.

 Supported entropy coders:

 - `cavlc`
 - `cabac`
      string entropy_coder = 11;
      Specified by:
      getEntropyCoderBytes in interface VideoStream.H264CodecSettingsOrBuilder
      Returns:
      The bytes for entropyCoder.

    • getBPyramid

      public boolean getBPyramid()
       Allow B-pyramid for reference frame selection. This may not be supported
 on all decoders. The default is `false`.
      bool b_pyramid = 12;
      Specified by:
      getBPyramid in interface VideoStream.H264CodecSettingsOrBuilder
      Returns:
      The bPyramid.

    • getBFrameCount

      public int getBFrameCount()
       The number of consecutive B-frames. Must be greater than or equal to
 zero. Must be less than
 [gop_frame_count][google.cloud.video.livestream.v1.VideoStream.H264CodecSettings.gop_frame_count]
 if set. The default is 0.
      int32 b_frame_count = 13;
      Specified by:
      getBFrameCount in interface VideoStream.H264CodecSettingsOrBuilder
      Returns:
      The bFrameCount.

    • getAqStrength

      public double getAqStrength()
       Specify the intensity of the adaptive quantizer (AQ). Must be between 0
 and 1, where 0 disables the quantizer and 1 maximizes the quantizer. A
 higher value equals a lower bitrate but smoother image. The default is 0.
      double aq_strength = 14;
      Specified by:
      getAqStrength in interface VideoStream.H264CodecSettingsOrBuilder
      Returns:
      The aqStrength.

    • getProfile

      public String getProfile()
       Enforces the specified codec profile. The following profiles are
 supported:

 *   `baseline`
 *   `main` (default)
 *   `high`

 The available options are [FFmpeg-compatible Profile
 Options](https://trac.ffmpeg.org/wiki/Encode/H.264#Profile).
 Note that certain values for this field may cause the
 transcoder to override other fields you set in the
 [H264CodecSettings][google.cloud.video.livestream.v1.VideoStream.H264CodecSettings]
 message.
      string profile = 15;
      Specified by:
      getProfile in interface VideoStream.H264CodecSettingsOrBuilder
      Returns:
      The profile.

    • getProfileBytes

      public com.google.protobuf.ByteString getProfileBytes()
       Enforces the specified codec profile. The following profiles are
 supported:

 *   `baseline`
 *   `main` (default)
 *   `high`

 The available options are [FFmpeg-compatible Profile
 Options](https://trac.ffmpeg.org/wiki/Encode/H.264#Profile).
 Note that certain values for this field may cause the
 transcoder to override other fields you set in the
 [H264CodecSettings][google.cloud.video.livestream.v1.VideoStream.H264CodecSettings]
 message.
      string profile = 15;
      Specified by:
      getProfileBytes in interface VideoStream.H264CodecSettingsOrBuilder
      Returns:
      The bytes for profile.

    • getTune

      public String getTune()
       Enforces the specified codec tune. The available options are
 [FFmpeg-compatible Encode
 Options](https://trac.ffmpeg.org/wiki/Encode/H.264#Tune)
 Note that certain values for this field may cause the transcoder to
 override other fields you set in the
 [H264CodecSettings][google.cloud.video.livestream.v1.VideoStream.H264CodecSettings]
 message.
      string tune = 16;
      Specified by:
      getTune in interface VideoStream.H264CodecSettingsOrBuilder
      Returns:
      The tune.

    • getTuneBytes

      public com.google.protobuf.ByteString getTuneBytes()
       Enforces the specified codec tune. The available options are
 [FFmpeg-compatible Encode
 Options](https://trac.ffmpeg.org/wiki/Encode/H.264#Tune)
 Note that certain values for this field may cause the transcoder to
 override other fields you set in the
 [H264CodecSettings][google.cloud.video.livestream.v1.VideoStream.H264CodecSettings]
 message.
      string tune = 16;
      Specified by:
      getTuneBytes in interface VideoStream.H264CodecSettingsOrBuilder
      Returns:
      The bytes for tune.

    • 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 VideoStream.H264CodecSettings parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static VideoStream.H264CodecSettings parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static VideoStream.H264CodecSettings parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static VideoStream.H264CodecSettings parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static VideoStream.H264CodecSettings parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static VideoStream.H264CodecSettings parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static VideoStream.H264CodecSettings parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static VideoStream.H264CodecSettings parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static VideoStream.H264CodecSettings parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static VideoStream.H264CodecSettings parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static VideoStream.H264CodecSettings parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static VideoStream.H264CodecSettings parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public VideoStream.H264CodecSettings.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static VideoStream.H264CodecSettings.Builder newBuilder()

    • newBuilder

      public static VideoStream.H264CodecSettings.Builder newBuilder(VideoStream.H264CodecSettings prototype)

    • toBuilder

      public VideoStream.H264CodecSettings.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected VideoStream.H264CodecSettings.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static VideoStream.H264CodecSettings getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<VideoStream.H264CodecSettings> 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 VideoStream.H264CodecSettings getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder