RTCCodecStats

Instance properties

channels Optional

A positive number indicating the number of channels supported by the codec.

clockRate Optional

A positive number containing the media sampling rate.

mimeType

A string containing the media MIME type/subtype, such as video/VP8.

payloadType

A positive integer value in the range of 0 to 127 indicating the payload type used in RTP encoding or decoding.

sdpFmtpLine Optional

A string containing the format-specific parameters of the "a=fmtp" line in the codec's SDP (if present).

transportId

A string containing the unique identifier of the transport on which this codec is being used. This can be used to match to the corresponding RTCTransportStats object.

Common instance properties

The following properties are common to all WebRTC statistics objects (see RTCStatsReport for more information):

id

A string that uniquely identifies the object that is being monitored to produce this set of statistics.

timestamp

A DOMHighResTimeStamp object indicating the time at which the sample was taken for this statistics object.

type

A string with the value "codec", indicating the type of statistics the object contains.

Examples

Given a variable myPeerConnection, which is an instance of RTCPeerConnection, the code below uses await to wait for the statistics report, and then iterates it using RTCStatsReport.forEach(). It then filters the dictionaries for just those reports that have the type of codec and logs the result.

const stats = await myPeerConnection.getStats();

stats.forEach((report) => {
  if (report.type === "codec") {
    // Log the codec information
    console.log(report);
  }
});

Specifications

Browser compatibility

See also

• RTCStatsReport
• codecs option in parameter passed to RTCRtpTransceiver.setCodecPreferences() and RTCRtpSender.setParameters()().
• codecs property in object returned by RTCRtpSender.getParameters() and RTCRtpReceiver.getParameters().