Class VideoStream.H265CodecSettings.Builder (0.77.0)

public static final class VideoStream.H265CodecSettings.Builder extends GeneratedMessageV3.Builder<VideoStream.H265CodecSettings.Builder> implements VideoStream.H265CodecSettingsOrBuilder

H265 codec settings.

Protobuf type google.cloud.video.livestream.v1.VideoStream.H265CodecSettings

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

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

buildPartial()

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

clear()

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

clearAqStrength()

public VideoStream.H265CodecSettings.Builder clearAqStrength()

Optional. 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 = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VideoStream.H265CodecSettings.Builder

This builder for chaining.

clearBFrameCount()

public VideoStream.H265CodecSettings.Builder clearBFrameCount()

Optional. 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 = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VideoStream.H265CodecSettings.Builder

This builder for chaining.

clearBPyramid()

public VideoStream.H265CodecSettings.Builder clearBPyramid()

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

bool b_pyramid = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VideoStream.H265CodecSettings.Builder

This builder for chaining.

clearBitrateBps()

public VideoStream.H265CodecSettings.Builder clearBitrateBps()

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).
  • For UHD resolution (<= 2160p), must be <= 25,000,000 (25 Mbps).

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

Returns
Type Description
VideoStream.H265CodecSettings.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearFrameRate()

public VideoStream.H265CodecSettings.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.H265CodecSettings.Builder

This builder for chaining.

clearGopDuration()

public VideoStream.H265CodecSettings.Builder clearGopDuration()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VideoStream.H265CodecSettings.Builder

clearGopFrameCount()

public VideoStream.H265CodecSettings.Builder clearGopFrameCount()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VideoStream.H265CodecSettings.Builder

This builder for chaining.

clearGopMode()

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

clearHeightPixels()

public VideoStream.H265CodecSettings.Builder clearHeightPixels()

Optional. 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. Valid range is [180, 2160].

int32 height_pixels = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VideoStream.H265CodecSettings.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearVbvFullnessBits()

public VideoStream.H265CodecSettings.Builder clearVbvFullnessBits()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VideoStream.H265CodecSettings.Builder

This builder for chaining.

clearVbvSizeBits()

public VideoStream.H265CodecSettings.Builder clearVbvSizeBits()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VideoStream.H265CodecSettings.Builder

This builder for chaining.

clearWidthPixels()

public VideoStream.H265CodecSettings.Builder clearWidthPixels()

Optional. 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. Valid range is [320, 4096].

int32 width_pixels = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VideoStream.H265CodecSettings.Builder

This builder for chaining.

clone()

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

getAqStrength()

public double getAqStrength()

Optional. 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 = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
double

The aqStrength.

getBFrameCount()

public int getBFrameCount()

Optional. 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 = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The bFrameCount.

getBPyramid()

public boolean getBPyramid()

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

bool b_pyramid = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The bPyramid.

getBitrateBps()

public 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).
  • For UHD resolution (<= 2160p), must be <= 25,000,000 (25 Mbps).

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

Returns
Type Description
int

The bitrateBps.

getDefaultInstanceForType()

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

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()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Duration

The gopDuration.

getGopDurationBuilder()

public Duration.Builder getGopDurationBuilder()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getGopDurationOrBuilder()

public DurationOrBuilder getGopDurationOrBuilder()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DurationOrBuilder

getGopFrameCount()

public int getGopFrameCount()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The gopFrameCount.

getGopModeCase()

public VideoStream.H265CodecSettings.GopModeCase getGopModeCase()
Returns
Type Description
VideoStream.H265CodecSettings.GopModeCase

getHeightPixels()

public int getHeightPixels()

Optional. 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. Valid range is [180, 2160].

int32 height_pixels = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The heightPixels.

getVbvFullnessBits()

public int getVbvFullnessBits()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The vbvFullnessBits.

getVbvSizeBits()

public int getVbvSizeBits()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The vbvSizeBits.

getWidthPixels()

public int getWidthPixels()

Optional. 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. Valid range is [320, 4096].

int32 width_pixels = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The widthPixels.

hasGopDuration()

public boolean hasGopDuration()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the gopDuration field is set.

hasGopFrameCount()

public boolean hasGopFrameCount()

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

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.H265CodecSettings other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeGopDuration(Duration value)

public VideoStream.H265CodecSettings.Builder mergeGopDuration(Duration value)

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setAqStrength(double value)

public VideoStream.H265CodecSettings.Builder setAqStrength(double value)

Optional. 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 = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value double

The aqStrength to set.

Returns
Type Description
VideoStream.H265CodecSettings.Builder

This builder for chaining.

setBFrameCount(int value)

public VideoStream.H265CodecSettings.Builder setBFrameCount(int value)

Optional. 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 = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The bFrameCount to set.

Returns
Type Description
VideoStream.H265CodecSettings.Builder

This builder for chaining.

setBPyramid(boolean value)

public VideoStream.H265CodecSettings.Builder setBPyramid(boolean value)

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

bool b_pyramid = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The bPyramid to set.

Returns
Type Description
VideoStream.H265CodecSettings.Builder

This builder for chaining.

setBitrateBps(int value)

public VideoStream.H265CodecSettings.Builder setBitrateBps(int value)

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).
  • For UHD resolution (<= 2160p), must be <= 25,000,000 (25 Mbps).

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

Parameter
Name Description
value int

The bitrateBps to set.

Returns
Type Description
VideoStream.H265CodecSettings.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setFrameRate(double value)

public VideoStream.H265CodecSettings.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.H265CodecSettings.Builder

This builder for chaining.

setGopDuration(Duration value)

public VideoStream.H265CodecSettings.Builder setGopDuration(Duration value)

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

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

setGopDuration(Duration.Builder builderForValue)

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

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

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

setGopFrameCount(int value)

public VideoStream.H265CodecSettings.Builder setGopFrameCount(int value)

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The gopFrameCount to set.

Returns
Type Description
VideoStream.H265CodecSettings.Builder

This builder for chaining.

setHeightPixels(int value)

public VideoStream.H265CodecSettings.Builder setHeightPixels(int value)

Optional. 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. Valid range is [180, 2160].

int32 height_pixels = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The heightPixels to set.

Returns
Type Description
VideoStream.H265CodecSettings.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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

setVbvFullnessBits(int value)

public VideoStream.H265CodecSettings.Builder setVbvFullnessBits(int value)

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The vbvFullnessBits to set.

Returns
Type Description
VideoStream.H265CodecSettings.Builder

This builder for chaining.

setVbvSizeBits(int value)

public VideoStream.H265CodecSettings.Builder setVbvSizeBits(int value)

Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The vbvSizeBits to set.

Returns
Type Description
VideoStream.H265CodecSettings.Builder

This builder for chaining.

setWidthPixels(int value)

public VideoStream.H265CodecSettings.Builder setWidthPixels(int value)

Optional. 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. Valid range is [320, 4096].

int32 width_pixels = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The widthPixels to set.

Returns
Type Description
VideoStream.H265CodecSettings.Builder

This builder for chaining.