Class VideoStream.H264CodecSettings.Builder (1.5.0)

Stay organized with collections Save and categorize content based on your preferences.
public static final class VideoStream.H264CodecSettings.Builder extends GeneratedMessageV3.Builder<VideoStream.H264CodecSettings.Builder> implements VideoStream.H264CodecSettingsOrBuilder

H264 codec settings.

Protobuf type google.cloud.video.transcoder.v1.VideoStream.H264CodecSettings

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public VideoStream.H264CodecSettings.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
VideoStream.H264CodecSettings.Builder
Overrides

build()

public VideoStream.H264CodecSettings build()
Returns
TypeDescription
VideoStream.H264CodecSettings

buildPartial()

public VideoStream.H264CodecSettings buildPartial()
Returns
TypeDescription
VideoStream.H264CodecSettings

clear()

public VideoStream.H264CodecSettings.Builder clear()
Returns
TypeDescription
VideoStream.H264CodecSettings.Builder
Overrides

clearAllowOpenGop()

public VideoStream.H264CodecSettings.Builder clearAllowOpenGop()

Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is false.

bool allow_open_gop = 8;

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

clearAqStrength()

public VideoStream.H264CodecSettings.Builder clearAqStrength()

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
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

clearBFrameCount()

public VideoStream.H264CodecSettings.Builder clearBFrameCount()

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

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

clearBPyramid()

public VideoStream.H264CodecSettings.Builder clearBPyramid()

Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is false.

bool b_pyramid = 15;

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

clearBitrateBps()

public VideoStream.H264CodecSettings.Builder clearBitrateBps()

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
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

clearCrfLevel()

public VideoStream.H264CodecSettings.Builder clearCrfLevel()

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
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

clearEnableTwoPass()

public VideoStream.H264CodecSettings.Builder clearEnableTwoPass()

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

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

clearEntropyCoder()

public VideoStream.H264CodecSettings.Builder clearEntropyCoder()

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

  • cavlc
  • cabac

string entropy_coder = 14;

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public VideoStream.H264CodecSettings.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
VideoStream.H264CodecSettings.Builder
Overrides

clearFrameRate()

public VideoStream.H264CodecSettings.Builder clearFrameRate()

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

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

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

clearGopDuration()

public VideoStream.H264CodecSettings.Builder clearGopDuration()

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

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

clearGopFrameCount()

public VideoStream.H264CodecSettings.Builder clearGopFrameCount()

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

int32 gop_frame_count = 9;

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

clearGopMode()

public VideoStream.H264CodecSettings.Builder clearGopMode()
Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

clearHeightPixels()

public VideoStream.H264CodecSettings.Builder clearHeightPixels()

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

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public VideoStream.H264CodecSettings.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
VideoStream.H264CodecSettings.Builder
Overrides

clearPixelFormat()

public VideoStream.H264CodecSettings.Builder clearPixelFormat()

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
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

clearPreset()

public VideoStream.H264CodecSettings.Builder clearPreset()

Enforces the specified codec preset. The default is veryfast. The available options are FFmpeg-compatible. 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
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

clearProfile()

public VideoStream.H264CodecSettings.Builder clearProfile()

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

  • baseline
  • main
  • high (default) The available options are FFmpeg-compatible. 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
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

clearRateControlMode()

public VideoStream.H264CodecSettings.Builder clearRateControlMode()

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

  • vbr - variable bitrate
  • crf - constant rate factor

string rate_control_mode = 6;

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

clearTune()

public VideoStream.H264CodecSettings.Builder clearTune()

Enforces the specified codec tune. The available options are FFmpeg-compatible. 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
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

clearVbvFullnessBits()

public VideoStream.H264CodecSettings.Builder clearVbvFullnessBits()

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
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

clearVbvSizeBits()

public VideoStream.H264CodecSettings.Builder clearVbvSizeBits()

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
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

clearWidthPixels()

public VideoStream.H264CodecSettings.Builder clearWidthPixels()

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

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

clone()

public VideoStream.H264CodecSettings.Builder clone()
Returns
TypeDescription
VideoStream.H264CodecSettings.Builder
Overrides

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

Returns
TypeDescription
boolean

The allowOpenGop.

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

Returns
TypeDescription
double

The aqStrength.

getBFrameCount()

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

Returns
TypeDescription
int

The bFrameCount.

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

Returns
TypeDescription
boolean

The bPyramid.

getBitrateBps()

public 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
TypeDescription
int

The bitrateBps.

getCrfLevel()

public 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
TypeDescription
int

The crfLevel.

getDefaultInstanceForType()

public VideoStream.H264CodecSettings getDefaultInstanceForType()
Returns
TypeDescription
VideoStream.H264CodecSettings

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEnableTwoPass()

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

Returns
TypeDescription
boolean

The enableTwoPass.

getEntropyCoder()

public String getEntropyCoder()

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

  • cavlc
  • cabac

string entropy_coder = 14;

Returns
TypeDescription
String

The entropyCoder.

getEntropyCoderBytes()

