RTCRtpEncodingParameters Dictionary object

  • Article

Provides information regarding parameters for RTP Encoding.

Syntax

dictionary RTCRtpEncodingParameters {
             unsigned long       ssrc = null;
             boolean             active = true;
             unsigned long       maxFramerate;
};

Standards information

RTCRtpEncodingParameters Dictionary

Member Type Description
ssrc unsigned long, defaults to null The SSRC for this layering/encoding. If ssrc is unset in a RTCRtpEncodingParameters object passed to the RTCRtpReceiver.receive method, then matching will occur based on payload type. If ssrc is unset in a RTCRtpEncodingParameters object passed to the RTCRtpSender.send method, the browser will choose, and the chosen value is not reflected in RTCRtpEncodingParameters.ssrc. The Microsoft ORTC API implementation does not support detection or healing SSRC collisions. In the event that the browser chooses the ssrc, it will not change due to a collision.
active boolean, defaults to true Whether the sender or receiver is active. If false, don't send any media right now. Disable is different than omitting the encoding; it can keep resources available to re-enable more quickly than re-adding. As noted in [RFC3264] Section 5.1, RTCP is still sent, regardless of the value of the active attribute. If unset, the default is assumed.
maxFramerate unsigned long The maximum framerate to use for this encoding. This setting is not used for scalable video coding.

 

Remarks

The following additional attributes are currently non-operational, but will gain support in the near future.

dictionary RTCRtpEncodingParameters {
             payloadtype         codecPayloadType = null;
             RTCRtpFecParameters fec;
             double              priority = 1.0;
             double              framerateBias = 0.5;
};
Member Type Description
codecPayloadType payloadtype, defaults to null For per-encoding codec specifications, give the codec Payload Type here. If unset, the browser will choose.
fec RTCRtpFecParameters Specifies the FEC mechanism if set.
priority double, defaults to 1.0 The higher the value, the more the bits will be given to each as available bandwidth goes up. Default is 1.0. For scalable video coding, this parameter is only relevant for the base layer. This parameter is ignored in an RTCRtpReceiver object. If unset, the default is assumed. This parameter has no effect in Microsoft Edge.

 

See also

RTCRtpCapabilities