diff options
author | Chocobozzz <me@florianbigard.com> | 2022-06-28 14:49:05 +0200 |
---|---|---|
committer | Chocobozzz <me@florianbigard.com> | 2022-06-28 14:49:05 +0200 |
commit | 4c8336af67bf4e570e227d5cb1fbcb7a53b3776e (patch) | |
tree | c1a976ea566be8940bfcb2c1785cd58a16477e4c | |
parent | a2fb5fb8b1007e3ce82e707917f5d9a37374e99b (diff) | |
download | PeerTube-4c8336af67bf4e570e227d5cb1fbcb7a53b3776e.tar.gz PeerTube-4c8336af67bf4e570e227d5cb1fbcb7a53b3776e.tar.zst PeerTube-4c8336af67bf4e570e227d5cb1fbcb7a53b3776e.zip |
Update embed URL query doc
-rw-r--r-- | support/doc/api/embeds.md | 51 |
1 files changed, 50 insertions, 1 deletions
diff --git a/support/doc/api/embeds.md b/support/doc/api/embeds.md index bc3b5304c..c3be120a1 100644 --- a/support/doc/api/embeds.md +++ b/support/doc/api/embeds.md | |||
@@ -79,7 +79,7 @@ Value must be `0` or `1`. | |||
79 | 79 | ||
80 | ## peertubeLink | 80 | ## peertubeLink |
81 | 81 | ||
82 | Hide PeerTube link in control bar. | 82 | Hide PeerTube instance link in control bar. |
83 | 83 | ||
84 | Value must be `0` or `1`. | 84 | Value must be `0` or `1`. |
85 | 85 | ||
@@ -101,6 +101,55 @@ Auto select a subtitle by default. | |||
101 | 101 | ||
102 | Value must be a valid subtitle ISO code (`fr`, `en`, etc.). | 102 | Value must be a valid subtitle ISO code (`fr`, `en`, etc.). |
103 | 103 | ||
104 | ## autoplay | ||
105 | |||
106 | Try to automatically play the video. | ||
107 | Most web browsers disable video autoplay if the user did not interact with the video. You can try to bypass this limitation by muting the video | ||
108 | |||
109 | Value must be `0` or `1`. | ||
110 | |||
111 | ## title | ||
112 | |||
113 | Hide embed title. | ||
114 | |||
115 | Value must be `0` or `1`. | ||
116 | |||
117 | ## warningTitle | ||
118 | |||
119 | Hide P2P warning title. | ||
120 | |||
121 | Value must be `0` or `1`. | ||
122 | |||
123 | ## p2p | ||
124 | |||
125 | Disable P2P. | ||
126 | |||
127 | Value must be `0` or `1`. | ||
128 | |||
129 | ## bigPlayBackgroundColor | ||
130 | |||
131 | Customize big play button background color. | ||
132 | |||
133 | Value must be a valid color (`red` or `rgba(100, 100, 100, 0.5)`). | ||
134 | |||
135 | ## foregroundColor | ||
136 | |||
137 | Customize embed font color. | ||
138 | |||
139 | Value must be a valid color (`red` or `rgba(100, 100, 100, 0.5)`). | ||
140 | |||
141 | ## mode | ||
142 | |||
143 | Force a specific player engine. | ||
144 | |||
145 | Value must be a valid mode (`webtorrent` or `p2p-media-loader`). | ||
146 | |||
147 | ## api | ||
148 | |||
149 | Enable embed JavaScript API (see methods below). | ||
150 | |||
151 | Value must be `0` or `1`. | ||
152 | |||
104 | 153 | ||
105 | # Methods | 154 | # Methods |
106 | 155 | ||