Enum RtpCodecCapability

pub enum RtpCodecCapability {
    Audio {
        mime_type: MimeTypeAudio,
        preferred_payload_type: Option<u8>,
        clock_rate: NonZeroU32,
        channels: NonZeroU8,
        parameters: RtpCodecParametersParameters,
        rtcp_feedback: Vec<RtcpFeedback>,
    },
    Video {
        mime_type: MimeTypeVideo,
        preferred_payload_type: Option<u8>,
        clock_rate: NonZeroU32,
        parameters: RtpCodecParametersParameters,
        rtcp_feedback: Vec<RtcpFeedback>,
    },
}

Provides information on the capabilities of a codec within the RTP capabilities. The list of media codecs supported by mediasoup and their settings is defined in the supported_rtp_capabilities.rs file.

Exactly one RtpCodecCapability will be present for each supported combination of parameters that requires a distinct value of preferred_payload_type. For example:

• Multiple H264 codecs, each with their own distinct packetization-mode and profile-level-id values.
• Multiple VP9 codecs, each with their own distinct profile-id value.

RtpCodecCapability entries in the media_codecs vector of RouterOptions do not require preferred_payload_type field (if unset, mediasoup will choose a random one). If given, make sure it’s in the 96-127 range.

Variants

Audio

Audio codec capability

Fields

mime_type: MimeTypeAudio

The codec MIME media type/subtype (e.g. ‘audio/opus’).

preferred_payload_type: Option<u8>

The preferred RTP payload type.

clock_rate: NonZeroU32

Codec clock rate expressed in Hertz.

channels: NonZeroU8

The number of channels supported (e.g. two for stereo). Just for audio. Default 1.

parameters: RtpCodecParametersParameters

Codec specific parameters. Some parameters (such as packetization-mode and profile-level-id in H264 or profile-id in VP9) are critical for codec matching.

rtcp_feedback: Vec<RtcpFeedback>

Transport layer and codec-specific feedback messages for this codec.

Video

Video codec capability

Fields

mime_type: MimeTypeVideo

The codec MIME media type/subtype (e.g. ‘video/VP8’).

preferred_payload_type: Option<u8>

The preferred RTP payload type.

clock_rate: NonZeroU32

Codec clock rate expressed in Hertz.

parameters: RtpCodecParametersParameters

Codec specific parameters. Some parameters (such as packetization-mode and profile-level-id in H264 or profile-id in VP9) are critical for codec matching.

rtcp_feedback: Vec<RtcpFeedback>

Transport layer and codec-specific feedback messages for this codec.

Trait Implementations

impl Clone for RtpCodecCapability

fn clone(&self) -> RtpCodecCapability

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RtpCodecCapability

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RtpCodecCapability

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for RtpCodecCapability

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for RtpCodecCapability

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for RtpCodecCapability

fn eq(&self, other: &RtpCodecCapability) -> 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 PartialOrd for RtpCodecCapability

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for RtpCodecCapability

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 RtpCodecCapability

impl StructuralPartialEq for RtpCodecCapability