Class VideoStream.Vp9CodecSettings.Builder (1.45.0)

public static final class VideoStream.Vp9CodecSettings.Builder extends GeneratedMessageV3.Builder<VideoStream.Vp9CodecSettings.Builder> implements VideoStream.Vp9CodecSettingsOrBuilder

VP9 codec settings.

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public VideoStream.Vp9CodecSettings.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
VideoStream.Vp9CodecSettings.Builder
Overrides

build()

public VideoStream.Vp9CodecSettings build()
Returns
Type Description
VideoStream.Vp9CodecSettings

buildPartial()

public VideoStream.Vp9CodecSettings buildPartial()
Returns
Type Description
VideoStream.Vp9CodecSettings

clear()

public VideoStream.Vp9CodecSettings.Builder clear()
Returns
Type Description
VideoStream.Vp9CodecSettings.Builder
Overrides

clearBitrateBps()

public VideoStream.Vp9CodecSettings.Builder clearBitrateBps()

Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 480,000,000.

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

Returns
Type Description
VideoStream.Vp9CodecSettings.Builder

This builder for chaining.

clearCrfLevel()

public VideoStream.Vp9CodecSettings.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.

Note: This field is not supported.

int32 crf_level = 7;

Returns
Type Description
VideoStream.Vp9CodecSettings.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public VideoStream.Vp9CodecSettings.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
VideoStream.Vp9CodecSettings.Builder
Overrides

clearFrameRate()

public VideoStream.Vp9CodecSettings.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
Type Description
VideoStream.Vp9CodecSettings.Builder

This builder for chaining.

clearGopDuration()

public VideoStream.Vp9CodecSettings.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 = 9;

Returns
Type Description
VideoStream.Vp9CodecSettings.Builder

clearGopFrameCount()

public VideoStream.Vp9CodecSettings.Builder clearGopFrameCount()

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

int32 gop_frame_count = 8;

Returns
Type Description
VideoStream.Vp9CodecSettings.Builder

This builder for chaining.

clearGopMode()

public VideoStream.Vp9CodecSettings.Builder clearGopMode()
Returns
Type Description
VideoStream.Vp9CodecSettings.Builder

clearHeightPixels()

public VideoStream.Vp9CodecSettings.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.

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
Type Description
VideoStream.Vp9CodecSettings.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public VideoStream.Vp9CodecSettings.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
VideoStream.Vp9CodecSettings.Builder
Overrides

clearPixelFormat()

public VideoStream.Vp9CodecSettings.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
Type Description
VideoStream.Vp9CodecSettings.Builder

This builder for chaining.

clearProfile()

public VideoStream.Vp9CodecSettings.Builder clearProfile()

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

  • profile0 (default)
  • profile1
  • profile2
  • profile3

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

string profile = 10;

Returns
Type Description
VideoStream.Vp9CodecSettings.Builder

This builder for chaining.

clearRateControlMode()

public VideoStream.Vp9CodecSettings.Builder clearRateControlMode()

Specify the rate_control_mode. The default is vbr.

Supported rate control modes:

  • vbr - variable bitrate

string rate_control_mode = 6;

Returns
Type Description
VideoStream.Vp9CodecSettings.Builder

This builder for chaining.

clearWidthPixels()

public VideoStream.Vp9CodecSettings.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.

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
Type Description
VideoStream.Vp9CodecSettings.Builder

This builder for chaining.

clone()

public VideoStream.Vp9CodecSettings.Builder clone()
Returns
Type Description
VideoStream.Vp9CodecSettings.Builder
Overrides

getBitrateBps()

public int getBitrateBps()

Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 480,000,000.

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

Returns
Type Description
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.

Note: This field is not supported.

int32 crf_level = 7;

Returns
Type Description
int

The crfLevel.

getDefaultInstanceForType()

public VideoStream.Vp9CodecSettings getDefaultInstanceForType()
Returns
Type Description
VideoStream.Vp9CodecSettings

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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
Type Description
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 = 9;

Returns
Type Description
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 = 9;

Returns
Type Description
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 = 9;

Returns
Type Description
DurationOrBuilder

getGopFrameCount()

public int getGopFrameCount()

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

int32 gop_frame_count = 8;

Returns
Type Description
int

The gopFrameCount.

getGopModeCase()

public VideoStream.Vp9CodecSettings.GopModeCase getGopModeCase()
Returns
Type Description
VideoStream.Vp9CodecSettings.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.

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
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for pixelFormat.

getProfile()

public String getProfile()

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

  • profile0 (default)
  • profile1
  • profile2
  • profile3

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

string profile = 10;

Returns
Type Description
String

The profile.

getProfileBytes()

public ByteString getProfileBytes()

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

  • profile0 (default)
  • profile1
  • profile2
  • profile3

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

string profile = 10;

Returns
Type Description
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

string rate_control_mode = 6;

Returns
Type Description
String

The rateControlMode.

getRateControlModeBytes()

public ByteString getRateControlModeBytes()

Specify the rate_control_mode. The default is vbr.

Supported rate control modes:

  • vbr - variable bitrate

string rate_control_mode = 6;

Returns
Type Description
ByteString

The bytes for rateControlMode.

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.

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
Type Description
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 = 9;

Returns
Type Description
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 = 8;

Returns
Type Description
boolean

