Get BGM list
1. API Description
This API is used to get the BGM list.
Request mode:
- V2.6.0 and above: POST [ip]/mwapi/V2.0/bgm/get-bgm-list
- V2.5.0 and below: POST [ip]/mwapi/get-bgm-list
| Administrator Rights | Logged-in |
|---|---|
| No | Yes |
2. Input Parameters
None
3. Output Parameters
| Name | Type | Description |
|---|---|---|
| result | Int | Status code |
| message | String | Status description |
| info | InfoData | BGM information |
InfoData
| Name | Type | Description |
|---|---|---|
| totalCount | Total counts of BGM | |
| musicList | Array of MusicListData | Array of BGM |
MusicListData
| Name | Type | Description |
|---|---|---|
| title | String | The song name |
| id | Int | The resource ID of current BGM, that is the unique identifier of the audio file in the device |
| duration | Int | Duration, in ms |
| artist | String | Artist |
4. Example
Getting the BGM list.
Input Example
None
Output Example
{
"info": {
"musicList": [
{
"artist": "Magewell",
"duration": 31000,
"id": 2098,
"title": "Music 01"
},
{
"artist": "Magewell",
"duration": 41000,
"id": 2100,
"title": "Music 03"
},
{
"artist": "Magewell",
"duration": 71000,
"id": 2099,
"title": "Music 02"
}
],
"totalCount": 3
},
"message": "success",
"result": 0
}
5. Error Code
No error code related to the API business logic. For other error codes, see Common Error Codes.