RTCRtpSender.getParameters()

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

Syntax

var rtpSendParameters = rtpSender.getParameters()

Parameters

None.

Return value

An RTCRtpSendParameters object indicating the current configuration of the sender.

Examples

This example gets the sender's current transaction ID; the transaction ID uniquely identifies the current set of parameters, to ensure that calls to setParameters() are always handled in the correct order, avoiding inadvertently overwriting parameters with older parameters.

function getSenderTransactionID(sender) {
  let parameters = sender.getParameters();

  return parameters.transactionId;
}

Specifications

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

Browser compatibility

BCD tables only load in the browser