Share via


RTCRtcpParameters object

[Some information relates to pre-released product which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.]

Provides information on RTCP settings.

Note  Edge Interop Note: Microsoft Edge currently does not support the cname attribute, and utilizes the compound attribute instead of the reducedSize attribute (a boolean with the opposite meaning). Also, Microsoft Edge requires that the ssrc attribute be set even when RTCRtpSender object(s) exists from which SSRC information could be obtained. In Microsoft Edge, the ssrc attribute is used not only to fill in fields within RTCP packets that are sent, but also in order to route incoming RTCP packets (see RTCP matching rules). This is necessary since Microsoft Edge utilizes RTCP APP packets that do not contain the SSRC fields supported by all other RTCP packets, allowing those packets to be routed to the relevant objects for processing.

 

Syntax

dictionary RTCRtcpParameters {
             unsigned long ssrc;
             DOMString     cname;
             boolean       compound = true;
             boolean       mux = true;
};

Standards information

Dictionary

Membery Type Description
cname DOMString The Canonical Name (CNAME) used by RTCP (e.g. in SDES messages). Guidelines for CNAME generation are provided in [RTP-USAGE] Section 4.9 and [RFC7022]. By default, ORTC implementations SHOULD set the CNAME to be the same within all RTCRtcpParameter objects created within the same Javascript sandbox. For backward compatibility with WebRTC 1.0, applications MAY set cname; if unset, cname is chosen by the browser.
compound boolean, defaults to true Whether reduced size RTCP [RFC5506] is configured (if false) or compound RTCP as specified in [RFC3550] (if true). The default is false. As noted in [MS-SDPEXT] Section 3.1.5.30.1 the RTCP reduced size format is not supported.
mux boolean, defaults to true Whether RTP and RTCP are multiplexed, as specified in [RFC5761]. The default is true. If set to false, the RTCIceTransport MUST have an associated RTCIceTransport object with a component of "RTCP", in which case RTCP will be sent on the associated RTCIceTransport.
ssrc unsigned long The SSRC to be used in the "SSRC of packet sender" field defined in [RFC3550] Section 6.4.2 (Receiver Report) and [RFC4585] Section 6.1 (Feedback Messages), as well as the "SSRC" field defined in [RFC3611] Section 2 (Extended Reports). This is only set for an RTCRtpReceiver. If unset, ssrc is chosen by the browser, and the chosen value is not reflected in RTCRtcpParameters.ssrc. If the browser chooses the ssrc it may change it in event of a collision, as described in [RFC3550].

 

See also

RTCRtpReceiver

RTCRtpSender

RtpParameters