15 min read

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

AudioEmitter

Inherits from: Instance → Object

AudioEmitter emits audio streams into the world. It provides a single Input pin that can be connected to by one or more Wires. Any streams wired to an AudioEmitter get broadcasted into the world from the emitter's parent's position. If the parent is an Attachment, Camera, or PVInstance, the parent's world-position will be used. If the parent is not one of these classes, the AudioEmitter is effectively silent.

AudioEmitters are heard by AudioListeners in order to implement 3D spatialization.

Inherits from: Instance

Memory category: Internal

Code samples: View on Creator Hub (audio-wiring---multi-emission).

Properties

Name	Type / Returns	Description
AudioEmitter.AcousticSimulationEnabled	boolean	Determines whether acoustic simulation should be used for this `AudioEmitter`.
AudioEmitter.AngleAttenuation	BinaryString	Represents how the perceived volume of the emitted sound changes based on the angle between a `AudioListener` and the `LookVector` associated with the `AudioEmitter`.
AudioEmitter.AudioInteractionGroup	string	Controls which `AudioListeners` are capable of hearing this `AudioEmitter`.
AudioEmitter.DistanceAttenuation	BinaryString	Represents how the perceived volume of the emitted sound changes as the distance between a `AudioListener` and the `AudioEmitter` increases.
AudioEmitter.DistanceAttenuationBounds	NumberRange	The minimum and maximum distance range used by the selected `DistanceAttenuationMode` preset.
AudioEmitter.DistanceAttenuationMode	DistanceAttenuationMode	Determines how the volume of this `AudioEmitter` attenuates over distance.
AudioEmitter.PositionInstance	Instance	The `Instance` whose position and orientation is used as the emitter's position if `PositionType` is set to `EmitterPositionType.Instance`.
AudioEmitter.PositionType	EmitterPositionType	Determines how the `AudioEmitter` determines its 3D location.
AudioEmitter.SimulationFidelity	AudioSimulationFidelity	Controls how detailed the audio simulation should be for this `AudioEmitter`.

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

AudioEmitter.AcousticSimulationEnabled

Determines whether sound from this AudioEmitter shoud automatically implement features of acoustic simulation, such as occlusion (being muffled through walls), diffraction (bending around corners), and reverberation (echoing off of walls), when being heard by an AudioListener. Note that the AudioListener also needs its AcousticSimulationEnabled property set to true for the effects to occur.

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

AudioEmitter.AngleAttenuation

Represents a volume-over-angle curve that affects how loudly a AudioListener will hear the AudioEmitter, based on the angle between them and the LookVector associated with the AudioEmitter.

This property is internal and can't be accessed by scripts; it exists to support replication. See SetAngleAttenuation() for usage details.

Field	Value
type	BinaryString
security	{"read":"RobloxEngineSecurity","write":"RobloxEngineSecurity"}
thread safety	ReadSafe
category	Emission
serialization	{"can_load":true,"can_save":true}
capabilities	["Audio"]

AudioEmitter.AudioInteractionGroup

If an AudioEmitter and an AudioListener share an interaction group, then the listener is capable of hearing the emitter.

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

AudioEmitter.DistanceAttenuation

Represents a volume-over-distance curve that affects how loudly a AudioListener will hear the AudioEmitter, based on the distance between them.

This property is internal and can't be accessed by scripts; it exists to support replication. See SetDistanceAttenuation() for usage details.

Field	Value
type	BinaryString
security	{"read":"RobloxEngineSecurity","write":"RobloxEngineSecurity"}
thread safety	ReadSafe
category	Emission
serialization	{"can_load":true,"can_save":true}
capabilities	["Audio"]

AudioEmitter.DistanceAttenuationBounds

Specifies the NumberRange that defines the minimum and maximum distances for the distance attenuation preset selected by DistanceAttenuationMode. The emitter is at full volume when a AudioListener is within the minimum distance and fully attenuated at or beyond the maximum distance. The attenuation curve between these bounds is determined by the chosen DistanceAttenuationMode.

Defaults to a NumberRange of [4, 10000]. This property is only used when DistanceAttenuationMode is set to a preset other than DistanceAttenuationMode.Custom.

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

