Switch or undisplay GFX
1. API Description
This API is used to switch GFX or undisplay GFX.
Request mode:
- V2.6.0 and above: POST [ip]/mwapi/V2.0/gfx/switch-gfx
- V2.5.0 and below: POST [ip]/mwapi/switch-osd
| Administrator Rights | Logged-in |
|---|---|
| No | Yes |
2. Input Parameters
| Name | Required | Type | Description |
|---|---|---|---|
| osdId | Yes | Int | GFX ID, which can be obtained via Get GFX list When osdID is set to 0, it indicates to undisplay GFX. |
3. Output Parameters
| Name | Type | Description |
|---|---|---|
| status | Int | Status code |
| message | String | Status description |
4. Example
Switch to the GFX with ID 100.
Input Example
{
"osdId": 100
}
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 |
|---|---|---|
| 7 | MW_STATUS_INVALID_ARG | Missing required parameters |