@@ -5,9 +5,10 @@ memory_category: Internal
55summary : |
66 Used to play text as speech audio.
77description : |
8- `Class.AudioTextToSpeech` is used to play text as speech audio. It provides a single
9- **Output** pin which can be connected to other pins via `Class.Wire|Wires`.
10- This API is still in development and is not yet publicly available
8+ `Class.AudioTextToSpeech` is used to play text as speech audio. It provides a
9+ single **Output** pin which can be connected to other pins via
10+ `Class.Wire|Wires`. This API is still in development and is not yet publicly
11+ available
1112code_samples :
1213 - audio-wiring---text-to-speech
1314inherits :
@@ -18,13 +19,14 @@ deprecation_message: ''
1819properties :
1920 - name : AudioTextToSpeech.IsLoaded
2021 summary : |
21- Denotes whether the `Class.AudioTextToSpeech` object is loaded, buffered, and ready to
22- play.
22+ Denotes whether the `Class.AudioTextToSpeech` object is loaded, buffered,
23+ and ready to play.
2324 description : |
24- Denotes whether the `Class.AudioTextToSpeech` object is loaded, buffered, and ready to
25- play. Although uncommon, `Class.AudioTextToSpeech` objects may have their
26- assets unloaded at runtime if there is extreme memory pressure, in which
27- case `Class.AudioTextToSpeech.IsLoaded|IsLoaded` will become false.
25+ Denotes whether the `Class.AudioTextToSpeech` object is loaded, buffered,
26+ and ready to play. Although uncommon, `Class.AudioTextToSpeech` objects
27+ may have their assets unloaded at runtime if there is extreme memory
28+ pressure, in which case `Class.AudioTextToSpeech.IsLoaded|IsLoaded` will
29+ become false.
2830 code_samples : []
2931 type : boolean
3032 tags :
@@ -46,10 +48,11 @@ properties:
4648 summary : |
4749 Denotes whether the `Class.AudioTextToSpeech` object is currently playing.
4850 description : |
49- Denotes whether the `Class.AudioTextToSpeech` object is currently playing. This
50- property is read-only, but replicates. To play and stop an
51- `Class.AudioTextToSpeech` object at runtime, use the `Class.AudioTextToSpeech:Play()|Play()`
52- and `Class.AudioTextToSpeech:Pause()|Pause()` methods.
51+ Denotes whether the `Class.AudioTextToSpeech` object is currently playing.
52+ This property is read-only, but replicates. To play and stop an
53+ `Class.AudioTextToSpeech` object at runtime, use the
54+ `Class.AudioTextToSpeech:Play()|Play()` and
55+ `Class.AudioTextToSpeech:Pause()|Pause()` methods.
5356 code_samples : []
5457 type : boolean
5558 tags : []
@@ -69,8 +72,8 @@ properties:
6972 summary : |
7073 Controls whether the `Class.AudioTextToSpeech` object loops.
7174 description : |
72- Controls whether the `Class.AudioTextToSpeech` object loops when exceeding the end of
73- its `Class.AudioTextToSpeech.TimeLength|TimeLength`.
75+ Controls whether the `Class.AudioTextToSpeech` object loops when exceeding
76+ the end of its `Class.AudioTextToSpeech.TimeLength|TimeLength`.
7477 code_samples : []
7578 type : boolean
7679 tags : []
@@ -88,10 +91,12 @@ properties:
8891 writeCapabilities : []
8992 - name : AudioTextToSpeech.Pitch
9093 summary : |
91- Controls the pitch of the generated speech audio, which will be independent of its speed.
94+ Controls the pitch of the generated speech audio, which will be
95+ independent of its speed.
9296 description : |
93- A value in musical semitones. The pitch of the generated speech audio is shifted from
94- its default value by `AudioTextToSpeech.Pitch` semitones. Ranges from -12.0 to 12.0.
97+ A value in musical semitones. The pitch of the generated speech audio is
98+ shifted from its default value by `AudioTextToSpeech.Pitch` semitones.
99+ Ranges from -12.0 to 12.0.
95100 code_samples : []
96101 type : float
97102 tags : []
@@ -109,10 +114,11 @@ properties:
109114 writeCapabilities : []
110115 - name : AudioTextToSpeech.PlaybackSpeed
111116 summary : |
112- Controls how quickly the speech audio will be played, which controls its pitch.
117+ Controls how quickly the speech audio will be played, which controls its
118+ pitch.
113119 description : |
114- Multiplier controlling how quickly the speech audio will be played, directly
115- controlling its perceived pitch. Ranges from 0 to 20.
120+ Multiplier controlling how quickly the speech audio will be played,
121+ directly controlling its perceived pitch. Ranges from 0 to 20.
116122 code_samples : []
117123 type : float
118124 tags : []
@@ -130,9 +136,11 @@ properties:
130136 writeCapabilities : []
131137 - name : AudioTextToSpeech.Speed
132138 summary : |
133- Controls the speed of the generated speech audio, which will be independent of its pitch.
139+ Controls the speed of the generated speech audio, which will be
140+ independent of its pitch.
134141 description : |
135- Multiplier controlling the speed of the generated speech audio. Ranges from 0.5 to 2.0.
142+ Multiplier controlling the speed of the generated speech audio. Ranges
143+ from 0.5 to 2.0.
136144 code_samples : []
137145 type : float
138146 tags : []
@@ -147,7 +155,7 @@ properties:
147155 can_save : true
148156 capabilities :
149157 - Audio
150- writeCapabilities : []
158+ writeCapabilities : []
151159 - name : AudioTextToSpeech.Text
152160 summary : |
153161 The text to be converted into speech audio by `Class.AudioTextToSpeech`.
@@ -192,7 +200,8 @@ properties:
192200 writeCapabilities : []
193201 - name : AudioTextToSpeech.TimePosition
194202 summary : |
195- Tracks the current position of the playhead within the generated speech audio.
203+ Tracks the current position of the playhead within the generated speech
204+ audio.
196205 description : |
197206 Tracks and controls the current position of the playhead within the
198207 generated speech audio, in seconds.
@@ -215,7 +224,7 @@ properties:
215224 summary : |
216225 The voice style to be used by `Class.AudioTextToSpeech`.
217226 description : |
218- The voice style to be used by`Class.AudioTextToSpeech`.
227+ The voice style to be used by`Class.AudioTextToSpeech`.
219228 code_samples : []
220229 type : string
221230 tags : []
@@ -275,57 +284,49 @@ methods:
275284 thread_safety : Unsafe
276285 capabilities : []
277286 writeCapabilities : []
278- - name : AudioTextToSpeech:GetWaveformAsync
279- summary : ' '
280- description : ' '
287+ - name : AudioTextToSpeech:Pause
288+ summary : |
289+ Pauses the `Class.AudioTextToSpeech` object wherever its
290+ `Class.AudioTextToSpeech.TimePosition|TimePosition` is.
291+ description : |
292+ Pauses the `Class.AudioTextToSpeech` object wherever its
293+ `Class.AudioTextToSpeech.TimePosition|TimePosition` is. Replicates from
294+ server to client.
281295 code_samples : []
282- parameters :
283- - name : timeRange
284- type : NumberRange
285- default :
286- summary : ' '
287- - name : samples
288- type : int
289- default :
290- summary : ' '
296+ parameters : []
291297 returns :
292- - type : Array
298+ - type : ()
293299 summary : ' '
294- tags :
295- - Yields
300+ tags : []
296301 deprecation_message : ' '
297302 security : None
298303 thread_safety : Unsafe
299304 capabilities : []
300305 writeCapabilities : []
301- - name : AudioTextToSpeech:LoadAsync
306+ - name : AudioTextToSpeech:Play
302307 summary : |
303- Generates speech audio.
308+ Plays the `Class.AudioTextToSpeech` from wherever its
309+ `Class.AudioTextToSpeech.TimePosition|TimePosition` is.
304310 description : |
305- A blocking call that begins the generation of speech audio based on the
306- current parameters. It will yield until the speech generation either
307- completes or fails.
308- Status is returned by an AssetFetchStatus value.
311+ Plays the `Class.AudioTextToSpeech` from wherever its
312+ `Class.AudioTextToSpeech.TimePosition|TimePosition` is. Replicates from
313+ server to client.
309314 code_samples : []
310315 parameters : []
311316 returns :
312- - type : AssetFetchStatus
317+ - type : ()
313318 summary : ' '
314- tags :
315- - Yields
319+ tags : []
316320 deprecation_message : ' '
317321 security : None
318322 thread_safety : Unsafe
319323 capabilities : []
320324 writeCapabilities : []
321- - name : AudioTextToSpeech:Pause
325+ - name : AudioTextToSpeech:Unload
322326 summary : |
323- Pauses the `Class.AudioTextToSpeech` object wherever its
324- `Class.AudioTextToSpeech.TimePosition|TimePosition` is.
327+ Unload the generated speech audio.
325328 description : |
326- Pauses the `Class.AudioTextToSpeech` object wherever its
327- `Class.AudioTextToSpeech.TimePosition|TimePosition` is. Replicates from server
328- to client.
329+ Frees resources by unloading the generated speech audio.
329330 code_samples : []
330331 parameters : []
331332 returns :
@@ -337,36 +338,43 @@ methods:
337338 thread_safety : Unsafe
338339 capabilities : []
339340 writeCapabilities : []
340- - name : AudioTextToSpeech:Play
341- summary : |
342- Plays the `Class.AudioTextToSpeech` from wherever its
343- `Class.AudioTextToSpeech.TimePosition|TimePosition` is.
344- description : |
345- Plays the `Class.AudioTextToSpeech` from wherever its
346- `Class.AudioTextToSpeech.TimePosition|TimePosition` is. Replicates from server
347- to client.
341+ - name : AudioTextToSpeech:GetWaveformAsync
342+ summary : ' '
343+ description : ' '
348344 code_samples : []
349- parameters : []
345+ parameters :
346+ - name : timeRange
347+ type : NumberRange
348+ default :
349+ summary : ' '
350+ - name : samples
351+ type : int
352+ default :
353+ summary : ' '
350354 returns :
351- - type : void
355+ - type : Array
352356 summary : ' '
353- tags : []
357+ tags :
358+ - Yields
354359 deprecation_message : ' '
355360 security : None
356361 thread_safety : Unsafe
357362 capabilities : []
358363 writeCapabilities : []
359- - name : AudioTextToSpeech:Unload
364+ - name : AudioTextToSpeech:LoadAsync
360365 summary : |
361- Unload the generated speech audio.
366+ Generates speech audio.
362367 description : |
363- Frees resources by unloading the generated speech audio.
368+ A blocking call that begins the generation of speech audio based on the
369+ current parameters. It will yield until the speech generation either
370+ completes or fails. Status is returned by an AssetFetchStatus value.
364371 code_samples : []
365372 parameters : []
366373 returns :
367- - type : void
374+ - type : AssetFetchStatus
368375 summary : ' '
369- tags : []
376+ tags :
377+ - Yields
370378 deprecation_message : ' '
371379 security : None
372380 thread_safety : Unsafe
@@ -375,18 +383,19 @@ methods:
375383events :
376384 - name : AudioTextToSpeech.Ended
377385 summary : |
378- Fires when the `Class.AudioTextToSpeech` object has completed playback and paused.
386+ Fires when the `Class.AudioTextToSpeech` object has completed playback and
387+ paused.
379388 description : |
380- Fires after the `Class.AudioTextToSpeech` object has completed playback and paused.
381- Note this event will **not** fire for audio with
382- `Class.AudioTextToSpeech.Looped|Looped` set to `true` since it continues playing
383- upon reaching its end. This event will also **not** fire when the audio is
384- paused before playback has completed; for this, use
389+ Fires after the `Class.AudioTextToSpeech` object has completed playback
390+ and paused. Note this event will **not** fire for audio with
391+ `Class.AudioTextToSpeech.Looped|Looped` set to `true` since it continues
392+ playing upon reaching its end. This event will also **not** fire when the
393+ audio is paused before playback has completed; for this, use
385394 `Class.AudioTextToSpeech:GetPropertyChangedSignal()` on the
386395 `Class.AudioTextToSpeech.IsPlaying|IsPlaying` property.
387396
388- This event is may be used to destroy an `Class.AudioTextToSpeech` object when it has
389- completed playback.
397+ This event is may be used to destroy an `Class.AudioTextToSpeech` object
398+ when it has completed playback.
390399 code_samples : []
391400 parameters : []
392401 tags : []
@@ -399,8 +408,8 @@ events:
399408 summary : |
400409 Fires when the `Class.AudioTextToSpeech` object loops.
401410 description : |
402- Event that fires after the `Class.AudioTextToSpeech` object loops. This happens when
403- the audio reaches the end of its content and
411+ Event that fires after the `Class.AudioTextToSpeech` object loops. This
412+ happens when the audio reaches the end of its content and
404413 `Class.AudioTextToSpeech.Looping|Looping` is `true`.
405414
406415 This event does **not** fire if the audio is looped manually by changing
@@ -432,7 +441,8 @@ events:
432441 type : string
433442 default :
434443 summary : |
435- The pin on the `Class.AudioTextToSpeech` that the `Class.Wire` targets.
444+ The pin on the `Class.AudioTextToSpeech` that the `Class.Wire`
445+ targets.
436446 - name : wire
437447 type : Wire
438448 default :
0 commit comments