aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2020-03-20 15:04:02 +0100
committerChocobozzz <me@florianbigard.com>2020-03-20 15:04:02 +0100
commit5ab994fe8e131c83a81d40ee86e86737de911e17 (patch)
tree995693f43cd536af8a1a19607a809d8b90ec159d
parent6cb556449064278bdcb1a54a7b980c2e7bc735f0 (diff)
downloadPeerTube-5ab994fe8e131c83a81d40ee86e86737de911e17.tar.gz
PeerTube-5ab994fe8e131c83a81d40ee86e86737de911e17.tar.zst
PeerTube-5ab994fe8e131c83a81d40ee86e86737de911e17.zip
Fix embed api documentation
-rw-r--r--client/src/standalone/videos/test-embed.ts2
-rw-r--r--support/doc/api/embeds.md10
2 files changed, 2 insertions, 10 deletions
diff --git a/client/src/standalone/videos/test-embed.ts b/client/src/standalone/videos/test-embed.ts
index e5e6365dc..202e86667 100644
--- a/client/src/standalone/videos/test-embed.ts
+++ b/client/src/standalone/videos/test-embed.ts
@@ -30,7 +30,7 @@ window.addEventListener('load', async () => {
30 ] 30 ]
31 31
32 monitoredEvents.forEach(e => { 32 monitoredEvents.forEach(e => {
33 player.addEventListener(e as PlayerEventType, () => console.log(`PLAYER: event '${e}' received`)) 33 player.addEventListener(e as PlayerEventType, (param) => console.log(`PLAYER: event '${e}' received`, param))
34 console.log(`PLAYER: now listening for event '${e}'`) 34 console.log(`PLAYER: now listening for event '${e}'`)
35 }) 35 })
36 36
diff --git a/support/doc/api/embeds.md b/support/doc/api/embeds.md
index 5586e013a..6ee7deeab 100644
--- a/support/doc/api/embeds.md
+++ b/support/doc/api/embeds.md
@@ -111,14 +111,6 @@ Get the playback volume. Returns a value between `0` and `1`.
111 111
112You can subscribe to events by using `addEventListener()`. See above for details. 112You can subscribe to events by using `addEventListener()`. See above for details.
113 113
114## Event `play`
115
116Fired when playback begins or is resumed after pausing.
117
118## Event `pause`
119
120Fired when playback is paused.
121
122## Event `playbackStatusUpdate` 114## Event `playbackStatusUpdate`
123 115
124Fired every half second to provide the current status of playback. The parameter of the callback will resemble: 116Fired every half second to provide the current status of playback. The parameter of the callback will resemble:
@@ -135,7 +127,7 @@ The `volume` field contains the volume from `0` (silent) to `1` (full volume). T
135 127
136## Event `playbackStatusChange` 128## Event `playbackStatusChange`
137 129
138Fired when playback transitions between states, such as `pausing` and `playing`. More states may be added later. 130Fired when playback transitions between states, such as `paused` and `playing`. More states may be added later.
139 131
140## Event `resolutionUpdate` 132## Event `resolutionUpdate`
141 133