2020-08-21 12:46:25 +00:00
|
|
|
# PeerTube video annotation
|
2020-08-21 13:04:10 +00:00
|
|
|
|
|
|
|
Add a field in the video form so users can set annotation to their video.
|
|
|
|
|
2022-05-02 06:33:29 +00:00
|
|
|
![](./screens/player.png)
|
|
|
|
![](./screens/config.png)
|
2020-08-21 13:04:10 +00:00
|
|
|
|
2020-08-24 12:42:10 +00:00
|
|
|
By default, the annotation will be on the top-right of the player.
|
|
|
|
|
2020-08-21 13:04:10 +00:00
|
|
|
Annotations format:
|
|
|
|
|
|
|
|
```
|
|
|
|
start --> stop
|
|
|
|
options: align=top-left (or top, top-right, right, bottom-right, bottom, bottom-left, left)
|
|
|
|
HTML
|
|
|
|
```
|
|
|
|
|
|
|
|
* `start` (in seconds): When to show the annotation
|
|
|
|
* `stop` (in seconds): When to hide the annotation
|
|
|
|
* `options: ...` (this line is optional): Set options for your annotation
|
|
|
|
* `HTML`: Content of your annotation
|
|
|
|
|
|
|
|
For example:
|
|
|
|
|
|
|
|
```
|
|
|
|
--> 4
|
|
|
|
Hello, how are you?
|
|
|
|
|
|
|
|
5-->10
|
|
|
|
See <a href="https://cpy.re" target="_blank">this document</a> for more information
|
|
|
|
|
|
|
|
12-->
|
|
|
|
options: align=top-left
|
|
|
|
This annotation will be at the top-left of the player
|
2023-02-07 10:02:57 +00:00
|
|
|
|
2020-08-21 13:04:10 +00:00
|
|
|
```
|
2023-02-07 10:04:34 +00:00
|
|
|
|
|
|
|
* In the first section, the text will be hidden after 4 seconds
|
|
|
|
* In the second section, the text will be displayed at second 5 and will be hidden at second 10
|
|
|
|
* In the third section, the text will be displayed at second 12 but will not be hidden. The text will also be located at the top left of the video.
|