ManagerSpeechOutput

Access this instance at HomeyAPIV2.speechOutput.

Extends

Classes

Methods

connect

(async) connect(): Promise.<void>

Connect to the realtime namespace.

Returns

Promise.<void>

disconnect

(async) disconnect(): Promise.<void>

Disconnect from the realtime namespace.

Returns

Promise.<void>

getOptionSpeed

(async) getOptionSpeed(): Promise.<any>

Scopes

SYSTEM

HTTP

GET /api/manager/speech-output/option/speed

Returns

Promise.<any>

getOptionVoice

(async) getOptionVoice(): Promise.<any>

Scopes

SYSTEM

HTTP

GET /api/manager/speech-output/option/voice

Returns

Promise.<any>

getVoice

(async) getVoice(opts): Promise.<HomeyAPIV2.ManagerSpeechOutput.Voice>

Scopes

homey.system

HTTP

GET /api/manager/speech-output/voice/:id

Parameters

Name Type Description
opts 		object
id 		string
}

Returns

Promise.<HomeyAPIV2.ManagerSpeechOutput.Voice>

getVoices

(async) getVoices(): Promise.<HomeyAPIV2.ManagerSpeechOutput.Voice>

Scopes

homey.system

HTTP

GET /api/manager/speech-output/voice/

Returns

Promise.<HomeyAPIV2.ManagerSpeechOutput.Voice>

installVoice

(async) installVoice(opts): Promise.<any>

Scopes

homey.system

HTTP

POST /api/manager/speech-output/voice

Parameters

Name Type Description
opts 		object
id 		string
}

Returns

Promise.<any>

isConnected

isConnected(): Boolean

If this manager's namespace is connected to Socket.io.

Returns

Boolean

playVoiceSample

(async) playVoiceSample(opts): Promise.<any>

Scopes

homey.system

HTTP

POST /api/manager/speech-output/voice/:id/sample

Parameters

Name Type Description
opts 		object
id 		string
}

Returns

Promise.<any>

say

(async) say(opts): Promise.<any>

Scopes

homey.speech

HTTP

POST /api/manager/speech-output/say

Parameters

Name Type Description
opts 		object
synthesize 		boolean <optional>
timeout 		number <optional>
session 		string <optional>
text 		string
}

Returns

Promise.<any>

setOptionSpeed

(async) setOptionSpeed(opts): Promise.<any>

Scopes

SYSTEM

HTTP

PUT /api/manager/speech-output/option/speed

Parameters

Name Type Description
opts 		object
value 		string
}

Returns

Promise.<any>

setOptionVoice

(async) setOptionVoice(opts): Promise.<any>

Scopes

SYSTEM

HTTP

PUT /api/manager/speech-output/option/voice

Parameters

Name Type Description
opts 		object
value 		string
}

Returns

Promise.<any>

uninstallVoice

(async) uninstallVoice(opts): Promise.<any>

Scopes

homey.system

HTTP

DELETE /api/manager/speech-output/voice/:id

Parameters

Name Type Description
opts 		object
id 		string
}

Returns

Promise.<any>

unsetOptionSpeed

(async) unsetOptionSpeed(): Promise.<any>

Scopes

SYSTEM

HTTP

DELETE /api/manager/speech-output/option/speed

Returns

Promise.<any>

unsetOptionVoice

(async) unsetOptionVoice(): Promise.<any>

Scopes

SYSTEM

HTTP

DELETE /api/manager/speech-output/option/voice

Returns

Promise.<any>

Events

voice.create

.on('voice.create')

Parameters

Name Type Description
voice 		HomeyAPIV2.ManagerSpeechOutput.Voice

voice.delete

.on('voice.delete')

Parameters

Name Type Description
voice 		HomeyAPIV2.ManagerSpeechOutput.Voice

voice.update

.on('voice.update')

Parameters

Name Type Description
voice 		HomeyAPIV2.ManagerSpeechOutput.Voice