Speak

Purpose

This function speaks some text.

Parameters

Parameter: text
Type: string
Description: This is the string you want to speak.  It may also be the complete path to a WAV file to be played.

Parameter: wait (boolean)
Type: boolean
Description: If set to TRUE, the function will not return until the system finishes speaking.  This is useful if you are switching between speaking and listening.  You cannot listen and speak at the same time on some systems.  If this parameter is missing, the system will not wait.

Parameter: host (optional)
Type: string
Description: Leaving this a null string will apply the command to the first instance HomeSeer finds, otherwise use the hostname of the computer for this command.  If more than one instance of the Speaker application is running on "host" then you may need to specify the instance as well in the format host:instance.

Returns

None.

Example

Sub Main()

' speak and wait
hs.speak "hello there", True
hs.speak "Hello people in the kitchen.", True, "Kitchen:*"

End Sub

See Also

Using Replacement Variables