Class: AudioSystem

Defined in: packages/core/src/audio/audio-system.ts:26

Runtime audio manager that loads sources, pools players, and applies XR-aware behavior.

Remarks

Creates an AudioListener on the player head and resumes/suspends the audio context when XR sessions start/end.
Pools Audio/PositionalAudio instances per entity to minimize allocations and implements play/overlap/fade-restart behaviors.
Optionally culls distant positional audio by a distance multiplier.

Extends

System<{ cullingDistanceMultiplier: { default: number; type: Float32; }; enableDistanceCulling: { default: true; type: Boolean; }; }, { audioEntities: { required: Component<{ _buffer: { default: any; type: Object; }; _fadeIn: { default: number; type: Float32; }; _fadeOut: { default: number; type: Float32; }; _instances: { default: any; type: Object; }; _isPlaying: { default: false; type: Boolean; }; _loaded: { default: false; type: Boolean; }; _loading: { default: false; type: Boolean; }; _pauseRequested: { default: false; type: Boolean; }; _playRequested: { default: false; type: Boolean; }; _pool: { default: any; type: Object; }; _stopRequested: { default: false; type: Boolean; }; autoplay: { default: false; type: Boolean; }; coneInnerAngle: { default: number; type: Float32; }; coneOuterAngle: { default: number; type: Float32; }; coneOuterGain: { default: number; type: Float32; }; crossfadeDuration: { default: number; type: Float32; }; distanceModel: { default: "inverse"; enum: { Exponential: "exponential"; Inverse: "inverse"; Linear: "linear"; }; type: Enum; }; instanceStealPolicy: { default: "oldest"; enum: { Furthest: "furthest"; Oldest: "oldest"; Quietest: "quietest"; }; type: Enum; }; loop: { default: false; type: Boolean; }; maxDistance: { default: number; type: Float32; }; maxInstances: { default: number; type: Int8; }; playbackMode: { default: "restart"; enum: { FadeRestart: "fade-restart"; Ignore: "ignore"; Overlap: "overlap"; Restart: "restart"; }; type: Enum; }; positional: { default: true; type: Boolean; }; refDistance: { default: number; type: Float32; }; rolloffFactor: { default: number; type: Float32; }; src: { default: string; type: String; }; volume: { default: number; type: Float32; }; }>[]; }; }, this>

Constructors

Constructor

new AudioSystem(_w, _qm, _p): AudioSystem

Defined in: node_modules/.pnpm/elics@3.3.0/node_modules/elics/lib/system.d.ts:73

Parameters

_w

World

_qm

QueryManager

_p

number

Returns

AudioSystem

Inherited from

createSystem( { audioEntities: { required: [AudioSource] }, }, { /** Enable distance-based culling for positional audio instances. */ enableDistanceCulling: { type: Types.Boolean, default: true }, /** Multiplier applied to `maxDistance` for culling threshold. */ cullingDistanceMultiplier: { type: Types.Float32, default: 1.5 }, }, ).constructor