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

DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
getParametersChrome Full support 59Edge Full support ≤79Firefox Full support YesIE No support NoOpera Full support 46Safari Full support YesWebView Android Full support 59Chrome Android Full support 59Firefox Android Full support YesOpera Android Full support 43Safari iOS Full support YesSamsung Internet Android Full support 7.0

Legend

Full support
Full support
No support
No support