RTCIceCandidate: toJSON() method
Baseline
Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2017.
The toJSON() method of the RTCIceCandidate interface returns a JSON-serializable plain object representing the RTCIceCandidate object.
The method is automatically called by JSON.stringify() when an RTCIceCandidate object is encountered during JSON serialization. The serialized value can then be deserialized using the RTCIceCandidate() constructor within the reviver of JSON.parse().
Syntax
toJSON()
Parameters
None.
Return value
A JSON-serializable plain object containing the following properties:
Each property's value is copied as-is.
Examples
Calling toJSON() directly
This example creates an RTCIceCandidate object. Calling toJSON() directly returns a plain object. Its properties have the same values as the corresponding properties of the original object.
const candidate = new RTCIceCandidate({
candidate: "",
sdpMid: "0",
sdpMLineIndex: 0,
});
const json = candidate.toJSON();
console.log(json); // A plain object
console.log(typeof json); // "object"
console.log(json.candidate); // Same value as candidate.candidate
Serializing to a JSON string
The RTCIceCandidate object from the previous example is serialized using JSON.stringify(), which calls the toJSON() method automatically.
const jsonString = JSON.stringify(candidate);
console.log(jsonString);
This would log a JSON string like so (formatted for readability):
{
"candidate": "",
"sdpMid": "0",
"sdpMLineIndex": 0,
"usernameFragment": null
}
Specifications
| Specification |
|---|
| WebRTC: Real-Time Communication in Browsers # dom-rtcicecandidate-tojson |