iv-org-mirror/documentation
1
0
Fork 0
mirror of https://gitea.invidious.io/iv-org/documentation.git synced 2024-08-15 00:53:34 +00:00
Code Issues Projects Releases Packages Wiki Activity
documentation/docs/url-parameters.md

104 lines
22 KiB
Markdown
Raw Normal View History

Better and shorter names for a lot of pages
2023-07-10 13:48:38 +00:00
# URL parameters
docs: add all untracked content
2021-01-28 21:04:37 +00:00
Update list of player parameters and add missing locales
2019-05-18 22:54:59 +00:00
A list of URL parameters for Invidious, which can automatically toggle various UI and player settings.
Created List of URL parameters (markdown)
2019-04-28 07:46:38 +00:00
Updated List of URL parameters (markdown)
2019-04-28 14:37:23 +00:00
_This list is incomplete. You can help by expanding it._
Update list of player parameters and add missing locales
2019-05-18 22:54:59 +00:00
| Parameter | Setting |
| -------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Site-wide parameters** | |
| _Dark mode_ | Configure default theme without setting cookies |
| `dark_mode=true` | Use dark theme |
Update with all but two URL Parameters (#360) * Update with quality_dash preference The documentation has been updated to include the quality_dash preference to enforce preferred quality using dash. * Added Extend Description As far as I know, only two URL parameters are missing from here now, VR Mode and Save Player Position. I have left these off intentionally because I do not know these option well enough to know what they do, how they work, or if they would be helpful parsed through extensions like Redirector or the URL Parameters Userscript. I shall leave these two to be added by an individual more knowledgeable. * Added `dark_mode=auto` Parameter * Moved _Player Style_ up to Player parameters * Update url-parameters.md How's this? * Update url-parameters.md Returned the video player parameters * Update url-parameters.md
2024-07-01 15:04:44 +00:00
| `dark_mode=false` | Use light theme |
| `dark_mode=auto` | Use system/browser theme
Update list of player parameters and add missing locales
2019-05-18 22:54:59 +00:00
| _Thin mode_ | Load HTML, CSS, JS and video elements (disables images) |
| `thin_mode=true` | Enabled |
| `thin_mode=false` | Disabled |
Link to iv-org
2020-08-25 11:46:07 +00:00
| _UI Language_ | Available locales are also listed [here](https://github.com/iv-org/invidious/blob/0.17.0/src/invidious.cr#L63-L75) |
Update list of player parameters and add missing locales
2019-05-18 22:54:59 +00:00
| `hl=ar` | Arabic |
| `hl=de` | German |
Add missing locales
2019-07-18 22:32:00 +00:00
| `hl=el` | Greek |
Update list of player parameters and add missing locales
2019-05-18 22:54:59 +00:00
| `hl=en-US` | English |
| `hl=eo` | Esperanto |
| `hl=es` | Spanish |
| `hl=eu` | Basque |
| `hl=fr` | French |
Add missing locales
2019-07-18 22:32:00 +00:00
| `hl=is` | Icelandic |
Update list of player parameters and add missing locales
2019-05-18 22:54:59 +00:00
| `hl=it` | Italian |
| `hl=nb_NO` | Norwegian Bokmål |
| `hl=nl` | Dutch |
| `hl=pl` | Polish |
| `hl=ru` | Russian |
| `hl=uk` | Ukranian |
Add missing locales
2019-07-18 22:32:00 +00:00
| `hl=zh-CN` | Chinese (traditional) |
Link to iv-org
2020-08-25 11:46:07 +00:00
| **Player parameters** | Available parameters also listed [here](https://github.com/iv-org/invidious/blob/0.17.0/src/invidious/videos.cr#L244) |
Update list of player parameters and add missing locales
2019-05-18 22:54:59 +00:00
| _Annotations_ | Show legacy annotations, provided by the [Internet Archive](https://archive.org/details/youtubeannotations) |
| `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](https://en.wikipedia.org/wiki/Dynamic_Adaptive_Streaming_over_HTTP) |
Added missing descriptions for consistency
2019-07-30 10:43:33 +00:00
| `quality=hd720` | 720p |
| `quality=medium` | 480p |
Update with all but two URL Parameters (#360) * Update with quality_dash preference The documentation has been updated to include the quality_dash preference to enforce preferred quality using dash. * Added Extend Description As far as I know, only two URL parameters are missing from here now, VR Mode and Save Player Position. I have left these off intentionally because I do not know these option well enough to know what they do, how they work, or if they would be helpful parsed through extensions like Redirector or the URL Parameters Userscript. I shall leave these two to be added by an individual more knowledgeable. * Added `dark_mode=auto` Parameter * Moved _Player Style_ up to Player parameters * Update url-parameters.md How's this? * Update url-parameters.md Returned the video player parameters * Update url-parameters.md
2024-07-01 15:04:44 +00:00
| _Quality_DASH_ | Default player quality when using DASH (default is Auto) |
| `quality_dash=auto` | Automatically change quality based on network conditions |
| `quality_dash=best` | Automatically use the best quality avalible |
| `quality_dash=###` | always use desired quality (480, 720, etc). |
| `quality_dash=worst` | Automatically use the worst quality avalible |
"Comments" added to URL-Parameters.md (#299) Add URL Parameter for disabling comments.
2022-11-06 12:32:07 +00:00
| _Related Videos_ | Show "Related videos" tab on the right-hand side |
| `related_videos=false` | Disabled |
| _Comments_ | Show comments below the video|
Update with all but two URL Parameters (#360) * Update with quality_dash preference The documentation has been updated to include the quality_dash preference to enforce preferred quality using dash. * Added Extend Description As far as I know, only two URL parameters are missing from here now, VR Mode and Save Player Position. I have left these off intentionally because I do not know these option well enough to know what they do, how they work, or if they would be helpful parsed through extensions like Redirector or the URL Parameters Userscript. I shall leave these two to be added by an individual more knowledgeable. * Added `dark_mode=auto` Parameter * Moved _Player Style_ up to Player parameters * Update url-parameters.md How's this? * Update url-parameters.md Returned the video player parameters * Update url-parameters.md
2024-07-01 15:04:44 +00:00
| `comments=false` | Disabled |
| _Extended Description_ | Extend Video Description by default |
| `extend_desc=true` | Enabled
**Player Style** | Define how the Video Player looks asthetically |
| `player_style=invidious` | Invidious, the default |
| `player_style=youtube` | YouTube, using a centered play button and always visible video control bar |
Update list of player parameters and add missing locales
2019-05-18 22:54:59 +00:00
| _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 |
Added missing descriptions for consistency
2019-07-30 10:43:33 +00:00
| `type=Default` | Default |
| `type=Music` | Music |
| `type=Gaming` | Gaming |
| `type=Movies` | Movies |
Update list of player parameters and add missing locales
2019-05-18 22:54:59 +00:00
| _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 |
Reference in a new issue Copy permalink