Share via

RTCRtpCodecParameters object

  • Article

[Some information relates to pre-released product which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.]

Provides information on codec settings.

Syntax

dictionary RTCRtpCodecParameters {
             DOMString                 name;
             payloadtype               payloadType;
             unsigned long             clockRate;
             unsigned long             maxptime;
             unsigned long             ptime;
             unsigned long             numChannels;
             sequence<RTCRtcpFeedback> rtcpFeedback;
             Dictionary                parameters;
};

Standards information

Dictionary

Member Type Description
clockRate unsigned long Codec clock rate expressed in Hertz, null if unset.
maxptime unsigned long The maximum packetization time supported by the RTCRtpReceiver.
name DOMString The MIME media type. Valid types are listed in [IANA-RTP-2]. The name MUST always be provided.
numChannels unsigned long The number of channels supported (e.g. stereo). If unset for audio, use the codec default. For video, this will be unset.
parameters Dictionary Codec-specific parameters available for signaling.
payloadType payloadType The value that goes in the RTP Payload Type Field [RFC3550]. The payloadType MUST always be provided.
ptime unsigned long The duration of media represented by a packet in milliseconds for the RTCRtpSender. If unset, the RTCRtpSender may select any value up to maxptime.
rtcpFeedback sequence<RTCRtcpFeedback> Transport layer and codec-specific feedback messages for this codec.

 

Note  The capabilities for commonly implemented codecs described in Edge Codec Capabilities, are also used as codec parameters, with RTCRtpCodecCapability.parameters of the receiver used as RTCRtpCodecParameters.parameters of the sender, and RTCRtpCodecCapability.parameters of the sender used as RTCRtpCodecParameters.parameters of the receiver, with the Property Name and Values unchanged.

 

See also

RTCRtpCapabilities

RTCRtpCodecCapability