9 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

AudioDeviceInput

Inherits from: Instance → Object

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.

Inherits from: Instance

Memory category: Internal

Properties

Name	Type / Returns	Description
AudioDeviceInput.AccessType	AccessModifierType	Determines whether the list of user IDs provided to `SetUserIdAccessList` is treated as an allow-list or deny-list.
AudioDeviceInput.Active	boolean	Controls whether the physical device is actively recording.
AudioDeviceInput.IsReady	boolean	Denotes whether this `AudioDeviceInput` is ready to produce sound.
AudioDeviceInput.Muted	boolean	Controls whether this `AudioDeviceInput` is muted.
AudioDeviceInput.Player	Player	Determines whose device is producing sound.
AudioDeviceInput.Volume	float	Volume level which is multiplied onto the output audio stream.

Inherited from Instance

Name	Type / Returns	Description
Instance.Archivable	boolean	Determines if an `Instance` and its descendants can be cloned using `Instance:Clone()`, and can be saved/published.
Instance.archivable	boolean
Instance.Capabilities	SecurityCapabilities	The set of capabilities allowed to be used for scripts inside this container.
Instance.IsInSandbox	boolean	Indicates whether the instance is inside a sandboxed container.
Instance.Name	string	A non-unique identifier of the `Instance`.
Instance.Parent	Instance	Determines the hierarchical parent of the `Instance`.
Instance.PredictionMode	PredictionMode	Reflects the client-side prediction mode applied to the instance under server-authoritative physics.
Instance.RobloxLocked	boolean	A deprecated property that used to protect `CoreGui` objects.
Instance.Sandboxed	boolean	When enabled, the instance can only access abilities in its `Capabilities` list.
Instance.UniqueId	UniqueId	A unique identifier for the instance.

Inherited from Object

Name	Type / Returns	Description
Object.ClassName	string	A read-only string representing the class this `Object` belongs to.
Object.className	string

AudioDeviceInput.AccessType

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.

Field	Value
type	AccessModifierType
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Permissions
serialization	{"can_load":true,"can_save":true}
capabilities	["Audio","Input"]

AudioDeviceInput.Active

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.

Field	Value
type	boolean
security	{"read":"None","write":"RobloxScriptSecurity"}
thread safety	ReadSafe
category	Recording
serialization	{"can_load":true,"can_save":true}
capabilities	["Audio","Input"]

AudioDeviceInput.IsReady

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

Field	Value
type	boolean
tags	["ReadOnly","NotReplicated"]
security	{"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"}
thread safety	ReadSafe
category	Recording
serialization	{"can_load":false,"can_save":true}
capabilities	["Audio","Input"]

AudioDeviceInput.Muted

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.

Field	Value
type	boolean
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Recording
serialization	{"can_load":true,"can_save":true}
capabilities	["Audio","Input"]

Code samples: View on Creator Hub (audio-wiring---push-to-talk).

AudioDeviceInput.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.

Field	Value
type	Player
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Recording
serialization	{"can_load":true,"can_save":true}
capabilities	["Audio","Input","Players"]

AudioDeviceInput.Volume

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

Field	Value
type	float
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	State
serialization	{"can_load":true,"can_save":true}
capabilities	["Audio","Input"]

Methods

Name	Type / Returns	Description
AudioDeviceInput:GetConnectedWires	List	Returns an array of `Wires` that are connected to the specified pin.
AudioDeviceInput:GetInputPins	Array	Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
AudioDeviceInput:GetOutputPins	Array	Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
AudioDeviceInput:GetUserIdAccessList	Array	Returns a list of user IDs that are either permitted to hear or blocked from hearing this `AudioDeviceInput`.
AudioDeviceInput:SetUserIdAccessList	()	Sets a list of user IDs that are either permitted to hear or blocked from hearing this `AudioDeviceInput`.

Inherited from Instance