AudioEmitter.DistanceAttenuationMode

Determines which formula is used to roll off the perceived volume of this AudioEmitter as the distance from a AudioListener increases, via DistanceAttenuationMode.

When set to any value other than DistanceAttenuationMode.Custom, DistanceAttenuationBounds defines the minimum and maximum distances for the rolloff, and the custom curve set by SetDistanceAttenuation() is ignored. Defaults to DistanceAttenuationMode.Custom.

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

AudioEmitter.PositionInstance

This property is only functional when PositionType is set to EmitterPositionType.Instance. In that scenario, this property determines which Instance will be used to determine the position of spatial audio emitted by the AudioEmitter to be heard by AudioListeners.

If set to an instance without a position or nil, the AudioEmitter will not be heard.

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

AudioEmitter.PositionType

The method by which the AudioEmitter determines its 3D location (the point from which audio can be heard by any nearby AudioListeners). Defaults to EmitterPositionType.Parent.

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

AudioEmitter.SimulationFidelity

Deprecated.

Controls how detailed the audio simulation should be for this AudioEmitter, similar to MeshPart.CollisionFidelity or MeshPart.RenderFidelity.

AudioEmitters and AudioListeners which disagree on the necessary level of detail will use the less-detailed option.

Field	Value
type	AudioSimulationFidelity
tags	["Deprecated"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Simulation
serialization	{"can_load":true,"can_save":true}
capabilities	["Audio"]

Methods

Name	Type / Returns	Description
AudioEmitter:GetAngleAttenuation	Dictionary	Gets the angle attenuation curve that the `AudioEmitter` is using, or an empty table if it's using the default curve.
AudioEmitter:GetAudibilityFor	float	Calculates how audible this emitter is for a particular `AudioListener`.
AudioEmitter:GetConnectedWires	List	Returns an array of `Wires` that are connected to the specified pin.
AudioEmitter:GetDistanceAttenuation	Dictionary	Gets the distance attenuation curve that the `AudioEmitter` is using, or an empty table if it's using the default curve.
AudioEmitter:GetInputPins	Array	Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
AudioEmitter:GetInteractingListeners	List	Lists all `AudioListeners` that are capable of hearing this emitter.
AudioEmitter:GetOutputPins	Array	Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
AudioEmitter:SetAngleAttenuation	()	Sets the angle attenuation curve that the `AudioEmitter` should use, or uses a constant curve of volume `1` if none is provided.
AudioEmitter:SetDistanceAttenuation	()	Sets the distance attenuation curve that the `AudioEmitter` should use, or uses an inverse rolloff curve if none is provided.

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

AudioEmitter:GetAngleAttenuation

Returns a table mapping angle to volume. Keys are numbers between 0 and 180 (inclusive), while values are numbers between 0 and 1 (inclusive) describing how volume attenuates depending on direction. This method returns an empty table if the default angle attenuation curve is being used.

Returns

Type	Description
Dictionary	Table mapping angle to volume, as described above.

Field	Value
tags	["CustomLuaState"]
security	None
thread safety	Unsafe
capabilities	["Audio"]

AudioEmitter:GetAudibilityFor

Calculates how audible this emitter is for a particular AudioListener. The resulting volume, ranging from 0 to 1, accounts for distance and angle attenuation on both the emitter and listener.

Parameters

Name	Type	Default	Description
listener	AudioListener		The `AudioListener` to calculate audibility for.

Returns

Type	Description
float	A number between `0` and `1` representing the combined volume after distance and angle attenuation.

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

AudioEmitter:GetConnectedWires

Returns an array of Wires that are connected to the specified pin. AudioEmitter has one "Input" 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"]

AudioEmitter:GetDistanceAttenuation

Returns a table mapping distance to volume. Keys are numbers greater than or equal to 0, while values are numbers between 0 and 1 (inclusive) describing how volume attenuates over distance. This method returns an empty table if the default distance attenuation curve is being used.

Note that this method always returns the custom curve set by SetDistanceAttenuation(), regardless of the current DistanceAttenuationMode setting. When a preset mode is active, the custom curve is not used for attenuation and this return value may not reflect the active rolloff behavior.

Returns

Type	Description
Dictionary	A table mapping distance to volume, as described above.

Field	Value
tags	["CustomLuaState"]
security	None
thread safety	Unsafe
capabilities	["Audio"]

AudioEmitter:GetInputPins

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

For AudioEmitter, this is Input only.

Returns

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

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

AudioEmitter:GetInteractingListeners

Returns an array of AudioListeners that share an AudioInteractionGroup with the emitter.

Returns

Type	Description
List	An array of `AudioListeners`.

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

AudioEmitter:GetOutputPins

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

For AudioEmitter, there are none.

Returns

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

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

AudioEmitter:SetAngleAttenuation

Sets a volume-over-angle curve that affects how loudly a AudioListener will hear the AudioEmitter, based on the angle between them and the LookVector associated with the AudioEmitter. Use this to model directional audio sources — for example, making an avatar's voice project more strongly in front of them, or having a monster's growl serve as a gameplay cue that it is facing the player.

The curve is represented by a table mapping angle keys to volume values. Keys are expected to be unique numbers between 0 and 180 (inclusive), while values are expected to be numbers between 0 and 1 (inclusive). Tables containing up to 400 key-value pairs are supported.

The volume of the AudioEmitter from the perspective of a AudioListener at an angle a is determined by linearly interpolating between the volume levels for the points on the curve whose angle values are directly above and below a. If there is either no point below a or no point above a, the volume level of the other point is chosen. Essentially, the curve is a sequence of points connected by straight lines, and beyond its left and right endpoints the curve extends outward at their respective volume levels.

This volume will be multiplied with the volumes from all other attenuation curves (including the ones on the receiving AudioListener) to obtain the final audibility.

If the table is empty or nil, the AudioEmitter defaults to using an angle attenuation curve with the constant volume value of 1.

Parameters

Name	Type	Default	Description
curve	Dictionary		A table mapping angle to volume. Keys are numbers between `0` and `180`, values are numbers between `0` and `1`.

Returns

Type	Description
()

Field	Value
tags	["CustomLuaState"]
security	None
thread safety	Unsafe
capabilities	["Audio"]

AudioEmitter:SetDistanceAttenuation

Sets a volume-over-distance curve that affects how loudly a AudioListener will hear the AudioEmitter, based on the distance between them. This curve is only used for attenuation when DistanceAttenuationMode is set to DistanceAttenuationMode.Custom.

The curve is represented by a table mapping distance keys to volume values. Keys are expected to be unique numbers greater than or equal to 0, while values are expected to be numbers between 0 and 1 (inclusive). Tables containing up to 400 key-value pairs are supported.

The volume of the AudioEmitter from the perspective of a AudioListener at a distance d is determined by linearly interpolating between the volume levels for the points on the curve whose distance values are directly above and below d. If there is either no point below d or no point above d, the volume level of the other point is chosen. Essentially, the curve is a sequence of points connected by straight lines, and beyond its left and right endpoints the curve extends outward infinitely at their respective volume levels.

This volume will be multiplied with the volumes from all other attenuation curves (including the ones on the receiving AudioListener) to obtain the final audibility.

If the table is empty or nil, the AudioEmitter defaults to using a distance attenuation curve determined by the inverse-square law.

Parameters

Name	Type	Default	Description
curve	Dictionary		A table mapping distance to volume. Keys are numbers greater than or equal to `0`, values are numbers between `0` and `1`.

Returns

Type	Description
()

Field	Value
tags	["CustomLuaState"]
security	None
thread safety	Unsafe
capabilities	["Audio"]

Code samples: View on Creator Hub (audio-wiring---custom-distance-attenuation).

Events

Name	Type / Returns	Description
AudioEmitter.WiringChanged		Fires when another instance is connected to or disconnected from the `AudioEmitter` 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.

AudioEmitter.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 AudioEmitter 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 `AudioEmitter` that the `Wire` targets.
wire	Wire	The `Wire` between the `AudioEmitter` and the other instance.
instance	Instance	The other instance that is or was connected through the `Wire`.

Field	Value
security	None
capabilities	["Audio"]