The RTCRtpCodecParameters dictionary, part of the WebRTC API, is used to describe the configuration parameters for a single media codec.

It's used in RTCRtpSender.getParameters(), RTCRtpSender.setParameters() and RTCRtpReceiver.getParameters(). Its also use used when calling RTCRtpTransceiver.setCodecPreferences() to configure a transceiver's codecs before beginning the offer/answer process to establish a WebRTC peer connection.

Most of the fields in this property take values which are defined and maintained by the Internet Assigned Numbers Authority (IANA). References to relevant IANA documents are provided in the see also section at the end of this article.

Instance properties

payloadType Optional

The RTP payload type used to identify this codec.

mimeType Optional

The codec's MIME media type and subtype specified as a string of the form "type/subtype". IANA maintains a registry of valid MIME types.

clockRate Optional

An unsigned long integer value specifying the codec's clock rate in hertz (Hz). The clock rate is the rate at which the codec's RTP timestamp advances. Most codecs have specific values or ranges of values they permit; see the IANA payload format media type registry for details.

channels Optional

An unsigned short integer indicating the number of channels the codec should support. For example, for audio codecs, a value of 1 specifies monaural sound while 2 indicates stereo.

sdpFmtpLine Optional

A string containing the format-specific parameters field from the "a=fmtp" line in the codec's SDP, if one is present; see section 5.8 of the IETF specification for JSEP.

Note: On an RTCRtpReceiver, the format-specific parameters come from the SDP sent by the remote peer, while for RTCRtpSender, they're provided by the local description.

See also

Real-Time Transport Protocol (RTP) Parameters

The IANA document providing registries of permitted values for the RTP parameters used by this dictionary.