Share via

RTCRtpCodecCapability Dictionary 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 the capabilities of a codec. A member of the RTCRtpCapabilities dictionary, called with the getCapabilities method.

Note  See Edge Codec Capabilities for specific information on the audio and video codecs supported by the Microsoft Edge ORTC API implementation.

 

Syntax

dictionary RTCRtpCodecCapability {
             DOMString                 name;
             DOMString                 kind;
             unsigned long             clockRate;
             payloadtype               preferredPayloadType;
             unsigned long             maxptime;
             unsigned long             ptime;
             unsigned long             numChannels;
             sequence<RTCRtcpFeedback> rtcpFeedback;
             Dictionary                parameters;
             Dictionary                options;
             unsigned short            maxTemporalLayers = 0;
             unsigned short            maxSpatialLayers = 0;
             boolean                   svcMultiStreamSupport;
};

Standards information

Dictionary

Member Type Description
clockRate unsigned long Codec clock rate expressed in Hertz, null if unset.
kind DOMString The media supported by the codec: "audio", "video" or "" for both.
maxSpatialLayers unsigned short (defaults to 0) Maximum number of spatial layer extensions supported by this codec (e.g. a value of 1 indicates support for up to 2 spatial layers). A value of 0 indicates no support for spatial scalability.
maxTemporalLayers unsigned short (defaults to 0) Maximum number of temporal layer extensions supported by this codec (e.g. a value of 1 indicates support for up to 2 temporal layers). A value of 0 indicates no support for temporal scalability.
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].
numChannels unsigned long The number of channels supported (e.g. stereo). For video, this will be unset.
options Dictionary Codec-specific parameters available for signaling.
parameters Dictionary Codec-specific parameters that must be signaled to the remote party.
preferredPayloadType payloadtype The preferred RTP payload type for the codec denoted by RTCRtpCodecCapability.name. This attribute was added to make it possible for the sender and receiver to pick a matching payload type when creating sender and receiver parameters. When returned by RTCRtpSender.getCapabilities(), RTCRtpCapabilities.codecs.preferredPayloadtype represents the preferred RTP payload type for sending. When returned by RTCRtpReceiver.getCapabilities(), RTCRtpCapabilities.codecs.preferredPayloadtype represents the preferred RTP payload type for receiving. To avoid payload type conflicts, each value of RTCRtpCodecCapability.name should have a unique value of RTCRtpCodecCapability.preferredPayloadtype.
ptime unsigned long The preferred duration of media represented by a packet in milliseconds for the RTCRtpSender or RTCRtpReceiver.
rtcpFeedback sequence<RTCRtcpFeedback> Transport layer and codec-specific feedback messages for this codec.
svcMultiStreamSupport boolean Whether the implementation can send SVC layers utilizing distinct SSRCs. Unset for audio codecs. For video codecs, only set if the codec supports scalable video coding with multiple streams.

 

See also

RTCRtpCapabilities

Edge Codec Capabilities