Component: Speech ( Data)
From Flowcode Help
Jump to navigationJump to search| Author | MatrixTSL |
| Version | 1.0 |
| Category | Data |
Contents
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
No additional examples
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
