1.0.6 • Published 2 years ago
brime-api v1.0.6
brime-api
BrimeApi - JavaScript client for brime-api
Installation
npm install brime-api --save
Getting Started
Please follow the installation instruction and execute the following JS code:
var BrimeApi = require('brime-api');
var api = new BrimeApi.DefaultApi()
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.broadcastsStats(callback);
Documentation for API Endpoints
All URIs are relative to https://localhost
Class | Method | HTTP request | Description |
---|---|---|---|
BrimeApi.DefaultApi | broadcastsStats | GET /stats/broadcasts | Broadcasts Stats |
BrimeApi.DefaultApi | categoriesBySlug | GET /categories/slug/{slug} | Categories by Slug |
BrimeApi.DefaultApi | categoriesByXid | GET /categories/{xid} | Categories by XID |
BrimeApi.DefaultApi | clipsByChannel | GET /clip/channel/{channel_xid} | Clips by Channel |
BrimeApi.DefaultApi | configuredEndpoints | GET /multistreaming/repubs | Configured Endpoints |
BrimeApi.DefaultApi | createClip | GET /clip/create | Create Clip |
BrimeApi.DefaultApi | createEndpoint | POST /multistreaming/repubs | Create Endpoint |
BrimeApi.DefaultApi | deleteEndpoint1 | DELETE /multistreaming/{platform} | Delete Endpoint |
BrimeApi.DefaultApi | getChannelByXid | GET /channels/{xid} | Channel lookup by XID |
BrimeApi.DefaultApi | getChannelInformation | GET /channels/slug/{slug} | Channel lookup by Slug |
BrimeApi.DefaultApi | listChattersViewers | GET /chat/channel/{xid}/chatters | List Chatters / Viewers |
BrimeApi.DefaultApi | listIngestServers | GET /ingests | Ingest Servers |
BrimeApi.DefaultApi | lookupClip | GET /clip/{xid} | Lookup Clip |
BrimeApi.DefaultApi | pastBroadcastsByChannel | GET /channel/{channel_xid}/broadcasts | Past Broadcasts by Channel |
BrimeApi.DefaultApi | registeredUsers | GET /users/count | Registered Users |
BrimeApi.DefaultApi | searchCategories | GET /categories/search/{name} | Search Categories |
BrimeApi.DefaultApi | sendMessage | POST /chat/send | Send Message |
BrimeApi.DefaultApi | supportedPlatforms | GET /multistreaming/platforms | Supported Platforms |
BrimeApi.DefaultApi | updateChatNameColor | POST /account/chat_color | Update Chat Name Color |
BrimeApi.DefaultApi | updateEndpoint | PUT /multistreaming/{platform} | Update Endpoint |
BrimeApi.DefaultApi | updateUserChatLanguage | POST /account/chat_lang | Update Chat Language |
BrimeApi.DefaultApi | userDisplayname | POST /account/displayname | Update Display Name |
BrimeApi.DefaultApi | userFollowingList | GET /account/following | User Following List |
BrimeApi.DefaultApi | userInfo | GET /account/me | User Info |