Webportal v2

embedded apps

API Reference - media.playerState

Required Privacy: Data & Location
Operations:

This API allows to synchronize the Media Player state. It allows to inform the HMI about the media player status according to a song being played.

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

Name of your App.

string

tld.domain.subdomain

com.example.app true
playState

Playstate to synchronize in the Media player.

Enum of strings

- play

- pause

- fastForward

- fastReverse

- stop
play true
Output Data
No outputted data
Code Example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
webportal.set(
    /* api name */
    "media.playerState",
    /* parameters */
     { 
      "appId": "com.example.app",
      "playState": "play"
        }
  )
  /* callback for `REPLY` messages */
  .then((message) => {
    if (message.status === 200) {
      /* handle `REPLY` success */
    }
    else { /* handle `REPLY` error */ }
  })
1
2
3
4
5
6
7
8
9
{
  "id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0", 
  "type": "SET", 
  "api": "media.playerState",
  "params":  { 
    "appId": "com.example.app",
    "playState": "play"
  }
}
1
2
3
4
5
6
7
8
9
// --- format of the `REPLY` message ---

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

false

This API allows to synchronize the Media Player state. It allows to inform the HMI about the media player status according to a song being played.

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

Name of your App.

string

tld.domain.subdomain

com.example.app
playState

Playstate to synchronized in the Media player.

Enum of strings

- play

- pause

- fastForward

- fastReverse

- next

- previous

- resume
play
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.playerState",
    /* 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.playerState",
  "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
// --- 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.playerState",
  "status": 200,
  "statusText": "OK", 
  "data":  { 
    "appId": "com.example.app",
    "playState": "play"
  } 
}