AudioDeviceInput¶
Not yet Class
Produces audio streams from physical devices, such as microphones.
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 · 18 modern Roblox members not implemented yet
Description¶
AudioDeviceInput produces audio streams from physical devices, such as microphones. It provides a single Output pin which can be connected to other pins via Wires. AudioDeviceInput has properties for selecting which Player is producing the stream, and controlling whether or not they are muted.
Inheritance¶
Object → Instance → AudioDeviceInput
Properties¶
| Member | Signature | Summary |
|---|---|---|
AccessList |
AccessList: BinaryString |
— |
AccessType |
AccessType: AccessModifierType |
Determines whether the list of user IDs provided to SetUserIdAccessList is treated as an allow-list or deny-list. |
Active |
Active: bool |
Controls whether the physical device is actively recording. |
DictationEnabled |
DictationEnabled: bool |
— |
EchoCancellation |
EchoCancellation: bool |
— |
GainControl |
GainControl: bool |
— |
IsReady |
IsReady: bool |
Denotes whether this AudioDeviceInput is ready to produce sound. |
Muted |
Muted: bool |
Controls whether this AudioDeviceInput is muted. |
MutedByLocalUser |
MutedByLocalUser: bool |
— |
NoiseSuppression |
NoiseSuppression: bool |
— |
Player |
Player: Player |
Determines whose device is producing sound. |
Volume |
Volume: float |
Volume level which is multiplied onto the output audio stream. |
Methods¶
| Member | Signature | Summary |
|---|---|---|
GetConnectedWires |
AudioDeviceInput:GetConnectedWires(pin: string): Instances |
Returns an array of Wires that are connected to the specified pin. |
GetInputPins |
AudioDeviceInput:GetInputPins(): Array |
Gets the list of pins that Wire can use in Wire.TargetName to connect to this instance via its [Wire.TargetInstance](Wire.md#targetinsta… |
GetOutputPins |
AudioDeviceInput:GetOutputPins(): Array |
Gets the list of pins that Wire can use in Wire.SourceName to connect to this instance via its [Wire.SourceInstance](Wire.md#sourceinsta… |
GetUserIdAccessList |
AudioDeviceInput:GetUserIdAccessList(): Array |
Returns a list of user IDs that are either permitted to hear or blocked from hearing this AudioDeviceInput. |
SetUserIdAccessList |
AudioDeviceInput:SetUserIdAccessList(userIds: Array): null |
Sets a list of user IDs that are either permitted to hear or blocked from hearing this AudioDeviceInput. |
Events¶
| Member | Signature | Summary |
|---|---|---|
WiringChanged |
WiringChanged(connected: bool, pin: string, wire: Wire, instance: Instance) |
Fires when another instance is connected to or disconnected from the AudioDeviceInput via a Wire. |
Roblox reference: AudioDeviceInput
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.