xAP Speech Schema

From XAP Automation
Jump to: navigation, search

tts.speak

Class=tts.speak

tts.speak
{
Say=(text to speak)
--- mandatory
Volume=(0-100)
--- optional
Voice=(TTS Voice to use)
--- optional
Device=(Soundcard to use)
--- optional
Priority=(Yes/No To stop current playback and play this text)
--- optional
Delay=(delay in ms between receipt of message and speech starting)
--- optional
filename=(If the is present then instead of playing the sound through the sound card it will be recorded into a wav file specified here)
--- optional
Sound=(Name of sound to play before speech. Should be sent without file extension)
--- optional
}

To stop speaking. Either just the current spoken message or the entire queue

Class=tts.speak

tts.stop
{
Stop=[Current|All]
--- mandatory
}

tts.locate

Used for another app to locate a tts app Class=tts.locate

tts.locate
{
Locate=Yes
}


Response to a tts.locate request Class=tts.service

tts.voice
{
Voice.X=(Voice name, X is sequential)
--- mandatory
Default=(Default Voice)
--- optional
}
tts.output
{
Output.X=(Output name, X is sequential)
--- mandatory
Default=(Default Output)
--- optional
}