blitzwing/cobalt-7
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs/api: remove information about /api/stream and add explanatory text

Browse source
This commit is contained in:
dumbmoron 2024-03-06 17:09:19 +00:00
parent a21465db2b
commit f34f6d131c
No known key found for this signature in database
GPG key ID: C59997C76C6A8E5F
1 changed files with 5 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
docs/api.md
View file

@ -54,15 +54,12 @@ item type: `object`
| `thumb` | `string` | item thumbnail that's displayed in the picker | used only for `video` type. |
## 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
| key | variables | description |
|:-----|:-----------------|:-------------------------------------------------------------------------------------------------------------------------------|
| `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 | |
therefore you don't need to worry about what they mean - but if you really want to know, you can
[read the source code](../src/modules/stream/manage.js).
## GET: `/api/serverInfo`
returns current basic server info.