Set BGM playback policy
1. API Description
This API is used to set the playback policy of BGM.
Request mode:
- V2.6.0 and above: POST [ip]/mwapi/V2.0/bgm/bgm-set-policy
- V2.5.0 and below: POST [ip]/mwapi/bgm-set-policy
| Administrator Rights | Logged-in |
|---|---|
| No | Yes |
2. Input Parameters
| Name | Required | Type | Description |
|---|---|---|---|
| musicPolicy | Yes | Int | Playback policy 1: Play by order 2: Shuffle 3: Loop one 4: Loop all |
3. Output Parameters
| Name | Type | Description |
|---|---|---|
| status | Int | Status code |
| message | String | Status description |
4. Example
Setting to play BGM by order.
Input Example
{
"musicPolicy":1
}
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 |