Struct mediasoup::rtp_parameters::RtpHeaderExtension

pub struct RtpHeaderExtension {
    pub kind: Option<MediaKind>,
    pub uri: RtpHeaderExtensionUri,
    pub preferred_id: u16,
    pub preferred_encrypt: bool,
    pub direction: RtpHeaderExtensionDirection,
}

Provides information relating to supported header extensions. The list of RTP header extensions supported by mediasoup is defined in the supported_rtp_capabilities.rs file.

mediasoup does not currently support encrypted RTP header extensions. The direction field is just present in mediasoup RTP capabilities (retrieved via mediasoup::router::Router::rtp_capabilities() or mediasoup::supported_rtp_capabilities::get_supported_rtp_capabilities(). It’s ignored if present in endpoints’ RTP capabilities.

Fields

kind: Option<MediaKind>

Media kind. If None, it’s valid for all kinds. Default any media kind.

uri: RtpHeaderExtensionUri

The URI of the RTP header extension, as defined in RFC 5285.

preferred_id: u16

The preferred numeric identifier that goes in the RTP packet. Must be unique.

preferred_encrypt: bool

If true, it is preferred that the value in the header be encrypted as per RFC 6904. Default false.

direction: RtpHeaderExtensionDirection

If SendRecv, mediasoup supports sending and receiving this RTP extension. SendOnly means that mediasoup can send (but not receive) it. RecvOnly means that mediasoup can receive (but not send) it.

Trait Implementations

impl Clone for RtpHeaderExtension

fn clone(&self) -> RtpHeaderExtension

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for RtpHeaderExtension

impl Debug for RtpHeaderExtension

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RtpHeaderExtension

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

Deserialize this value from the given Serde deserializer.

impl Eq for RtpHeaderExtension

impl Hash for RtpHeaderExtension

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for RtpHeaderExtension

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<RtpHeaderExtension> for RtpHeaderExtension

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

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

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

This method tests for !=.

impl PartialOrd<RtpHeaderExtension> for RtpHeaderExtension

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl Serialize for RtpHeaderExtension

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

Serialize this value into the given Serde serializer.

impl StructuralEq for RtpHeaderExtension

impl StructuralPartialEq for RtpHeaderExtension