google.cloud.video.livestream.v1.VideoStream.H264CodecSettings */ class H264CodecSettings extends \Google\Protobuf\Internal\Message { /** * Required. The width of the video in pixels. Must be an even integer. * Valid range is [320, 1920]. * * Generated from protobuf field int32 width_pixels = 1; */ private $width_pixels = 0; /** * Required. The height of the video in pixels. Must be an even integer. * Valid range is [180, 1080]. * * Generated from protobuf field int32 height_pixels = 2; */ private $height_pixels = 0; /** * Required. The target video frame rate in frames per second (FPS). Must be less * than or equal to 60. 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](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for * more information. * * Generated from protobuf field double frame_rate = 3 [(.google.api.field_behavior) = REQUIRED]; */ private $frame_rate = 0.0; /** * 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). * * Generated from protobuf field int32 bitrate_bps = 4 [(.google.api.field_behavior) = REQUIRED]; */ private $bitrate_bps = 0; /** * Specifies whether an open Group of Pictures (GOP) structure should be * allowed or not. The default is `false`. * * Generated from protobuf field bool allow_open_gop = 6; */ private $allow_open_gop = false; /** * Size of the Video Buffering Verifier (VBV) buffer in bits. Must be * greater than zero. The default is equal to [bitrate_bps][google.cloud.video.livestream.v1.VideoStream.H264CodecSettings.bitrate_bps]. * * Generated from protobuf field int32 vbv_size_bits = 9; */ private $vbv_size_bits = 0; /** * 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][google.cloud.video.livestream.v1.VideoStream.H264CodecSettings.vbv_size_bits]. * * Generated from protobuf field int32 vbv_fullness_bits = 10; */ private $vbv_fullness_bits = 0; /** * The entropy coder to use. The default is `cabac`. * Supported entropy coders: * - `cavlc` * - `cabac` * * Generated from protobuf field string entropy_coder = 11; */ private $entropy_coder = ''; /** * Allow B-pyramid for reference frame selection. This may not be supported * on all decoders. The default is `false`. * * Generated from protobuf field bool b_pyramid = 12; */ private $b_pyramid = false; /** * The number of consecutive B-frames. Must be greater than or equal to * zero. Must be less than [gop_frame_count][google.cloud.video.livestream.v1.VideoStream.H264CodecSettings.gop_frame_count] if set. The default * is 0. * * Generated from protobuf field int32 b_frame_count = 13; */ private $b_frame_count = 0; /** * 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. * * Generated from protobuf field double aq_strength = 14; */ private $aq_strength = 0.0; /** * Enforces the specified codec profile. The following profiles are * supported: * * `baseline` * * `main` (default) * * `high` * The available options are [FFmpeg-compatible Profile * Options](https://trac.ffmpeg.org/wiki/Encode/H.264#Profile). * Note that certain values for this field may cause the * transcoder to override other fields you set in the [H264CodecSettings][google.cloud.video.livestream.v1.VideoStream.H264CodecSettings] * message. * * Generated from protobuf field string profile = 15; */ private $profile = ''; /** * Enforces the specified codec tune. The available options are * [FFmpeg-compatible Encode * Options](https://trac.ffmpeg.org/wiki/Encode/H.264#Tune) * Note that certain values for this field may cause the transcoder to * override other fields you set in the [H264CodecSettings][google.cloud.video.livestream.v1.VideoStream.H264CodecSettings] message. * * Generated from protobuf field string tune = 16; */ private $tune = ''; protected $gop_mode; /** * Constructor. * * @param array $data { * Optional. Data for populating the Message object. * * @type int $width_pixels * Required. The width of the video in pixels. Must be an even integer. * Valid range is [320, 1920]. * @type int $height_pixels * Required. The height of the video in pixels. Must be an even integer. * Valid range is [180, 1080]. * @type float $frame_rate * Required. The target video frame rate in frames per second (FPS). Must be less * than or equal to 60. 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](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for * more information. * @type int $bitrate_bps * 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). * @type bool $allow_open_gop * Specifies whether an open Group of Pictures (GOP) structure should be * allowed or not. The default is `false`. * @type int $gop_frame_count * 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]. * @type \Google\Protobuf\Duration $gop_duration * 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][google.cloud.video.livestream.v1.SegmentSettings.segment_duration], and * [segment_duration][google.cloud.video.livestream.v1.SegmentSettings.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. * @type int $vbv_size_bits * Size of the Video Buffering Verifier (VBV) buffer in bits. Must be * greater than zero. The default is equal to [bitrate_bps][google.cloud.video.livestream.v1.VideoStream.H264CodecSettings.bitrate_bps]. * @type int $vbv_fullness_bits * 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][google.cloud.video.livestream.v1.VideoStream.H264CodecSettings.vbv_size_bits]. * @type string $entropy_coder * The entropy coder to use. The default is `cabac`. * Supported entropy coders: * - `cavlc` * - `cabac` * @type bool $b_pyramid * Allow B-pyramid for reference frame selection. This may not be supported * on all decoders. The default is `false`. * @type int $b_frame_count * The number of consecutive B-frames. Must be greater than or equal to * zero. Must be less than [gop_frame_count][google.cloud.video.livestream.v1.VideoStream.H264CodecSettings.gop_frame_count] if set. The default * is 0. * @type float $aq_strength * 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. * @type string $profile * Enforces the specified codec profile. The following profiles are * supported: * * `baseline` * * `main` (default) * * `high` * The available options are [FFmpeg-compatible Profile * Options](https://trac.ffmpeg.org/wiki/Encode/H.264#Profile). * Note that certain values for this field may cause the * transcoder to override other fields you set in the [H264CodecSettings][google.cloud.video.livestream.v1.VideoStream.H264CodecSettings] * message. * @type string $tune * Enforces the specified codec tune. The available options are * [FFmpeg-compatible Encode * Options](https://trac.ffmpeg.org/wiki/Encode/H.264#Tune) * Note that certain values for this field may cause the transcoder to * override other fields you set in the [H264CodecSettings][google.cloud.video.livestream.v1.VideoStream.H264CodecSettings] message. * } */ public function __construct($data = NULL) { \GPBMetadata\Google\Cloud\Video\Livestream\V1\Outputs::initOnce(); parent::__construct($data); } /** * Required. The width of the video in pixels. Must be an even integer. * Valid range is [320, 1920]. * * Generated from protobuf field int32 width_pixels = 1; * @return int */ public function getWidthPixels() { return $this->width_pixels; } /** * Required. The width of the video in pixels. Must be an even integer. * Valid range is [320, 1920]. * * Generated from protobuf field int32 width_pixels = 1; * @param int $var * @return $this */ public function setWidthPixels($var) { GPBUtil::checkInt32($var); $this->width_pixels = $var; return $this; } /** * Required. The height of the video in pixels. Must be an even integer. * Valid range is [180, 1080]. * * Generated from protobuf field int32 height_pixels = 2; * @return int */ public function getHeightPixels() { return $this->height_pixels; } /** * Required. The height of the video in pixels. Must be an even integer. * Valid range is [180, 1080]. * * Generated from protobuf field int32 height_pixels = 2; * @param int $var * @return $this */ public function setHeightPixels($var) { GPBUtil::checkInt32($var); $this->height_pixels = $var; return $this; } /** * Required. The target video frame rate in frames per second (FPS). Must be less * than or equal to 60. 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](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for * more information. * * Generated from protobuf field double frame_rate = 3 [(.google.api.field_behavior) = REQUIRED]; * @return float */ public function getFrameRate() { return $this->frame_rate; } /** * Required. The target video frame rate in frames per second (FPS). Must be less * than or equal to 60. 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](https://cloud.google.com/transcoder/docs/concepts/frame-rate) for * more information. * * Generated from protobuf field double frame_rate = 3 [(.google.api.field_behavior) = REQUIRED]; * @param float $var * @return $this */ public function setFrameRate($var) { GPBUtil::checkDouble($var); $this->frame_rate = $var; return $this; } /** * 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). * * Generated from protobuf field int32 bitrate_bps = 4 [(.google.api.field_behavior) = REQUIRED]; * @return int */ public function getBitrateBps() { return $this->bitrate_bps; } /** * 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). * * Generated from protobuf field int32 bitrate_bps = 4 [(.google.api.field_behavior) = REQUIRED]; * @param int $var * @return $this */ public function setBitrateBps($var) { GPBUtil::checkInt32($var); $this->bitrate_bps = $var; return $this; } /** * Specifies whether an open Group of Pictures (GOP) structure should be * allowed or not. The default is `false`. * * Generated from protobuf field bool allow_open_gop = 6; * @return bool */ public function getAllowOpenGop() { return $this->allow_open_gop; } /** * Specifies whether an open Group of Pictures (GOP) structure should be * allowed or not. The default is `false`. * * Generated from protobuf field bool allow_open_gop = 6; * @param bool $var * @return $this */ public function setAllowOpenGop($var) { GPBUtil::checkBool($var); $this->allow_open_gop = $var; return $this; } /** * 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]. * * Generated from protobuf field int32 gop_frame_count = 7; * @return int */ public function getGopFrameCount() { return $this->readOneof(7); } public function hasGopFrameCount() { return $this->hasOneof(7); } /** * 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]. * * Generated from protobuf field int32 gop_frame_count = 7; * @param int $var * @return $this */ public function setGopFrameCount($var) { GPBUtil::checkInt32($var); $this->writeOneof(7, $var); return $this; } /** * 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][google.cloud.video.livestream.v1.SegmentSettings.segment_duration], and * [segment_duration][google.cloud.video.livestream.v1.SegmentSettings.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. * * Generated from protobuf field .google.protobuf.Duration gop_duration = 8; * @return \Google\Protobuf\Duration|null */ public function getGopDuration() { return $this->readOneof(8); } public function hasGopDuration() { return $this->hasOneof(8); } /** * 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][google.cloud.video.livestream.v1.SegmentSettings.segment_duration], and * [segment_duration][google.cloud.video.livestream.v1.SegmentSettings.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. * * Generated from protobuf field .google.protobuf.Duration gop_duration = 8; * @param \Google\Protobuf\Duration $var * @return $this */ public function setGopDuration($var) { GPBUtil::checkMessage($var, \Google\Protobuf\Duration::class); $this->writeOneof(8, $var); return $this; } /** * Size of the Video Buffering Verifier (VBV) buffer in bits. Must be * greater than zero. The default is equal to [bitrate_bps][google.cloud.video.livestream.v1.VideoStream.H264CodecSettings.bitrate_bps]. * * Generated from protobuf field int32 vbv_size_bits = 9; * @return int */ public function getVbvSizeBits() { return $this->vbv_size_bits; } /** * Size of the Video Buffering Verifier (VBV) buffer in bits. Must be * greater than zero. The default is equal to [bitrate_bps][google.cloud.video.livestream.v1.VideoStream.H264CodecSettings.bitrate_bps]. * * Generated from protobuf field int32 vbv_size_bits = 9; * @param int $var * @return $this */ public function setVbvSizeBits($var) { GPBUtil::checkInt32($var); $this->vbv_size_bits = $var; return $this; } /** * 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][google.cloud.video.livestream.v1.VideoStream.H264CodecSettings.vbv_size_bits]. * * Generated from protobuf field int32 vbv_fullness_bits = 10; * @return int */ public function getVbvFullnessBits() { return $this->vbv_fullness_bits; } /** * 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][google.cloud.video.livestream.v1.VideoStream.H264CodecSettings.vbv_size_bits]. * * Generated from protobuf field int32 vbv_fullness_bits = 10; * @param int $var * @return $this */ public function setVbvFullnessBits($var) { GPBUtil::checkInt32($var); $this->vbv_fullness_bits = $var; return $this; } /** * The entropy coder to use. The default is `cabac`. * Supported entropy coders: * - `cavlc` * - `cabac` * * Generated from protobuf field string entropy_coder = 11; * @return string */ public function getEntropyCoder() { return $this->entropy_coder; } /** * The entropy coder to use. The default is `cabac`. * Supported entropy coders: * - `cavlc` * - `cabac` * * Generated from protobuf field string entropy_coder = 11; * @param string $var * @return $this */ public function setEntropyCoder($var) { GPBUtil::checkString($var, True); $this->entropy_coder = $var; return $this; } /** * Allow B-pyramid for reference frame selection. This may not be supported * on all decoders. The default is `false`. * * Generated from protobuf field bool b_pyramid = 12; * @return bool */ public function getBPyramid() { return $this->b_pyramid; } /** * Allow B-pyramid for reference frame selection. This may not be supported * on all decoders. The default is `false`. * * Generated from protobuf field bool b_pyramid = 12; * @param bool $var * @return $this */ public function setBPyramid($var) { GPBUtil::checkBool($var); $this->b_pyramid = $var; return $this; } /** * The number of consecutive B-frames. Must be greater than or equal to * zero. Must be less than [gop_frame_count][google.cloud.video.livestream.v1.VideoStream.H264CodecSettings.gop_frame_count] if set. The default * is 0. * * Generated from protobuf field int32 b_frame_count = 13; * @return int */ public function getBFrameCount() { return $this->b_frame_count; } /** * The number of consecutive B-frames. Must be greater than or equal to * zero. Must be less than [gop_frame_count][google.cloud.video.livestream.v1.VideoStream.H264CodecSettings.gop_frame_count] if set. The default * is 0. * * Generated from protobuf field int32 b_frame_count = 13; * @param int $var * @return $this */ public function setBFrameCount($var) { GPBUtil::checkInt32($var); $this->b_frame_count = $var; return $this; } /** * 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. * * Generated from protobuf field double aq_strength = 14; * @return float */ public function getAqStrength() { return $this->aq_strength; } /** * 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. * * Generated from protobuf field double aq_strength = 14; * @param float $var * @return $this */ public function setAqStrength($var) { GPBUtil::checkDouble($var); $this->aq_strength = $var; return $this; } /** * Enforces the specified codec profile. The following profiles are * supported: * * `baseline` * * `main` (default) * * `high` * The available options are [FFmpeg-compatible Profile * Options](https://trac.ffmpeg.org/wiki/Encode/H.264#Profile). * Note that certain values for this field may cause the * transcoder to override other fields you set in the [H264CodecSettings][google.cloud.video.livestream.v1.VideoStream.H264CodecSettings] * message. * * Generated from protobuf field string profile = 15; * @return string */ public function getProfile() { return $this->profile; } /** * Enforces the specified codec profile. The following profiles are * supported: * * `baseline` * * `main` (default) * * `high` * The available options are [FFmpeg-compatible Profile * Options](https://trac.ffmpeg.org/wiki/Encode/H.264#Profile). * Note that certain values for this field may cause the * transcoder to override other fields you set in the [H264CodecSettings][google.cloud.video.livestream.v1.VideoStream.H264CodecSettings] * message. * * Generated from protobuf field string profile = 15; * @param string $var * @return $this */ public function setProfile($var) { GPBUtil::checkString($var, True); $this->profile = $var; return $this; } /** * Enforces the specified codec tune. The available options are * [FFmpeg-compatible Encode * Options](https://trac.ffmpeg.org/wiki/Encode/H.264#Tune) * Note that certain values for this field may cause the transcoder to * override other fields you set in the [H264CodecSettings][google.cloud.video.livestream.v1.VideoStream.H264CodecSettings] message. * * Generated from protobuf field string tune = 16; * @return string */ public function getTune() { return $this->tune; } /** * Enforces the specified codec tune. The available options are * [FFmpeg-compatible Encode * Options](https://trac.ffmpeg.org/wiki/Encode/H.264#Tune) * Note that certain values for this field may cause the transcoder to * override other fields you set in the [H264CodecSettings][google.cloud.video.livestream.v1.VideoStream.H264CodecSettings] message. * * Generated from protobuf field string tune = 16; * @param string $var * @return $this */ public function setTune($var) { GPBUtil::checkString($var, True); $this->tune = $var; return $this; } /** * @return string */ public function getGopMode() { return $this->whichOneof("gop_mode"); } }