Class
AudioSpeechToText
Converts spoken audio into text.
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.
Properties 3#
Enabledboolean | Whether the AudioSpeechToText object is enabled for processing
input audio into text.ReadSafe |
Textstring | The text resulting from the conversion of speech audio.ReadSafe |
VoiceDetectedboolean | Whether the AudioSpeechToText object is detecting speech in the
incoming audio signal.ReadSafeReadOnlyNotReplicated |
Enabled: boolean#
ReadSafe
Whether the AudioSpeechToText object is enabled for processing
input audio into text.
Text: string#
ReadSafe
The text resulting from the conversion of speech audio.
VoiceDetected: boolean#
ReadOnlyNotReplicatedReadSafe
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.
Methods 3#
| GetConnectedWires | Returns an array of Wires that are connected to the specified
pin. |
| GetInputPins | Gets the list of pins that a Wire can use in
Wire.TargetName to connect to this instance via its
Wire.TargetInstance property. |
| GetOutputPins | Gets the list of pins that a Wire can use in
Wire.SourceName to connect to this instance via its
Wire.SourceInstance property. |
GetConnectedWires(pin: string): List<Wire>#
Returns an array of Wires that are connected to the specified
pin. AudioSpeechToText has one "Input" pin.
| Name | Type | Default | Description |
|---|---|---|---|
pin | string | An input or output pin on this instance |
Returns
List<Wire>— An array ofWires
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.
For AudioSpeechToText, this is Input only.
Returns
Array— An array of strings representing valid pin names.
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.
For AudioSpeechToText, there are none.
Returns
Array— An array of strings representing valid pin names.
Events 1#
| WiringChanged | Fires when another instance is connected to or disconnected from the
AudioSpeechToText via a Wire. |
WiringChanged(connected: boolean, pin: string, wire: Wire, instance: Instance)#
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.
| Name | Type | Default | Description |
|---|---|---|---|
connected | boolean | Whether the instance got connected or disconnected. | |
pin | string | The pin on the AudioSpeechToText that the Wire
targets. | |
wire | Wire | The Wire between the AudioSpeechToText and the other
instance. | |
instance | Instance | The other instance that is or was connected through the Wire. |
Inherited members#
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild