Component: Speech ( Data): Difference between revisions

Latest revision as of 14:23, 13 July 2026

Author	MatrixTSL
Version	1.0
Category	Data

Speech component

Component that utilises the SpeechSynthesis module of the browser to convert text to audio.

Version information

Library Version, Component Version, Date, Author, Info
1, 1.0, 18-06-24, ST, Created

Detailed description

No detailed description exists yet for this component

Examples

Speech Component Test Example

This example lists the available voices and tests the capabilities of the Speech component.

Speech component test.fcsx

The web app created by this example can be viewed here: Speech component test.html

Macro reference

Cancel

	Cancel
Cancels the current speech and removes all speech fro the queue
- VOID	Return

GetVoiceCount

	GetVoiceCount
Returns the number of available voices.
- LONG	Return

GetVoiceName

	GetVoiceName
Gets the name of the voice from the list of available voices
- LONG	Index
The index of the voice (from 0 to the count of available voices)
- STRING	Return

IsPaused

	IsPaused
Returns true if speech synthesis is currently paused
- BOOL	Return

IsPending

	IsPending
Returns true if there is queued text waiting to be spoken
- BOOL	Return

IsSpeaking

	IsSpeaking
Returns true if there is text currently being spoken, even if speech is currently paused
- BOOL	Return

Pause

	Pause
Puts the speech synthesis into a paused state
- VOID	Return

Resume

	Resume
Puts the speech synthesis into a non-paused state
- VOID	Return

SetLanguage

	SetLanguage

- STRING	Language

- VOID	Return

SetProperties

	SetProperties
Sets the rate, pitch and volume of the speech
- FLOAT	Pitch
Pitch of speech (0.0 to 2.0, or -1 to keep unchanged)
- FLOAT	Rate
Speed of speech (0.1 to 10.0, or -1 to keep unchanged)
- FLOAT	Volume
Volume of speech (0.0 to 1.0, or -1 to keep unchanged)
- VOID	Return

SetVoice

	SetVoice
Sets the voice to use for speech
- LONG	Index
The index of the voice to use (0 to voice count, or -1 for default voice)
- VOID	Return

Speak

	Speak
Sends text to the speech synthesis queue to be spoken. It will be spoken once any other queued speech has been spoken.
- STRING	sText

- VOID	Return

Property reference

	Properties

Component Source Code

Please click here to download the component source project: FC_Comp_Source_WEBEXP_Speech.fcsx

Please click here to view the component source code (Beta): FC_Comp_Source_WEBEXP_Speech.fcsx

@@ Line 28: / Line 28: @@
 ==Examples==
-''<span style="color:red;">No additional examples</span>''
+===Speech Component Test Example===
+This example lists the available voices and tests the capabilities of the Speech component.
+{{Fcfile|Speech component test.fcsx|Speech component test.fcsx}}
+The web app created by this example can be viewed here: [https://www.flowcode.co.uk/example/WebComps/Speech%20component%20test.html Speech component test.html]
 ==Macro reference==
 ===Cancel===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Cancel'''
+| width="90%" class="mtx-class-macrohead" | '''Cancel'''
 |-
 | colspan="2" | Cancels the current speech and removes all speech fro the queue&nbsp;
@@ Line 49: / Line 52: @@
 ===GetVoiceCount===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetVoiceCount'''
+| width="90%" class="mtx-class-macrohead" | '''GetVoiceCount'''
 |-
 | colspan="2" | Returns the number of available voices.&nbsp;
@@ Line 63: / Line 66: @@
 ===GetVoiceName===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetVoiceName'''
+| width="90%" class="mtx-class-macrohead" | '''GetVoiceName'''
 |-
 | colspan="2" | Gets the name of the voice from the list of available voices&nbsp;
@@ Line 82: / Line 85: @@
 ===IsPaused===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''IsPaused'''
+| width="90%" class="mtx-class-macrohead" | '''IsPaused'''
 |-
 | colspan="2" | Returns true if speech synthesis is currently paused&nbsp;
@@ Line 96: / Line 99: @@
 ===IsPending===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''IsPending'''
+| width="90%" class="mtx-class-macrohead" | '''IsPending'''
 |-
 | colspan="2" | Returns true if there is queued text waiting to be spoken&nbsp;
@@ Line 110: / Line 113: @@
 ===IsSpeaking===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''IsSpeaking'''
+| width="90%" class="mtx-class-macrohead" | '''IsSpeaking'''
 |-
 | colspan="2" | Returns true if there is text currently being spoken, even if speech is currently paused&nbsp;
@@ Line 124: / Line 127: @@
 ===Pause===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Pause'''
+| width="90%" class="mtx-class-macrohead" | '''Pause'''
 |-
 | colspan="2" | Puts the speech synthesis into a paused state&nbsp;
@@ Line 138: / Line 141: @@
 ===Resume===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Resume'''
+| width="90%" class="mtx-class-macrohead" | '''Resume'''
 |-
 | colspan="2" | Puts the speech synthesis into a non-paused state&nbsp;
@@ Line 152: / Line 155: @@
 ===SetLanguage===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLanguage'''
+| width="90%" class="mtx-class-macrohead" | '''SetLanguage'''
 |-
 | colspan="2" | &nbsp;
@@ Line 171: / Line 174: @@
 ===SetProperties===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetProperties'''
+| width="90%" class="mtx-class-macrohead" | '''SetProperties'''
 |-
 | colspan="2" | Sets the rate, pitch and volume of the speech&nbsp;
@@ Line 200: / Line 203: @@
 ===SetVoice===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetVoice'''
+| width="90%" class="mtx-class-macrohead" | '''SetVoice'''
 |-
 | colspan="2" | Sets the voice to use for speech&nbsp;
@@ Line 219: / Line 222: @@
 ===Speak===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Speak'''
+| width="90%" class="mtx-class-macrohead" | '''Speak'''
 |-
 | colspan="2" | Sends text to the speech synthesis queue to be spoken. It will be spoken once any other queued speech has been spoken.&nbsp;
@@ Line 239: / Line 242: @@
 ==Property reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+| width="90%" class="mtx-class-macrohead" | '''Properties'''
 |-
 |}

SteveT (talk | contribs)