Manual:Text-to-Speech - Revision history

Vadi: Update functions for removal of 'speech'

2019-01-30T07:58:27Z

Update functions for removal of 'speech'

Vadi: /* Basics */

2019-01-12T08:04:56Z

Basics

Kebap: Available since Mudlet 3.13 --> 3.16

2018-11-20T23:42:00Z

Available since Mudlet 3.13 --> 3.16

Vadi: /* Advanced */ Start linking to TTS functions

2018-08-10T01:15:50Z

Advanced: Start linking to TTS functions

Kebap: Update version note

2018-08-10T00:15:37Z

Update version note

Kebap: Table of contents to right

2018-08-09T19:38:38Z

Table of contents to right

Vadi: Added initial TTS commands

2018-08-09T15:44:50Z

Added initial TTS commands

New page

== Basics ==
You can make Mudlet speak outloud by doing the following:

<syntaxhighlight lang="lua">
ttsSpeak("Wow my Mudlet can talk!")
</syntaxhighlight>

{{Note}} Available in Mudlet 3.12.

The same works from an alias or a trigger - try adding an alias with a pattern <code>^say (.+)$</code> and the code of:

<syntaxhighlight lang="lua">
ttsSpeak(matches[2])
</syntaxhighlight>

Doing <code>say hello world!</code> will say your text for you. That's all you need to get started!

== Advanced ==
If you've added a few triggers and played around with it for a bit, you might notice one problem - ttsSpeak() is great and simple, but it also won't wait for current spoken text to finish. If you start saying something else in the middle of it, the current speech will be interrupted and the new text will start. Sometimes this is good, sometimes it's not. When you'd like to add text to a queue, you can use ttsQueueSpeech():

<syntaxhighlight lang="lua">
ttsQueueSpeech("We begin with some text")
ttsQueueSpeech("And we continue it without interruption")
</syntaxhighlight>

You can see what's currently in the text queue with ttsGetSpeechQueue(), pause/resume the speech with ttsPauseSpeech()/ttsResumeSpeech(), clear the queue ttsClearQueue(), and get the text that is currently being spoken with ttsGetCurrentLine().

See the current state of the TTS engine (ready, paused, speech started, error, unknown) with ttsGetState().

== Tweaking Text-to-Speech ==
Different voices will be available depending on the computer you use (Windows/macOS/Linux). You can get the list of available voices with ttsGetVoices(), get the current one in use with ttsGetCurrentVoice(), and choose a particular voice with ttsSetVoiceByName()/ttsSetVoiceByIndex().

Once you've set upon using a particular voice, you can tweak the speech speed with ttsSetSpeechRate(), adjust the volume with ttsSetSpeechVolume(), and adjust the pitch with ttsSetSpeechPitch().

== Troubleshooting ==
If Text-to-Speech is not saying anything at all, check that ttsGetVoices() has any voices - they might not be available on your platform.

@@ Line 7: / Line 7: @@
 </syntaxhighlight>
-{{Note}} Available in Mudlet 3.16.
+{{Note}} Available in Mudlet 3.17.
 The same works from an alias or a trigger - try adding an alias with a pattern <code>^say (.+)$</code> and the code of:

@@ Line 7: / Line 7: @@
 </syntaxhighlight>
-{{Note}} Available in Mudlet 3.13.
+{{Note}} Available in Mudlet 3.16.
 The same works from an alias or a trigger - try adding an alias with a pattern <code>^say (.+)$</code> and the code of:

← Older revision		Revision as of 19:38, 9 August 2018
Line 1:		Line 1:
		+	{{TOC right}}
	== Basics ==		== Basics ==
	You can make Mudlet speak outloud by doing the following:		You can make Mudlet speak outloud by doing the following:

@@ Line 18: / Line 18: @@
 == Advanced ==