Whether the gopFrameCount field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(VideoStream.Vp9CodecSettings other)

public VideoStream.Vp9CodecSettings.Builder mergeFrom(VideoStream.Vp9CodecSettings other)
Parameter
Name Description
other VideoStream.Vp9CodecSettings
Returns
Type Description
VideoStream.Vp9CodecSettings.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public VideoStream.Vp9CodecSettings.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VideoStream.Vp9CodecSettings.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public VideoStream.Vp9CodecSettings.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
VideoStream.Vp9CodecSettings.Builder
Overrides

mergeGopDuration(Duration value)

public VideoStream.Vp9CodecSettings.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 = 9;

Parameter
Name Description
value Duration
Returns
Type Description
VideoStream.Vp9CodecSettings.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final VideoStream.Vp9CodecSettings.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
VideoStream.Vp9CodecSettings.Builder
Overrides

setBitrateBps(int value)

public VideoStream.Vp9CodecSettings.Builder setBitrateBps(int value)

Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 480,000,000.

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

Parameter
Name Description
value int

The bitrateBps to set.

Returns
Type Description
VideoStream.Vp9CodecSettings.Builder

This builder for chaining.

setCrfLevel(int value)

public VideoStream.Vp9CodecSettings.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.

Note: This field is not supported.

int32 crf_level = 7;

Parameter
Name Description
value int

The crfLevel to set.

Returns
Type Description
VideoStream.Vp9CodecSettings.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public VideoStream.Vp9CodecSettings.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
VideoStream.Vp9CodecSettings.Builder
Overrides

setFrameRate(double value)

public VideoStream.Vp9CodecSettings.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
Name Description
value double

The frameRate to set.

Returns
Type Description
VideoStream.Vp9CodecSettings.Builder

This builder for chaining.

setGopDuration(Duration value)

public VideoStream.Vp9CodecSettings.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 = 9;

Parameter
Name Description
value Duration
Returns
Type Description
VideoStream.Vp9CodecSettings.Builder

setGopDuration(Duration.Builder builderForValue)

public VideoStream.Vp9CodecSettings.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 = 9;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
VideoStream.Vp9CodecSettings.Builder

setGopFrameCount(int value)

public VideoStream.Vp9CodecSettings.Builder setGopFrameCount(int value)

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

int32 gop_frame_count = 8;

Parameter
Name Description
value int

The gopFrameCount to set.

Returns
Type Description
VideoStream.Vp9CodecSettings.Builder

This builder for chaining.

setHeightPixels(int value)

public VideoStream.Vp9CodecSettings.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.

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;

Parameter
Name Description
value int

The heightPixels to set.

Returns
Type Description
VideoStream.Vp9CodecSettings.Builder

This builder for chaining.

setPixelFormat(String value)

public VideoStream.Vp9CodecSettings.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
Name Description
value String

The pixelFormat to set.

Returns
Type Description
VideoStream.Vp9CodecSettings.Builder

This builder for chaining.

setPixelFormatBytes(ByteString value)

public VideoStream.Vp9CodecSettings.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
Name Description
value ByteString

The bytes for pixelFormat to set.

Returns
Type Description
VideoStream.Vp9CodecSettings.Builder

This builder for chaining.

setProfile(String value)

public VideoStream.Vp9CodecSettings.Builder setProfile(String value)

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

  • profile0 (default)
  • profile1
  • profile2
  • profile3

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

string profile = 10;

Parameter
Name Description
value String

The profile to set.

Returns
Type Description
VideoStream.Vp9CodecSettings.Builder

This builder for chaining.

setProfileBytes(ByteString value)

public VideoStream.Vp9CodecSettings.Builder setProfileBytes(ByteString value)

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

  • profile0 (default)
  • profile1
  • profile2
  • profile3

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

string profile = 10;

Parameter
Name Description
value ByteString

The bytes for profile to set.

Returns
Type Description
VideoStream.Vp9CodecSettings.Builder

This builder for chaining.

setRateControlMode(String value)

public VideoStream.Vp9CodecSettings.Builder setRateControlMode(String value)

Specify the rate_control_mode. The default is vbr.

Supported rate control modes:

  • vbr - variable bitrate

string rate_control_mode = 6;

Parameter
Name Description
value String

The rateControlMode to set.

Returns
Type Description
VideoStream.Vp9CodecSettings.Builder

This builder for chaining.

setRateControlModeBytes(ByteString value)

public VideoStream.Vp9CodecSettings.Builder setRateControlModeBytes(ByteString value)

Specify the rate_control_mode. The default is vbr.

Supported rate control modes:

  • vbr - variable bitrate

string rate_control_mode = 6;

Parameter
Name Description
value ByteString

The bytes for rateControlMode to set.

Returns
Type Description
VideoStream.Vp9CodecSettings.Builder

This builder for chaining.

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

public VideoStream.Vp9CodecSettings.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
VideoStream.Vp9CodecSettings.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final VideoStream.Vp9CodecSettings.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
VideoStream.Vp9CodecSettings.Builder
Overrides

setWidthPixels(int value)

public VideoStream.Vp9CodecSettings.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.

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;

Parameter
Name Description
value int

The widthPixels to set.

Returns
Type Description
VideoStream.Vp9CodecSettings.Builder

This builder for chaining.