AudioEmitter¶
Not yet Class
Emits audio streams into the 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.
0 Nova members · 28 modern Roblox members not implemented yet
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.
Inheritance¶
Object → Instance → AudioEmitter
Properties¶
| Member | Signature | Summary |
|---|---|---|
AcousticSimulationEnabled |
AcousticSimulationEnabled: bool |
Determines whether acoustic simulation should be used for this AudioEmitter. |
AngleAttenuation |
AngleAttenuation: BinaryString |
Represents how the perceived volume of the emitted sound changes based on the angle between a AudioListener and the [LookVector](../datatypes/CFrame.… |
AudioInteractionGroup |
AudioInteractionGroup: string |
Controls which AudioListeners are capable of hearing this AudioEmitter. |
DiffractionEnabled |
DiffractionEnabled: SimulationMode |
— |
DistanceAttenuation |
DistanceAttenuation: BinaryString |
Represents how the perceived volume of the emitted sound changes as the distance between a AudioListener and the AudioEmitter incr… |
DistanceAttenuationBounds |
DistanceAttenuationBounds: NumberRange |
The minimum and maximum distance range used by the selected DistanceAttenuationMode preset. |
DistanceAttenuationMode |
DistanceAttenuationMode: DistanceAttenuationMode |
Determines how the volume of this AudioEmitter attenuates over distance. |
OcclusionEnabled |
OcclusionEnabled: SimulationMode |
— |
PositionInstance |
PositionInstance: Instance |
The Instance whose position and orientation is used as the emitter's position if PositionType is set to [EmitterPositionTy… |
PositionType |
PositionType: EmitterPositionType |
Determines how the AudioEmitter determines its 3D location. |
ReverbEnabled |
ReverbEnabled: SimulationMode |
— |
SimulationFidelity |
SimulationFidelity: AudioSimulationFidelity |
Controls how detailed the audio simulation should be for this AudioEmitter. |
Methods¶
| Member | Signature | Summary |
|---|---|---|
GetAngleAttenuation |
AudioEmitter:GetAngleAttenuation(): Dictionary |
Gets the angle attenuation curve that the AudioEmitter is using, or an empty table if it's using the default curve. |
GetAudibilityFor |
AudioEmitter:GetAudibilityFor(listener: AudioListener): float |
Calculates how audible this emitter is for a particular AudioListener. |
GetConnectedWires |
AudioEmitter:GetConnectedWires(pin: string): Instances |
Returns an array of Wires that are connected to the specified pin. |
GetDistanceAttenuation |
AudioEmitter:GetDistanceAttenuation(): Dictionary |
Gets the distance attenuation curve that the AudioEmitter is using, or an empty table if it's using the default curve. |
GetInputPins |
AudioEmitter: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… |
GetInteractingListeners |
AudioEmitter:GetInteractingListeners(): Instances |
Lists all AudioListeners that are capable of hearing this emitter. |
GetOutputPins |
AudioEmitter: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… |
SetAngleAttenuation |
AudioEmitter:SetAngleAttenuation(curve: Dictionary): null |
Sets the angle attenuation curve that the AudioEmitter should use, or uses a constant curve of volume 1 if none is provided. |
SetDistanceAttenuation |
AudioEmitter:SetDistanceAttenuation(curve: Dictionary): null |
Sets the distance attenuation curve that the AudioEmitter 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 AudioEmitter via a Wire. |
Roblox reference: AudioEmitter
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.