iv-org-mirror
/
documentation
mirror of https://gitea.invidious.io/iv-org/documentation.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Compare commits

base: iv-org-mirror:9ba26c6b43af3aca0ad03c88b62957807ff5e02f
Branches Tags
iv-org-mirror:master
iv-org-mirror:change-version-rule
...
compare: iv-org-mirror:b63e8a71f2b9af39a8f47dbe4d5f9661b0bf3099
Branches Tags
iv-org-mirror:master
iv-org-mirror:change-version-rule

7 Commits
9ba26c6b43 ... b63e8a71f2

Author SHA1 Message Date
MintMain21 b63e8a71f2
Merge 1cb3ea84ca into 29c528970d 2024-05-05 00:14:22 +02:00
Sebastian Hädrich 29c528970d
fix(api) 🏷️ Add missing properties to /videos API endpoint (#551) 
– type
– storyboards
– isPostLiveDvr
– dashUrl
 2024-05-05 00:13:58 +02:00
MintMain21 1cb3ea84ca
Update url-parameters.md 
How's this?
 2023-07-15 00:18:27 -07:00
MintMain21 66572c14c7
Moved _Player Style_ up to Player parameters 2023-04-06 13:37:31 -07:00
MintMain21 4b308d03a6
Added `dark_mode=auto` Parameter 2023-04-06 13:34:17 -07:00
MintMain21 4047372cef
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.
 2023-04-05 20:18:37 -07:00
MintMain21 a83a6fcc41
Update with quality_dash preference 
The documentation has been updated to include the quality_dash preference to enforce preferred quality using dash.
 2023-03-04 14:03:03 -08:00
2 changed files with 30 additions and 5 deletions
Show Stats Expand all files Collapse all files

16
docs/api.md
View File

@ -37,6 +37,7 @@ All endpoints that return a JSON body support `&hl=LANGUAGE` for translating fie
```javascript
{
"type": String, // "video"|"published"
"title": String,
"videoId": String,
"videoThumbnails": [
@ -47,6 +48,19 @@ All endpoints that return a JSON body support `&hl=LANGUAGE` for translating fie
"height": Int32
}
],
"storyboards": [
{
"url": String,
"templateUrl": String,
"width": Int32,
"height": Int32,
"count": Int32,
"interval ": Int32,
"storyboardWidth": Int32,
"storyboardHeight": Int32,
"storyboardCount": Int32
}
],
"description": String,
"descriptionHtml": String,
@ -82,7 +96,9 @@ All endpoints that return a JSON body support `&hl=LANGUAGE` for translating fie
"rating": Float32,
"isListed": Bool,
"liveNow": Bool,
"isPostLiveDvr": Bool,
"isUpcoming": Bool,
"dashUrl:" String,
"premiereTimestamp": Int64?,
"hlsUrl": String?,

19
docs/url-parameters.md
View File

@ -9,7 +9,8 @@ _This list is incomplete. You can help by expanding it._
| **Site-wide parameters** | |
| _Dark mode_ | Configure default theme without setting cookies |
| `dark_mode=true` | Use dark theme |
| `dark_mode=false` | Use light theme |
| `dark_mode=false` | Use light theme |
| `dark_mode=auto` | Use system/browser theme
| _Thin mode_ | Load HTML, CSS, JS and video elements (disables images) |
| `thin_mode=true` | Enabled |
| `thin_mode=false` | Disabled |
@ -52,10 +53,20 @@ _This list is incomplete. You can help by expanding it._
| `quality=dash` | [DASH](https://en.wikipedia.org/wiki/Dynamic_Adaptive_Streaming_over_HTTP) |
| `quality=hd720` | 720p |
| `quality=medium` | 480p |
| _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 |
| _Related Videos_ | Show "Related videos" tab on the right-hand side |
| `related_videos=false` | Disabled |
| _Comments_ | Show comments below the video|
| `comments=false` | Disabled |
| `comments=false` | Disabled |
| _Extended Description_ | Extend Video Description by default |
| `extend_desc=true` | Enabled
| _Player Style_ | Video Player UI |
| `player_style=invidious` | Invidious, the default |
| `player_style=youtube` | YouTube, using a centered play button and always visible video control bar |
| _Speed_ | Default player speed, can be any positive number |
| `speed=0.5` | Play at 0.5x speed |
| `speed=2` | Play at 2x speed |
@ -91,6 +102,4 @@ _This list is incomplete. You can help by expanding it._
| _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 |