AudioListener¶
Records an audio stream from its surrounding AudioEmitters in the 3D world.
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.
Description¶
AudioListener records an audio stream from its surrounding AudioEmitters in the 3D world. It provides a single Output pin which can be connected to other pins via Wires. If the parent is an Attachment, Camera, or PVInstance, the parent's world CFrame will be used for listening. If the parent is not one of these classes, the AudioListener effectively hears nothing.
Inheritance¶
Object → Instance → AudioListener
Properties¶
| Member | Signature | Summary |
|---|---|---|
AcousticSimulationEnabled |
AcousticSimulationEnabled: bool |
Determines whether acoustic simulation should be used for this AudioListener. |
AngleAttenuation |
AngleAttenuation: BinaryString |
Represents how the perceived volume of the emitted sound changes based on the angle between a AudioEmitter and the [LookVector](../datatypes/CFrame.md… |
AudioInteractionGroup |
AudioInteractionGroup: string |
Controls which AudioEmitters are audible to this AudioListener. |
DiffractionEnabled |
DiffractionEnabled: SimulationMode |
— |
DistanceAttenuation |
DistanceAttenuation: BinaryString |
Represents how the perceived volume of emitted sounds change as the distance between AudioEmitters and the AudioListener increases. |
OcclusionEnabled |
OcclusionEnabled: SimulationMode |
— |
PositionInstance |
PositionInstance: Instance |
The Instance whose position and orientation is used as the listener's position if PositionType is set to [ListenerPositio… |
PositionType |
PositionType: ListenerPositionType |
Determines how the AudioListener determines its 3D location. |
ReverbEnabled |
ReverbEnabled: SimulationMode |
— |
SimulationFidelity |
SimulationFidelity: AudioSimulationFidelity |
Controls how detailed the audio simulation should be for this AudioListener. |
Methods¶
| Member | Signature | Summary |
|---|---|---|
GetAngleAttenuation |
AudioListener:GetAngleAttenuation(): Dictionary |
Gets the angle attenuation curve that the AudioListener is using, or an empty table if it's using the default curve. |
GetAudibilityFor |
AudioListener:GetAudibilityFor(emitter: AudioEmitter): float |
Calculates how audible an AudioEmitter is for this listener |
GetConnectedWires |
AudioListener:GetConnectedWires(pin: string): Instances |
Returns an array of Wires that are connected to the specified pin. |
GetDistanceAttenuation |
AudioListener:GetDistanceAttenuation(): Dictionary |
Gets the distance attenuation curve that the AudioListener is using, or an empty table if it's using the default curve. |
GetInputPins |
AudioListener: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… |
GetInteractingEmitters |
AudioListener:GetInteractingEmitters(): Instances |
Lists all AudioEmitters that this listener is capable of hearing. |
GetOutputPins |
AudioListener: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… |
Reset |
AudioListener:Reset(): null |
— |
SetAngleAttenuation |
AudioListener:SetAngleAttenuation(curve: Dictionary): null |
Sets the angle attenuation curve that the AudioListener should use, or uses a constant curve of volume 1 if none is provided. |
SetDistanceAttenuation |
AudioListener:SetDistanceAttenuation(curve: Dictionary): null |
Sets the distance attenuation curve that the AudioListener should use, or uses an inverse rolloff curve if none is provided. |
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 AudioListener via a Wire. |
Roblox reference: AudioListener
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.