Title here
Summary here
AbstractAlexaService
AbstractAlexaService ⇐ Abstract
Kind: global abstract class
Extends: Abstract
Service:
- AbstractAlexaService ⇐
Abstract- new AbstractAlexaService()
- .init() ⇒
Promise - .isProductRegistered() ⇒
Promise.<Boolean> - .startProductRegistration() ⇒
Promise - .stopProductRegistration() ⇒
Promise - .unregisterProduct() ⇒
Promise - .tapToTalk() ⇒
Promise - .enableAudioFeedback(enable) ⇒
Promise.<Number> - .isAudioFeedbackEnabled() ⇒
Promise.<Boolean> - .setLanguage(lng) ⇒
Promise - .getCurrentLanguage() ⇒
Promise.<String> - .getLanguageList() ⇒
Promise.<String> - .isActivated() ⇒
Promise - .activate() ⇒
Promise - .deactivate() ⇒
Promise - .playbackButtonPressed(button) ⇒
Promise - .playbackModeToggle(toggleMode) ⇒
Promise - ._init() ⇒
Promise - ._isProductRegistered() ⇒
Promise.<Boolean> - ._startProductRegistration() ⇒
Promise - ._stopProductRegistration() ⇒
Promise - ._unregisterProduct() ⇒
Promise - ._enableAudioFeedback(enable) ⇒
Promise.<Number> - ._isAudioFeedbackEnabled() ⇒
Promise.<Boolean> - ._setLanguage(lng) ⇒
Promise - ._getCurrentLanguage() ⇒
Promise.<String> - ._getLanguageList() ⇒
Promise.<String> - ._tapToTalk() ⇒
Promise - ._playbackButtonPressed(button) ⇒
Promise - ._playbackModeToggle(toggleMode) ⇒
Promise - ._isActivated() ⇒
Promise.<boolean> - ._activate() ⇒
Promise - ._deactivate() ⇒
Promise - ._onPairingCode(data) ⇒
Promise - ._onPairingDone() ⇒
Promise - ._onPairingExpired(error) ⇒
Promise - ._onPairingFailed(error) ⇒
Promise - ._onPairingPending() ⇒
Promise - ._onListeningStarted() ⇒
Promise - ._onListeningActive() ⇒
Promise - ._onListeningStopped() ⇒
Promise - ._onSpeakingStarted() ⇒
Promise - ._onSpeakingStopped() ⇒
Promise - ._onThinking() ⇒
Promise - ._onCardsChange(params) ⇒
Promise - ._onPlayerChange(params) ⇒
Promise - ._onMusicStop() ⇒
Promise - ._onMicOff() ⇒
Promise - ._onSmartScreenStart() ⇒
Promise - ._onSmartScreenStop() ⇒
Promise
AbstractAlexaService()
Service which handles Amazon’s ALEXA platform.
init() ⇒ Promise
Init the service
Kind: instance method of AbstractAlexaService
isProductRegistered() ⇒ Promise.<Boolean>
Allows to test if current device is registered
Kind: instance method of AbstractAlexaService
startProductRegistration() ⇒ Promise
Allows to start current device registration
Kind: instance method of AbstractAlexaService
stopProductRegistration() ⇒ Promise
Allows to stop current device registration
Kind: instance method of AbstractAlexaService
unregisterProduct() ⇒ Promise
Allows to unregister current device
Kind: instance method of AbstractAlexaService
tapToTalk() ⇒ Promise
Just a way to trigger Alexa manually
Kind: instance method of AbstractAlexaService
enableAudioFeedback(enable) ⇒ Promise.<Number>
Allows to enable audio feedback
Kind: instance method of AbstractAlexaService
| Param | Type | Description |
|---|---|---|
| enable | Boolean | True to enable |
isAudioFeedbackEnabled() ⇒ Promise.<Boolean>
Returns true if audio feedback is enabled, false else
Kind: instance method of AbstractAlexaService
Returns: Promise.<Boolean> - Returns true if audio feedback is enabled, false else
setLanguage(lng) ⇒ Promise
Set a new language for Amazon SDK
Kind: instance method of AbstractAlexaService
| Param | Type | Description |
|---|---|---|
| lng | String | Language to set |
getCurrentLanguage() ⇒ Promise.<String>
Returns the current language set in the Amazon SDK
Kind: instance method of AbstractAlexaService
Returns: Promise.<String> - Returns the current language set in the Amazon SDK
getLanguageList() ⇒ Promise.<String>
Returns the supported languages from Amazon SDK
Kind: instance method of AbstractAlexaService
Returns: Promise.<String> - Returns the supported languages from Amazon SDK
isActivated() ⇒ Promise
get the activation status
Kind: instance method of AbstractAlexaService
activate() ⇒ Promise
Activate the product
Kind: instance method of AbstractAlexaService
deactivate() ⇒ Promise
Deactivate the product
Kind: instance method of AbstractAlexaService
playbackButtonPressed(button) ⇒ Promise
Method to inform Alexa that a playback button has been pressed
Kind: instance method of AbstractAlexaService
| Param | Type | Description |
|---|---|---|
| button | object | the pressed button |
playbackModeToggle(toggleMode) ⇒ Promise
Method to inform Alexa that a playback mode has been toggled
Kind: instance method of AbstractAlexaService
| Param | Type | Description |
|---|---|---|
| toggleMode | object | the toggle mode |
_init() ⇒ Promise
Init the service.
Kind: instance abstract method of AbstractAlexaService
Access: protected
_isProductRegistered() ⇒ Promise.<Boolean>
Allows to test if current device is registered
Kind: instance abstract method of AbstractAlexaService
Access: protected
_startProductRegistration() ⇒ Promise
Allows to start current device registration
Kind: instance abstract method of AbstractAlexaService
Access: protected
_stopProductRegistration() ⇒ Promise
Allows to stop current device registration
Kind: instance abstract method of AbstractAlexaService
Access: protected
_unregisterProduct() ⇒ Promise
Allows to unregister current device
Kind: instance abstract method of AbstractAlexaService
Access: protected
_enableAudioFeedback(enable) ⇒ Promise.<Number>
Allows to enable audio feedback
Kind: instance abstract method of AbstractAlexaService
Access: protected
| Param | Type | Description |
|---|---|---|
| enable | Boolean | True to enable |
_isAudioFeedbackEnabled() ⇒ Promise.<Boolean>
Returns true if audio feedback is enabled, false else
Kind: instance method of AbstractAlexaService
Returns: Promise.<Boolean> - Returns true if audio feedback is enabled, false else
_setLanguage(lng) ⇒ Promise
Set a new language for Amazon SDK
Kind: instance method of AbstractAlexaService
| Param | Type | Description |
|---|---|---|
| lng | String | Language to set |
_getCurrentLanguage() ⇒ Promise.<String>
Returns the current language set in the Amazon SDK
Kind: instance method of AbstractAlexaService
Returns: Promise.<String> - Returns the current language set in the Amazon SDK
_getLanguageList() ⇒ Promise.<String>
Returns the supported languages from Amazon SDK
Kind: instance method of AbstractAlexaService
Returns: Promise.<String> - Returns the supported languages from Amazon SDK
_tapToTalk() ⇒ Promise
Just a way to trigger Alexa manually
Kind: instance abstract method of AbstractAlexaService
Access: protected
_playbackButtonPressed(button) ⇒ Promise
Method to inform Alexa that a playback button has been pressed
Kind: instance abstract method of AbstractAlexaService
Access: protected
| Param | Type | Description |
|---|---|---|
| button | object | the pressed button |
_playbackModeToggle(toggleMode) ⇒ Promise
AMethod to inform Alexa that a playback mode has been toggled
Kind: instance abstract method of AbstractAlexaService
Access: protected
| Param | Type | Description |
|---|---|---|
| toggleMode | object | the toggle mode |
_isActivated() ⇒ Promise.<boolean>
get activation status
Kind: instance abstract method of AbstractAlexaService
Access: protected
_activate() ⇒ Promise
Allow to activate the product
Kind: instance abstract method of AbstractAlexaService
Access: protected
_deactivate() ⇒ Promise
Allow to deactivate the product
Kind: instance abstract method of AbstractAlexaService
Access: protected
_onPairingCode(data) ⇒ Promise
Kind: instance method of AbstractAlexaService
Access: protected
| Param | Type | Description |
|---|---|---|
| data | data | Pairing code and url. |
_onPairingDone() ⇒ Promise
Kind: instance method of AbstractAlexaService
Access: protected
_onPairingExpired(error) ⇒ Promise
Kind: instance method of AbstractAlexaService
Access: protected
| Param | Type | Description |
|---|---|---|
| error | Error | Paring error. |
_onPairingFailed(error) ⇒ Promise
Kind: instance method of AbstractAlexaService
Access: protected
| Param | Type | Description |
|---|---|---|
| error | Error | Paring error. |
_onPairingPending() ⇒ Promise
Kind: instance method of AbstractAlexaService
Access: protected
_onListeningStarted() ⇒ Promise
Kind: instance method of AbstractAlexaService
Access: protected
_onListeningActive() ⇒ Promise
Kind: instance method of AbstractAlexaService
Access: protected
_onListeningStopped() ⇒ Promise
Kind: instance method of AbstractAlexaService
Access: protected
_onSpeakingStarted() ⇒ Promise
Kind: instance method of AbstractAlexaService
Access: protected
_onSpeakingStopped() ⇒ Promise
Kind: instance method of AbstractAlexaService
Access: protected
_onThinking() ⇒ Promise
Kind: instance method of AbstractAlexaService
Access: protected
_onCardsChange(params) ⇒ Promise
Kind: instance method of AbstractAlexaService
Access: protected
| Param | Type | Description |
|---|---|---|
| params | Object | the parameters |
| params.status | Number | the card/player status |
| params.data | Object | the card/player data |
_onPlayerChange(params) ⇒ Promise
Kind: instance method of AbstractAlexaService
Access: protected
| Param | Type | Description |
|---|---|---|
| params | Object | the parameters |
| params.status | Number | the card/player status |
| params.data | Object | the card/player data |
_onMusicStop() ⇒ Promise
Kind: instance method of AbstractAlexaService
Access: protected
_onMicOff() ⇒ Promise
Kind: instance method of AbstractAlexaService
Access: protected
_onSmartScreenStart() ⇒ Promise
Triggered when the Alexa Smart Screen starts
Kind: instance method of AbstractAlexaService
Access: protected
_onSmartScreenStop() ⇒ Promise
Triggered when the Alexa Smart Screen stops
Kind: instance method of AbstractAlexaService
Access: protected