Interface IAudioEngineV2Options
interface IAudioEngineV2Options {
listenerAutoUpdate: boolean;
listenerEnabled: boolean;
listenerMinUpdateTime: number;
listenerPosition: Vector3;
listenerRotation: Vector3;
listenerRotationQuaternion: Quaternion;
parameterRampDuration: number;
volume: number;
}
listenerAutoUpdate: boolean;
listenerEnabled: boolean;
listenerMinUpdateTime: number;
listenerPosition: Vector3;
listenerRotation: Vector3;
listenerRotationQuaternion: Quaternion;
parameterRampDuration: number;
volume: number;
}
Hierarchy (View Summary)
- ISpatialAudioListenerOptions
- IAudioEngineV2Options
Properties
listener Auto Update
listenerAutoUpdate: boolean
Whether to automatically update the position and rotation of the listener. Defaults to true.
listener Enabled
listenerEnabled: boolean
Set to true to enable the listener. Defaults to false.
listener Min Update Time
listenerMinUpdateTime: number
The minimum update time in seconds of the listener if it is attached to a mesh, scene or transform node. Defaults to 0.
- The listener's position and rotation will not update faster than this time, but they may update slower depending on the frame rate.
listener Position
The listener position. Defaults to (0, 0, 0).
listener Rotation
The listener rotation, as Euler angles. Defaults to (0, 0, 0).
listener Rotation Quaternion
The listener rotation, as a quaternion. Defaults to (0, 0, 0, 1).
parameter Ramp Duration
parameterRampDuration: number
The smoothing duration to use when changing audio parameters, in seconds. Defaults to 0.01 (10 milliseconds).
volume
volume: number
The initial output volume of the audio engine. Defaults to 1.
Options for creating a v2 audio engine.