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

Interface VideoStream.H264CodecSettingsOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
VideoStream.H264CodecSettings, VideoStream.H264CodecSettings.Builder
Enclosing class:
VideoStream
public static interface VideoStream.H264CodecSettingsOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getAllowOpenGop()
    Specifies whether an open Group of Pictures (GOP) structure should be allowed or not.
    double
    getAqStrength()
    Specify the intensity of the adaptive quantizer (AQ).
    int
    getBFrameCount()
    The number of consecutive B-frames.
    int
    getBitrateBps()
    Required.
    boolean
    getBPyramid()
    Allow B-pyramid for reference frame selection.
    String
    getEntropyCoder()
    The entropy coder to use.
    com.google.protobuf.ByteString
    getEntropyCoderBytes()
    The entropy coder to use.
    double
    getFrameRate()
    Required.
    com.google.protobuf.Duration
    getGopDuration()
    Select the GOP size based on the specified duration.
    com.google.protobuf.DurationOrBuilder
    getGopDurationOrBuilder()
    Select the GOP size based on the specified duration.
    int
    getGopFrameCount()
    Select the GOP size based on the specified frame count.
    VideoStream.H264CodecSettings.GopModeCase
    getGopModeCase()
     
    int
    getHeightPixels()
    Required.
    String
    getProfile()
    Enforces the specified codec profile.
    com.google.protobuf.ByteString
    getProfileBytes()
    Enforces the specified codec profile.
    String
    getTune()
    Enforces the specified codec tune.
    com.google.protobuf.ByteString
    getTuneBytes()
    Enforces the specified codec tune.
    int
    getVbvFullnessBits()
    Initial fullness of the Video Buffering Verifier (VBV) buffer in bits.
    int
    getVbvSizeBits()
    Size of the Video Buffering Verifier (VBV) buffer in bits.
    int
    getWidthPixels()
    Required.
    boolean
    hasGopDuration()
    Select the GOP size based on the specified duration.
    boolean
    hasGopFrameCount()
    Select the GOP size based on the specified frame count.

    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

    • getWidthPixels

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

    • getHeightPixels

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

    • getFrameRate

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

    • getBitrateBps

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

    • getAllowOpenGop

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

    • hasGopFrameCount

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

    • getGopFrameCount

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

    • hasGopDuration

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

    • getGopDuration

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

    • getGopDurationOrBuilder

      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;

    • getVbvSizeBits

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

    • getVbvFullnessBits

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

    • getEntropyCoder

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

 Supported entropy coders:

 - `cavlc`
 - `cabac`
      string entropy_coder = 11;
      Returns:
      The entropyCoder.

    • getEntropyCoderBytes

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

 Supported entropy coders:

 - `cavlc`
 - `cabac`
      string entropy_coder = 11;
      Returns:
      The bytes for entropyCoder.

    • getBPyramid

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

    • getBFrameCount

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

    • getAqStrength

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

    • getProfile

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

    • getProfileBytes

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

    • getTune

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

    • getTuneBytes

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

    • getGopModeCase

      VideoStream.H264CodecSettings.GopModeCase getGopModeCase()