AbstractVoiceService

AbstractVoiceService ⇐ Abstract

Kind: global abstract class
Extends: Abstract
Service:

AbstractVoiceService()

Service to handle Bluetooth device feature to handle voice feature

init() ⇒ Promise.<*, Error>

Init the service.

Kind: instance method of AbstractVoiceService
Returns: Promise.<*, Error> - Promise resolved when init is done

setRgpdVoiceState(state) ⇒ Promise.<*, Error>

Set the voice service RGPD state.

Kind: instance method of AbstractVoiceService
Returns: Promise.<*, Error> - Promise resolved when RGPD voice state is set

ParamTypeDescription
stateboolean

The RGPD state to set set, true if accepted, false otherwise

_init() ⇒ Promise.<*, Error>

Kind: instance abstract method of AbstractVoiceService
Returns: Promise.<*, Error> - Promise resolved when init is done
Access: protected

_setRgpdVoiceState(state) ⇒ Promise.<*, Error>

Kind: instance abstract method of AbstractVoiceService
Returns: Promise.<*, Error> - Promise resolved when RGPD voice state is set
Access: protected

ParamTypeDescription
stateboolean

The RGPD state to set set, true if accepted, false otherwise

_onListeningStarted(input) ⇒ Promise

Kind: instance method of AbstractVoiceService
Access: protected

ParamTypeDescription
inputnumber

The voice input (RCU or Far FIELD)

_onListeningStopped() ⇒ Promise

Kind: instance method of AbstractVoiceService
Access: protected

_onCommandReceived(cmd, text, input) ⇒ Promise

Kind: instance method of AbstractVoiceService
Access: protected

ParamTypeDescription
cmdVoiceCommand

The received voice command

textstring

The asr final text

inputnumber

The voice input (RCU or Far FIELD)

_onAsrEmpty() ⇒ Promise

Kind: instance method of AbstractVoiceService
Access: protected

_onNluFailed(text) ⇒ Promise

Kind: instance method of AbstractVoiceService
Access: protected

ParamTypeDescription
textstring

The asr final text

_onAsrIntermediateReceived(text) ⇒ Promise

Kind: instance method of AbstractVoiceService
Access: protected

ParamTypeDescription
textstring

The ASR understood text to display

_onRgpdVoiceStateAsked() ⇒ Promise

Kind: instance method of AbstractVoiceService
Access: protected

“listeningStarted”

Fired when the system starts to listen for voice input

Kind: event emitted by AbstractVoiceService

“listeningStopped”

Fired when the system stops to listen for voice input

Kind: event emitted by AbstractVoiceService

“commandReceived”

Fired when a voice command is received

Kind: event emitted by AbstractVoiceService

“asrEmpty”

Fired when ASR empty

Kind: event emitted by AbstractVoiceService

“nluFailed”

Fired when NLU failed

Kind: event emitted by AbstractVoiceService

“homeError”

Fired when there is a voice Error

Kind: event emitted by AbstractVoiceService

“asrIntermediateReceived”

Fired when an ASR intermediate is received

Kind: event emitted by AbstractVoiceService

“rgpdVoiceStateAsked”

Fired when NLU failed

Kind: event emitted by AbstractVoiceService

INPUT_DEVICE_FAR_FIELD : number

Kind: static constant of AbstractVoiceService
Default: 0

INPUT_DEVICE_RCU : number

Kind: static constant of AbstractVoiceService
Default: 1