Webportal v2

embedded apps

API Reference - media.audioSources

Required Privacy: Data & Location
Plateforme Compatibility:

Read the current active media source or change the current media source (to WP, BT, USB, Radio, etc…).

This API allows to read or modify the media audio source using IDs. Theses IDs are available in media.availableAudioSource API.

Input Parameter
No input params
Output Data
Data name Description Type Unit/Values Example
audioSourceID

ID of an audio source.

int

n/a

10
Code Example
1
2
3
4
5
6
7
8
9
10
11
12
13
webportal.get(
    /* api name */
    "media.audioSources",
    /* 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.audioSources",
  "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.audioSources",
  "status": 200,
  "statusText": "OK", 
  "data": 10
}

false

Read the current active media source or change the current media source (to WP, BT, USB, Radio, etc…).

This API allows to read or modify the media audio source using IDs. Theses IDs are available in media.availableAudioSource API.

Input Parameter
Param name Description Type Unit/Values Example Required
audioSourceID

ID of an audio source.

int

n/a

10 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.audioSources",
    /* parameters */
    10
  )
  /* 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.audioSources",
  "params": 10
}
1
2
3
4
5
6
7
8
9
// --- format of the `REPLY` message ---

{
  "id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
  "type": "REPLY",
  "api": "media.audioSources",
  "status": 200,
  "statusText": "OK"
}

false

Read the current active media source or change the current media source (to WP, BT, USB, Radio, etc…).

This API allows to read or modify the media audio source using IDs. Theses IDs are available in media.availableAudioSource API.

Input Parameter
No input params
Output Data
Data name Description Type Unit/Values Example
audioSourceID

ID of an audio source.

int

n/a

10
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.audioSources",
    /* 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.audioSources",
  "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.audioSources",
  "status": 200,
  "statusText": "OK", 
  "data": 10
}