mirror of
https://gitea.invidious.io/iv-org/documentation.git
synced 2024-08-15 00:53:34 +00:00
bd5c262fb1
* Fix documentation on search's `sort` parameter * remove `news` from trending type * Remove channels/comments documentation * Remove channels search documentation from api.md page * add missing endpoints * fix `resolveurl` name * update param description for community post comments * update `search-filters.md` and `url-parameters.md` to include api changes
20 KiB
20 KiB
URL parameters
A list of URL parameters for Invidious, which can automatically toggle various UI and player settings.
This list is incomplete. You can help by expanding it.
Parameter | Setting |
---|---|
Site-wide parameters | |
Dark mode | Configure default theme without setting cookies |
dark_mode=true |
Use dark theme |
dark_mode=false |
Use light theme |
Thin mode | Load HTML, CSS, JS and video elements (disables images) |
thin_mode=true |
Enabled |
thin_mode=false |
Disabled |
UI Language | Available locales are also listed here |
hl=ar |
Arabic |
hl=de |
German |
hl=el |
Greek |
hl=en-US |
English |
hl=eo |
Esperanto |
hl=es |
Spanish |
hl=eu |
Basque |
hl=fr |
French |
hl=is |
Icelandic |
hl=it |
Italian |
hl=nb_NO |
Norwegian Bokmål |
hl=nl |
Dutch |
hl=pl |
Polish |
hl=ru |
Russian |
hl=uk |
Ukranian |
hl=zh-CN |
Chinese (traditional) |
Player parameters | Available parameters also listed here |
Annotations | Show legacy annotations, provided by the Internet Archive |
iv_load_policy=1 |
Show annotations |
iv_load_policy=3 |
Hide annotations |
Autoplay | Automatically play video on load |
autoplay=1 |
Enabled |
autoplay=0 |
Disabled |
Continue | When video is done, automatically go to the next related video (similar to YouTube’s Autoplay feature) |
continue=1 |
Enabled |
continue=0 |
Disabled |
Listen | Play only audio portion of video |
listen=true |
Enabled |
listen=false |
Disabled |
Local | Proxy video streams, equivalent to enabling Proxy videos? in preferences |
local=true |
Enabled |
local=false |
Disabled |
Subtitles | List of ISO 639-1 language codes (comma-separated) |
subtitles=en |
English (will use auto-generated if native translation is unavailable) |
Quality | Default player quality |
quality=dash |
DASH |
quality=hd720 |
720p |
quality=medium |
480p |
Related Videos | Show "Related videos" tab on the right-hand side |
related_videos=false |
Disabled |
Comments | Show comments below the video |
comments=false |
Disabled |
Speed | Default player speed, can be any positive number |
speed=0.5 |
Play at 0.5x speed |
speed=2 |
Play at 2x speed |
speed=9.34 |
Play at 9.34x speed |
Loop | Loop player by default |
loop=1 |
Enabled |
loop=0 |
Disabled |
Volume | Default player volume, can be any whole number between 0 and 100 |
volume=10 |
Play video at 10% volume |
Region | Provide "hint" (as ISO 3166 country code) for Invidious to load videos from the specified region |
region=JP |
Attempt to load video as if the user were in Japan |
region=DE |
Attempt to load video as if the user were in Germany |
Controls | Provide player controls |
controls=1 |
Enabled |
controls=0 |
Disabled |
Raw | Redirect to latest copy of video at the specified quality and optionally proxy video |
raw=1 |
Enabled |
raw=0 |
Disabled |
Time controls | Control when the player starts and stops playback. Providing loop=1 will only loop the specified section |
start=TIME , t=TIME , time_continue=TIME |
Start playback at TIME seconds into the video. Supports TIME as either an integer specifying seconds or using 12h30m10s22ms syntax. For example, t=12m9s is equivalent to t=729 |
end=TIME |
Stop playback at either TIME seconds or using the above mentioned 12h56m10s22ms syntax. |
Search parameters | |
Region | Provide "hint" (as ISO 3166 country code) for Invidious to load search results from the specified region |
region=JP |
Attempt to load search results as if the user were in Japan |
region=DE |
Attempt to load search results as if the user were in Germany |
Trending parameters | |
Trending type | View trending videos only in a specific category |
type=Default |
Default |
type=Music |
Music |
type=Gaming |
Gaming |
type=Movies |
Movies |
Region | Provide "hint" (as ISO 3166 country code) for Invidious to load trending videos from the specified region |
region=JP |
Load videos that are trending in Japan |
region=DE |
Load videos that are trending in Germany |
Player Style | |
player_style=invidious |
Invidious, the default |
player_style=youtube |
YouTube, using a centered play button and always visible video control bar |