public ByteString getEntropyCoderBytes()

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

  • cavlc
  • cabac

string entropy_coder = 14;

Returns
TypeDescription
ByteString

The bytes for entropyCoder.

getFrameRate()

public 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 Calculating frame rate for more information.

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

Returns
TypeDescription
double

The frameRate.

getGopDuration()

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

Returns
TypeDescription
Duration

The gopDuration.

getGopDurationBuilder()

public Duration.Builder getGopDurationBuilder()

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

Returns
TypeDescription
Builder

getGopDurationOrBuilder()

public 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, and segmentDuration must be divisible by gopDuration.

.google.protobuf.Duration gop_duration = 10;

Returns
TypeDescription
DurationOrBuilder

getGopFrameCount()

public int getGopFrameCount()

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

int32 gop_frame_count = 9;

Returns
TypeDescription
int

The gopFrameCount.

getGopModeCase()

public VideoStream.H264CodecSettings.GopModeCase getGopModeCase()
Returns
TypeDescription
VideoStream.H264CodecSettings.GopModeCase

getHeightPixels()

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

Returns
TypeDescription
int

The heightPixels.

getPixelFormat()

public 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
TypeDescription
String

The pixelFormat.

getPixelFormatBytes()

public 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
TypeDescription
ByteString

The bytes for pixelFormat.

getPreset()

public String getPreset()

Enforces the specified codec preset. The default is veryfast. The available options are FFmpeg-compatible. 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
TypeDescription
String

The preset.

getPresetBytes()

public ByteString getPresetBytes()

Enforces the specified codec preset. The default is veryfast. The available options are FFmpeg-compatible. 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
TypeDescription
ByteString

The bytes for preset.

getProfile()

public String getProfile()

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

  • baseline
  • main
  • high (default) The available options are FFmpeg-compatible. 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
TypeDescription
String

The profile.

getProfileBytes()

public ByteString getProfileBytes()

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

  • baseline
  • main
  • high (default) The available options are FFmpeg-compatible. 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
TypeDescription
ByteString

The bytes for profile.

getRateControlMode()

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

Returns
TypeDescription
String

The rateControlMode.

getRateControlModeBytes()

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

Returns
TypeDescription
ByteString

The bytes for rateControlMode.

getTune()

public String getTune()

Enforces the specified codec tune. The available options are FFmpeg-compatible. 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
TypeDescription
String

The tune.

getTuneBytes()

public ByteString getTuneBytes()

Enforces the specified codec tune. The available options are FFmpeg-compatible. 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
TypeDescription
ByteString

The bytes for tune.

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

int32 vbv_fullness_bits = 13;

Returns
TypeDescription
int

The vbvFullnessBits.

getVbvSizeBits()

public 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
TypeDescription
int

The vbvSizeBits.

getWidthPixels()

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

Returns
TypeDescription
int

The widthPixels.

hasGopDuration()

public 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, and segmentDuration must be divisible by gopDuration.

.google.protobuf.Duration gop_duration = 10;

Returns
TypeDescription
boolean

Whether the gopDuration field is set.

hasGopFrameCount()

public boolean hasGopFrameCount()

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

int32 gop_frame_count = 9;

Returns
TypeDescription
boolean

Whether the gopFrameCount field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(VideoStream.H264CodecSettings other)

public VideoStream.H264CodecSettings.Builder mergeFrom(VideoStream.H264CodecSettings other)
Parameter
NameDescription
otherVideoStream.H264CodecSettings
Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public VideoStream.H264CodecSettings.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
VideoStream.H264CodecSettings.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public VideoStream.H264CodecSettings.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
VideoStream.H264CodecSettings.Builder
Overrides

mergeGopDuration(Duration value)

public VideoStream.H264CodecSettings.Builder mergeGopDuration(Duration value)

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

Parameter
NameDescription
valueDuration
Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final VideoStream.H264CodecSettings.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
VideoStream.H264CodecSettings.Builder
Overrides

setAllowOpenGop(boolean value)

public VideoStream.H264CodecSettings.Builder setAllowOpenGop(boolean value)

Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is false.

bool allow_open_gop = 8;

Parameter
NameDescription
valueboolean

The allowOpenGop to set.

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

setAqStrength(double value)

public VideoStream.H264CodecSettings.Builder setAqStrength(double value)

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;

Parameter
NameDescription
valuedouble

The aqStrength to set.

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

setBFrameCount(int value)

public VideoStream.H264CodecSettings.Builder setBFrameCount(int value)

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

Parameter
NameDescription
valueint

The bFrameCount to set.

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

setBPyramid(boolean value)

public VideoStream.H264CodecSettings.Builder setBPyramid(boolean value)

Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is false.

bool b_pyramid = 15;

Parameter
NameDescription
valueboolean

The bPyramid to set.

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

setBitrateBps(int value)

public VideoStream.H264CodecSettings.Builder setBitrateBps(int value)

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];

Parameter
NameDescription
valueint

The bitrateBps to set.

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

setCrfLevel(int value)

public VideoStream.H264CodecSettings.Builder setCrfLevel(int value)

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;

