Interface AudioContext

    An audio-processing graph built from audio modules linked together, each represented by an AudioNode.

    MDN Reference

    interface AudioContext {
        audioWorklet: AudioWorklet;
        baseLatency: number;
        currentTime: number;
        destination: AudioDestinationNode;
        listener: AudioListener;
        onstatechange: (this: BaseAudioContext, ev: Event) => any;
        outputLatency: number;
        sampleRate: number;
        state: AudioContextState;
        addEventListener<K extends "statechange">(
            type: K,
            listener: (this: AudioContext, ev: BaseAudioContextEventMap[K]) => any,
            options?: boolean | AddEventListenerOptions,
        ): void;
        addEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | AddEventListenerOptions,
        ): void;
        close(): Promise<void>;
        createAnalyser(): AnalyserNode;
        createBiquadFilter(): BiquadFilterNode;
        createBuffer(
            numberOfChannels: number,
            length: number,
            sampleRate: number,
        ): AudioBuffer;
        createBufferSource(): AudioBufferSourceNode;
        createChannelMerger(numberOfInputs?: number): ChannelMergerNode;
        createChannelSplitter(numberOfOutputs?: number): ChannelSplitterNode;
        createConstantSource(): ConstantSourceNode;
        createConvolver(): ConvolverNode;
        createDelay(maxDelayTime?: number): DelayNode;
        createDynamicsCompressor(): DynamicsCompressorNode;
        createGain(): GainNode;
        createIIRFilter(feedforward: number[], feedback: number[]): IIRFilterNode;
        createIIRFilter(
            feedforward: Iterable<number>,
            feedback: Iterable<number>,
        ): IIRFilterNode;
        createMediaElementSource(
            mediaElement: HTMLMediaElement,
        ): MediaElementAudioSourceNode;
        createMediaStreamDestination(): MediaStreamAudioDestinationNode;
        createMediaStreamSource(
            mediaStream: MediaStream,
        ): MediaStreamAudioSourceNode;
        createOscillator(): OscillatorNode;
        createPanner(): PannerNode;
        createPeriodicWave(
            real: number[] | Float32Array,
            imag: number[] | Float32Array,
            constraints?: PeriodicWaveConstraints,
        ): PeriodicWave;
        createPeriodicWave(
            real: Iterable<number>,
            imag: Iterable<number>,
            constraints?: PeriodicWaveConstraints,
        ): PeriodicWave;
        createScriptProcessor(
            bufferSize?: number,
            numberOfInputChannels?: number,
            numberOfOutputChannels?: number,
        ): ScriptProcessorNode;
        createStereoPanner(): StereoPannerNode;
        createWaveShaper(): WaveShaperNode;
        decodeAudioData(
            audioData: ArrayBuffer,
            successCallback?: DecodeSuccessCallback,
            errorCallback?: DecodeErrorCallback,
        ): Promise<AudioBuffer>;
        dispatchEvent(event: Event): boolean;
        getOutputTimestamp(): AudioTimestamp;
        removeEventListener<K extends "statechange">(
            type: K,
            listener: (this: AudioContext, ev: BaseAudioContextEventMap[K]) => any,
            options?: boolean | EventListenerOptions,
        ): void;
        removeEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | EventListenerOptions,
        ): void;
        resume(): Promise<void>;
        suspend(): Promise<void>;
    }
    Hierarchy

    Properties

    audioWorklet baseLatency currentTime destination listener onstatechange outputLatency sampleRate state

    Methods

    addEventListener close createAnalyser createBiquadFilter createBuffer createBufferSource createChannelMerger createChannelSplitter createConstantSource createConvolver createDelay createDynamicsCompressor createGain createIIRFilter createMediaElementSource createMediaStreamDestination createMediaStreamSource createOscillator createPanner createPeriodicWave createScriptProcessor createStereoPanner createWaveShaper decodeAudioData dispatchEvent getOutputTimestamp removeEventListener resume suspend

    Properties

    ReadonlyaudioWorklet

    audioWorklet: AudioWorklet

    Available only in secure contexts.

    MDN Reference

    ReadonlybaseLatency

    baseLatency: number

    MDN Reference

    ReadonlycurrentTime

    currentTime: number

    MDN Reference

    Readonlydestination

    destination: AudioDestinationNode

    MDN Reference

    Readonlylistener

    listener: AudioListener

    MDN Reference

    onstatechange

    onstatechange: (this: BaseAudioContext, ev: Event) => any

    MDN Reference

    ReadonlyoutputLatency

    outputLatency: number

    MDN Reference

    ReadonlysampleRate

    sampleRate: number

    MDN Reference

    Readonlystate

    state: AudioContextState

    MDN Reference

    Methods

    addEventListener

    • addEventListener<K extends "statechange">(
          type: K,
          listener: (this: AudioContext, ev: BaseAudioContextEventMap[K]) => any,
          options?: boolean | AddEventListenerOptions,
      ): void

    • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

      The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

      When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

      When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

      When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

      If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

      The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

      MDN Reference

      Type Parameters

      • K extends "statechange"

      Parameters

      Returns void

    • addEventListener(
          type: string,
          listener: EventListenerOrEventListenerObject,
          options?: boolean | AddEventListenerOptions,
      ): void

    • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

      The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

      When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

      When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

      When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

      If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

      The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

      MDN Reference

      Parameters

      Returns void

    close

    createAnalyser

    createBiquadFilter

    createBuffer

    createBufferSource

    createChannelMerger

    createChannelSplitter

    createConstantSource

    createConvolver

    createDelay

    createDynamicsCompressor

    createGain

    createIIRFilter

    createMediaElementSource

    createMediaStreamDestination

    createMediaStreamSource

    createOscillator

    createPanner

    createPeriodicWave

    createScriptProcessor

    createStereoPanner

    createWaveShaper

    decodeAudioData

    dispatchEvent

    • dispatchEvent(event: Event): boolean

    • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

      MDN Reference

      Parameters

      Returns boolean

    getOutputTimestamp

    removeEventListener

    resume

    suspend

    Settings

    Member Visibility

    On This Page

    Properties
    Methods