Manual:Text to Speech Functions - Revision history

Vadi: /* ttsSetVoiceByName */

2022-07-09T09:10:46Z

ttsSetVoiceByName

Vadi: /* ttsSetVoiceByIndex */

2022-07-09T09:10:32Z

ttsSetVoiceByIndex

Vadi: /* ttsSetRate */

2022-07-09T08:51:26Z

ttsSetRate

Vadi: /* ttsSetVoiceByIndex */

2022-07-09T08:32:40Z

ttsSetVoiceByIndex

Vadi: /* ttsSetVoiceByName */

2022-07-09T08:32:22Z

ttsSetVoiceByName

Vadi: /* ttsSetVolume */

2022-07-09T08:25:16Z

ttsSetVolume

Vadi: /* ttsSetRate */

2022-07-09T08:06:25Z

ttsSetRate

Dargoth: /* ttsClearQueue */

2021-06-03T00:41:20Z

ttsClearQueue

Kebap: add description text for page

2021-01-05T10:07:05Z

add description text for page

Vadi: /* Text to Speech Functions */ Update for MudletVersion macro

2021-01-05T08:30:58Z

Text to Speech Functions: Update for MudletVersion macro

@@ Line 401: / Line 401: @@
 ==ttsSetVoiceByName==
 ;ttsSetVoiceByName(name)
-: If you have multiple voices available, and know their name already, you can switch them with this function. On macOS, adjusting the system voice adjusts this value automatically.
+: If you have multiple voices available, and know their name already, you can switch them with this function. On macOS and Windows, adjusting the system voice adjusts this value automatically.
 : Returns true, if the setting was successful, false otherwise.

@@ Line 381: / Line 381: @@
 ==ttsSetVoiceByIndex==
 ;ttsSetVoiceByIndex(index)
-: If you have multiple voices available, you can switch them with this function by giving their index position as seen in the table you receive from ttsGetVoices(). If you know their name, you can also use ttsSetVoiceByName.  On macOS, adjusting the system voice adjusts this value automatically.
+: If you have multiple voices available, you can switch them with this function by giving their index position as seen in the table you receive from ttsGetVoices(). If you know their name, you can also use ttsSetVoiceByName. On macOS and Windows, adjusting the system voice adjusts this value automatically.
 : Returns true, if the setting was successful, errors otherwise.

@@ Line 327: / Line 327: @@
 ==ttsSetRate==
 ;ttsSetRate(rate)
-: Sets the rate or speed of speech playback. On macOS, adjusting the system rate adjusts this value automatically.
+: Sets the rate or speed of speech playback. On macOS and Windows, adjusting the system rate adjusts this value automatically.
 ;Parameters

@@ Line 381: / Line 381: @@
 ==ttsSetVoiceByIndex==
 ;ttsSetVoiceByIndex(index)
-: If you have multiple voices available, you can switch them with this function by giving their index position as seen in the table you receive from ttsGetVoices(). If you know their name, you can also use ttsSetVoiceByName.
+: If you have multiple voices available, you can switch them with this function by giving their index position as seen in the table you receive from ttsGetVoices(). If you know their name, you can also use ttsSetVoiceByName.  On macOS, adjusting the system voice adjusts this value automatically.
 : Returns true, if the setting was successful, errors otherwise.

@@ Line 401: / Line 401: @@
 ==ttsSetVoiceByName==
 ;ttsSetVoiceByName(name)
-: If you have multiple voices available, and know their name already, you can switch them with this function.
+: If you have multiple voices available, and know their name already, you can switch them with this function. On macOS, adjusting the system voice adjusts this value automatically.
 : Returns true, if the setting was successful, false otherwise.

@@ Line 354: / Line 354: @@
 ==ttsSetVolume==
 ;ttsSetVolume(volume)
-: Sets the volume of speech playback.
+: Sets the volume of speech playback. On macOS, adjusting the system rate adjusts this value automatically.
 ;Parameters

@@ Line 23: / Line 23: @@
 : Returns false if an invalid index is given.
