📄 `PositionalAudio.js`¶

📊 Analysis Summary¶

Metric	Count
🔧 Functions	13
🧱 Classes	1
📦 Imports	3
📊 Variables & Constants	6

📚 Table of Contents¶

Imports
Variables & Constants
Functions
Classes

🛠️ File Location:¶

📂 src/audio/PositionalAudio.js

📦 Imports¶

Name	Source
`Vector3`	`../math/Vector3.js`
`Quaternion`	`../math/Quaternion.js`
`Audio`	`./Audio.js`

Variables & Constants¶

Name	Type	Kind	Value	Exported
`_position`	`Vector3`	let/var	`new Vector3()`	✗
`_quaternion`	`Quaternion`	let/var	`new Quaternion()`	✗
`_scale`	`Vector3`	let/var	`new Vector3()`	✗
`_orientation`	`Vector3`	let/var	`new Vector3()`	✗
`panner`	`PannerNode`	let/var	`this.panner`	✗
`endTime`	`any`	let/var	`this.context.currentTime + this.listener.timeDelta`	✗

Functions¶

`PositionalAudio.connect(): this`¶

Returns: this

Calls:

super.connect
this.panner.connect

Code

connect() {

        super.connect();

        this.panner.connect( this.gain );

        return this;

    }

`PositionalAudio.disconnect(): this`¶

Returns: this

Calls:

super.disconnect
this.panner.disconnect

Code

disconnect() {

        super.disconnect();

        this.panner.disconnect( this.gain );

        return this;

    }

`PositionalAudio.getOutput(): PannerNode`¶

Returns: PannerNode

Code

getOutput() {

        return this.panner;

    }

`PositionalAudio.getRefDistance(): number`¶

JSDoc:

/**
     * Returns the current reference distance.
     *
     * @return {number} The reference distance.
     */

Returns: number

Code

getRefDistance() {

        return this.panner.refDistance;

    }

`PositionalAudio.setRefDistance(value: number): PositionalAudio`¶

JSDoc:

/**
     * Defines the reference distance for reducing volume as the audio source moves
     * further from the listener – i.e. the distance at which the volume reduction
     * starts taking effect.
     *
     * @param {number} value - The reference distance to set.
     * @return {PositionalAudio} A reference to this instance.
     */

Parameters:

value number

Returns: PositionalAudio

Code

setRefDistance( value ) {

        this.panner.refDistance = value;

        return this;

    }

`PositionalAudio.getRolloffFactor(): number`¶

JSDoc:

/**
     * Returns the current rolloff factor.
     *
     * @return {number} The rolloff factor.
     */

Returns: number

Code

getRolloffFactor() {

        return this.panner.rolloffFactor;

    }

`PositionalAudio.setRolloffFactor(value: number): PositionalAudio`¶

JSDoc:

/**
     * Defines how quickly the volume is reduced as the source moves away from the listener.
     *
     * @param {number} value - The rolloff factor.
     * @return {PositionalAudio} A reference to this instance.
     */

Parameters:

value number

Returns: PositionalAudio

Code

setRolloffFactor( value ) {

        this.panner.rolloffFactor = value;

        return this;

    }

`PositionalAudio.getDistanceModel(): "linear" | "inverse" | "exponential"`¶

JSDoc:

/**
     * Returns the current distance model.
     *
     * @return {('linear'|'inverse'|'exponential')} The distance model.
     */

Returns: "linear" | "inverse" | "exponential"

Code

getDistanceModel() {

        return this.panner.distanceModel;

    }

`PositionalAudio.setDistanceModel(value: "linear" | "inverse" | "exponential"): PositionalAudio`¶

JSDoc:

/**
     * Defines which algorithm to use to reduce the volume of the audio source
     * as it moves away from the listener.
     *
     * Read [the spec]{@link https://www.w3.org/TR/webaudio-1.1/#enumdef-distancemodeltype}
     * for more details.
     *
     * @param {('linear'|'inverse'|'exponential')} value - The distance model to set.
     * @return {PositionalAudio} A reference to this instance.
     */

