@types/three/src/audio/AudioAnalyser.d.ts

TypeScript definitions for three

import { Audio } from "./Audio.js";

/**
 * This class can be used to analyse audio data.
 *
 * ```js
 * // create an AudioListener and add it to the camera
 * const listener = new THREE.AudioListener();
 * camera.add( listener );
 *
 * // create an Audio source
 * const sound = new THREE.Audio( listener );
 *
 * // load a sound and set it as the Audio object's buffer
 * const audioLoader = new THREE.AudioLoader();
 * audioLoader.load( 'sounds/ambient.ogg', function( buffer ) {
 * 	sound.setBuffer( buffer );
 * 	sound.setLoop(true);
 * 	sound.setVolume(0.5);
 * 	sound.play();
 * });
 *
 * // create an AudioAnalyser, passing in the sound and desired fftSize
 * const analyser = new THREE.AudioAnalyser( sound, 32 );
 *
 * // get the average frequency of the sound
 * const data = analyser.getAverageFrequency();
 * ```
 */
export class AudioAnalyser {
    /**
     * Constructs a new audio analyzer.
     *
     * @param {Audio} audio - The audio to analyze.
     * @param {number} [fftSize=2048] - The window size in samples that is used when performing a Fast Fourier Transform (FFT) to get frequency domain data.
     */
    constructor(audio: Audio<AudioNode>, fftSize?: number);
    /**
     * The global audio listener.
     */
    analyser: AnalyserNode;
    /**
     * Holds the analyzed data.
     */
    data: Uint8Array;
    /**
     * Returns an array with frequency data of the audio.
     *
     * Each item in the array represents the decibel value for a specific frequency.
     * The frequencies are spread linearly from 0 to 1/2 of the sample rate.
     * For example, for 48000 sample rate, the last item of the array will represent
     * the decibel value for 24000 Hz.
     *
     * @return {Uint8Array} The frequency data.
     */
    getFrequencyData(): Uint8Array;
    /**
     * Returns the average of the frequencies returned by {@link AudioAnalyser#getFrequencyData}.
     *
     * @return {number} The average frequency.
     */
    getAverageFrequency(): number;
}