Reference API Roblox

Engine API

Website

Related

Reference API Roblox

AudioListener

Records an audio stream from its surrounding AudioEmitters in the 3D world.

This class is not browsable. It is not visible in Studio's object browser.
Tags: [NotBrowsable]

Member index 7

HistoryMember
592AudioInteractionGroup: string
641DistanceAttenuation: BinaryString
593GetAudibilityOf(emitter: AudioEmitter): float
637GetConnectedWires(pin: string): Objects
641GetDistanceAttenuation(): Dictionary
637GetInteractingEmitters(): Objects
641SetDistanceAttenuation(curve: Dictionary): null
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
553className: string
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
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: 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
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

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.

History 15

Members 7

AudioInteractionGroup

TypeDefault
string

Controls which AudioEmitters are audible to this AudioListener. Emitters that share an interaction group can be heard by this Listener.

History 2

DistanceAttenuation

TypeDefault
BinaryString

History 1

GetAudibilityOf

Parameters (1)
emitterAudioEmitter
Returns (1)
float

History 1

GetConnectedWires

Parameters (1)
pinstring
Returns (1)
Objects

History 4

GetDistanceAttenuation

Parameters (0)
No parameters.
Returns (1)
Dictionary
This function has a custom internal state. It may behave in a non-standard way.

History 1

Tags: [CustomLuaState]

GetInteractingEmitters

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

History 3

SetDistanceAttenuation

Parameters (1)
curveDictionary
Returns (1)
null
This function has a custom internal state. It may behave in a non-standard way.

History 1

Tags: [CustomLuaState]

Settings