-See also:
+: See also: [[#ttsGetQueue|ttsGetQueue]], [[#ttsQueue|ttsQueue]]
 ;Parameters

@@ Line 1: / Line 1: @@
 {{TOC right}}
 = Text to Speech Functions =
-These functions can make Mudlet talk for you (audible sound from written words). The feature is available since Mudlet version 3.17. Check out the [[Manual:Text-to-Speech|Text-To-Speech Manual]] for more detail on how this all works together.
+These functions can make Mudlet talk for you (audible sound from written words). Check out the [[Manual:Text-to-Speech|Text-To-Speech Manual]] for more detail on how this all works together.
 Several [[Manual:Event_Engine|Mudlet events]] are available functionality as well:

@@ Line 27: / Line 27: @@
 : (optional) number. The text at this index position of the queue will be removed. If no number is given, the whole queue is cleared.
-{{note}} Available since Mudlet 3.17
+{{MudletVersion|3.17}}
 ;Example
@@ Line 53: / Line 53: @@
 [[#ttsQueue|ttsQueue]]
-{{note}} Available since Mudlet 3.17
+{{MudletVersion|3.17}}
 ;Example
@@ Line 81: / Line 81: @@
 [[#ttsGetVoices|ttsGetVoices]]
-{{note}} Available since Mudlet 3.17
+{{MudletVersion|3.17}}
 ;Example
@@ Line 97: / Line 97: @@
 [[#ttsSetPitch|ttsSetPitch]]
-{{note}} Available since Mudlet 3.17
+{{MudletVersion|3.17}}
 ;Example
@@ Line 117: / Line 117: @@
 : (optional) number. The text at this index position of the queue will be returned. If no index is given, the whole queue will be returned. If the given index does not exist, the function returns false.
-{{note}} Available since Mudlet 3.17
+{{MudletVersion|3.17}}
 ;Example
@@ Line 139: / Line 139: @@
 [[#ttsSetRate|ttsSetRate]]
-{{note}} Available since Mudlet 3.17
+{{MudletVersion|3.17}}
 ;Example
@@ Line 158: / Line 158: @@
 [[#ttsQueue|ttsQueue]]
-{{note}} Available since Mudlet 3.17
+{{MudletVersion|3.17}}
 ;Example
@@ Line 178: / Line 178: @@
 [[#ttsSetVoiceByIndex|ttsSetVoiceByIndex]]
-{{note}} Available since Mudlet 3.17
+{{MudletVersion|3.17}}
 ;Example
@@ Line 197: / Line 197: @@
 [[#ttsSetVolume|ttsSetVolume]]
-{{note}} Available since Mudlet 3.17
+{{MudletVersion|3.17}}
 ;Example
@@ Line 213: / Line 213: @@
 [[#ttsQueue|ttsQueue]]
-{{note}} Available since Mudlet 3.17
+{{MudletVersion|3.17}}
 ;Example
@@ Line 242: / Line 242: @@
 : (optional) number. The text will be inserted to the queue at this index position. If no index is provided, the text will be added to the end of the queue.
-{{note}} Available since Mudlet 3.17
+{{MudletVersion|3.17}}
 ;Example
@@ Line 264: / Line 264: @@
 [[#ttsQueue|ttsQueue]]
-{{note}} Available since Mudlet 3.17
+{{MudletVersion|3.17}}
 ;Example
@@ Line 286: / Line 286: @@
 : Any written text which you would like to hear spoken to you. You can write literal text, or put in string variables, maybe taken from triggers or aliases, etc.
-{{note}} Available since Mudlet 3.17
+{{MudletVersion|3.17}}
 ;Example
@@ Line 304: / Line 304: @@
 : Number. Should be between 1 and -1, will be limited otherwise.
-{{note}} Available since Mudlet 3.17
+{{MudletVersion|3.17}}
 ;Example
@@ Line 331: / Line 331: @@
 : Number. Should be between 1 and -1, will be limited otherwise.
-{{note}} Available since Mudlet 3.17
+{{MudletVersion|3.17}}
 ;Example
@@ Line 358: / Line 358: @@
 : Number. Should be between 1 and 0, will be limited otherwise.
-{{note}} Available since Mudlet 3.17
+{{MudletVersion|3.17}}
 ;Example
@@ Line 389: / Line 389: @@
 : Number. The voice from this index position of the ttsGetVoices table will be set.
-{{note}} Available since Mudlet 3.17
+{{MudletVersion|3.17}}
 ;Example
@@ Line 409: / Line 409: @@
 : Text. The voice with this exact name will be set.
-{{note}} Available since Mudlet 3.17
+{{MudletVersion|3.17}}
 ;Example
@@ Line 425: / Line 425: @@
 [[#ttsQueue|ttsQueue]]
-{{note}} Available since Mudlet 3.17
+{{MudletVersion|3.17}}
 ;Example