tone
Version:
A Web Audio framework for making interactive music in the browser.
91 lines (90 loc) • 2.92 kB
TypeScript
import { Param } from "../../core/context/Param";
import { ToneAudioNode, ToneAudioNodeOptions } from "../../core/context/ToneAudioNode";
import { Degrees, GainFactor } from "../../core/type/Units";
import "../../core/context/Listener";
export interface Panner3DOptions extends ToneAudioNodeOptions {
coneInnerAngle: Degrees;
coneOuterAngle: Degrees;
coneOuterGain: GainFactor;
distanceModel: DistanceModelType;
maxDistance: number;
orientationX: number;
orientationY: number;
orientationZ: number;
panningModel: PanningModelType;
positionX: number;
positionY: number;
positionZ: number;
refDistance: number;
rolloffFactor: number;
}
/**
* A spatialized panner node which supports equalpower or HRTF panning.
* @category Component
*/
export declare class Panner3D extends ToneAudioNode<Panner3DOptions> {
readonly name: string;
/**
* The panning object
*/
private _panner;
readonly input: PannerNode;
readonly output: PannerNode;
readonly positionX: Param<"number">;
readonly positionY: Param<"number">;
readonly positionZ: Param<"number">;
readonly orientationX: Param<"number">;
readonly orientationY: Param<"number">;
readonly orientationZ: Param<"number">;
/**
* @param positionX The initial x position.
* @param positionY The initial y position.
* @param positionZ The initial z position.
*/
constructor(positionX: number, positionY: number, positionZ: number);
constructor(options?: Partial<Panner3DOptions>);
static getDefaults(): Panner3DOptions;
/**
* Sets the position of the source in 3d space.
*/
setPosition(x: number, y: number, z: number): this;
/**
* Sets the orientation of the source in 3d space.
*/
setOrientation(x: number, y: number, z: number): this;
/**
* The panning model. Either "equalpower" or "HRTF".
*/
panningModel: PanningModelType;
/**
* A reference distance for reducing volume as source move further from the listener
*/
refDistance: number;
/**
* Describes how quickly the volume is reduced as source moves away from listener.
*/
rolloffFactor: number;
/**
* The distance model used by, "linear", "inverse", or "exponential".
*/
distanceModel: DistanceModelType;
/**
* The angle, in degrees, inside of which there will be no volume reduction
*/
coneInnerAngle: Degrees;
/**
* The angle, in degrees, outside of which the volume will be reduced
* to a constant value of coneOuterGain
*/
coneOuterAngle: Degrees;
/**
* The gain outside of the coneOuterAngle
*/
coneOuterGain: GainFactor;
/**
* The maximum distance between source and listener,
* after which the volume will not be reduced any further.
*/
maxDistance: number;
dispose(): this;
}