RTCIceCandidate object
[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.]
The RTCSessionDescription object is used to represent an internet connectivity establishment (ICE) candidate server. This server can be used to establish a peer connection.
Syntax
var candidate = new RTCIceCandidate(candidateInitDict);
Members
The RTCIceCandidate object has these types of members:
- Properties
Properties
The RTCIceCandidate object has these properties.
| Property | Access type | Description |
|---|---|---|
Read-only |
The candidate property returns the "candidate-attribute", which contains a transport address for a candidate that can be used for connectivity checks. |
|
Read-only |
The sdpMid returns the identifier of the "media stream identification"(used for identifying media streams within a session description) for the media component this candidate is associated with. |
|
Read-only |
The sdpMLineIndex property returns the index (starting at zero) of the media description in the SDP this candidate is associated with. |
Remarks
The RTCIceCandidate constructor includes the following parameters:
| Parameter | Type | Description |
|---|---|---|
| candidateInitDict | RTCIceCandidateInit | Optional. Initializes the candidate. |