GMS_HTML5_TTS as well as the Extension, is also composed of Scripts to more easily call the various functions .
Each of them begins with the words "scr_TTS_".
Actually you could use functions directly instead of Scripts, but bearing in mind that a developer could test their game
(in GameMakerStudio ) not only for the HTML5 form, but also using other platforms (Windows, Andorid, etc ...).   This could cause errors, as the functions present in the TTS.js file were created only for the HTML5 module.
For this reason the various Scripts contain the functions of TTS.js, enclosed within a code, which allows their use only :

1. in a browser;
2. in a browser compatible with text-to-speech;
3. in a browser that has at least one voice available;

Code :

1° script

Ini

This first script will need to be called in the Create of the first game object.
It will initialize all the variables useful for the functioning of the text-to-speech,
then it will find all the voices available at that moment and their names.

The main variables of GMS_HTML5_TTS are contained in this script :

To the TTS_Info_Voice_Work variable, through the TTS_Get_Voice_Work () function; will be assigned true or false ( depending on whether the browser is enabled for speech synthesis or not ).  If it returns true, the voices will be heard.


To the TTS_Total_Number_Voice variable, through the TTS_Get_Total_Number_Voice (); function the total number of voices will be assigned.
Usually offline, the most common browsers have 4 or more voices.
When online, however, there may be many more voices.
Each voice is numbered starting from the first which corresponds to the number 0;
This number for the same voice may vary from online to offline, from browser to browser and from country to country :



For each voice found, the TTS_Voice_Name[ ] variables ( arrays ) will be created.
In addition to being numbered, the voices also have their own names.
Then through the function TTS_Get_Voice_Name ( ); we assign the name of the related voice to these variables :
The name of an voices might contain :

• the name of the creator / owner ( Microsoft, Google, etc ... ) ;
• a personal name ( masculine or feminine ) ;
• the language ;
• the nation ;

Here is a possible result :

2° script

Search

If you have a text written in English it is best to have it heard by an English voice.
Through this script you can search for an voice that corresponds to the language of the OS or a specific voice that has the first or second word entered in its name. Then set the TTS_Voice_Selected variable with the number related to that voice.

argument0   =   if set to true, the language of the OS or browser will be searched first and then a check is made to see if an entry is available for that language;
The first search will be performed with the term of Edge;
If it doesn't find it, it searches again but with the Chrome term;
If it still does not find anything then it will search for the word of argumen1;
If it finds nothing again then it will search for the word of argument2;
The search via OS is deliberately limited to only a few main languages present on both Chrome online and Edge online :

Nation	**	Term Edge online	Term Chrome online
German	de-DE	German	Deutsch
Italy	it-IT	Italian	italiano
Poland	pl-PL	Polish	polski
Indonesia	id-ID	Indonesian	Bahasa
Japan	ja-JP	Japanese	日本語
Korea	ko-KR	Korean	한국의
Netherlands	nl-NL	Dutch	Netherlands
India	hi-IN	Hindi	हिन्दी
United Kingdom	en-GB	English (United Kingdom)	UK English
United States	en-US	English (United States)	US English
France	fr-FR	French	français
Brazil	pt-BR	Portuguese (Brazil)	português do Brasil
Russia	ru-RU	Russian (Russia)	русский
Spain	es-ES	Spanish (Spain)	espaňol
Mexico	es-MX	Spanish (Mexico)	espaňol de Estados Unidos
Chinese HK	zh-HK	Chinese (Hong Kong)	粤語（香港）
Chinese CN	zh-CN	Chinese (Mainland)	普通话（中国大陆）
Chinese TW	zh-TW	Chinese (Taiwan)	國語（臺灣）

You can find more names here
Download new voices

argument1   =   word to search for in item names ;
argument2   =   if the first word is not found, this second word will be searched.

Keep in mind that if you search for the voice 'Japanese' on Edge you will only need to search for this word in English, while for Chrome (which shows some names with Japanese, Chinese, Korean symbols and characters, etc ... ), you should look for: '日本語' ;
Also consider that a voice on the various browsers may not correspond to the same number;

Search examples :

• Search for a voice based on the language of the OS only :
  
  scr_TTS_Search ( true , ' ', ' ' );
• Search for an voice based on the OS language, otherwise the entry containing word1 or word2 :
  
  scr_TTS_Search ( true , 'English ( United States )', 'English Female' );
• Search for a voice that contains word1 otherwise word2 :
  
  scr_TTS_Search ( false , ' Italian ', 'Italiano' );