Name	Type / Returns	Description
Instance:AddTag	()	Applies a tag to the instance.
Instance:children	Instances	Returns an array of the object's children.
Instance:ClearAllChildren	()	This method destroys all of an instance's children.
Instance:Clone	Instance	Create a copy of an instance and all its descendants, ignoring instances that are not `Archivable`.
Instance:clone	Instance
Instance:Destroy	()	Sets the `Instance.Parent` property to `nil`, locks the `Instance.Parent` property, disconnects all connections, and calls `Destroy()` on all children.
Instance:destroy	()
Instance:FindFirstAncestor	Instance?	Returns the first ancestor of the `Instance` whose `Instance.Name` is equal to the given name.
Instance:FindFirstAncestorOfClass	Instance?	Returns the first ancestor of the `Instance` whose `Object.ClassName` is equal to the given className.
Instance:FindFirstAncestorWhichIsA	Instance?	Returns the first ancestor of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstChild	Instance?	Returns the first child of the `Instance` found with the given name.
Instance:findFirstChild	Instance
Instance:FindFirstChildOfClass	Instance?	Returns the first child of the `Instance` whose `ClassName` is equal to the given class name.
Instance:FindFirstChildWhichIsA	Instance?	Returns the first child of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstDescendant	Instance?	Returns the first descendant found with the given `Instance.Name`.
Instance:GetActor	Actor?	Returns the `Actor` associated with the Instance, if any.
Instance:GetAttribute	Variant	Returns the value which has been assigned to the given attribute name.
Instance:GetAttributeChangedSignal	RBXScriptSignal	Returns an event that fires when the given attribute changes.
Instance:GetAttributes	Dictionary	Returns a dictionary of the instance's attributes.
Instance:GetChildren	Instances	Returns an array containing all of the instance's children.
Instance:getChildren	Instances
Instance:GetDebugId	string	Returns a coded string of the debug ID used internally by Roblox.
Instance:GetDescendants	Instances	Returns an array containing all of the descendants of the instance.
Instance:GetFullName	string	Returns a string describing the instance's ancestry.
Instance:GetStyled	Variant	Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Instance:GetStyledPropertyChangedSignal	RBXScriptSignal	Returns an event that fires when the given style property changes on the instance.
Instance:GetTags	Array	Gets an array of all tags applied to the instance.
Instance:HasTag	boolean	Check whether the instance has a given tag.
Instance:IsAncestorOf	boolean	Returns true if an `Instance` is an ancestor of the given descendant.
Instance:IsDescendantOf	boolean	Returns `true` if an `Instance` is a descendant of the given ancestor.
Instance:isDescendantOf	boolean
Instance:IsPropertyModified	boolean	Returns `true` if the value stored in the specified property is not equal to the code-instantiated default.
Instance:QueryDescendants	Instances	Returns an array containing all descendants of the instance that match the `selector` string.
Instance:Remove	()	Sets the object's `Parent` to `nil`, and does the same for all its descendants.
Instance:remove	()
Instance:RemoveTag	()	Removes a tag from the instance.
Instance:ResetPropertyToDefault	()	Resets a property to its default value.
Instance:SetAttribute	()	Sets the attribute with the given name to the given value.
Instance:WaitForChild	Instance	Returns the child of the `Instance` with the given name. If the child does not exist, it will yield the current thread until it does.

Inherited from Object

Name	Type / Returns	Description
Object:GetPropertyChangedSignal	RBXScriptSignal	Get an event that fires when a given property of the object changes.
Object:IsA	boolean	Returns true if an object's class matches or inherits from a given class.
Object:isA	boolean

AudioDeviceInput:GetConnectedWires

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

Parameters

Name	Type	Default	Description
pin	string		An input or output pin on this instance

Returns

Type	Description
List	An array of `Wires`

Field	Value
security	None
thread safety	Unsafe
capabilities	["Audio","Input"]

AudioDeviceInput:GetInputPins

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

For AudioDeviceInput, there are none.

Returns

Type	Description
Array	An array of strings representing valid pin names.

Field	Value
security	None
thread safety	Unsafe
capabilities	["Audio","Input"]

AudioDeviceInput:GetOutputPins

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

For AudioDeviceInput, this is Output only.

Returns

Type	Description
Array	An array of strings representing valid pin names.

Field	Value
security	None
thread safety	Unsafe
capabilities	["Audio","Input"]

AudioDeviceInput:GetUserIdAccessList

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

Returns

Type	Description
Array	An array of user IDs that are either in the allow-list or the deny-list.

Field	Value
security	None
thread safety	Unsafe
capabilities	["Audio","Input"]

AudioDeviceInput:SetUserIdAccessList

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.

Parameters

Name	Type	Default	Description
userIds	Array		An array of user IDs to apply to this `AudioDeviceInput`.

Returns

Type	Description
()	void

Field	Value
security	None
thread safety	Unsafe
capabilities	["Audio","Input"]

Events

Name	Type / Returns	Description
AudioDeviceInput.WiringChanged		Fires when another instance is connected to or disconnected from the `AudioDeviceInput` via a `Wire`.

Inherited from Instance

Name	Type / Returns	Description
Instance.AncestryChanged		Fires when the `Instance.Parent` property of this object or one of its ancestors is changed.
Instance.AttributeChanged		Fires whenever an attribute is changed on the `Instance`.
Instance.ChildAdded		Fires after an object is parented to this `Instance`.
Instance.childAdded
Instance.ChildRemoved		Fires after a child is removed from this `Instance`.
Instance.DescendantAdded		Fires after a descendant is added to the `Instance`.
Instance.DescendantRemoving		Fires immediately before a descendant of the `Instance` is removed.
Instance.Destroying		Fires immediately before (or is deferred until after) the instance is destroyed via `Instance:Destroy()`.
Instance.StyledPropertiesChanged		Fires whenever any style property is changed on the instance, including when a property is set to `nil`.

Inherited from Object

Name	Type / Returns	Description
Object.Changed		Fires immediately after a property of the object changes, with some limitations.

AudioDeviceInput.WiringChanged

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

Parameters

Name	Type	Description
connected	boolean	Whether the instance got connected or disconnected.
pin	string	The pin on the `AudioDeviceInput` that the `Wire` targets.
wire	Wire	The `Wire` between the `AudioDeviceInput` and the other instance.
instance	Instance	The other instance that is or was connected through the `Wire`.

Field	Value
security	None
capabilities	["Audio","Input"]