FTB for screencast overlay
1. API Description
This API is used to set FTB effect for screencast overlay.
Request mode:
- V2.6.0 and above: POST [ip]/mwapi/V2.0/input/set-screencast-voerlay-fade-out
- V2.5.0 and below: POST [ip]/mwapi/set-screencast-voerlay-fade-out
| Administrator Rights | Logged-in |
|---|---|
| No | Yes |
2. Input Parameters
| Name | Required | Type | Description |
|---|---|---|---|
| screencastOverlayFadeOut | Yes | Int | FTB mode of screencast overlay 0: Never, 1: FTB in 5 seconds, 2: FTB in 10 seconds, 3: FTB in 20 seconds, 4: FTB in 30 seconds, 5: FTB in 1 minute |
3. Output Parameters
| Name | Type | Description |
|---|---|---|
| status | Int | Status code |
4. Example
Setting FTB in 30 seconds for screencast overlay.
Input Example
{
"screencastOverlayFadeOut": 4
}
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 |
|---|---|---|
| 7 | MW_STATUS_INVALID_ARG | Missing required parameters |
| 49 | MW_STATUS_INVALID_DATA | Incorrect parameter |