Reference documentation and code samples for the Google Cloud Video Transcoder V1 Client class H265CodecSettings.
H265 codec settings.
Generated from protobuf message google.cloud.video.transcoder.v1.VideoStream.H265CodecSettings
Namespace
Google \ Cloud \ Video \ Transcoder \ V1 \ VideoStreamMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ width_pixels |
int
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. |
↳ height_pixels |
int
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. |
↳ 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. The minimum value is 1,000. The maximum value is 800,000,000. |
↳ pixel_format |
string
Pixel format to use. The default is |
↳ rate_control_mode |
string
Specify the |
↳ crf_level |
int
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. |
↳ allow_open_gop |
bool
Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is |
↳ gop_frame_count |
int
Select the GOP size based on the specified frame count. Must be greater than zero. |
↳ gop_duration |
Google\Protobuf\Duration
Select the GOP size based on the specified duration. The default is |
↳ enable_two_pass |
bool
Use two-pass encoding strategy to achieve better video quality. |
↳ vbv_size_bits |
int
Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to |
↳ vbv_fullness_bits |
int
Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to 90% of |
↳ b_pyramid |
bool
Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is |
↳ b_frame_count |
int
The number of consecutive B-frames. Must be greater than or equal to zero. Must be less than |
↳ aq_strength |
float
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. |
↳ profile |
string
Enforces the specified codec profile. The following profiles are supported: * 8-bit profiles * |
↳ tune |
string
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 |
↳ preset |
string
Enforces the specified codec preset. The default is |
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.
Returns | |
---|---|
Type | Description |
int |
setWidthPixels
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.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
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.
Returns | |
---|---|
Type | Description |
int |
setHeightPixels
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.
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. The minimum value is 1,000. The maximum value is 800,000,000.
Returns | |
---|---|
Type | Description |
int |
setBitrateBps
Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getPixelFormat
Pixel format to use. The default is yuv420p
.
Supported pixel formats:
yuv420p
pixel formatyuv422p
pixel formatyuv444p
pixel formatyuv420p10
10-bit HDR pixel formatyuv422p10
10-bit HDR pixel formatyuv444p10
10-bit HDR pixel formatyuv420p12
12-bit HDR pixel formatyuv422p12
12-bit HDR pixel formatyuv444p12
12-bit HDR pixel format
Returns | |
---|---|
Type | Description |
string |
setPixelFormat
Pixel format to use. The default is yuv420p
.
Supported pixel formats:
yuv420p
pixel formatyuv422p
pixel formatyuv444p
pixel formatyuv420p10
10-bit HDR pixel formatyuv422p10
10-bit HDR pixel formatyuv444p10
10-bit HDR pixel formatyuv420p12
12-bit HDR pixel formatyuv422p12
12-bit HDR pixel formatyuv444p12
12-bit HDR pixel format
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getRateControlMode
Specify the rate_control_mode
. The default is vbr
.
Supported rate control modes:
vbr
- variable bitratecrf
- constant rate factor
Returns | |
---|---|
Type | Description |
string |
setRateControlMode
Specify the rate_control_mode
. The default is vbr
.
Supported rate control modes:
vbr
- variable bitratecrf
- constant rate factor
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
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.
Returns | |
---|---|
Type | Description |
int |
setCrfLevel
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.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getAllowOpenGop
Specifies whether an open Group of Pictures (GOP) structure should be
allowed or not. The default is false
.
Returns | |
---|---|
Type | Description |
bool |
setAllowOpenGop
Specifies whether an open Group of Pictures (GOP) structure should be
allowed or not. The default is false
.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |
getGopFrameCount
Select the GOP size based on the specified frame count. Must be greater than zero.
Returns | |
---|---|
Type | Description |
int |
hasGopFrameCount
setGopFrameCount
Select the GOP size based on the specified frame count. Must be greater than zero.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
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
.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Duration|null |
hasGopDuration
setGopDuration
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
.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Duration
|
Returns | |
---|---|
Type | Description |
$this |
getEnableTwoPass
Use two-pass encoding strategy to achieve better video quality.
VideoStream.rate_control_mode
must be vbr
. The default is false
.
Returns | |
---|---|
Type | Description |
bool |
setEnableTwoPass
Use two-pass encoding strategy to achieve better video quality.
VideoStream.rate_control_mode
must be vbr
. The default is false
.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |
getVbvSizeBits
Size of the Video Buffering Verifier (VBV) buffer in bits. Must be
greater than zero. The default is equal to VideoStream.bitrate_bps
.
Returns | |
---|---|
Type | Description |
int |
setVbvSizeBits
Size of the Video Buffering Verifier (VBV) buffer in bits. Must be
greater than zero. The default is equal to VideoStream.bitrate_bps
.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
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
.
Returns | |
---|---|
Type | Description |
int |
setVbvFullnessBits
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
.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getBPyramid
Allow B-pyramid for reference frame selection. This may not be supported
on all decoders. The default is false
.
Returns | |
---|---|
Type | Description |
bool |
setBPyramid
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
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.
Returns | |
---|---|
Type | Description |
int |
setBFrameCount
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.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
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.
Returns | |
---|---|
Type | Description |
float |
setAqStrength
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 |
getProfile
Enforces the specified codec profile. The following profiles are supported:
- 8-bit profiles
main
(default)main-intra
mainstillpicture
- 10-bit profiles
main10
(default)main10-intra
main422-10
main422-10-intra
main444-10
main444-10-intra
- 12-bit profiles
main12
(default)main12-intra
main422-12
main422-12-intra
main444-12
main444-12-intra
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 H265CodecSettings
message.
Returns | |
---|---|
Type | Description |
string |
setProfile
Enforces the specified codec profile. The following profiles are supported:
- 8-bit profiles
main
(default)main-intra
mainstillpicture
- 10-bit profiles
main10
(default)main10-intra
main422-10
main422-10-intra
main444-10
main444-10-intra
- 12-bit profiles
main12
(default)main12-intra
main422-12
main422-12-intra
main444-12
main444-12-intra
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 H265CodecSettings
message.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
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 H265CodecSettings
message.
Returns | |
---|---|
Type | Description |
string |
setTune
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 H265CodecSettings
message.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
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 H265CodecSettings
message.
Returns | |
---|---|
Type | Description |
string |
setPreset
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 H265CodecSettings
message.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getGopMode
Returns | |
---|---|
Type | Description |
string |