MDN self-hosted library · e01.org

VideoColorSpace: toJSON() method

WebCodecs APIwindowanddedicated

WebCodecs APIwindow_and_dedicated

The toJSON() method of the VideoColorSpace interface returns a JSON-serializable plain object representing the VideoColorSpace object.

The method is automatically called by JSON.stringify() when a VideoColorSpace object is encountered during JSON serialization. The serialized value can then be deserialized using the VideoColorSpace() constructor within the reviver of JSON.parse().

Syntax

toJSON()

Parameters

None.

Return value

A JSON-serializable plain object containing the following properties:

  • fullRange
  • matrix
  • primaries
  • transfer

Each property's value is copied as-is.

Examples

Calling toJSON() directly

Calling toJSON() directly returns a plain object containing the VideoColorSpace object's properties.

const colorSpace = new VideoColorSpace({
  primaries: "bt709",
  transfer: "bt709",
  matrix: "bt709",
  fullRange: true,
});

const json = colorSpace.toJSON();
console.log(json);
// { fullRange: true, matrix: "bt709", primaries: "bt709", transfer: "bt709" }
console.log(typeof json); // "object"

Serializing to a JSON string

The VideoColorSpace object from the previous example is serialized using JSON.stringify(), which calls the toJSON() method automatically.

console.log(JSON.stringify(colorSpace));

This would log a JSON string like so (formatted for readability):

{
  "fullRange": true,
  "matrix": "bt709",
  "primaries": "bt709",
  "transfer": "bt709"
}

Specifications

Browser compatibility