Parameters:

value "linear" | "inverse" | "exponential"

Returns: PositionalAudio

Code

setDistanceModel( value ) {

        this.panner.distanceModel = value;

        return this;

    }

`PositionalAudio.getMaxDistance(): number`¶

JSDoc:

/**
     * Returns the current max distance.
     *
     * @return {number} The max distance.
     */

Returns: number

Code

getMaxDistance() {

        return this.panner.maxDistance;

    }

`PositionalAudio.setMaxDistance(value: number): PositionalAudio`¶

JSDoc:

/**
     * Defines the maximum distance between the audio source and the listener,
     * after which the volume is not reduced any further.
     *
     * This value is used only by the `linear` distance model.
     *
     * @param {number} value - The max distance.
     * @return {PositionalAudio} A reference to this instance.
     */

Parameters:

value number

Returns: PositionalAudio

Code

setMaxDistance( value ) {

        this.panner.maxDistance = value;

        return this;

    }

`PositionalAudio.setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): PositionalAudio`¶

JSDoc:

/**
     * Sets the directional cone in which the audio can be listened.
     *
     * @param {number} coneInnerAngle - An angle, in degrees, of a cone inside of which there will be no volume reduction.
     * @param {number} coneOuterAngle - An angle, in degrees, of a cone outside of which the volume will be reduced by a constant value, defined by the `coneOuterGain` parameter.
     * @param {number} coneOuterGain - The amount of volume reduction outside the cone defined by the `coneOuterAngle`. When set to `0`, no sound can be heard.
     * @return {PositionalAudio} A reference to this instance.
     */

Parameters:

coneInnerAngle number
coneOuterAngle number
coneOuterGain number

Returns: PositionalAudio

Code

setDirectionalCone( coneInnerAngle, coneOuterAngle, coneOuterGain ) {

        this.panner.coneInnerAngle = coneInnerAngle;
        this.panner.coneOuterAngle = coneOuterAngle;
        this.panner.coneOuterGain = coneOuterGain;

        return this;

    }

`PositionalAudio.updateMatrixWorld(force: any): void`¶

Parameters:

force any

Returns: void

Calls:

super.updateMatrixWorld
this.matrixWorld.decompose
_orientation.set( 0, 0, 1 ).applyQuaternion
panner.positionX.linearRampToValueAtTime
panner.positionY.linearRampToValueAtTime
panner.positionZ.linearRampToValueAtTime
panner.orientationX.linearRampToValueAtTime
panner.orientationY.linearRampToValueAtTime
panner.orientationZ.linearRampToValueAtTime
panner.setPosition
panner.setOrientation

Internal Comments:

// code path for Chrome and Firefox (see #14393) (x2)

Code

updateMatrixWorld( force ) {

        super.updateMatrixWorld( force );

        if ( this.hasPlaybackControl === true && this.isPlaying === false ) return;

        this.matrixWorld.decompose( _position, _quaternion, _scale );

        _orientation.set( 0, 0, 1 ).applyQuaternion( _quaternion );

        const panner = this.panner;

        if ( panner.positionX ) {

            // code path for Chrome and Firefox (see #14393)

            const endTime = this.context.currentTime + this.listener.timeDelta;

            panner.positionX.linearRampToValueAtTime( _position.x, endTime );
            panner.positionY.linearRampToValueAtTime( _position.y, endTime );
            panner.positionZ.linearRampToValueAtTime( _position.z, endTime );
            panner.orientationX.linearRampToValueAtTime( _orientation.x, endTime );
            panner.orientationY.linearRampToValueAtTime( _orientation.y, endTime );
            panner.orientationZ.linearRampToValueAtTime( _orientation.z, endTime );

        } else {

            panner.setPosition( _position.x, _position.y, _position.z );
            panner.setOrientation( _orientation.x, _orientation.y, _orientation.z );

        }

    }

Classes¶