Reference API Roblox

Engine API

Website

Related

Reference API Roblox

AudioDeviceInput

Produces audio streams from physical devices, such as microphones.

This class is not browsable. It is not visible in Studio's object browser.
Memory categoryInternal
Tags: [NotBrowsable]

Member index 10

HistoryMember
592AccessType: AccessModifierType
592Active: bool
592IsReady: bool
592Muted: bool
592Player: Player
629Volume: float
637GetConnectedWires(pin: string): Objects
588GetUserIdAccessList(): Array
588SetUserIdAccessList(userIds: Array): null
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
553className: string
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
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

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.

History 21

Members 10

AccessType

TypeDefault
AccessModifierTypeDeny

Determines whether the list of user IDs provided to SetUserIdAccessList is treated as an allow-list or deny-list.

If AccessType is AccessModifierType.Allow, then only the supplied user IDs are permitted to hear this AudioDeviceInput. If AccessType is AccessModifierType.Deny, then only the supplied user IDs are blocked from hearing this AudioDeviceInput.

Since player voices are networked, this property should only be assigned from the server in order to replicate properly.

Thread safetyReadSafe
CategoryPermissions
Loaded/Savedtrue

History 2

Active

TypeDefault
booltrue

Controls whether the physical device is actively recording. This property is only set by Roblox core scripts, but it may be read by user scripts. Generally, an AudioDeviceInput may only be producing sound if Active is true and Muted is false.

Write securityRobloxScriptSecurity
Thread safetyReadSafe
CategoryRecording
Loaded/Savedtrue

History 2

GetConnectedWires

Parameters (1)
pinstring
Returns (1)
Objects
Thread safetyUnsafe

History 4

GetUserIdAccessList

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

Returns a list of user IDs that are either permitted to hear or blocked from hearing this AudioDeviceInput, depending on the AccessType.

Thread safetyUnsafe

History 1

IsReady

TypeDefault
boolfalse

Denotes whether this AudioDeviceInput is ready to produce sound, meaning all network connections have been established.

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.
SecurityRobloxScriptSecurity
Thread safetyReadSafe
CategoryRecording
Loaded/Savedfalse/true

History 2

Tags: [ReadOnly, NotReplicated]

Muted

TypeDefault
boolfalse

Controls whether this AudioDeviceInput is muted. Unlike Active, this property is publicly scriptable.

Generally, an AudioDeviceInput may only be heard if Active is true and Muted is false.

Thread safetyReadSafe
CategoryRecording
Loaded/Savedtrue

History 2

Player

TypeDefault
Player

Determines whose device is producing sound. In order to replicate properly, this should only be assigned from the server. Assigning this property locally generally does not work, unless Player is Players.LocalPlayer.

Thread safetyReadSafe
CategoryRecording
Loaded/Savedtrue

History 2

SetUserIdAccessList

Parameters (1)
userIdsArray
Returns (1)
null

Sets a list of user IDs that are either permitted to hear or blocked from hearing this AudioDeviceInput, depending on the AccessType.

Note that this method replicates from server to client; in general, it should only be called from the server in order to replicate properly.

Thread safetyUnsafe

History 1

Volume

TypeDefault
float1

Volume level which is multiplied onto the output audio stream. Ranges from 0 to 3.

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 1

Settings