- Since:
- 1.0.0
Methods
-
async say(optsopt)
-
Required OAuth scopes:
- homey.speech
Parameters:
Name Type Attributes Description opts
object <optional>
Named parameters Properties
Name Type Attributes Description text
string session
string <optional>
timeout
number <optional>
synthesize
boolean <optional>
-
async getVoices(optsopt) → {Object.<string, HomeyAPI.ManagerSpeechOutput.Voice>}
-
Required OAuth scopes:
- homey.system
Parameters:
Name Type Attributes Description opts
object <optional>
Named parameters Properties
Name Type Attributes Description filter
HomeyAPI.ManagerSpeechOutput.Voice <optional>
A response filter (Using a filter will bypass all caches, use sparingely) Returns:
Object.<string, HomeyAPI.ManagerSpeechOutput.Voice> - Successful response -
async getVoice(optsopt) → {HomeyAPI.ManagerSpeechOutput.Voice}
-
Required OAuth scopes:
- homey.system
Parameters:
Name Type Attributes Description opts
object <optional>
Named parameters Properties
Name Type Description id
string Returns:
HomeyAPI.ManagerSpeechOutput.Voice - Successful response -
async uninstallVoice(optsopt)
-
Required OAuth scopes:
- homey.system
Parameters:
Name Type Attributes Description opts
object <optional>
Named parameters Properties
Name Type Description id
string -
async installVoice(optsopt)
-
Required OAuth scopes:
- homey.system
Parameters:
Name Type Attributes Description opts
object <optional>
Named parameters Properties
Name Type Description id
string -
async playVoiceSample(optsopt)
-
Required OAuth scopes:
- homey.system
Parameters:
Name Type Attributes Description opts
object <optional>
Named parameters Properties
Name Type Description id
string -
async setOptionSpeed(optsopt)
-
Required OAuth scopes:
- homey.system
Parameters:
Name Type Attributes Description opts
object <optional>
Named parameters Properties
Name Type Description value
string ("very_slow" | "slow" | "normal" | "fast" | "very_fast") -
async getOptionSpeed(optsopt)
-
Required OAuth scopes:
- homey.system
Parameters:
Name Type Attributes Description opts
object <optional>
Named parameters -
async setOptionVoice(optsopt)
-
Required OAuth scopes:
- homey.system
Parameters:
Name Type Attributes Description opts
object <optional>
Named parameters Properties
Name Type Description value
string -
async getOptionVoice(optsopt)
-
Required OAuth scopes:
- homey.system
Parameters:
Name Type Attributes Description opts
object <optional>
Named parameters -
destroy()
-
Unsubscribes to realtime events, clear all caches, and remove all event listeners for this manager and it's managed objects
Events
-
download_progress
-
When a voice download has made progress
Parameters:
Name Type Description voiceId
string percent
number -
download_error
-
When a voice download has errored
Parameters:
Name Type Description voiceId
string -
download_done
-
When a voice download finished
-
voice.create
-
Fired when a managed Voice is created
Parameters:
Name Type Description voice
HomeyAPI.ManagerSpeechOutput.Voice The affected Voice -
voice.update
-
Fired when a managed Voice is changed
Parameters:
Name Type Description voice
HomeyAPI.ManagerSpeechOutput.Voice The affected Voice -
voice.delete
-
Fired when a managed Voice has been deleted
Parameters:
Name Type Description voice
HomeyAPI.ManagerSpeechOutput.Voice The affected Voice