mirror of
https://github.com/wukko/cobalt.git
synced 2024-11-06 00:10:02 +00:00
docs/api: remove information about /api/stream and add explanatory text
This commit is contained in:
parent
a21465db2b
commit
f34f6d131c
1 changed files with 5 additions and 8 deletions
13
docs/api.md
13
docs/api.md
|
@ -54,15 +54,12 @@ item type: `object`
|
||||||
| `thumb` | `string` | item thumbnail that's displayed in the picker | used only for `video` type. |
|
| `thumb` | `string` | item thumbnail that's displayed in the picker | used only for `video` type. |
|
||||||
|
|
||||||
## GET: `/api/stream`
|
## GET: `/api/stream`
|
||||||
cobalt's live render (or stream) endpoint. used for sending various media content over to the user.
|
cobalt's live render (or stream) endpoint. usually, you will receive a url to this endpoint
|
||||||
|
from a successful call to `/api/json`. however, the parameters passed to it are **opaque**
|
||||||
|
and **unmodifiable** from your (the api client's) perspective, and can change between versions.
|
||||||
|
|
||||||
### request query variables
|
therefore you don't need to worry about what they mean - but if you really want to know, you can
|
||||||
| key | variables | description |
|
[read the source code](../src/modules/stream/manage.js).
|
||||||
|:-----|:-----------------|:-------------------------------------------------------------------------------------------------------------------------------|
|
|
||||||
| `p` | `1` | used for probing whether user is rate limited. |
|
|
||||||
| `t` | stream token | unique stream id. used for retrieving cached stream info data. |
|
|
||||||
| `h` | hmac | hashed combination of: (hashed) ip address, stream token, expiry timestamp, and service name. used for verification of stream. |
|
|
||||||
| `e` | expiry timestamp | |
|
|
||||||
|
|
||||||
## GET: `/api/serverInfo`
|
## GET: `/api/serverInfo`
|
||||||
returns current basic server info.
|
returns current basic server info.
|
||||||
|
|
Loading…
Reference in a new issue