mirror of
https://gitea.invidious.io/iv-org/documentation.git
synced 2024-08-15 00:53:34 +00:00
Compare commits
7 commits
9ba26c6b43
...
b63e8a71f2
Author | SHA1 | Date | |
---|---|---|---|
|
b63e8a71f2 | ||
|
29c528970d | ||
|
1cb3ea84ca | ||
|
66572c14c7 | ||
|
4b308d03a6 | ||
|
4047372cef | ||
|
a83a6fcc41 |
2 changed files with 30 additions and 5 deletions
16
docs/api.md
16
docs/api.md
|
@ -37,6 +37,7 @@ All endpoints that return a JSON body support `&hl=LANGUAGE` for translating fie
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
{
|
{
|
||||||
|
"type": String, // "video"|"published"
|
||||||
"title": String,
|
"title": String,
|
||||||
"videoId": String,
|
"videoId": String,
|
||||||
"videoThumbnails": [
|
"videoThumbnails": [
|
||||||
|
@ -47,6 +48,19 @@ All endpoints that return a JSON body support `&hl=LANGUAGE` for translating fie
|
||||||
"height": Int32
|
"height": Int32
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
|
"storyboards": [
|
||||||
|
{
|
||||||
|
"url": String,
|
||||||
|
"templateUrl": String,
|
||||||
|
"width": Int32,
|
||||||
|
"height": Int32,
|
||||||
|
"count": Int32,
|
||||||
|
"interval ": Int32,
|
||||||
|
"storyboardWidth": Int32,
|
||||||
|
"storyboardHeight": Int32,
|
||||||
|
"storyboardCount": Int32
|
||||||
|
}
|
||||||
|
],
|
||||||
|
|
||||||
"description": String,
|
"description": String,
|
||||||
"descriptionHtml": String,
|
"descriptionHtml": String,
|
||||||
|
@ -82,7 +96,9 @@ All endpoints that return a JSON body support `&hl=LANGUAGE` for translating fie
|
||||||
"rating": Float32,
|
"rating": Float32,
|
||||||
"isListed": Bool,
|
"isListed": Bool,
|
||||||
"liveNow": Bool,
|
"liveNow": Bool,
|
||||||
|
"isPostLiveDvr": Bool,
|
||||||
"isUpcoming": Bool,
|
"isUpcoming": Bool,
|
||||||
|
"dashUrl:" String,
|
||||||
"premiereTimestamp": Int64?,
|
"premiereTimestamp": Int64?,
|
||||||
|
|
||||||
"hlsUrl": String?,
|
"hlsUrl": String?,
|
||||||
|
|
|
@ -9,7 +9,8 @@ _This list is incomplete. You can help by expanding it._
|
||||||
| **Site-wide parameters** | |
|
| **Site-wide parameters** | |
|
||||||
| _Dark mode_ | Configure default theme without setting cookies |
|
| _Dark mode_ | Configure default theme without setting cookies |
|
||||||
| `dark_mode=true` | Use dark theme |
|
| `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_ | Load HTML, CSS, JS and video elements (disables images) |
|
||||||
| `thin_mode=true` | Enabled |
|
| `thin_mode=true` | Enabled |
|
||||||
| `thin_mode=false` | Disabled |
|
| `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=dash` | [DASH](https://en.wikipedia.org/wiki/Dynamic_Adaptive_Streaming_over_HTTP) |
|
||||||
| `quality=hd720` | 720p |
|
| `quality=hd720` | 720p |
|
||||||
| `quality=medium` | 480p |
|
| `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_ | Show "Related videos" tab on the right-hand side |
|
||||||
| `related_videos=false` | Disabled |
|
| `related_videos=false` | Disabled |
|
||||||
| _Comments_ | Show comments below the video|
|
| _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_ | Default player speed, can be any positive number |
|
||||||
| `speed=0.5` | Play at 0.5x speed |
|
| `speed=0.5` | Play at 0.5x speed |
|
||||||
| `speed=2` | Play at 2x 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_ | 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=JP` | Load videos that are trending in Japan |
|
||||||
| `region=DE` | Load videos that are trending in Germany |
|
| `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 |
|
|
||||||
|
|
Loading…
Reference in a new issue