RTCRtpReceiver.getParameters()

The getParameters() method of the RTCRtpReceiver interface returns an RTCRtpReceiveParameters object describing the current configuration for the encoding and transmission of media on the receiver's track.

Syntax

let rtpReceiveParameters = rtpReceiver.getParameters();

Parameters

None.

Return value

An RTCRtpReceiveParameters object indicating the current configuration of the receiver.

Examples

This example obtains the canonical name (CNAME) being used for RTCP on an  RTCRtpReceiver.

function getRtcpCNAME(receiver) {
  let parameters = receiver.getParameters();

  return parameters.rtcp.cname;
}

Specifications

Specification Status Comment
WebRTC 1.0: Real-time Communication Between Browsers
The definition of 'RTCRtpReceiver.getParameters()' in that specification.
Candidate Recommendation Initial definition.

Browser compatibility

BCD tables only load in the browser