From: Chocobozzz Date: Fri, 20 Mar 2020 14:04:02 +0000 (+0100) Subject: Fix embed api documentation X-Git-Tag: v2.2.0-rc.1~332 X-Git-Url: https://git.immae.eu/?a=commitdiff_plain;h=5ab994fe8e131c83a81d40ee86e86737de911e17;p=github%2FChocobozzz%2FPeerTube.git Fix embed api documentation --- 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 () => { ] monitoredEvents.forEach(e => { - player.addEventListener(e as PlayerEventType, () => console.log(`PLAYER: event '${e}' received`)) + player.addEventListener(e as PlayerEventType, (param) => console.log(`PLAYER: event '${e}' received`, param)) console.log(`PLAYER: now listening for event '${e}'`) }) 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`. You can subscribe to events by using `addEventListener()`. See above for details. -## Event `play` - -Fired when playback begins or is resumed after pausing. - -## Event `pause` - -Fired when playback is paused. - ## Event `playbackStatusUpdate` Fired 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 ## Event `playbackStatusChange` -Fired when playback transitions between states, such as `pausing` and `playing`. More states may be added later. +Fired when playback transitions between states, such as `paused` and `playing`. More states may be added later. ## Event `resolutionUpdate`