API Reference - media.id3Content
Required Privacy:
Data &
Location
This API allows to retrieve the ID3 metadata of the current file playing.
| Input Parameter | |||||
|---|---|---|---|---|---|
| No input params |
| Output Data | ||||
|---|---|---|---|---|
| Data name | Description | Type | Unit/Values | Example |
| album | Current album name. |
string |
|
Ziggy Stardust and the Spiders from Mars
|
| artist | Current artist name. |
string |
|
David Bowie
|
| genre | Current genre name. |
string |
|
Glam Rock
|
| album | Current album name. |
string |
|
Starman
|
Code Example
1
2
3
4
5
6
7
8
9
10
11
12
13
webportal.get(
/* api name */
"media.id3Content",
/* parameters */
null
)
/* callback for `REPLY` messages */
.then((message) => {
if (message.status === 200) {
/* handle `REPLY` success */
}
else { /* handle `REPLY` error */ }
})
1
2
3
4
5
6
{
"id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
"type": "GET",
"api": "media.id3Content",
"params": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// --- format of the `REPLY` message ---
{
"id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
"type": "REPLY",
"api": "media.id3Content",
"status": 200,
"statusText": "OK",
"data": {
"album": "Ziggy Stardust and the Spiders from Mars",
"artist": "David Bowie",
"genre": "Glam Rock",
"album": "Starman"
}
}
false
This API allows to retrieve the ID3 metadata of the current file playing.
| Input Parameter | |||||
|---|---|---|---|---|---|
| No input params |
| Output Data | ||||
|---|---|---|---|---|
| Data name | Description | Type | Unit/Values | Example |
| album | Current album name. |
string |
|
Ziggy Stardust and the Spiders from Mars
|
| artist | Current artist name. |
string |
|
David Bowie
|
| genre | Current genre name. |
string |
|
Glam Rock
|
| album | Current album name. |
string |
|
Starman
|
Code Example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
webportal.subscribe(
/* api name */
"media.id3Content",
/* parameters */
null,
/* callback for `NOTIFY` messages */
async (notifyMessage) => {
if (notifyMessage.status === 200) {
/* handle `NOTIFY` response */
}
else { /* handle `NOTIFY` error */ }
}
)
/* callback for `REPLY` messages */
.then((message) => {
if (message.status === 200) {
/* handle `REPLY` success */
}
else { /* handle `REPLY` error */ }
})
1
2
3
4
5
6
{
"id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
"type": "SUBSCRIBE",
"api": "media.id3Content",
"params": null
}
1
2
3
4
5
6
7
8
9
10
11
// --- format of the `REPLY` message ---
// type: acknowledge the status of the subscription
// reception: only once after the subscription request
// contains outputed data: no
{
"id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
"type": "REPLY",
"status": 200,
"statusText": "OK"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// --- format of the `NOTIFY` message ---
// type: event message about the subscription
// reception: each time the conditions of the subscription are met
// contains outputed data: yes
{
"id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
"type": "NOTIFY",
"api": "media.id3Content",
"status": 200,
"statusText": "OK",
"data": {
"album": "Ziggy Stardust and the Spiders from Mars",
"artist": "David Bowie",
"genre": "Glam Rock",
"album": "Starman"
}
}