SetVoice

Purpose

This command changes the voice of a speaker client instance to the voice name provided.

Parameters

Parameter: voice name
Type: string
Description: This is the voice name string of the voice you wish to change the speaker client to use - it is not case sensitive but must match one of the voice names in your system.  (See the Speaker Client for a list of voice names.)

Parameter: host
Type: string
Description: Leaving this a null string will change the voice for the first instance HomeSeer finds, otherwise use the hostname of the computer you are interested in changing the voice of.  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

Return value: return status
Type: integer (.NET Short)
Description: Zero (0) means the voice was not found, One (1) indicates success.