 |
Automated updating of API pages at this location, to reflect patch changes, has ceased from 10.1.7 onwards. |
Reads text to speech.
C_VoiceChat.SpeakText(voiceID, text, destination, rate, volume)
Arguments[]
- voiceID
- number - Voice IDs from .GetTtsVoices or .GetRemoteTtsVoices.
- text
- string - The message to speak.
- destination
- Enum.VoiceTtsDestination
| Value | Field | Description |
|---|---|---|
| 0 | RemoteTransmission | |
| 1 | LocalPlayback | |
| 2 | RemoteTransmissionWithLocalPlayback | |
| 3 | QueuedRemoteTransmission | |
| 4 | QueuedLocalPlayback | |
| 5 | QueuedRemoteTransmissionWithLocalPlayback | |
| 6 | ScreenReader |
- rate
- number - Speech rate; the speed at which the text is read.
- volume
- number :
[0-100]
Details[]
- Despite the name, nearly-simultaneous queued messages will play out of order; the 'queue' is neither FIFO or LIFO.
- The languages packs installed will vary, and it is possible for none to be installed. The user's local preferences may be found with C_TTSSettings.GetVoiceOptionID.
Example[]
Speaks a message with Microsoft David (enUS system locale).
/run C_VoiceChat.SpeakText(0, "Hello world", Enum.VoiceTtsDestination.LocalPlayback, 0, 100)
Speaks a message with Microsoft Zira (enUS system locale), with a slower speech rate.
/run C_VoiceChat.SpeakText(1, "Hello world", Enum.VoiceTtsDestination.LocalPlayback, -10, 100)
Patch changes[]
Patch 9.1.0 (2021-06-29): Added.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||