ManagerSpeechOutput

Access this instance at HomeyAPIV2.speechOutput.

Extends

Classes

Instance Properties

homey

homey: HomeyAPIV3

The Homey of the Manager.

Type

uri

uri: String

The URI of the Item, e.g. homey:manager:bar.

Type

  • String

Instance Methods

addListener

addListener(event, callback)

Parameters

Name Type Description
event 		string
callback 		function

connect

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

Connect to this manager's Socket.io namespace.

Returns

Promise.<void>

destroy

destroy()

Destroy this Manager by cleaning up all references, unbinding event listeners and disconnecting from the Socket.io namespace.

disconnect

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

Discconnect from this manager's Socket.io namespace.

Returns

Promise.<void>

emit

emit(event, …data)

Parameters

Name Type Description
event 		string
data 		any <repeatable>

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.<Object.<string, HomeyAPIV2.ManagerSpeechOutput.Voice>>

Scopes

homey.system

HTTP

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

Returns

Promise.<Object.<string, 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

off

off(event, callback)

Parameters

Name Type Description
event 		string
callback 		function

on

on(event, callback)

Parameters

Name Type Description
event 		string
callback 		function

once

once(event, callback)

Parameters

Name Type Description
event 		string
callback 		function

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>

removeAllListeners

removeAllListeners(event)

Parameters

Name Type Description
event 		string

removeListener

removeListener(event, callback)

Shortcut to EventEmitter#off

Parameters

Name Type Description
event 		string
callback 		function

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