mirror of
https://github.com/rojo-rbx/rojo.git
synced 2026-10-24 06:34:09 +00:00
155 lines
4.4 KiB
YAML
155 lines
4.4 KiB
YAML
# This file is automatically generated. Please don't edit it manually.
|
|
# To submit a bug report on the content, see
|
|
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
|
|
|
|
name: AudioSpeechToText
|
|
type: class
|
|
memory_category: Internal
|
|
summary: |
|
|
Converts spoken audio into text.
|
|
description: |
|
|
`Class.AudioSpeechToText` is used to convert speech audio into text. This
|
|
class provides a single **Input** pin that can be connected to other pins via
|
|
`Class.Wire|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)`.
|
|
|
|
For more information, see
|
|
[Speech-to-text](../../../audio/objects.md#speech-to-text).
|
|
code_samples:
|
|
- audio-wiring---speech-to-text
|
|
inherits:
|
|
- Instance
|
|
descendants: []
|
|
tags: []
|
|
deprecation_message: ''
|
|
properties:
|
|
- name: AudioSpeechToText.Enabled
|
|
summary: |
|
|
Whether the `Class.AudioSpeechToText` object is enabled for processing
|
|
input audio into text.
|
|
description: |
|
|
Whether the `Class.AudioSpeechToText` object is enabled for processing
|
|
input audio into text.
|
|
code_samples: []
|
|
type: boolean
|
|
tags: []
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: State
|
|
serialization:
|
|
can_load: true
|
|
can_save: true
|
|
capabilities:
|
|
- Audio
|
|
- name: AudioSpeechToText.Text
|
|
summary: |
|
|
The text resulting from the conversion of speech audio.
|
|
description: |
|
|
The text resulting from the conversion of speech audio.
|
|
code_samples: []
|
|
type: string
|
|
tags: []
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: State
|
|
serialization:
|
|
can_load: true
|
|
can_save: true
|
|
capabilities:
|
|
- Audio
|
|
- name: AudioSpeechToText.VoiceDetected
|
|
summary: |
|
|
Whether the `Class.AudioSpeechToText` object is detecting speech in the
|
|
incoming audio signal.
|
|
description: |
|
|
Whether the `Class.AudioSpeechToText` object is detecting speech in the
|
|
incoming audio signal. `Class.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.
|
|
code_samples: []
|
|
type: boolean
|
|
tags:
|
|
- ReadOnly
|
|
- NotReplicated
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: State
|
|
serialization:
|
|
can_load: false
|
|
can_save: true
|
|
capabilities:
|
|
- Audio
|
|
methods:
|
|
- name: AudioSpeechToText:GetConnectedWires
|
|
summary: |
|
|
Returns an array of `Class.Wire|Wires` that are connected to the specified
|
|
pin.
|
|
description: |
|
|
Returns an array of `Class.Wire|Wires` that are connected to the specified
|
|
pin. `Class.AudioSpeechToText` has one input pin.
|
|
code_samples: []
|
|
parameters:
|
|
- name: pin
|
|
type: string
|
|
default:
|
|
summary: ''
|
|
returns:
|
|
- type: Instances
|
|
summary: ''
|
|
tags: []
|
|
deprecation_message: ''
|
|
security: None
|
|
thread_safety: Unsafe
|
|
capabilities:
|
|
- Audio
|
|
events:
|
|
- name: AudioSpeechToText.WiringChanged
|
|
summary: |
|
|
Fires when another instance is connected to or disconnected from the
|
|
`Class.AudioSpeechToText` via a `Class.Wire`.
|
|
description: |
|
|
Event that fires after a `Class.Wire` becomes connected or disconnected,
|
|
and that `Class.Wire` is now or was previously connected to a pin on the
|
|
`Class.AudioSpeechToText` and to some other wirable instance.
|
|
code_samples: []
|
|
parameters:
|
|
- name: connected
|
|
type: boolean
|
|
default:
|
|
summary: |
|
|
Whether the instance got connected or disconnected.
|
|
- name: pin
|
|
type: string
|
|
default:
|
|
summary: |
|
|
The pin on the `Class.AudioSpeechToText` that the `Class.Wire`
|
|
targets.
|
|
- name: wire
|
|
type: Wire
|
|
default:
|
|
summary: |
|
|
The `Class.Wire` between the `Class.AudioSpeechToText` and the other
|
|
instance.
|
|
- name: instance
|
|
type: Instance
|
|
default:
|
|
summary: |
|
|
The other instance that is or was connected through the `Class.Wire`.
|
|
tags: []
|
|
deprecation_message: ''
|
|
security: None
|
|
capabilities:
|
|
- Audio
|
|
callbacks: []
|