API Reference - media.radioStationFrequency
This API allows to work with the current radio frenquency.
Calling GET will return the current radio frequency/channel.
| Input Parameter | |||||
|---|---|---|---|---|---|
| No input params |
| Output Data | ||||
|---|---|---|---|---|
| Data name | Description | Type | Unit/Values | Example |
| radioFrequency | Value of the FM/AM frequency or DAB channel index. |
int |
|
100000
|
Code Example
1
2
3
4
5
6
7
8
9
10
11
12
13
webportal.get(
/* api name */
"media.radioStationFrequency",
/* 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.radioStationFrequency",
"params": null
}
1
2
3
4
5
6
7
8
9
10
// --- format of the `REPLY` message ---
{
"id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
"type": "REPLY",
"api": "media.radioStationFrequency",
"status": 200,
"statusText": "OK",
"data": 100000
}
false
This API allows to work with the current radio frenquency.
Calling SET will change the current radio frequency/channel.
| Input Parameter | |||||
|---|---|---|---|---|---|
| Param name | Description | Type | Unit/Values | Example | Required |
| radioFrequency | Set the new value of the radio channel you want to play in the HMI. Could be FM/AM frequency or DAB channel index. |
int |
|
100000
|
true |
| Output Data | ||||
|---|---|---|---|---|
| No outputted data |
Code Example
1
2
3
4
5
6
7
8
9
10
11
12
13
webportal.set(
/* api name */
"media.radioStationFrequency",
/* parameters */
100000
)
/* 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": "SET",
"api": "media.radioStationFrequency",
"params": 100000
}
1
2
3
4
5
6
7
8
9
// --- format of the `REPLY` message ---
{
"id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
"type": "REPLY",
"api": "media.radioStationFrequency",
"status": 200,
"statusText": "OK"
}
false
This API allows to work with the current radio frenquency.
Calling SUBSCRIBE will return the radio frequency/channel when the value is changed.
| Input Parameter | |||||
|---|---|---|---|---|---|
| No input params |
| Output Data | ||||
|---|---|---|---|---|
| Data name | Description | Type | Unit/Values | Example |
| radioFrequency | Value of the FM/AM frequency or DAB channel index. |
int |
|
100000
|
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.radioStationFrequency",
/* 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.radioStationFrequency",
"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
// --- 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.radioStationFrequency",
"status": 200,
"statusText": "OK",
"data": 100000
}