Reference API Roblox

Engine API

Website

Related

Reference API Roblox

AudioSpeechToText

Converts spoken audio into text.

Memory categoryInternal

Member index 8

HistoryMember
731Enabled: bool
677Text: string
731VoiceDetected: bool
677GetConnectedWires(pin: string): Instances
731GetInputPins(): Array
731GetOutputPins(): Array
677WiringChanged(connected: bool, pin: string, wire: Wire, instance: Instance)
inherited from Instance
731Archivable: bool
731Capabilities: SecurityCapabilities
731IsInSandbox: bool
731Name: string
731Parent: Instance
731PredictionMode: PredictionMode
731Sandboxed: bool
731UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
731children(): Instances
731clone(): Instance
731destroy(): null
731findFirstChild(name: string, recursive: bool = false): Instance
731getChildren(): Instances
731isDescendantOf(ancestor: Instance): bool
731remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
731childAdded(child: Instance)
inherited from Object
731ClassName: string
731className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
731isA(className: string): bool
647Changed(property: string)

Removed member index 1

HistoryMember
724IsDictationEnabled: bool

Description

AudioSpeechToText is used to convert speech audio into text. This class provides a single Input pin that 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 + (5 * number_of_concurrent_users). You can purchase additional usage using Extended Services.

For more information, see Speech-to-text.

History 18

Members 8

Enabled

TypeDefault
boolfalse

Whether the AudioSpeechToText object is enabled for processing input audio into text.

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 3

GetConnectedWires

Parameters (1)
pinstring
Returns (1)
Instances

Returns an array of Wires that are connected to the specified pin. AudioSpeechToText has one "Input" pin.

Thread safetyUnsafe

History 1

GetInputPins

Parameters (0)
No parameters.
Returns (1)
Array

Gets the list of pins that a Wire can use in Wire.TargetName to connect to this instance via its Wire.TargetInstance property.

For AudioSpeechToText, this is Input only.

Thread safetyUnsafe

History 1

GetOutputPins

Parameters (0)
No parameters.
Returns (1)
Array

Gets the list of pins that a Wire can use in Wire.SourceName to connect to this instance via its Wire.SourceInstance property.

For AudioSpeechToText, there are none.

Thread safetyUnsafe

History 1

Text

TypeDefault
string

The text resulting from the conversion of speech audio.

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 1

VoiceDetected

TypeDefault
boolfalse

Whether the AudioSpeechToText object is detecting speech in the incoming audio signal. AudioSpeechToText records the speech audio until it ceases or until a maximum amount of 10 seconds has been recorded. Then it converts the recorded audio into text.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryState
Loaded/Savedfalse/true

History 3

Tags: [ReadOnly, NotReplicated]

WiringChanged

Parameters (4)
connectedbool
pinstring
wireWire
instanceInstance

Event that fires after a Wire becomes connected or disconnected, and that Wire is now or was previously connected to a pin on the AudioSpeechToText and to some other wirable instance.

Thread safetyUnsafe

History 1

Removed members 1

IsDictationEnabled

TypeDefault
boolfalse
SecurityRobloxScriptSecurity
Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 2

Settings