mediasoup::scalability_modes

Enum ScalabilityMode

Source
pub enum ScalabilityMode {
Show 40 variants None, L1T2, L1T2h, L1T3, L1T3h, L2T1, L2T1h, L2T1Key, L2T2, L2T2h, L2T2Key, L2T2KeyShift, L2T3, L2T3h, L2T3Key, L2T3KeyShift, L3T1, L3T1h, L3T1Key, L3T2, L3T2h, L3T2Key, L3T2KeyShift, L3T3, L3T3h, L3T3Key, L3T3KeyShift, S2T1, S2T1h, S2T2, S2T2h, S2T3, S2T3h, S3T1, S3T1h, S3T2, S3T2h, S3T3, S3T3h, Custom { scalability_mode: String, spatial_layers: NonZeroU8, temporal_layers: NonZeroU8, ksvc: bool, },
}
Expand description

Scalability mode.

Most modes match webrtc-svc, but custom ones are also supported by mediasoup.

Variants§

§

None

No scalability used, there is just one spatial and one temporal layer.

§

L1T2

L1T2.

§

L1T2h

L1T2h.

§

L1T3

L1T3.

§

L1T3h

L1T3h.

§

L2T1

L2T1.

§

L2T1h

L2T1h.

§

L2T1Key

L2T1_KEY.

§

L2T2

L2T2.

§

L2T2h

L2T2h.

§

L2T2Key

L2T2_KEY.

§

L2T2KeyShift

L2T2_KEY_SHIFT.

§

L2T3

L2T3.

§

L2T3h

L2T3h.

§

L2T3Key

L2T3_KEY.

§

L2T3KeyShift

L2T3_KEY_SHIFT.

§

L3T1

L3T1.

§

L3T1h

L3T1h.

§

L3T1Key

L3T1_KEY.

§

L3T2

L3T2.

§

L3T2h

L3T2h.

§

L3T2Key

L3T2_KEY.

§

L3T2KeyShift

L3T2_KEY_SHIFT.

§

L3T3

L3T3.

§

L3T3h

L3T3h.

§

L3T3Key

L3T3_KEY.

§

L3T3KeyShift

L3T3_KEY_SHIFT.

§

S2T1

S2T1.

§

S2T1h

S2T1h.

§

S2T2

S2T2.

§

S2T2h

S2T2h.

§

S2T3

S2T3.

§

S2T3h

S2T3h.

§

S3T1

S3T1.

§

S3T1h

S3T1h.

§

S3T2

S3T2.

§

S3T2h

S3T2h.

§

S3T3

S3T3.

§

S3T3h

S3T3h.

§

Custom

Custom scalability mode not defined in webrtc-svc.

Fields

§scalability_mode: String

Scalability mode as string

§spatial_layers: NonZeroU8

Number of spatial layers.

§temporal_layers: NonZeroU8

Number of temporal layers.

§ksvc: bool

K-SVC mode.

Implementations§

Source§

impl ScalabilityMode

Source

pub fn is_none(&self) -> bool

Returns true if there is no scalability.

Source

pub fn spatial_layers(&self) -> NonZeroU8

Number of spatial layers.

Source

pub fn temporal_layers(&self) -> NonZeroU8

Number of temporal layers.

Source

pub fn ksvc(&self) -> bool

K-SVC mode.

Source

pub fn as_str(&self) -> &str

String representation of scalability mode.

Trait Implementations§

Source§

impl Clone for ScalabilityMode

Source§

fn clone(&self) -> ScalabilityMode

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ScalabilityMode

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ScalabilityMode

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ScalabilityMode

Source§

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for ScalabilityMode

Source§

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

Formats the value using the given formatter. Read more
Source§

impl FromStr for ScalabilityMode

Source§

type Err = ParseScalabilityModeError

The associated error which can be returned from parsing.
Source§

fn from_str(scalability_mode: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more
Source§

impl Hash for ScalabilityMode

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for ScalabilityMode

Source§

fn cmp(&self, other: &ScalabilityMode) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for ScalabilityMode

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialOrd for ScalabilityMode

Source§

fn partial_cmp(&self, other: &ScalabilityMode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Serialize for ScalabilityMode

Source§

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for ScalabilityMode

Source§

impl StructuralPartialEq for ScalabilityMode

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,