Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
AudioTextToSpeech
Inherits from: Instance → Object
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.
For a more in-depth look, see Text-to-speech.
Inherits from: Instance
Memory category: Internal
Code samples: View on Creator Hub (audio-wiring---text-to-speech).
Properties
| Name | Type / Returns | Description |
|---|---|---|
| AudioTextToSpeech.IsLoaded | boolean | Denotes whether the AudioTextToSpeech object is loaded, buffered, and ready to play. |
| AudioTextToSpeech.IsPlaying | boolean | Denotes whether the AudioTextToSpeech object is currently playing. |
| AudioTextToSpeech.Looping | boolean | Controls whether the AudioTextToSpeech object loops. |
| AudioTextToSpeech.Pitch | float | Controls the pitch of the generated speech audio, which will be independent of its speed. |
| AudioTextToSpeech.PlaybackSpeed | float | Controls how quickly the speech audio will be played, which controls its pitch. |
| AudioTextToSpeech.Speed | float | Controls the speed of the generated speech audio, which will be independent of its pitch. |
| AudioTextToSpeech.Text | string | The text to be converted into speech audio by AudioTextToSpeech. |
| AudioTextToSpeech.TimeLength | double | Denotes the length of the generated speech audio. |
| AudioTextToSpeech.TimePosition | double | Tracks the current position of the playhead within the generated speech audio. |
| AudioTextToSpeech.VoiceId | string | The voice style to be used by AudioTextToSpeech. |
| AudioTextToSpeech.Volume | float | Controls how loudly the generated speech audio will be played. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.Archivable | boolean | Determines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published. |
| Instance.archivable | boolean | |
| Instance.Capabilities | SecurityCapabilities | The set of capabilities allowed to be used for scripts inside this container. |
| Instance.IsInSandbox | boolean | Indicates whether the instance is inside a sandboxed container. |
| Instance.Name | string | A non-unique identifier of the Instance. |
| Instance.Parent | Instance | Determines the hierarchical parent of the Instance. |
| Instance.PredictionMode | PredictionMode | Reflects the client-side prediction mode applied to the instance under server-authoritative physics. |
| Instance.RobloxLocked | boolean | A deprecated property that used to protect CoreGui objects. |
| Instance.Sandboxed | boolean | When enabled, the instance can only access abilities in its Capabilities list. |
| Instance.UniqueId | UniqueId | A unique identifier for the instance. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.ClassName | string | A read-only string representing the class this Object belongs to. |
| Object.className | string |
AudioTextToSpeech.IsLoaded
Denotes whether the AudioTextToSpeech object is loaded, buffered, and ready to play. Although uncommon, AudioTextToSpeech objects may have their assets unloaded at runtime if there is extreme memory pressure, in which case IsLoaded will become false.
| Field | Value |
|---|---|
| type | boolean |
| tags | ["ReadOnly","NotReplicated"] |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Asset |
| serialization | {"can_load":false,"can_save":true} |
| capabilities | ["Audio"] |
AudioTextToSpeech.IsPlaying
Denotes whether the AudioTextToSpeech object is currently playing. This property is read-only, but replicates. To play and stop an AudioTextToSpeech object at runtime, use the Play() and Pause() methods.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"None","write":"RobloxEngineSecurity"} |
| thread safety | ReadSafe |
| category | Playback |
| serialization | {"can_load":false,"can_save":false} |
| capabilities | ["Audio"] |
AudioTextToSpeech.Looping
Controls whether the AudioTextToSpeech object loops when exceeding the end of its TimeLength.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Playback |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Audio"] |
AudioTextToSpeech.Pitch
A value in musical semitones. The pitch of the generated speech audio is shifted from its default value by AudioTextToSpeech.Pitch semitones. Ranges from -12.0 to 12.0.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Asset |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Audio"] |
AudioTextToSpeech.PlaybackSpeed
Multiplier controlling how quickly the speech audio will be played, directly controlling its perceived pitch. Ranges from 0 to 20.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Playback |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Audio"] |
AudioTextToSpeech.Speed
Multiplier controlling the speed of the generated speech audio. Ranges from 0.5 to 2.0.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Asset |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Audio"] |
AudioTextToSpeech.Text
The text to be converted into speech audio by AudioTextToSpeech. The text has a maximum length of 300 characters.
| Field | Value |
|---|---|
| type | string |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Asset |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Audio"] |
AudioTextToSpeech.TimeLength
Denotes the generated speech audio in seconds.
| Field | Value |
|---|---|
| type | double |
| tags | ["ReadOnly","NotReplicated"] |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Asset |
| serialization | {"can_load":false,"can_save":true} |
| capabilities | ["Audio"] |
AudioTextToSpeech.TimePosition
Tracks and controls the current position of the playhead within the generated speech audio, in seconds.
| Field | Value |
|---|---|
| type | double |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Playback |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Audio"] |
AudioTextToSpeech.VoiceId
The voice style to be used by AudioTextToSpeech. A list of available voices and their corresponding VoiceIds can be found in the text-to-speech guide.
| Field | Value |
|---|---|
| type | string |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Asset |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Audio"] |
AudioTextToSpeech.Volume
Volume level which is multiplied onto the output audio stream, controlling how loudly the generated speech audio will be played. Ranges from 0 to 3.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | State |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Audio"] |
Methods
| Name | Type / Returns | Description |
|---|---|---|
| AudioTextToSpeech:GetConnectedWires | List | Returns an array of Wires that are connected to the specified pin. |
| 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 property. |
| 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 property. |
| AudioTextToSpeech:GetWaveformAsync | Array | Returns a sampling of the waveform data for the generated audio. |
| AudioTextToSpeech:LoadAsync | AssetFetchStatus | Generates speech audio. |
| AudioTextToSpeech:Pause | () | Pauses the AudioTextToSpeech object wherever its TimePosition is. |
| AudioTextToSpeech:Play | () | Plays the AudioTextToSpeech from wherever its TimePosition is. |
| AudioTextToSpeech:Unload | () | Unload the generated speech audio. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance:AddTag | () | Applies a tag to the instance. |
| Instance:children | Instances | Returns an array of the object's children. |
| Instance:ClearAllChildren | () | This method destroys all of an instance's children. |
| Instance:Clone | Instance | Create a copy of an instance and all its descendants, ignoring instances that are not Archivable. |
| Instance:clone | Instance | |
| Instance:Destroy | () | Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children. |
| Instance:destroy | () | |
| Instance:FindFirstAncestor | Instance? | Returns the first ancestor of the Instance whose Instance.Name is equal to the given name. |
| Instance:FindFirstAncestorOfClass | Instance? | Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className. |
| Instance:FindFirstAncestorWhichIsA | Instance? | Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstChild | Instance? | Returns the first child of the Instance found with the given name. |
| Instance:findFirstChild | Instance | |
| Instance:FindFirstChildOfClass | Instance? | Returns the first child of the Instance whose ClassName is equal to the given class name. |
| Instance:FindFirstChildWhichIsA | Instance? | Returns the first child of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstDescendant | Instance? | Returns the first descendant found with the given Instance.Name. |
| Instance:GetActor | Actor? | Returns the Actor associated with the Instance, if any. |
| Instance:GetAttribute | Variant | Returns the value which has been assigned to the given attribute name. |
| Instance:GetAttributeChangedSignal | RBXScriptSignal | Returns an event that fires when the given attribute changes. |
| Instance:GetAttributes | Dictionary | Returns a dictionary of the instance's attributes. |
| Instance:GetChildren | Instances | Returns an array containing all of the instance's children. |
| Instance:getChildren | Instances | |
| Instance:GetDebugId | string | Returns a coded string of the debug ID used internally by Roblox. |
| Instance:GetDescendants | Instances | Returns an array containing all of the descendants of the instance. |
| Instance:GetFullName | string | Returns a string describing the instance's ancestry. |
| Instance:GetStyled | Variant | Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified. |
| Instance:GetStyledPropertyChangedSignal | RBXScriptSignal | Returns an event that fires when the given style property changes on the instance. |
| Instance:GetTags | Array | Gets an array of all tags applied to the instance. |
| Instance:HasTag | boolean | Check whether the instance has a given tag. |
| Instance:IsAncestorOf | boolean | Returns true if an Instance is an ancestor of the given descendant. |
| Instance:IsDescendantOf | boolean | Returns true if an Instance is a descendant of the given ancestor. |
| Instance:isDescendantOf | boolean | |
| Instance:IsPropertyModified | boolean | Returns true if the value stored in the specified property is not equal to the code-instantiated default. |
| Instance:QueryDescendants | Instances | Returns an array containing all descendants of the instance that match the selector string. |
| Instance:Remove | () | Sets the object's Parent to nil, and does the same for all its descendants. |
| Instance:remove | () | |
| Instance:RemoveTag | () | Removes a tag from the instance. |
| Instance:ResetPropertyToDefault | () | Resets a property to its default value. |
| Instance:SetAttribute | () | Sets the attribute with the given name to the given value. |
| Instance:WaitForChild | Instance | Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object:GetPropertyChangedSignal | RBXScriptSignal | Get an event that fires when a given property of the object changes. |
| Object:IsA | boolean | Returns true if an object's class matches or inherits from a given class. |
| Object:isA | boolean |
AudioTextToSpeech:GetConnectedWires
Returns an array of Wires that are connected to the specified pin. AudioTextToSpeech has one "Output" pin.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| pin | string | An input or output pin on this instance |
Returns
| Type | Description |
|---|---|
| List | An array of Wires |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Audio"] |
AudioTextToSpeech:GetInputPins
Gets the list of pins that a Wire can use in Wire.TargetName to connect to this instance via its Wire.TargetInstance property.
For AudioTextToSpeech, there are none.
Returns
| Type | Description |
|---|---|
| Array | An array of strings representing valid pin names. |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Audio"] |
AudioTextToSpeech:GetOutputPins
Gets the list of pins that a Wire can use in Wire.SourceName to connect to this instance via its Wire.SourceInstance property.
For AudioTextToSpeech, this is Output only.
Returns
| Type | Description |
|---|---|
| Array | An array of strings representing valid pin names. |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Audio"] |
AudioTextToSpeech:GetWaveformAsync
Returns a sampling of the waveform data for the generated text-to-speech audio. This can be used to check the volume of the audio over the course of its duration without playing it.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| timeRange | NumberRange | The start and end time (in seconds) of the segment to read. | |
| samples | int | The number of samples to return for the specified range. |
Returns
| Type | Description |
|---|---|
| Array | A table of samples numbers ranging between -1 and 1 representing the sampled waveform, |
| Field | Value |
|---|---|
| tags | ["Yields"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["Audio"] |
AudioTextToSpeech:LoadAsync
A blocking call that begins the generation of speech audio based on the current parameters. It will yield until the speech generation either completes or fails. Status is returned by an AssetFetchStatus value.
Returns
| Type | Description |
|---|---|
| AssetFetchStatus | An AssetFetchStatus — Success once the speech audio has been generated, or Failure if generation could not be completed. |
| Field | Value |
|---|---|
| tags | ["Yields"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["Audio"] |
AudioTextToSpeech:Pause
Pauses the AudioTextToSpeech object wherever its TimePosition is. Replicates from server to client.
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Audio"] |
AudioTextToSpeech:Play
Plays the AudioTextToSpeech from wherever its TimePosition is. Replicates from server to client.
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Audio"] |
AudioTextToSpeech:Unload
Frees resources by unloading the generated speech audio.
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Audio"] |
Events
| Name | Type / Returns | Description |
|---|---|---|
| AudioTextToSpeech.Ended | Fires when the AudioTextToSpeech object has completed playback and paused. | |
| AudioTextToSpeech.Looped | Fires when the AudioTextToSpeech object loops. | |
| AudioTextToSpeech.WiringChanged | Fires when another instance is connected to or disconnected from the AudioTextToSpeech via a Wire. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.AncestryChanged | Fires when the Instance.Parent property of this object or one of its ancestors is changed. | |
| Instance.AttributeChanged | Fires whenever an attribute is changed on the Instance. | |
| Instance.ChildAdded | Fires after an object is parented to this Instance. | |
| Instance.childAdded | ||
| Instance.ChildRemoved | Fires after a child is removed from this Instance. | |
| Instance.DescendantAdded | Fires after a descendant is added to the Instance. | |
| Instance.DescendantRemoving | Fires immediately before a descendant of the Instance is removed. | |
| Instance.Destroying | Fires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy(). | |
| Instance.StyledPropertiesChanged | Fires whenever any style property is changed on the instance, including when a property is set to nil. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.Changed | Fires immediately after a property of the object changes, with some limitations. |
AudioTextToSpeech.Ended
Fires after the AudioTextToSpeech object has completed playback and paused. Note this event will not fire for audio with Looped set to true since it continues playing upon reaching its end. This event will also not fire when the audio is paused before playback has completed; for this, use AudioTextToSpeech:GetPropertyChangedSignal() on the IsPlaying property.
This event may be used to destroy an AudioTextToSpeech object when it has completed playback.
| Field | Value |
|---|---|
| security | None |
| capabilities | ["Audio"] |
AudioTextToSpeech.Looped
Event that fires after the AudioTextToSpeech object loops. This happens when the audio reaches the end of its content and Looping is true.
This event does not fire if the audio is looped manually by changing its TimePosition.
| Field | Value |
|---|---|
| security | None |
| capabilities | ["Audio"] |
AudioTextToSpeech.WiringChanged
Event that fires after a Wire becomes connected or disconnected, and that Wire is now or was previously connected to a pin on the AudioTextToSpeech and to some other wirable instance.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| connected | boolean | Whether the instance got connected or disconnected. | |
| pin | string | The pin on the AudioTextToSpeech that the Wire targets. | |
| wire | Wire | The Wire between the AudioTextToSpeech and the other instance. | |
| instance | Instance | The other instance that is or was connected through the Wire. |
| Field | Value |
|---|---|
| security | None |
| capabilities | ["Audio"] |