Webportal v2

embedded apps

API Reference - speech.voiceRecognition

Edit
Required Privacy: Always available
Operations:
SET
speech.voiceRecognition
Edit

This API allows to work with speech recognition function of the vehicle.

`“status”: 500, if the an error happend with speech regonition.

This API is not currently available in Europe.

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

Start or cancel voice regonition.

string

 - start
- cancel 		start 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 */
    "speech.voiceRecognition",
    /* parameters */
    "start"
  )
  /* 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": "speech.voiceRecognition",
  "params": "start"
}

1
2
3
4
5
6
7
8
9

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

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

false

SUBSCRIBE
speech.voiceRecognition
Edit

This API allows to work with speech recognition function of the vehicle.

This API is not currently available in Europe.

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

Domain of the command.

string

n/a

 		MusicPlayerCommand
CommandType

Type of the command send.

string

n/a

 		MUSIC_PLAYER_RESPONSE_ADD_TO_FAVOURITE_LIST
vrResponse

VRManager result.

string

n/a
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 */
    "speech.voiceRecognition",
    /* 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": "speech.voiceRecognition",
  "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
16

// --- 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": "speech.voiceRecognition",
  "status": 200,
  "statusText": "OK", 
  "data":  { 
    "CommandKind": "MusicPlayerCommand",
    "CommandType": "MUSIC_PLAYER_RESPONSE_ADD_TO_FAVOURITE_LIST",
    "vrResponse": ""
  } 
}

Back to Ref List

Related References