Add videos list filters param in api doc

[github/Chocobozzz/PeerTube.git] / support / doc / api / embeds.md

diff --git a/support/doc/api/embeds.md b/support/doc/api/embeds.md
index 80e03b487d23b94d068b05aa88a9bdb476d96c10..7085b4b0ad569e2592eafd143a433fb350ac7712 100644 (file)
--- a/support/doc/api/embeds.md
+++ b/support/doc/api/embeds.md
@@ -113,16 +113,20 @@ You can subscribe to events by using `addEventListener()`. See above for details
 
 ## Event `playbackStatusUpdate`
 
-Fired every half second to provide the current status of playback. The parameter of the callback will resemble:
+Fired every half second to provide the current status of playback. 
+The parameter of the callback will resemble:
 
 ```json
 {
   "position": 22.3,
   "volume": 0.9,
+  "duration": "171.37499",
   "playbackState": "playing"
 }
 ```
 
+`duration` field and `ended` `playbackState` are available in PeerTube >= 2.2.
+
 The `volume` field contains the volume from `0` (silent) to `1` (full volume).
 The `playbackState` can be `unstarted`, `playing`, `paused` or `ended`. More states may be added later.