AudioTextToSpeech¶

Not yet Class GUI

Plays text as speech audio.

Not implemented yet

This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.

0 Nova members · 30 modern Roblox members not implemented yet

Description¶

AudioTextToSpeech is used to play text as speech audio. It provides a single Output pin which can be connected to other pins via Wires.

Roblox uses the following formula to throttle requests for this API based on the number of players in your experience: max requests per minute per experience = 1 + (6 * number_of_concurrent_users). You can purchase additional usage using Extended Services.

There is also a client-side throttle of 4 requests per second per user.

For a more in-depth look, see Text-to-speech.

Inheritance¶

Object → Instance → AudioTextToSpeech

Properties¶

Member	Signature	Summary
`AutoLocalize`	`AutoLocalize: bool`	Controls whether AudioTextToSpeech.Text is automatically translated into the player's language and routed to an appropriate voice.
`IsLoaded`	`IsLoaded: bool`	Denotes whether the AudioTextToSpeech object is loaded, buffered, and ready to play.
`IsPlaying`	`IsPlaying: bool`	Denotes whether the AudioTextToSpeech object is currently playing.
`Looping`	`Looping: bool`	Controls whether the AudioTextToSpeech object loops.
`Pitch`	`Pitch: float`	Controls the pitch of the generated speech audio, which will be independent of its speed.
`PlaybackSpeed`	`PlaybackSpeed: float`	Controls how quickly the speech audio will be played, which controls its pitch.
`Speed`	`Speed: float`	Controls the speed of the generated speech audio, which will be independent of its pitch.
`Text`	`Text: string`	The text to be converted into speech audio by AudioTextToSpeech.
`TimeLength`	`TimeLength: double`	Denotes the length of the generated speech audio.
`TimePosition`	`TimePosition: double`	Tracks the current position of the playhead within the generated speech audio.
`VoiceId`	`VoiceId: string`	The voice style to be used by AudioTextToSpeech.
`Volume`	`Volume: float`	Controls how loudly the generated speech audio will be played.

Methods¶

Member	Signature	Summary
`GetConnectedWires`	`AudioTextToSpeech:GetConnectedWires(pin: string): Instances`	Returns an array of Wires that are connected to the specified pin.
`GetInputPins`	`AudioTextToSpeech:GetInputPins(): Array`	Gets the list of pins that a Wire can use in Wire.TargetName to connect to this instance via its [Wire.TargetInstance](Wire.md#targetins…
`GetOutputPins`	`AudioTextToSpeech:GetOutputPins(): Array`	Gets the list of pins that a Wire can use in Wire.SourceName to connect to this instance via its [Wire.SourceInstance](Wire.md#sourceins…
`GetWaveformAsync`	`AudioTextToSpeech:GetWaveformAsync(timeRange: NumberRange, samples: int): Array`	Returns a sampling of the waveform data for the generated audio.
`LoadAsync`	`AudioTextToSpeech:LoadAsync(): AssetFetchStatus`	Generates speech audio.
`LoadPlatformAsync`	`AudioTextToSpeech:LoadPlatformAsync(): AssetFetchStatus`	—
`Pause`	`AudioTextToSpeech:Pause(): null`	Pauses the AudioTextToSpeech object wherever its TimePosition is.
`Play`	`AudioTextToSpeech:Play(): null`	Plays the AudioTextToSpeech from wherever its TimePosition is.
`Unload`	`AudioTextToSpeech:Unload(): null`	Unload the generated speech audio.

Events¶

Member	Signature	Summary
`Ended`	`Ended()`	Fires when the AudioTextToSpeech object has completed playback and paused.
`Looped`	`Looped()`	Fires when the AudioTextToSpeech object loops.
`WiringChanged`	`WiringChanged(connected: bool, pin: string, wire: Wire, instance: Instance)`	Fires when another instance is connected to or disconnected from the AudioTextToSpeech via a Wire.

Roblox reference: AudioTextToSpeech

Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.