aboutsummaryrefslogtreecommitdiffhomepage
path: root/support
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2022-06-28 14:49:05 +0200
committerChocobozzz <me@florianbigard.com>2022-06-28 14:49:05 +0200
commit4c8336af67bf4e570e227d5cb1fbcb7a53b3776e (patch)
treec1a976ea566be8940bfcb2c1785cd58a16477e4c /support
parenta2fb5fb8b1007e3ce82e707917f5d9a37374e99b (diff)
downloadPeerTube-4c8336af67bf4e570e227d5cb1fbcb7a53b3776e.tar.gz
PeerTube-4c8336af67bf4e570e227d5cb1fbcb7a53b3776e.tar.zst
PeerTube-4c8336af67bf4e570e227d5cb1fbcb7a53b3776e.zip
Update embed URL query doc
Diffstat (limited to 'support')
-rw-r--r--support/doc/api/embeds.md51
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
82Hide PeerTube link in control bar. 82Hide PeerTube instance link in control bar.
83 83
84Value must be `0` or `1`. 84Value must be `0` or `1`.
85 85
@@ -101,6 +101,55 @@ Auto select a subtitle by default.
101 101
102Value must be a valid subtitle ISO code (`fr`, `en`, etc.). 102Value must be a valid subtitle ISO code (`fr`, `en`, etc.).
103 103
104## autoplay
105
106Try to automatically play the video.
107Most 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
109Value must be `0` or `1`.
110
111## title
112
113Hide embed title.
114
115Value must be `0` or `1`.
116
117## warningTitle
118
119Hide P2P warning title.
120
121Value must be `0` or `1`.
122
123## p2p
124
125Disable P2P.
126
127Value must be `0` or `1`.
128
129## bigPlayBackgroundColor
130
131Customize big play button background color.
132
133Value must be a valid color (`red` or `rgba(100, 100, 100, 0.5)`).
134
135## foregroundColor
136
137Customize embed font color.
138
139Value must be a valid color (`red` or `rgba(100, 100, 100, 0.5)`).
140
141## mode
142
143Force a specific player engine.
144
145Value must be a valid mode (`webtorrent` or `p2p-media-loader`).
146
147## api
148
149Enable embed JavaScript API (see methods below).
150
151Value must be `0` or `1`.
152
104 153
105# Methods 154# Methods
106 155