Webportal v2

embedded apps

API Reference - media.songCurrentTime

Edit
Required Privacy: Data & Location
Operations:
GET
media.songCurrentTime
Edit

This API allows to synchronize the Media Player time position setting of the playing song.

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
currentTime

Value of the current song’s time position.

Float

second

 		126.34
Code Example 
1
2
3
4
5
6
7
8
9
10
11
12
13

webportal.get(
    /* api name */
    "media.songCurrentTime",
    /* 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.songCurrentTime",
  "params":  null
}

1
2
3
4
5
6
7
8
9
10
11
12
13

// --- format of the `REPLY` message ---

{
  "id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
  "type": "REPLY",
  "api": "media.songCurrentTime",
  "status": 200,
  "statusText": "OK", 
  "data":  { 
    "appId": "com.example.app",
    "currentTime": "126.34"
  } 
}

false

SET
media.songCurrentTime
Edit

This API allows to synchronize the Media Player time position setting of the playing song.

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

Name of your App.

string

tld.domain.subdomain

 		com.example.app true
currentTime

Value of the current song’s time position.

Float

second

 		126.34 true
Output Data
Data name Description Type Unit/Values Example
appId

Name of your App.

string

tld.domain.subdomain

 		com.example.app
currentTime

Value of the current song’s time position.

Float

second

 		126.34
Code Example 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

webportal.set(
    /* api name */
    "media.songCurrentTime",
    /* parameters */
     { 
      "appId": "com.example.app",
      "currentTime": "126.34"
        }
  )
  /* 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.songCurrentTime",
  "params":  { 
    "appId": "com.example.app",
    "currentTime": "126.34"
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13

// --- format of the `REPLY` message ---

{
  "id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
  "type": "REPLY",
  "api": "media.songCurrentTime",
  "status": 200,
  "statusText": "OK", 
  "data":  { 
    "appId": "com.example.app",
    "currentTime": "126.34"
  } 
}

false

SUBSCRIBE
media.songCurrentTime
Edit

This API allows to synchronize the Media Player time position setting of the playing song.

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
currentTime

Value of the current song’s time position.

Float

second

 		126.34
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.songCurrentTime",
    /* 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.songCurrentTime",
  "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.songCurrentTime",
  "status": 200,
  "statusText": "OK", 
  "data":  { 
    "appId": "com.example.app",
    "currentTime": "126.34"
  } 
}

Back to Ref List

Related References