-If you've added a few triggers and played around with it for a bit, you might notice one problem - [[Manual:Text to Speech Functions#ttsSpeak|ttsSpeak()]] is great and simple, but it also won't wait for current spoken text to finish. If you start saying something else in the middle of it, the current speech will be interrupted and the new text will start. Sometimes this is good, sometimes it's not. When you'd like to add text to a queue, you can use [[Manual:Text to Speech Functions#ttsQueueSpeech|ttsQueueSpeech()]]:
+If you've added a few triggers and played around with it for a bit, you might notice one problem - [[Manual:Text to Speech Functions#ttsSpeak|ttsSpeak()]] is great and simple, but it also won't wait for current spoken text to finish. If you start saying something else in the middle of it, the current speech will be interrupted and the new text will start. Sometimes this is good, sometimes it's not. When you'd like to add text to a queue, you can use [[Manual:Text to Speech Functions#ttsQueue|ttsQueue()]]:
 <syntaxhighlight lang="lua">
-ttsQueueSpeech("We begin with some text")
+ttsQueue("We begin with some text")
-ttsQueueSpeech("And we continue it without interruption")
+ttsQueue("And we continue it without interruption")
 </syntaxhighlight>
-You can see what's currently in the text queue with ttsGetSpeechQueue(), pause/resume the speech with ttsPauseSpeech()/ttsResumeSpeech(), clear the queue ttsClearQueue(), and get the text that is currently being spoken with ttsGetCurrentLine().
+You can see what's currently in the text queue with [[Manual:Text to Speech Functions#ttsGetQueue|ttsGetQueue()]], pause/resume the speech with [[Manual:Text to Speech Functions#ttsPause|ttsPause()]]/[[Manual:Text to Speech Functions#ttsResume|ttsResume()]], clear the queue [[Manual:Text to Speech Functions#ttsClearQueue|ttsClearQueue()]], and get the text that is currently being spoken with [[Manual:Text to Speech Functions#ttsGetCurrentLine|ttsGetCurrentLine()]].
-See the current state of the TTS engine (ready, paused, speech started, error, unknown) with ttsGetState().
+See the current state of the TTS engine (ready, paused, speech started, error, unknown) with [[Manual:Text to Speech Functions#ttsGetState|ttsGetState()]].
 == Tweaking Text-to-Speech ==
-Different voices will be available depending on the computer you use (Windows/macOS/Linux). You can get the list of available voices with ttsGetVoices(), get the current one in use with ttsGetCurrentVoice(), and choose a particular voice with ttsSetVoiceByName()/ttsSetVoiceByIndex().
+Different voices will be available depending on the computer you use (Windows/macOS/Linux). You can get the list of available voices with [[Manual:Text to Speech Functions#ttsGetVoices|ttsGetVoices()]], get the current one in use with [[Manual:Text to Speech Functions#ttsGetCurrentVoice|ttsGetCurrentVoice()]], and choose a particular voice with [[Manual:Text to Speech Functions#ttsSetVoiceByName|ttsSetVoiceByName()]]/[[Manual:Text to Speech Functions#ttsSetVoiceByIndex|ttsSetVoiceByIndex()]].
-Once you've set upon using a particular voice, you can tweak the speech speed with ttsSetSpeechRate(), adjust the volume with ttsSetSpeechVolume(), and adjust the pitch with ttsSetSpeechPitch().
+Once you've set upon using a particular voice, you can tweak the speech speed with [[Manual:Text to Speech Functions#ttsSetRate|ttsSetRate()]], adjust the volume with [[Manual:Text to Speech Functions#ttsSetVolume|ttsSetVolume()]], and adjust the pitch with [[Manual:Text to Speech Functions#ttsSetPitch|ttsSetPitch()]].
 == Troubleshooting ==
-If Text-to-Speech is not saying anything at all, check that ttsGetVoices() has any voices - they might not be available on your platform.
+If Text-to-Speech is not saying anything at all, check that [[Manual:Text to Speech Functions#ttsGetVoices|ttsGetVoices()]] has any voices - they might not be available on your platform.