Struct livekit_protocol::livekit::EncodingOptions

pub struct EncodingOptions {
    pub width: i32,
    pub height: i32,
    pub depth: i32,
    pub framerate: i32,
    pub audio_codec: i32,
    pub audio_bitrate: i32,
    pub audio_frequency: i32,
    pub video_codec: i32,
    pub video_bitrate: i32,
    pub key_frame_interval: f64,
}

Fields

width: i32

(default 1920)

height: i32

(default 1080)

depth: i32

(default 24)

framerate: i32

(default 30)

audio_codec: i32

(default OPUS)

audio_bitrate: i32

(default 128)

audio_frequency: i32

(default 44100)

video_codec: i32

(default H264_MAIN)

video_bitrate: i32

(default 4500)

key_frame_interval: f64

in seconds (default 4s for streaming, segment duration for segmented output, encoder default for files)

Implementations

impl EncodingOptions

pub fn audio_codec(&self) -> AudioCodec

Returns the enum value of audio_codec, or the default if the field is set to an invalid enum value.

pub fn set_audio_codec(&mut self, value: AudioCodec)

Sets audio_codec to the provided enum value.

pub fn video_codec(&self) -> VideoCodec

Returns the enum value of video_codec, or the default if the field is set to an invalid enum value.

pub fn set_video_codec(&mut self, value: VideoCodec)

Sets video_codec to the provided enum value.

Trait Implementations

impl Clone for EncodingOptions

fn clone(&self) -> EncodingOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EncodingOptions

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

Formats the value using the given formatter.

impl Default for EncodingOptions

fn default() -> Self

Returns the “default value” for a type.

impl Message for EncodingOptions

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.

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

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8, Global>where Self: Sized,

Encodes the message to a newly allocated buffer.

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

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

fn encode_length_delimited_to_vec(&self) -> Vec<u8, Global>where Self: Sized,

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

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

Decodes an instance of the message from a buffer.

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

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

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

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

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

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

impl PartialEq<EncodingOptions> for EncodingOptions

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for EncodingOptions