yetangitu/Peertube
1
0
Fork 0
mirror of https://github.com/Chocobozzz/PeerTube.git synced 2025-10-03 01:39:37 +02:00
Code Issues Releases Wiki Activity

Add ability to update embed captions

Browse source
This commit is contained in:
Chocobozzz 2020-05-06 11:54:33 +02:00
parent fc8aabd0bf
commit 1151f5210c
No known key found for this signature in database
GPG key ID: 583A612D890159BE
7 changed files with 98 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

18
support/doc/api/embeds.md
View file

@ -4,8 +4,8 @@ PeerTube lets you embed videos and programmatically control their playback. This
## Playground
Any PeerTube embed URL (ie `https://my-instance.example.com/videos/embed/52a10666-3a18-4e73-93da-e8d3c12c305a`) can be viewed as an embedding playground which
allows you to test various aspects of PeerTube embeds. Simply replace `/embed` with `/test-embed` and visit the URL in a browser.
Any PeerTube embed URL (ie `https://my-instance.example.com/videos/embed/52a10666-3a18-4e73-93da-e8d3c12c305a`) can be viewed as an embedding playground which
allows you to test various aspects of PeerTube embeds. Simply replace `/embed` with `/test-embed` and visit the URL in a browser.
For instance, the playground URL for the above embed URL is `https://my-instance.example.com/videos/test-embed/52a10666-3a18-4e73-93da-e8d3c12c305a`.
## Quick Start
@ -95,11 +95,11 @@ Get the available playback rates, where `1` represents normal speed, `0.5` is ha
Get the current playback rate. See `getPlaybackRates()` for more information.
## `setPlaybackRate(rate : number) : Promise<void>`
## `setPlaybackRate(rate: number) : Promise<void>`
Set the current playback rate. The passed rate should be a value as returned by `getPlaybackRates()`.
## `setVolume(factor : number) : Promise<void>`
## `setVolume(factor: number) : Promise<void>`
Set the playback volume. Value should be between `0` and `1`.
@ -107,13 +107,21 @@ Set the playback volume. Value should be between `0` and `1`.
Get the playback volume. Returns a value between `0` and `1`.
## `setCaption(id: string) : Promise<void>`
Update current caption using the caption id.
## `getCaptions(): Promise<{ id: string, label: string, src: string, mode: 'disabled' | 'showing' }>`
Get video captions.
# Events
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.
Fired every half second to provide the current status of playback.
The parameter of the callback will resemble:
```json