[−][src]Struct mediasoup::rtp_parameters::RtpParameters
The RTP send parameters describe a media stream received by mediasoup from an endpoint through its corresponding mediasoup Producer. These parameters may include a mid value that the mediasoup transport will use to match received RTP packets based on their MID RTP extension value.
mediasoup allows RTP send parameters with a single encoding and with multiple encodings (simulcast). In the latter case, each entry in the encodings array must include a ssrc field or a rid field (the RID RTP extension value). Check the Simulcast and SVC sections for more information.
The RTP receive parameters describe a media stream as sent by mediasoup to an endpoint through its corresponding mediasoup Consumer. The mid value is unset (mediasoup does not include the MID RTP extension into RTP packets being sent to endpoints).
There is a single entry in the encodings array (even if the corresponding producer uses simulcast). The consumer sends a single and continuous RTP stream to the endpoint and spatial/temporal layer selection is possible via consumer.setPreferredLayers().
As an exception, previous bullet is not true when consuming a stream over a PipeTransport, in which all RTP streams from the associated producer are forwarded verbatim through the consumer.
The RTP receive parameters will always have their ssrc values randomly generated for all of its encodings (and optional rtx: { ssrc: XXXX } if the endpoint supports RTX), regardless of the original RTP send parameters in the associated producer. This applies even if the producer's encodings have rid set.
Fields
mid: Option<String>
The MID RTP extension value as defined in the BUNDLE specification
codecs: Vec<RtpCodecParameters>
Media and RTX codecs in use.
header_extensions: Vec<RtpHeaderExtensionParameters>
RTP header extensions in use.
encodings: Vec<RtpEncodingParameters>
Transmitted RTP streams and their settings.
rtcp: RtcpParameters
Parameters used for RTCP.
Trait Implementations
impl Clone for RtpParameters
[src]
pub fn clone(&self) -> RtpParameters
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for RtpParameters
[src]
impl Default for RtpParameters
[src]
pub fn default() -> RtpParameters
[src]
impl<'de> Deserialize<'de> for RtpParameters
[src]
pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl PartialEq<RtpParameters> for RtpParameters
[src]
pub fn eq(&self, other: &RtpParameters) -> bool
[src]
pub fn ne(&self, other: &RtpParameters) -> bool
[src]
impl PartialOrd<RtpParameters> for RtpParameters
[src]
pub fn partial_cmp(&self, other: &RtpParameters) -> Option<Ordering>
[src]
pub fn lt(&self, other: &RtpParameters) -> bool
[src]
pub fn le(&self, other: &RtpParameters) -> bool
[src]
pub fn gt(&self, other: &RtpParameters) -> bool
[src]
pub fn ge(&self, other: &RtpParameters) -> bool
[src]
impl Serialize for RtpParameters
[src]
pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer,
[src]
__S: Serializer,
impl StructuralPartialEq for RtpParameters
[src]
Auto Trait Implementations
impl RefUnwindSafe for RtpParameters
[src]
impl Send for RtpParameters
[src]
impl Sync for RtpParameters
[src]
impl Unpin for RtpParameters
[src]
impl UnwindSafe for RtpParameters
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,