Webportal v2

embedded apps

API Reference - media.fastForward

Edit
Required Privacy: Data & Location
Operation:
SET
media.fastForward
Edit

This API allows to work with fast forward within the media player.

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

Turn fast forward on/off.

boolean

 - true: perform fast forwarding
- false: resume playing 		true 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.fastForward",
    /* parameters */
    true
  )
  /* 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.fastForward",
  "params": true
}

1
2
3
4
5
6
7
8
9

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

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

false

Back to Ref List

Related References