hs.speech.attributesForVoice(voice) -> table
com.apple.speech.synthesis.voice.
name
. You can provide this suffix or not as you prefer when specifying a voice name.hs.speech.availableVoices([full]) -> array
com.apple.speech.synthesis.voice.
name
. This prefix is normally suppressed unless you pass in true.hs.speech.defaultVoice([full]) -> string
com.apple.speech.synthesis.voice.
name
. This prefix is normally suppressed unless you pass in true.hs.speech.isAnyApplicationSpeaking() -> boolean
hs.speech:speaking
.hs.speech.new([voice]) -> synthesizerObject
com.apple.speech.synthesis.voice.
name
. You can provide this suffix or not as you prefer when specifying a voice name.hs.speech:voice
method.hs.speech:continue() -> synthesizerObject
hs.speech:isPaused() -> boolean | nil
| | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | Type | Method | | Description | Returns whether or not the synthesizer is currently paused. | | Parameters |hs.speech.log.level = 3
. See hs.logger
for more information)hs.speech:isSpeaking() -> boolean | nil
| | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | Type | Method | | Description | Returns whether or not the synthesizer is currently speaking, either to an audio device or to a file. | | Parameters |hs.speech.log.level = 3
. See hs.logger
for more information)hs.speech:modulation([modulation]) -> synthsizerObject | modulation | nil
| | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | Type | Method | | Description | Gets or sets the pitch modulation for the synthesizer's voice. | | Parameters |hs.speech:pause([where]) -> synthesizerObject
hs.speech:phonemes(text) -> string
hs.speech:speak
if you find that the default interpretation is not correct. You will need to set the input mode to Phonetic by prefixing the text with "[[inpt PHON]]".hs.speech:phoneticSymbols
after setting an appropriate voice.hs.speech:phoneticSymbols() -> array | nil
| | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | Type | Method | | Description | Returns an array of the phonetic symbols recognized by the synthesizer for the current voice. | | Parameters |hs.speech:phonemes
or that you should use for this sound when crafting a phonetic string yourself.hs.speech:pitch([pitch]) -> synthsizerObject | pitch | nil
| | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | Type | Method | | Description | Gets or sets the base pitch for the synthesizer's voice. | | Parameters |hs.speech:rate([rate]) -> synthesizerObject | rate
| | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | Type | Method | | Description | Gets or sets the synthesizers speaking rate (words per minute). | | Parameters |hs.speech:reset() -> synthsizerObject | nil
| | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | Type | Method | | Description | Reset a synthesizer back to its default state. | | Parameters |hs.speech:setCallback(fn) -> synthesizerObject
hs.speech:speak(textToSpeak) -> synthesizerObject
hs.speech:speaking() -> boolean
hs.speech.isAnyApplicationSpeaking
.hs.speech:speakToFile(textToSpeak, destination) -> synthesizerObject
hs.speech:stop([where]) -> synthesizerObject
hs.speech:usesFeedbackWindow([flag]) -> synthesizerObject | boolean
| | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | Type | Method | | Description | Gets or sets whether or not the synthesizer uses the speech feedback window. | | Parameters |hs.speech:voice([full] | [voice]) -> synthesizerObject | voice
| | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | Type | Method | | Description | Gets or sets the active voice for a synthesizer. | | Parameters |com.apple.speech.synthesis.voice.
name
. You can provide this suffix or not as you prefer when specifying a voice name.hs.speech:volume([volume]) -> synthesizerObject | volume
| | -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | Type | Method | | Description | Gets or sets the synthesizers speaking volume. | | Parameters |