Tag: WoW API docs |
No edit summary Tag: WoW API docs |
||
| Line 1: | Line 1: | ||
{{wowapi|t=a|namespace=C_VoiceChat|system=VoiceChat}} |
{{wowapi|t=a|namespace=C_VoiceChat|system=VoiceChat}} |
||
| + | Reads text to speech. |
||
| − | Needs summary. |
||
C_VoiceChat.SpeakText(voiceID, text, destination, rate, volume) |
C_VoiceChat.SpeakText(voiceID, text, destination, rate, volume) |
||
| Line 10: | Line 10: | ||
;rate : <span class="apitype">number</span> - Speech rate; the speed at which the text is read. |
;rate : <span class="apitype">number</span> - Speech rate; the speed at which the text is read. |
||
;volume : <span class="apitype">number</span> : <code>[0-100]</code> |
;volume : <span class="apitype">number</span> : <code>[0-100]</code> |
||
| + | |||
| + | ==Details== |
||
| + | * Multiple QueuedLocalMessages may play out of order; the queue is neither FIFO nor LIFO. |
||
==Example== |
==Example== |
||
Revision as of 05:04, 11 January 2022
 |
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
- Multiple QueuedLocalMessages may play out of order; the queue is neither FIFO nor LIFO.
Example
Speaks a message with Microsoft David (enUS).
/run C_VoiceChat.SpeakText(0, "Hello world", Enum.VoiceTtsDestination.LocalPlayback, 0, 100)
Speaks a message with Microsoft Zira (enUS), 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.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||