Skip to content

Commit

Permalink
Formatting updated
Browse files Browse the repository at this point in the history
  • Loading branch information
Fenrirthviti committed Aug 19, 2016
1 parent e4a7bbc commit 7db1ebb
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion api/API_DOCS
Expand Up @@ -2,12 +2,15 @@ API notes

Functions list:

Stream functions:
/api/<api_key>/stream/info - returns all active stream information
/api/<api_key>/stream/ping - returns recording status, stream URL, and watch URL for all current live channels
/api/<api_key>/stream/ping/<displayname> - returns stream live status, recording status, stream URL, and watch URL for a specific channel
/api/<api_key>/stream/record-start/<displayname> - starts recording the specified channel
/api/<api_key>/stream/record-stop/<displayname> - stops recording the specified channel

Subscription functions:
/api/<api_key>/subscription/add/<displayname> - Add current user (verified through API key) as a subscriber to specified channel
/api/<api_key>/subscription/remove/<displayname> - Remove current user (verified through API key) as a subsriber to specified channel
/api/<api_key>/subscription/list/<displayname> - Show list of all current subscriptions for the specific channel (subscribers and subscribed). If no user is specified, will show your own subscriptions. **TODO - make this only able to show your own subs
/api/<api_key>/subscription/list - Show list of all current subscriptions for your account (subscribers and subscribed). Account shown is tied to API key

0 comments on commit 7db1ebb

Please sign in to comment.