Remote Commentator
APIs of Remote Commentator
51 subscribers
33 endpoints
The in-depth APIMemo review for this API hasn't been published yet —
the data below comes straight from the public marketplace listing.
Remote Commentator endpoints
| Method | Endpoint | Description |
|---|---|---|
| Event | ||
| POST |
Delete Event /event/v2/delete/{id} |
**Brief description:** - Delete Event **Request URL:** - POST `/event/v2/delete/{id}` **Return example** ```json { "errorCode": "0x0", "errorInfo": "Success", "result": null } ``` |
| POST |
Update Event /event/v2/update/{id} |
**Brief description:** - Update Event **Request URL:** - POST `/event/v2/update/{id}` **Parameter:** | Parameter name | Required | Type | Explain | | :-------------- | :------- |… |
| POST |
Create Event /event/v2/create |
**Request URL:** - POST `/event/v2/create` ## Parameters | Parameter name | Required | Type | Explain | | :------------------ | :------- | :------ |… |
| POST |
Stop Event /event/v2/stop/{id} |
**Brief description:** - Stop Event **Request URL:** - POST `/event/v2/stop/{id}` **Path Variables:** | Parameter name | Required | Type | Explain | | :------------- | :------- |… |
| POST |
Get Event By ID /event/v2/{id} |
**Brief description:** - Get Event by ID **Request URL:** - POST `/event/v2/{id}` **Parameter:** | Parameter name | Required | Type | Explain | | :------------- | :------- |… |
| POST |
List Region /event/listRegion |
**Request URL:** - POST `/event/listRegion` ## Parameters | Parameter name | Required | Type | Explain | | :------------- | :------- | :----- | ------- | | language | Y | String… |
| Device | ||
| POST |
Get Device List /device/pageDevice |
**Request URL:** - POST `/device/pageDevice` ## Parameters - RequestHeader need Authorization token - **Content-Type: application/json** | Parameter name | Required | Type |… |
| Audio Mixer | ||
| GET |
Get Running Task Ids /am/getRunningTaskIds |
Get all running AM task ids, Limit 100 |
| GET |
Task Info /am/taskInfo/{taskIds} |
Get event info by Audio Mixer task ids **URL path Parameter:** | param | require | type |description | | ------------ | ------------ | ------------ | ------------ | | taskIds |… |
| Receiver | ||
| POST |
Check Commentator Feature /receiver/checkCommentatorFeature/{rid} |
Check R commentator feature is available or not |
| GET |
Get Local SDI /receiver/getLocalSDI/{rid} |
Get R local SDI |
| User Setting | ||
| GET |
Get User Setting List /userSetting/list |
Get user setting list **Response:** > attention: the result is json object | **param** | **require** | **type** | **description** | | :--------: | :---------: | :------: |… |
| POST |
Set User Setting /userSetting/setUserSetting |
set user setting **Parameter:** |Parameter name|Required|Type|Explain| |:---- |:---|:----- |----- | | key | Y | string | config key | | value | Y | string | config value | |
| User Source | ||
| POST |
Get Output Receiver List /user/source/output/receiver/page |
**Request URL:** - POST `/user/source/output/receiver/page` ## Parameters | Parameter name | Required | Type | Explain | | :------------- | :------- | :----- |… |
| Event Input | ||
| POST |
Update Input Audio Track /eventInput/updateInputAudioTrack |
Update running event input aduio track **Parameter:** |Parameter name|Required|Type|Explain| |:---- |:---|:----- |----- | |eventId |Yes |string | event id | |inputAudioTracks… |
| GET |
Input and audio track /eventInput/inputAndAudioTrack/{eventId} |
Get input and input audio tarck info |
| Event Preview | ||
| POST |
updateAudioTrack /eventPreview/updateAudioTrack |
Update audio track |
| GET |
Get Auido Track /eventPreview/getAudioTrack/{eventId} |
Get audio track |
| Commentator Party | ||
| POST |
Add Mix Audio /commentator/party/addMixAudio |
**Brief description:** - Add mix audio **Request URL:** - POST `/commentator-backend/commentator/party/addMixAudio` **Parameter:** |Parameter name|Required|Type|Explain| |:----… |
| POST |
Remove Mix Audio /commentator/party/removeMixAudio |
**Brief description:** - Remove mix audio **Request URL:** - POST `/commentator-backend/commentator/party/removeMixAudio` **Parameter:** |Parameter name|Required|Type|Explain|… |
| POST |
Mute Mix Audio /commentator/party/noLogin/muteMixAudio |
**Brief description:** - Mute mix audio **Request URL:** - POST `/commentator-backend/commentator/party/muteMixAudio` or… |
| POST |
Unmute Mix Audio /commentator/party/noLogin/unmuteMixAudio |
**Brief description:** - Unmute mix audio **Request URL:** - POST `/commentator-backend/commentator/party/unmuteMixAudio` or… |
| Coordination | ||
| POST |
Settings /coordination/settings/{eventId} |
Coordination settings |
| POST |
Update Settings /coordination/update/{eventId} |
Update coordination settings |
| Event Party | ||
| POST |
Event Party Info /event/party/noLogin/{partyCode} |
Get event party info by party code |
| Output | ||
| POST |
Receiver Occupied /output/receiver/occupied |
Receiver occupied |
| Output Template | ||
| POST |
Get Output Template /output/template/{id} |
Get output template |
| Production | ||
| POST |
Get Production Slots /production/slots |
**Request URL:** - POST `/production/slots` _Response_ ```json { "errorInfo": "OK", "errorCode": "0x0", "result": ["s1", "s2", "s3", "s4", "s5", "s6"], "repeated": null } ``` |
| Public | ||
| GET |
Check get env /xxxxxx |
Get current user env Please call Partyline `Check get env` API https://rapidapi.com/tvu-networks-tvu-networks-default/api/partyline |
| GET |
initConfig v2 /publicApi/v2/initConfig |
Get Commenator basic information |
| Admin | ||
| POST |
Monitor Page /admin/monitorPage |
**Brief description:** - Usage Page **Request URL:** - POST `http://10.12.22.101/commentator-backend/admin/usagePage` **Parameter:** |Parameter name|Required|Type|Explain| |:----… |
| POST |
Usage Page /admin/usagePage |
**Brief description:** - Usage Page **Request URL:** - POST `http://10.12.22.101/commentator-backend/admin/usagePage` **Parameter:** |Parameter name|Required|Type|Explain| |:----… |
| Other endpoints | ||
| POST |
Get Ext IP Source /user/source/input/pp/page |
**Request URL:** - POST `/user/source/input/pp/page` ## Parameters | Parameter name | Required | Type | Explain | | :------------- | :------- | :----- |… |
Remote Commentator pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|