Overlay screencast parameters
1. API Description
This API is used to overlay screencast image size and frame rate on screen.
Request mode:
- V2.6.0 and above: POST [ip]/mwapi/V2.0/input/set-screencast-format-enable
- V2.5.0 and below: POST [ip]/mwapi/set-screencast-format-enable
| Administrator Rights | Logged-in |
|---|---|
| No | Yes |
2. Input Parameters
| Name | Required | Type | Description |
|---|---|---|---|
| screencastFormatEnable | Yes | Int | Overlay screencast image size and frame rate on screen. 1: Overlay, 0: Not overlay |
3. Output Parameters
| Name | Type | Description |
|---|---|---|
| status | Int | Status code |
4. Example
Setting to overlay screencast image size and frame rate on screen.
Input Example
{
"screencastFormatEnable": 1
}
Output Example
{
"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 |