AudioPlaybackStats: toJSON() method
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The toJSON() method of the AudioPlaybackStats interface returns a JSON-serializable plain object representing the AudioPlaybackStats object.
The method is automatically called by JSON.stringify() when an AudioPlaybackStats object is encountered during JSON serialization.
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 obtains an AudioPlaybackStats object from an audio context. Calling toJSON() directly returns a plain object. Its properties have the same values as the corresponding properties of the original object.
const audioCtx = new AudioContext();
const stats = audioCtx.playbackStats;
// ...
const json = stats.toJSON();
console.log(json); // A plain object
console.log(typeof json); // "object"
console.log(json.underrunEvents); // Same value as stats.underrunEvents
Serializing to a JSON string
The AudioPlaybackStats object from the previous example is serialized using JSON.stringify(), which calls the toJSON() method automatically.
console.log(JSON.stringify(stats));
This would log a JSON string like so (formatted for readability):
{
"underrunDuration": 0.125,
"underrunEvents": 1,
"totalDuration": 68.252138,
"averageLatency": 0.01863,
"minimumLatency": 0.01,
"maximumLatency": 0.018654
}
Specifications
| Specification |
|---|
| Web Audio API # dom-audioplaybackstats-tojson |