Struct EncodingParameters

pub struct EncodingParameters {
    pub rid: String,
    pub active: bool,
    pub max_bitrate: Option<u32>,
    pub scale_resolution_down_by: Option<u8>,
}

Representation of an RTCRtpEncodingParameters.

Fields

rid: String

RTP stream ID (RID) to be sent using the RID header extension.

active: bool

Indicator whether this encoding is actively being sent.

Being false doesn’t cause the SSRC to be removed, so an RTCP BYE is not sent.

max_bitrate: Option<u32>

Maximum bitrate that can be used to send this encoding.

User agent is free to allocate bandwidth between the encodings, as long as this value is not exceeded.

scale_resolution_down_by: Option<u8>

Factor for scaling down video’s resolution in each dimension before sending.

Only present for video encodings.

For example, if this value is 2, a video will be scaled down by a factor of 2 in each dimension, resulting in sending a video of one quarter the size. If this value is 1, the video won’t be affected.

Must be greater than or equal to 1.

Trait Implementations

impl Clone for EncodingParameters

fn clone(&self) -> EncodingParameters

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EncodingParameters

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EncodingParameters

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for EncodingParameters

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for EncodingParameters

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for EncodingParameters

impl StructuralPartialEq for EncodingParameters