Package com.google.cloud.video.transcoder.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 Details

    • getWidthPixels

      int getWidthPixels()
       The width of the video in pixels. Must be an even integer.
 When not specified, the width is adjusted to match the specified height
 and input aspect ratio. If both are omitted, the input width is used.

 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 width_pixels = 1;
      Returns:
      The widthPixels.

    • getHeightPixels

      int getHeightPixels()
       The height of the video in pixels. Must be an even integer.
 When not specified, the height is adjusted to match the specified width
 and input aspect ratio. If both are omitted, the input height is used.

 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 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 120.
      double frame_rate = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The frameRate.

    • getFrameRateConversionStrategyValue

      int getFrameRateConversionStrategyValue()
       Optional. Frame rate conversion strategy for desired frame rate. The
 default is `DOWNSAMPLE`.
      .google.cloud.video.transcoder.v1.VideoStream.FrameRateConversionStrategy frame_rate_conversion_strategy = 23 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for frameRateConversionStrategy.

    • getFrameRateConversionStrategy

      VideoStream.FrameRateConversionStrategy getFrameRateConversionStrategy()
       Optional. Frame rate conversion strategy for desired frame rate. The
 default is `DOWNSAMPLE`.
      .google.cloud.video.transcoder.v1.VideoStream.FrameRateConversionStrategy frame_rate_conversion_strategy = 23 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The frameRateConversionStrategy.

    • getBitrateBps

      int getBitrateBps()
       Required. The video bitrate in bits per second. The minimum value is
 1,000. The maximum value is 800,000,000.
      int32 bitrate_bps = 4 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bitrateBps.

    • getPixelFormat

      String getPixelFormat()
       Pixel format to use. The default is `yuv420p`.

 Supported pixel formats:

 - `yuv420p` pixel format
 - `yuv422p` pixel format
 - `yuv444p` pixel format
 - `yuv420p10` 10-bit HDR pixel format
 - `yuv422p10` 10-bit HDR pixel format
 - `yuv444p10` 10-bit HDR pixel format
 - `yuv420p12` 12-bit HDR pixel format
 - `yuv422p12` 12-bit HDR pixel format
 - `yuv444p12` 12-bit HDR pixel format
      string pixel_format = 5;
      Returns:
      The pixelFormat.

    • getPixelFormatBytes

      com.google.protobuf.ByteString getPixelFormatBytes()
       Pixel format to use. The default is `yuv420p`.

 Supported pixel formats:

 - `yuv420p` pixel format
 - `yuv422p` pixel format
 - `yuv444p` pixel format
 - `yuv420p10` 10-bit HDR pixel format
 - `yuv422p10` 10-bit HDR pixel format
 - `yuv444p10` 10-bit HDR pixel format
 - `yuv420p12` 12-bit HDR pixel format
 - `yuv422p12` 12-bit HDR pixel format
 - `yuv444p12` 12-bit HDR pixel format
      string pixel_format = 5;
      Returns:
      The bytes for pixelFormat.

    • getRateControlMode

      String getRateControlMode()
       Specify the mode. The default is `vbr`.

 Supported rate control modes:

 - `vbr` - variable bitrate
 - `crf` - constant rate factor
      string rate_control_mode = 6;
      Returns:
      The rateControlMode.

    • getRateControlModeBytes

      com.google.protobuf.ByteString getRateControlModeBytes()
       Specify the mode. The default is `vbr`.

 Supported rate control modes:

 - `vbr` - variable bitrate
 - `crf` - constant rate factor
      string rate_control_mode = 6;
      Returns:
      The bytes for rateControlMode.

    • getCrfLevel

      int getCrfLevel()
       Target CRF level. Must be between 10 and 36, where 10 is the highest
 quality and 36 is the most efficient compression. The default is 21.
      int32 crf_level = 7;
      Returns:
      The crfLevel.

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

    • hasGopFrameCount

      boolean hasGopFrameCount()
       Select the GOP size based on the specified frame count. Must be greater
 than zero.
      int32 gop_frame_count = 9;
      Returns:
      Whether the gopFrameCount field is set.

    • getGopFrameCount

      int getGopFrameCount()
       Select the GOP size based on the specified frame count. Must be greater
 than zero.
      int32 gop_frame_count = 9;
      Returns:
      The gopFrameCount.

    • hasGopDuration

      boolean hasGopDuration()
       Select the GOP size based on the specified duration. The default is
 `3s`. Note that `gopDuration` must be less than or equal to
 [`segmentDuration`](#SegmentSettings), and
 [`segmentDuration`](#SegmentSettings) must be divisible by
 `gopDuration`.
      .google.protobuf.Duration gop_duration = 10;
      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
 `3s`. Note that `gopDuration` must be less than or equal to
 [`segmentDuration`](#SegmentSettings), and
 [`segmentDuration`](#SegmentSettings) must be divisible by
 `gopDuration`.
      .google.protobuf.Duration gop_duration = 10;
      Returns:
      The gopDuration.

    • getGopDurationOrBuilder

      com.google.protobuf.DurationOrBuilder getGopDurationOrBuilder()
       Select the GOP size based on the specified duration. The default is
 `3s`. Note that `gopDuration` must be less than or equal to
 [`segmentDuration`](#SegmentSettings), and
 [`segmentDuration`](#SegmentSettings) must be divisible by
 `gopDuration`.
      .google.protobuf.Duration gop_duration = 10;

    • getEnableTwoPass

      boolean getEnableTwoPass()
       Use two-pass encoding strategy to achieve better video quality.
 [H264CodecSettings.rate_control_mode][google.cloud.video.transcoder.v1.VideoStream.H264CodecSettings.rate_control_mode]
 must be `vbr`. The default is `false`.
      bool enable_two_pass = 11;
      Returns:
      The enableTwoPass.

    • getVbvSizeBits

      int getVbvSizeBits()
       Size of the Video Buffering Verifier (VBV) buffer in bits. Must be
 greater than zero. The default is equal to
 [H264CodecSettings.bitrate_bps][google.cloud.video.transcoder.v1.VideoStream.H264CodecSettings.bitrate_bps].
      int32 vbv_size_bits = 12;
      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
 [H264CodecSettings.vbv_size_bits][google.cloud.video.transcoder.v1.VideoStream.H264CodecSettings.vbv_size_bits].
      int32 vbv_fullness_bits = 13;
      Returns:
      The vbvFullnessBits.

    • getEntropyCoder

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

 Supported entropy coders:

 - `cavlc`
 - `cabac`
      string entropy_coder = 14;
      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 = 14;
      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 = 15;
      Returns:
      The bPyramid.

    • getBFrameCount

      int getBFrameCount()
       The number of consecutive B-frames. Must be greater than or equal to
 zero. Must be less than
 [H264CodecSettings.gop_frame_count][google.cloud.video.transcoder.v1.VideoStream.H264CodecSettings.gop_frame_count]
 if set. The default is 0.
      int32 b_frame_count = 16;
      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 = 17;
      Returns:
      The aqStrength.

    • getProfile

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

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

 The available options are
 [FFmpeg-compatible](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`
 message.
      string profile = 18;
      Returns:
      The profile.

    • getProfileBytes

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

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

 The available options are
 [FFmpeg-compatible](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`
 message.
      string profile = 18;
      Returns:
      The bytes for profile.

    • getTune

      String getTune()
       Enforces the specified codec tune. The available options are
 [FFmpeg-compatible](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`
 message.
      string tune = 19;
      Returns:
      The tune.

    • getTuneBytes

      com.google.protobuf.ByteString getTuneBytes()
       Enforces the specified codec tune. The available options are
 [FFmpeg-compatible](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`
 message.
      string tune = 19;
      Returns:
      The bytes for tune.

    • getPreset

      String getPreset()
       Enforces the specified codec preset. The default is `veryfast`. The
 available options are
 [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Preset).
 Note that certain values for this field may cause the
 transcoder to override other fields you set in the `H264CodecSettings`
 message.
      string preset = 20;
      Returns:
      The preset.

    • getPresetBytes

      com.google.protobuf.ByteString getPresetBytes()
       Enforces the specified codec preset. The default is `veryfast`. The
 available options are
 [FFmpeg-compatible](https://trac.ffmpeg.org/wiki/Encode/H.264#Preset).
 Note that certain values for this field may cause the
 transcoder to override other fields you set in the `H264CodecSettings`
 message.
      string preset = 20;
      Returns:
      The bytes for preset.

    • hasSdr

      boolean hasSdr()
       Optional. SDR color format setting for H264.
      .google.cloud.video.transcoder.v1.VideoStream.H264ColorFormatSDR sdr = 21 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the sdr field is set.

    • getSdr

      VideoStream.H264ColorFormatSDR getSdr()
       Optional. SDR color format setting for H264.
      .google.cloud.video.transcoder.v1.VideoStream.H264ColorFormatSDR sdr = 21 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The sdr.

    • getSdrOrBuilder

      VideoStream.H264ColorFormatSDROrBuilder getSdrOrBuilder()
       Optional. SDR color format setting for H264.
      .google.cloud.video.transcoder.v1.VideoStream.H264ColorFormatSDR sdr = 21 [(.google.api.field_behavior) = OPTIONAL];

    • hasHlg

      boolean hasHlg()
       Optional. HLG color format setting for H264.
      .google.cloud.video.transcoder.v1.VideoStream.H264ColorFormatHLG hlg = 22 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the hlg field is set.

    • getHlg

      VideoStream.H264ColorFormatHLG getHlg()
       Optional. HLG color format setting for H264.
      .google.cloud.video.transcoder.v1.VideoStream.H264ColorFormatHLG hlg = 22 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The hlg.

    • getHlgOrBuilder

      VideoStream.H264ColorFormatHLGOrBuilder getHlgOrBuilder()
       Optional. HLG color format setting for H264.
      .google.cloud.video.transcoder.v1.VideoStream.H264ColorFormatHLG hlg = 22 [(.google.api.field_behavior) = OPTIONAL];

    • getGopModeCase

      VideoStream.H264CodecSettings.GopModeCase getGopModeCase()

    • getColorFormatCase

      VideoStream.H264CodecSettings.ColorFormatCase getColorFormatCase()