RTCRtpCodecCapability

The WebRTC API's RTCRtpCodecCapability dictionary provides information describing the capabilities of a single media codec.

Properties

channels Optional
An unsigned integer value indicating the maximum number of channels supported by the codec; for example, a codec that supports only mono sound would have a value of 1; stereo codecs would have a 2, etc.
clockRate
An unsigned long integer specifying the codec's clock rate in Hertz (Hz). The IANA maintains a list of codecs and their parameters, including their clock rates.
mimeType
A DOMString indicating the codec's MIME media type and subtype. See Codecs used by WebRTC for details about potential codecs that might be referenced here.
sdpFmtpLine Optional
A DOMString giving the format specific parameters field from the a=fmtp line in the SDP which corresponds to the codec, if such a line exists. If there is no parameters field, this property is left out.

Description

RTCRtpCodecCapabilities describes the basic parameters for a single codec supported by the user's device. An array of objects of this type is returned in the codecs property of the RTCRtpCapabilities object returned in response to a call to either of the static functions RTCRtpSender.getCapabilities() or RTCRtpReceiver.getCapabilities().

Examples

TBD

Specifications

Specification Status Comment
WebRTC 1.0: Real-time Communication Between Browsers
The definition of 'RTCRtpCodecCapability' in that specification.
Candidate Recommendation

Browser compatibility

No compatibility data found. Please contribute data for "api.RTCRtpCodecCapability" (depth: 1) to the MDN compatibility data repository.