RTCIceCandidate: sdpMid property

The read-only property sdpMid on the RTCIceCandidate interface returns a string specifying the media stream identification tag of the media component with which the candidate is associated. This ID uniquely identifies a given stream for the component with which the candidate is associated.

This property can be configured by specifying the value of the sdpMid property in the candidateInfo options object that is passed to the RTCIceCandidate() constructor. If you call the constructor with an m-line string instead of the options object, the value of sdpMid is extracted from the specified candidate m-line string.

Value

A string which uniquely identifies the source media component from which the candidate draws data, or null if no such association exists for the candidate.

Note: Attempting to add a candidate (using addIceCandidate()) that has a value of null for both sdpMid and sdpMLineIndex will throw a TypeError exception.

Specifications

Specification
WebRTC: Real-Time Communication in Browsers
# dom-rtcicecandidate-sdpmid

Browser compatibility

BCD tables only load in the browser