Google Cloud Video Live Stream V1 Client - Class H265CodecSettings (1.3.0)

Reference documentation and code samples for the Google Cloud Video Live Stream V1 Client class H265CodecSettings.

H265 codec settings.

Generated from protobuf message google.cloud.video.livestream.v1.VideoStream.H265CodecSettings

Namespace

Google \ Cloud \ Video \ LiveStream \ V1 \ VideoStream

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ width_pixels int

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].
↳ height_pixels int

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].
↳ frame_rate float

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.
↳ bitrate_bps int

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).
↳ gop_frame_count int

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].
↳ gop_duration Google\Protobuf\Duration

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.
↳ vbv_size_bits int

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

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.
↳ b_pyramid bool

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

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.
↳ aq_strength float

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.

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

Returns
Type Description
int

setWidthPixels

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

Parameter
Name Description
var int
Returns
Type Description
$this

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

Returns
Type Description
int

setHeightPixels

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

Parameter
Name Description
var int
Returns
Type Description
$this

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.

Returns
Type Description
float

setFrameRate

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.

Parameter
Name Description
var float
Returns
Type Description
$this

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

setBitrateBps

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).
Parameter
Name Description
var int
Returns
Type Description
$this

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

Returns
Type Description
int

hasGopFrameCount

setGopFrameCount

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

Parameter
Name Description
var int
Returns
Type Description
$this

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.

Returns
Type Description
Google\Protobuf\Duration|null

hasGopDuration

setGopDuration

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.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getVbvSizeBits

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

Returns
Type Description
int

setVbvSizeBits

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

Parameter
Name Description
var int
Returns
Type Description
$this

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.

Returns
Type Description
int

setVbvFullnessBits

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.

Parameter
Name Description
var int
Returns
Type Description
$this

getBPyramid

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

Returns
Type Description
bool

setBPyramid

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

Parameter
Name Description
var bool
Returns
Type Description
$this

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.

Returns
Type Description
int

setBFrameCount

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.

Parameter
Name Description
var int
Returns
Type Description
$this

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.

Returns
Type Description
float

setAqStrength

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.

Parameter
Name Description
var float
Returns
Type Description
$this

getGopMode

Returns
Type Description
string