Set watcher
1. API Description
This API is used to set the number and permission of watchers.
Request mode:
- V2.6.0 and above: POST [ip]/mwapi/V2.0/app/set-observer-settings
- V2.5.0 and below: POST [ip]/mwapi/set-observer-settings
| Administrator Rights | Logged-in |
|---|---|
| No | Yes |
2. Input Parameters
| Name | Required | Type | Description |
|---|---|---|---|
| observerCount | Yes | Int | The number of watchers 0: None; 1: 1; 2: 2 |
| observerLocked | Yes | Boolean | Lock the scene for the watcher to view. true: lock; false: unlock |
| observerAnnotateEnable | Yes | Boolean | Allow the watcher to telestrate. true: allow; false: not allow |
3. Output Parameters
| Name | Type | Description |
|---|---|---|
| status | Int | Status code |
| message | String | Status description |
4. Example
Setting one watcher who is allowed to watch all the scenes and make telestration.
Input Example
{
"observerCount": 1,
"observerLocked": false,
"observerAnnotateEnable": true
}
Output Example
{
"message": "success",
"status": 0
}
5. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Status | Definition | Description |
|---|---|---|
| 49 | MW_STATUS_INVALID_DATA | The parameters are missing or incorrect |