Add isSpatialAudio to event documentation

canalplus · Oct 19, 2023 · 6597a83 · 6597a83
1 parent b1e7a6d
commit 6597a83
Showing 1 changed file with 28 additions and 0 deletions.
diff --git a/doc/api/Player_Events.md b/doc/api/Player_Events.md
@@ -179,6 +179,22 @@ The array emitted contains object describing each available audio track:
 
   This information is usually set only if the current Manifest contains one.
 
+- `representations` (`Array.<Object>`):
+  [Representations](../Getting_Started/Glossary.md#representation) of this video track, with
+  attributes:
+
+  - `id` (`string`): The id used to identify this Representation.
+    No other Representation from this track will have the same `id`.
+
+  - `bitrate` (`Number`): The bitrate of this Representation, in bits per
+    seconds.
+
+  - `codec` (`string|undefined`): The audio codec the Representation is
+    in, as announced in the corresponding Manifest.
+
+  - `isSpatialAudio` (`Boolean|undefined`): If set to `true`, this Representation
+    has spatial audio.
+
 This event only concerns the currently-playing Period.
 
 ### availableVideoTracksChange
@@ -295,6 +311,18 @@ properties:
 
   This information is usually set only if the current Manifest contains one.
 
+- `representations` (`Array.<Object>`):
+  [Representations](../Getting_Started/Glossary.md#representation) of this video track, with
+  attributes:
+  - `id` (`string`): The id used to identify this Representation.
+    No other Representation from this track will have the same `id`.
+  - `bitrate` (`Number`): The bitrate of this Representation, in bits per
+    seconds.
+  - `codec` (`string|undefined`): The audio codec the Representation is
+    in, as announced in the corresponding Manifest.
+  - `isSpatialAudio` (`Boolean|undefined`): If set to `true`, this Representation
+    has spatial audio.
+
 This event only concerns the currently-playing Period.
 
 ### textTrackChange