The RTCIceCandidate
method toJSON()
converts the RTCIceCandidate
on which it's called into JSON.
A stringified version of the object can then be obtained by calling stringify()
on the returned object.
The RTCIceCandidate
method toJSON()
converts the RTCIceCandidate
on which it's called into JSON.
A stringified version of the object can then be obtained by calling stringify()
on the returned object.
js
toJSON()
None.
A JSON object with the following properties, which have been set to the corresponding values in the RTCIceCandidate
object:
candidate
Optional
A string describing the network connectivity information for the candidate. Additional information can be found in RTCIceCandidate.candidate
.
sdpMid
Optional
A string containing the identification tag of the media stream with which the candidate is associated, or null
if there is no associated media stream. Additional information can be found in RTCIceCandidate.sdpMid
.
sdpMLineIndex
Optional
A number property containing the zero-based index of the m-line with which the candidate is associated, within the SDP of the media description, or null
if no such associated exists. Additional information can be found in RTCIceCandidate.sdpMLineIndex
.
usernameFragment
Optional
A string containing the username fragment (usually referred to in shorthand as "ufrag" or "ice-ufrag"). This fragment, along with the ICE password ("ice-pwd"), uniquely identifies a single ongoing ICE interaction (including for any communication with the STUN server). Additional information can be found in RTCIceCandidate.usernameFragment
.
Note: The returned JSON object has the same form/properties as the candidateInfo
object that can optionally be passed to the RTCIceCandidate() constructor
to configure the candidate.
This simple example obtains a JSON string representing an RTCIceCandidate
found in the variable candidate
.
js
let jsonString = candidate.toJSON().stringify();
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
toJSON |
43 | 15 | 27 | No | 30 | 11 | 43 | 43 | 27 | 30 | 11 | 4.0 |
© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/RTCIceCandidate/toJSON