speech

Summit speech library.

Classes

Name Summary
SpeechFile

Represents a reference to a speech file object

Functions

Name Summary
speech

Constructs a ‘speech’ object.

Classes : speech

SpeechFile

Represents a reference to a speech file object

Fields
Name Type Summary
text

string

The text to TTS and play. This is read-only.

Functions : speech

speech(text, options)

Constructs a ‘speech’ object. This is useful for chaining multiple channel.say() commands and can be passed along to channel.play() or to channel.gather() to make an interruptable TTS greeting to a gather statement.

Parameters
Name Type Default Summary

text

string

Text for the TTS engine to say.

options

table

Parameter: options
Name Type Default Summary

language

string

'en'

Language the speech object will use. Available options:

  • “en” – US English
  • “es” – Spanish
  • “cafr” – Canadian French

ttsEngine

string

'neospeech2'

Speech engine the speech object will use. Available options:

  • “flite”
  • “neospeech”
  • “neospeech2”

voice

string

'woman'

Voice type the speech object will use. Available options:

  • “woman”
  • “man”
Returns
Type Summary

SpeechFile

A reference to a speech file

Usage
local speech = require('summit.speech')
local msg = speech("Help me!")
channel.play(msg)
local other_msg = speech("I'm stuck inside the phone!", {voice="man"})
channel.gather({play={msg, other_msg}})