Plugin TTSMS

SEE ALSO: TTS Settings

Go to the main Plugins page.

Go to the complete Plugin List.

Plugin Description

Text-to-Speech actions.

Actions for the TTSMS plugin

SetLang

TTSMS.SetLang
Used with VoxWav for Android.
Instructs VoxWav to attempt to set the TTS engine to the language specified by the two character Language Code.

• Parameters: 1

1. Language Code : en, es, fr, de, pt etc. [string]

SetOutput

TTSMS.SetOutput
Sets the audio output device to be used for TTS (text to speech).
It will select the first device found with a descriptions that contains <DeviceName>.
If <DeviceName> is an integer it will select by the device number.

• Parameters: 1

1. DeviceName : The name of the output device to use for TTS [string]

SetVoiceName

TTSMS.SetVoiceName
Set the TTS engine to use the voice with the name <VoiceName>.
You can view the available names in VC options. Voice name must match exactly.

• Parameters: 1

1. VoiceName : <voicename> [string]

SetVoiceNum

TTSMS.SetVoiceNum
Set the TTS engine to use the voice with the <VoiceNum>th voice. The order of voices can be seen in VoxCommando options.
The number and names of voices may change if you install or uninstall voices.
The first voice in the list will have a number of: 0

• Parameters: 1

1. VoiceNum : First voice is 0 [integer]

SetVolume

TTSMS.SetVolume
Sets the output volume of the TTS voice.

• Parameters: 1

1. TTS Volume : <1-100> [integer]

Speak

TTSMS.Speak
Speaks the string aloud. VC will choose randomly from multiple phrases separated by the symbol: |

• Parameters: 1

1. TTS text : <stringoption1 | stringoption2 | etc. [string]

Speak2Wav

TTSMS.Speak2Wav
Same as TTS.Speak, but instead of speaking aloud, the speech will be recorded to a wav file.

If PlayWav is true the wav will be played immediately, otherwise the file will be created but not played by VoxCommando.

• Parameters: 1-3

1. TTS text : What should the TTS engine say? [string]
2. Path : Where to save the wav file [string]
3. PlayWav : True = play the wav file after creating it [boolean]

SpeakSync

TTSMS.SpeakSync
Same as TTS.Speak, but VC will wait until speaking is complete before continuing to the next action.

• Parameters: 1

1. TTS text : <stringoption1 | stringoption2 | etc.> [string]

Stop

TTSMS.Stop
Interrupts the TTS voice (if it is still speaking). In other words it stops the TTS voice from speaking. Text that has not been spoken yet is discarded.