Reference API Roblox

Engine API

Website

Related

Reference API Roblox

AudioEmitter

Emits audio streams into the world.

Memory categoryInternal

Member index 12

HistoryMember
648AngleAttenuation: BinaryString
592AudioInteractionGroup: string
625DistanceAttenuation: BinaryString
652SimulationFidelity: AudioSimulationFidelity
648GetAngleAttenuation(): Dictionary
593GetAudibilityFor(listener: AudioListener): float
648GetConnectedWires(pin: string): Instances
620GetDistanceAttenuation(): Dictionary
648GetInteractingListeners(): Instances
648SetAngleAttenuation(curve: Dictionary): null
620SetDistanceAttenuation(curve: Dictionary): null
652WiringChanged(connected: bool, pin: string, wire: Wire, instance: Instance)
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
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
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: 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
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

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.

History 24

Members 12

AngleAttenuation

TypeDefault
BinaryString

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.

SecurityRobloxSecurity
Thread safetyReadSafe
CategoryEmission
Loaded/Savedtrue

History 1

AudioInteractionGroup

TypeDefault
string

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

Thread safetyReadSafe
CategoryInteractions
Loaded/Savedtrue

History 2

DistanceAttenuation

TypeDefault
BinaryString

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.

SecurityRobloxSecurity
Thread safetyReadSafe
CategoryEmission
Loaded/Savedtrue

History 2

GetAngleAttenuation

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

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.

This function has a custom internal state. It may behave in a non-standard way.
Thread safetyUnsafe

History 1

Tags: [CustomLuaState]

GetAudibilityFor

Parameters (1)
listenerAudioListener
Returns (1)
float
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

GetConnectedWires

Parameters (1)
pinstring
Returns (1)
Instances

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

Thread safetyUnsafe

History 5

GetDistanceAttenuation

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

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.

This function has a custom internal state. It may behave in a non-standard way.
Thread safetyUnsafe

History 1

Tags: [CustomLuaState]

GetInteractingListeners

Parameters (0)
No parameters.
Returns (1)
Instances
Thread safetyUnsafe

History 4

SetAngleAttenuation

Parameters (1)
curveDictionary
Returns (1)
null

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.

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.

This function has a custom internal state. It may behave in a non-standard way.
Thread safetyUnsafe

History 1

Tags: [CustomLuaState]

SetDistanceAttenuation

Parameters (1)
curveDictionary
Returns (1)
null

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

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.

This function has a custom internal state. It may behave in a non-standard way.
Thread safetyUnsafe

History 1

Tags: [CustomLuaState]

SimulationFidelity

TypeDefault
AudioSimulationFidelityAutomatic
Thread safetyReadSafe
CategorySimulation
Loaded/Savedtrue

History 1

WiringChanged

Parameters (4)
connectedbool
pinstring
wireWire
instanceInstance

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.

Thread safetyUnsafe

History 1

Settings