Add embed `getImageDataUrl` doc

2024-05-30 16:30:54 +02:00 · 2024-05-30 16:30:54 +02:00 · c5e48b8af0
parent 103505421f
commit c5e48b8af0
1 changed files with 7 additions and 0 deletions
--- a/support/doc/api/embeds.md
+++ b/support/doc/api/embeds.md
@ -287,6 +287,13 @@ Set the video password so the user doesn't have to manually fill it.
 `waitPasswordFromEmbedAPI=1` is required in embed URL.


+### `getImageDataUrl(): Promise<string>`
+
+**PeerTube >= 6.2**
+
+Get the current frame as JPEG image data URL.
+
+
 ## Embed events

 You can subscribe to events by using `addEventListener()`. See above for details.