Interface VideoStream.H264CodecSettingsOrBuilder (0.56.0) 

public static interface VideoStream.H264CodecSettingsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAllowOpenGop()

public abstract 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
Type Description
boolean

The allowOpenGop.

getAqStrength()

public abstract 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
Type Description
double

The aqStrength.

getBFrameCount()

public abstract int getBFrameCount()

The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than gop_frame_count if set. The default is 0.

int32 b_frame_count = 13;

Returns
Type Description
int

The bFrameCount.

getBPyramid()

public abstract 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
Type Description
boolean

The bPyramid.

getBitrateBps()

public abstract 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).

int32 bitrate_bps = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The bitrateBps.

getEntropyCoder()

public abstract String getEntropyCoder()

The entropy coder to use. The default is cabac.

Supported entropy coders:

  • cavlc
  • cabac

string entropy_coder = 11;

Returns
Type Description
String

The entropyCoder.

getEntropyCoderBytes()

public abstract ByteString getEntropyCoderBytes()

The entropy coder to use. The default is cabac.

Supported entropy coders:

  • cavlc
  • cabac

string entropy_coder = 11;

Returns
Type Description
ByteString

The bytes for entropyCoder.

getFrameRate()

public abstract 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 for more information.

double frame_rate = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
double

The frameRate.

getGopDuration()

public abstract 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, and 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
Type Description
Duration

The gopDuration.

getGopDurationOrBuilder()

public abstract 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, and 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
Type Description
DurationOrBuilder

getGopFrameCount()

public abstract 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
Type Description
int

The gopFrameCount.

getGopModeCase()

public abstract VideoStream.H264CodecSettings.GopModeCase getGopModeCase()
Returns
Type Description
VideoStream.H264CodecSettings.GopModeCase

getHeightPixels()

public abstract int getHeightPixels()

Required. The height of the video in pixels. Must be an even integer. Valid range is [180, 1080].

int32 height_pixels = 2;

Returns
Type Description
int

The heightPixels.

getProfile()

public abstract String getProfile()

Enforces the specified codec profile. The following profiles are supported:

  • baseline
  • main (default)

  • high

    The available options are FFmpeg-compatible Profile Options. Note that certain values for this field may cause the transcoder to override other fields you set in the H264CodecSettings message.

string profile = 15;

Returns
Type Description
String

The profile.

getProfileBytes()

public abstract ByteString getProfileBytes()

Enforces the specified codec profile. The following profiles are supported:

  • baseline
  • main (default)

  • high

    The available options are FFmpeg-compatible Profile Options. Note that certain values for this field may cause the transcoder to override other fields you set in the H264CodecSettings message.

string profile = 15;

Returns
Type Description
ByteString

The bytes for profile.

getTune()

public abstract String getTune()

Enforces the specified codec tune. The available options are FFmpeg-compatible Encode Options Note that certain values for this field may cause the transcoder to override other fields you set in the H264CodecSettings message.

string tune = 16;

Returns
Type Description
String

The tune.

getTuneBytes()

public abstract ByteString getTuneBytes()

Enforces the specified codec tune. The available options are FFmpeg-compatible Encode Options Note that certain values for this field may cause the transcoder to override other fields you set in the H264CodecSettings message.

string tune = 16;

Returns
Type Description
ByteString

The bytes for tune.

getVbvFullnessBits()

public abstract 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.

int32 vbv_fullness_bits = 10;

Returns
Type Description
int

The vbvFullnessBits.

getVbvSizeBits()

public abstract int getVbvSizeBits()

Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to bitrate_bps.

int32 vbv_size_bits = 9;

Returns
Type Description
int

The vbvSizeBits.

getWidthPixels()

public abstract int getWidthPixels()

Required. The width of the video in pixels. Must be an even integer. Valid range is [320, 1920].

int32 width_pixels = 1;

Returns
Type Description
int

The widthPixels.

hasGopDuration()

public abstract 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, and 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
Type Description
boolean

Whether the gopDuration field is set.

hasGopFrameCount()

public abstract 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
Type Description
boolean

Whether the gopFrameCount field is set.