Interface VideoStreamOrBuilder (0.4.3)

public interface VideoStreamOrBuilder 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 = 14;

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 = 21;

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 VideoStream.gop_frame_count if set. The default is 0.

int32 b_frame_count = 19;

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 = 18;

Returns

Type	Description
boolean	The bPyramid.

getBitrateBps()

public abstract int getBitrateBps()

Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value for H264/H265 is 800,000,000. The maximum value for VP9 is 480,000,000.

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

Returns

Type	Description
int	The bitrateBps.

getCodec()

public abstract String getCodec()

Codec type. The following codecs are supported:

h264 (default)
h265
vp9

string codec = 1;

Returns

Type	Description
String	The codec.

getCodecBytes()

public abstract ByteString getCodecBytes()

Codec type. The following codecs are supported:

h264 (default)
h265
vp9

string codec = 1;

Returns

Type	Description
ByteString	The bytes for codec.

getCrfLevel()

public abstract 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 = 11;

Returns

Type	Description
int	The crfLevel.

getEnableTwoPass()

public abstract boolean getEnableTwoPass()

Use two-pass encoding strategy to achieve better video quality. VideoStream.rate_control_mode must be "vbr". The default is false.

bool enable_two_pass = 10;

Returns

Type	Description
boolean	The enableTwoPass.

getEntropyCoder()

public abstract String getEntropyCoder()

The entropy coder to use. The default is "cabac". Supported entropy coders:

'cavlc'
'cabac'

string entropy_coder = 17;

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 = 17;

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 120. 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 Calculate frame rate for more information.

double frame_rate = 20 [(.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 "3s". Note that gopDuration must be less than or equal to segmentDuration, and segmentDuration must be divisible by gopDuration.

.google.protobuf.Duration gop_duration = 16;

Returns

Type	Description
Duration	The gopDuration.

getGopDurationOrBuilder()

public abstract DurationOrBuilder getGopDurationOrBuilder()

.google.protobuf.Duration gop_duration = 16;

Returns

Type	Description
DurationOrBuilder

getGopFrameCount()

public abstract int getGopFrameCount()

Select the GOP size based on the specified frame count. Must be greater than zero.

int32 gop_frame_count = 15;

Returns

Type	Description
int	The gopFrameCount.

getGopModeCase()

public abstract VideoStream.GopModeCase getGopModeCase()

Returns

Type	Description
VideoStream.GopModeCase

getHeightPixels()

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

int32 height_pixels = 5;

Returns

Type	Description
int	The heightPixels.

getPixelFormat()

public abstract 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 = 7;

Returns

Type	Description
String	The pixelFormat.

getPixelFormatBytes()

public abstract 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 = 7;

Returns

Type	Description
ByteString	The bytes for pixelFormat.

getPreset()

public abstract String getPreset()

Enforces the specified codec preset. The default is veryfast. The available options are <a href="https://trac.ffmpeg.org/wiki/Encode/H.264#Preset" class="external">FFmpeg-compatible</a>. Note that certain values for this field may cause the transcoder to override other fields you set in the VideoStream message.

string preset = 4;

Returns

Type	Description
String	The preset.

getPresetBytes()

public abstract ByteString getPresetBytes()

string preset = 4;

Returns

Type	Description
ByteString	The bytes for preset.

getProfile()

public abstract String getProfile()

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

baseline
main
high (default) The available options are <a href="https://trac.ffmpeg.org/wiki/Encode/H.264#Profile" class="external">FFmpeg-compatible</a>. Note that certain values for this field may cause the transcoder to override other fields you set in the VideoStream message.

string profile = 2;

Returns

Type	Description
String	The profile.

getProfileBytes()

public abstract ByteString getProfileBytes()

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

baseline
main
high (default) The available options are <a href="https://trac.ffmpeg.org/wiki/Encode/H.264#Profile" class="external">FFmpeg-compatible</a>. Note that certain values for this field may cause the transcoder to override other fields you set in the VideoStream message.

string profile = 2;

Returns

Type	Description
ByteString	The bytes for profile.

getRateControlMode()

public abstract String getRateControlMode()

Specify the rate_control_mode. The default is "vbr". Supported rate control modes:

'vbr' - variable bitrate
'crf' - constant rate factor

string rate_control_mode = 9;

Returns

Type	Description
String	The rateControlMode.

getRateControlModeBytes()

public abstract ByteString getRateControlModeBytes()

Specify the rate_control_mode. The default is "vbr". Supported rate control modes:

'vbr' - variable bitrate
'crf' - constant rate factor

string rate_control_mode = 9;

Returns

Type	Description
ByteString	The bytes for rateControlMode.

getTune()

public abstract String getTune()

Enforces the specified codec tune. The available options are <a href="https://trac.ffmpeg.org/wiki/Encode/H.264#Tune" class="external">FFmpeg-compatible</a>. Note that certain values for this field may cause the transcoder to override other fields you set in the VideoStream message.

string tune = 3;

Returns

Type	Description
String	The tune.

getTuneBytes()

public abstract ByteString getTuneBytes()

string tune = 3;

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 VideoStream.vbv_size_bits.

int32 vbv_fullness_bits = 13;

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 VideoStream.bitrate_bps.

int32 vbv_size_bits = 12;

Returns

Type	Description
int	The vbvSizeBits.

getWidthPixels()

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

int32 width_pixels = 6;

Returns

Type	Description
int	The widthPixels.

hasGopDuration()

public abstract boolean hasGopDuration()

.google.protobuf.Duration gop_duration = 16;

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. Must be greater than zero.

int32 gop_frame_count = 15;

Returns

Type	Description
boolean	Whether the gopFrameCount field is set.