Struct gapi_grpc::google::cloud::video::transcoder::v1beta1::VideoStream

pub struct VideoStream {
    pub codec: String,
    pub profile: String,
    pub tune: String,
    pub preset: String,
    pub height_pixels: i32,
    pub width_pixels: i32,
    pub pixel_format: String,
    pub bitrate_bps: i32,
    pub rate_control_mode: String,
    pub enable_two_pass: bool,
    pub crf_level: i32,
    pub vbv_size_bits: i32,
    pub vbv_fullness_bits: i32,
    pub allow_open_gop: bool,
    pub entropy_coder: String,
    pub b_pyramid: bool,
    pub b_frame_count: i32,
    pub frame_rate: f64,
    pub aq_strength: f64,
    pub gop_mode: Option<GopMode>,
}

Video stream resource.

Fields

codec: String

Codec type. The default is "h264".

Supported codecs:

• ‘h264’
• ‘h265’
• ‘vp9’

profile: String

Enforce specified codec profile. The default is "high".

Supported codec profiles:

• ‘baseline’
• ‘main’
• ‘high’

tune: String

Enforce specified codec tune.

preset: String

Enforce specified codec preset. The default is "veryfast".

height_pixels: i32

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.

width_pixels: i32

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.

pixel_format: String

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.

bitrate_bps: i32

Required. The video bitrate in bits per second. Must be between 1 and 1,000,000,000.

rate_control_mode: String

Specify the rate_control_mode. The default is "vbr".

Supported rate control modes:

• ‘vbr’ - variable bitrate
• ‘crf’ - constant rate factor

enable_two_pass: bool

Use two-pass encoding strategy to achieve better video quality. VideoStream.rate_control_mode must be "vbr". The default is false.

crf_level: i32

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.

vbv_size_bits: i32

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

vbv_fullness_bits: i32

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.

allow_open_gop: bool

Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is false.

entropy_coder: String

The entropy coder to use. The default is "cabac".

Supported entropy coders:

• ‘cavlc’
• ‘cabac’

b_pyramid: bool

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

b_frame_count: i32

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.

frame_rate: f64

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.

The following table shows the computed video FPS given the target FPS (in parenthesis) and input FPS (in the first column):

|        | (30)   | (60)   | (25) | (50) |
|--------|--------|--------|------|------|
| 240    | Fail   | Fail   | Fail | Fail |
| 120    | 30     | 60     | 20   | 30   |
| 100    | 25     | 50     | 20   | 30   |
| 50     | 25     | 50     | 20   | 30   |
| 60     | 30     | 60     | 20   | 30   |
| 59.94  | 29.97  | 59.94  | 20   | 30   |
| 48     | 24     | 48     | 20   | 30   |
| 30     | 30     | 30     | 20   | 30   |
| 25     | 25     | 25     | 20   | 30   |
| 24     | 24     | 24     | 20   | 30   |
| 23.976 | 23.976 | 23.976 | 20   | 30   |
| 15     | 15     | 15     | 20   | 30   |
| 12     | 12     | 12     | 20   | 30   |
| 10     | 10     | 10     | 20   | 30   |

aq_strength: f64

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.

gop_mode: Option<GopMode>

GOP mode can be either by frame count or duration.

Trait Implementations

impl Clone for VideoStream

fn clone(&self) -> VideoStream

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VideoStream

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for VideoStream

fn default() -> VideoStream

Returns the “default value” for a type.

impl Message for VideoStream

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

pub fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes a length-delimited instance of the message from the buffer.

pub fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

pub fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<VideoStream> for VideoStream

fn eq(&self, other: &VideoStream) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &VideoStream) -> bool

This method tests for !=.

impl StructuralPartialEq for VideoStream