• Search for a voice that contains word1 otherwise symbols or idioms :
  
  scr_TTS_Search ( false , ' Japanese ', '日本語' );

However, it is likely that in some browsers there is not an voice with that specific word and therefore it will be set by default with the number zero ( whatever voice it is ) :   TTS_Voice_Selected = 0;

3° script

Play

Plays text with a certain voice;
Multiple voices cannot be heard at the same time.

argument0 = string with the text;
argument1 = stop the previous voice( true o false ) .

In GameMakerStudio you can use the hashtag # to wrap the text.
However, it could also be read by a voice.
To avoid this, we remove unwanted symbols using this code:

4° script

Pause

argument0 = true    : will pause the voice;
argument0 = false   : will resume the voice from the pause point;

5° script

Stop

Stop, delete the voice;

Demo Play, Pause e Stop

6° script

Speaking

Check if the voice is playing at that moment.
If true returns, the voice is playing;
If false returns, the voice is not playing;

For example, I used this feature in a game to make a character's mouth animate just when his voice could be heard :

8° script

Voice Select

Create a select, with all voices, as selectable options.
It will be external to the canvas and will use the browser font.
For use in the GameMakerStudio STEP event.
argument0 = position x;
argument1 = position y ;

9° script

Voice Button

Add one, more, or all of the clickable buttons, with the names of the voices.
It is possible to use this script several times ( for example to create several buttons in different positions ).
It will be external to the canvas and will use the browser font.
For use in the GameMakerStudio STEP event.
argument0 = position x;
argument1 = position y ;
argument2 = number of voice;
argument2 = TTS_Voice_Selected ;     ( number of the selected voice ) .
argument2 = 10000 ;     create a button for each voice present ;

7° script

Voice List

Draw a scrollable list with all the voices names. Depending on the number of voices present, it may resize the height of the page.html .
It will be external to the canvas and will use the browser font.
For use in the GameMakerStudio DRAW event .
argument0 = position x;
argument1 = position y ;
argument2 = true; ( visible text )   false; ( text not visible )

Result from offline browser, both on Edge, Opera and Chrome (7 Microsoft voices):


Result from online Edge browser ( 76 voices )   e   from Chrome online (26 voices):

As you can see some voices names in the Chrome browser, they report characters that may not be present in the font of your project. In this case, however, the browser's default font will be used, which in theory already contains all those symbols. When you are online this list could resize the page.html, especially in height;

Font Voice List

Drawing the name of a voice inside the canvas implies the use of a GameMakerStudio font and no longer that of the browser. This could create graphic problems if you were to draw the name of a voice with characters / symbols / idioms ( for Chinese, Japanese, Korean, Arabic, etc ... ) as happens on Chrome, which may not be present in your font.

To overcome this we use my sprite as a font, which contains in addition to all the letters and numbers, also some characters / idioms, necessary for the Chrome browser.
However, this does not ensure a 100% perfect result in the various browsers.
In fact, further characters / idioms not present in it, will be invisible :

"Google ไทย"	=	"Google "
" عربي"	=	" "

Report this code in the create of the obj_TTS_Control, to create the font :

Report this code in the scr_TTS_Font_Voice_List script :
Finally add in the room_end event, the following code to destroy the font:

Using this script ( to be inserted in the GameMakerStudio Draw event ), we will then draw inside the canvas, using my sprite as a font :
argument0 = position x;
argument1 = position y ;

argument2 = number of the voice to be drawn;
argument2 = TTS_Voice_Selected ;     ( number of the selected voice ) .
argument2 = 10000 ;     All the voices present will be drawn ( scrollable list from top to bottom, changing the position y ) ;

It is possible to use this script several times ( for example to report names in different positions ).

Flag

We create flags so that the user can select the desired voice.
If a voice for that country is not available, or its argument is set to false , its flag will not be created. The number of selectable flags is 15 Nations :
   argument0 = United Kingdom;
   argument1 = United States;
   argument2 = Italy;
   argument3 = Spain;
   argument4 = France;
   argument5 = German;
   argument6 = Russia;
   argument7 = Brazil;
   argument8 = Japan;
   argument9 = Korean;
   argument10 = Chine;
   argument11 = Hindi;
   argument12 = Pol;
   argument13 = Indonesian;
   argument14 = Netherlands;

Demo Insert Your Name

Have a voice say a player's name after they have typed it in at the beginning of a game.