Parameter
NameDescription
valueint

The crfLevel to set.

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

setEnableTwoPass(boolean value)

public VideoStream.H264CodecSettings.Builder setEnableTwoPass(boolean value)

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

Parameter
NameDescription
valueboolean

The enableTwoPass to set.

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

setEntropyCoder(String value)

public VideoStream.H264CodecSettings.Builder setEntropyCoder(String value)

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

  • cavlc
  • cabac

string entropy_coder = 14;

Parameter
NameDescription
valueString

The entropyCoder to set.

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

setEntropyCoderBytes(ByteString value)

public VideoStream.H264CodecSettings.Builder setEntropyCoderBytes(ByteString value)

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

  • cavlc
  • cabac

string entropy_coder = 14;

Parameter
NameDescription
valueByteString

The bytes for entropyCoder to set.

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public VideoStream.H264CodecSettings.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
VideoStream.H264CodecSettings.Builder
Overrides

setFrameRate(double value)

public VideoStream.H264CodecSettings.Builder setFrameRate(double value)

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

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

Parameter
NameDescription
valuedouble

The frameRate to set.

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

setGopDuration(Duration value)

public VideoStream.H264CodecSettings.Builder setGopDuration(Duration value)

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

Parameter
NameDescription
valueDuration
Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

setGopDuration(Duration.Builder builderForValue)

public VideoStream.H264CodecSettings.Builder setGopDuration(Duration.Builder builderForValue)

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

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

setGopFrameCount(int value)

public VideoStream.H264CodecSettings.Builder setGopFrameCount(int value)

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

int32 gop_frame_count = 9;

Parameter
NameDescription
valueint

The gopFrameCount to set.

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

setHeightPixels(int value)

public VideoStream.H264CodecSettings.Builder setHeightPixels(int value)

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

Parameter
NameDescription
valueint

The heightPixels to set.

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

setPixelFormat(String value)

public VideoStream.H264CodecSettings.Builder setPixelFormat(String value)

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;

Parameter
NameDescription
valueString

The pixelFormat to set.

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

setPixelFormatBytes(ByteString value)

public VideoStream.H264CodecSettings.Builder setPixelFormatBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for pixelFormat to set.

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

setPreset(String value)

public VideoStream.H264CodecSettings.Builder setPreset(String value)

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

string preset = 20;

Parameter
NameDescription
valueString

The preset to set.

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

setPresetBytes(ByteString value)

public VideoStream.H264CodecSettings.Builder setPresetBytes(ByteString value)

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

string preset = 20;

Parameter
NameDescription
valueByteString

The bytes for preset to set.

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

setProfile(String value)

public VideoStream.H264CodecSettings.Builder setProfile(String value)

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

  • baseline
  • main
  • high (default) The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the H264CodecSettings message.

string profile = 18;

Parameter
NameDescription
valueString

The profile to set.

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

setProfileBytes(ByteString value)

public VideoStream.H264CodecSettings.Builder setProfileBytes(ByteString value)

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

  • baseline
  • main
  • high (default) The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the H264CodecSettings message.

string profile = 18;

Parameter
NameDescription
valueByteString

The bytes for profile to set.

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

setRateControlMode(String value)

public VideoStream.H264CodecSettings.Builder setRateControlMode(String value)

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

  • vbr - variable bitrate
  • crf - constant rate factor

string rate_control_mode = 6;

Parameter
NameDescription
valueString

The rateControlMode to set.

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

setRateControlModeBytes(ByteString value)

public VideoStream.H264CodecSettings.Builder setRateControlModeBytes(ByteString value)

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

  • vbr - variable bitrate
  • crf - constant rate factor

string rate_control_mode = 6;

Parameter
NameDescription
valueByteString

The bytes for rateControlMode to set.

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public VideoStream.H264CodecSettings.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
VideoStream.H264CodecSettings.Builder
Overrides

setTune(String value)

public VideoStream.H264CodecSettings.Builder setTune(String value)

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

string tune = 19;

Parameter
NameDescription
valueString

The tune to set.

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

setTuneBytes(ByteString value)

public VideoStream.H264CodecSettings.Builder setTuneBytes(ByteString value)

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

string tune = 19;

Parameter
NameDescription
valueByteString

The bytes for tune to set.

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final VideoStream.H264CodecSettings.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
VideoStream.H264CodecSettings.Builder
Overrides

setVbvFullnessBits(int value)

public VideoStream.H264CodecSettings.Builder setVbvFullnessBits(int value)

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;

Parameter
NameDescription
valueint

The vbvFullnessBits to set.

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

setVbvSizeBits(int value)

public VideoStream.H264CodecSettings.Builder setVbvSizeBits(int value)

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;

Parameter
NameDescription
valueint

The vbvSizeBits to set.

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.

setWidthPixels(int value)

public VideoStream.H264CodecSettings.Builder setWidthPixels(int value)

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

Parameter
NameDescription
valueint

The widthPixels to set.

Returns
TypeDescription
VideoStream.H264CodecSettings.Builder

This builder for chaining.