AudioContext | typescript

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

Hierarchy

BaseAudioContext
- AudioContext

Index

Properties

BaseAudioContext

BaseAudioContext: object

Type declaration

constructor: function
- new __type(): BaseAudioContext
- - Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:2467
  Returns BaseAudioContext
prototype: BaseAudioContext

audioWorklet

audioWorklet: AudioWorklet

baseLatency

baseLatency: number

currentTime

currentTime: number

destination

destination: AudioDestinationNode

listener

listener: AudioListener

onstatechange

onstatechange: function | null

outputLatency

outputLatency: number

sampleRate

sampleRate: number

state

state: AudioContextState

Methods

addEventListener

addEventListener<K>(type: K, listener: function, options?: boolean | AddEventListenerOptions): void
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void

Overrides BaseAudioContext.addEventListener
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:2195
Type parameters
- K: keyof BaseAudioContextEventMap
Parameters
- type: K
- listener: function
  - - (this: AudioContext, ev: BaseAudioContextEventMap[K]): any
    - Parameters
      - this: AudioContext
      - ev: BaseAudioContextEventMap[K]
      Returns any
- Optional options: boolean | AddEventListenerOptions
Returns void
Overrides BaseAudioContext.addEventListener
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:2196
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void

close

close(): Promise<void>

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:2187
Returns Promise<void>

createAnalyser

createAnalyser(): AnalyserNode

Inherited from BaseAudioContext.createAnalyser
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:2441
Returns AnalyserNode

createBiquadFilter

createBiquadFilter(): BiquadFilterNode

Inherited from BaseAudioContext.createBiquadFilter
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:2442
Returns BiquadFilterNode

createBuffer

createBuffer(numberOfChannels: number, length: number, sampleRate: number): AudioBuffer

Inherited from BaseAudioContext.createBuffer
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:2443
Parameters
- numberOfChannels: number
- length: number
- sampleRate: number
Returns AudioBuffer

createBufferSource

createBufferSource(): AudioBufferSourceNode

Inherited from BaseAudioContext.createBufferSource
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:2444
Returns AudioBufferSourceNode

createChannelMerger

createChannelMerger(numberOfInputs?: number): ChannelMergerNode

Inherited from BaseAudioContext.createChannelMerger
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:2445
Parameters
- Optional numberOfInputs: number
Returns ChannelMergerNode

createChannelSplitter

createChannelSplitter(numberOfOutputs?: number): ChannelSplitterNode

Inherited from BaseAudioContext.createChannelSplitter
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:2446
Parameters
- Optional numberOfOutputs: number
Returns ChannelSplitterNode

createConstantSource

createConstantSource(): ConstantSourceNode

Inherited from BaseAudioContext.createConstantSource
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:2447
Returns ConstantSourceNode

createConvolver

createConvolver(): ConvolverNode

Inherited from BaseAudioContext.createConvolver
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:2448
Returns ConvolverNode

createDelay

createDelay(maxDelayTime?: number): DelayNode

Inherited from BaseAudioContext.createDelay
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:2449
Parameters
- Optional maxDelayTime: number
Returns DelayNode

createDynamicsCompressor

createDynamicsCompressor(): DynamicsCompressorNode

Inherited from BaseAudioContext.createDynamicsCompressor
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:2450
Returns DynamicsCompressorNode

createGain

createGain(): GainNode

Inherited from BaseAudioContext.createGain
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:2451
Returns GainNode

createIIRFilter

createIIRFilter(feedforward: number[], feedback: number[]): IIRFilterNode

Inherited from BaseAudioContext.createIIRFilter
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:2452
Parameters
- feedforward: number[]
- feedback: number[]
Returns IIRFilterNode

createMediaElementSource

createMediaElementSource(mediaElement: HTMLMediaElement): MediaElementAudioSourceNode

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:2188
Parameters
- mediaElement: HTMLMediaElement
Returns MediaElementAudioSourceNode

createMediaStreamDestination

createMediaStreamDestination(): MediaStreamAudioDestinationNode

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:2189
Returns MediaStreamAudioDestinationNode

createMediaStreamSource

createMediaStreamSource(mediaStream: MediaStream): MediaStreamAudioSourceNode

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:2190
Parameters
- mediaStream: MediaStream
Returns MediaStreamAudioSourceNode

createMediaStreamTrackSource

createMediaStreamTrackSource(mediaStreamTrack: MediaStreamTrack): MediaStreamTrackAudioSourceNode

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:2191
Parameters
- mediaStreamTrack: MediaStreamTrack
Returns MediaStreamTrackAudioSourceNode

createOscillator

createOscillator(): OscillatorNode

Inherited from BaseAudioContext.createOscillator
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:2453
Returns OscillatorNode

createPanner

createPanner(): PannerNode

Inherited from BaseAudioContext.createPanner
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:2454
Returns PannerNode

createPeriodicWave

createPeriodicWave(real: number[] | Float32Array, imag: number[] | Float32Array, constraints?: PeriodicWaveConstraints): PeriodicWave

Inherited from BaseAudioContext.createPeriodicWave
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:2455
Parameters
- real: number[] | Float32Array
- imag: number[] | Float32Array
- Optional constraints: PeriodicWaveConstraints
Returns PeriodicWave

createScriptProcessor

createScriptProcessor(bufferSize?: number, numberOfInputChannels?: number, numberOfOutputChannels?: number): ScriptProcessorNode

Inherited from BaseAudioContext.createScriptProcessor
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:2456
Parameters
- Optional bufferSize: number
- Optional numberOfInputChannels: number
- Optional numberOfOutputChannels: number
Returns ScriptProcessorNode

createStereoPanner

createStereoPanner(): StereoPannerNode

Inherited from BaseAudioContext.createStereoPanner
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:2457
Returns StereoPannerNode

createWaveShaper

createWaveShaper(): WaveShaperNode

Inherited from BaseAudioContext.createWaveShaper
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:2458
Returns WaveShaperNode

decodeAudioData

decodeAudioData(audioData: ArrayBuffer, successCallback?: DecodeSuccessCallback | null, errorCallback?: DecodeErrorCallback | null): Promise<AudioBuffer>

Inherited from BaseAudioContext.decodeAudioData
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:2459
Parameters
- audioData: ArrayBuffer
- Optional successCallback: DecodeSuccessCallback | null
- Optional errorCallback: DecodeErrorCallback | null
Returns Promise<AudioBuffer>

dispatchEvent

dispatchEvent(event: Event): boolean

Inherited from EventTarget.dispatchEvent
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5526
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.

Parameters
- event: Event
Returns boolean

getOutputTimestamp

getOutputTimestamp(): AudioTimestamp

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:2192
Returns AudioTimestamp

removeEventListener

removeEventListener<K>(type: K, listener: function, options?: boolean | EventListenerOptions): void
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void

Overrides BaseAudioContext.removeEventListener
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:2197
Type parameters
- K: keyof BaseAudioContextEventMap
Parameters
- type: K
- listener: function
  - - (this: AudioContext, ev: BaseAudioContextEventMap[K]): any
    - Parameters
      - this: AudioContext
      - ev: BaseAudioContextEventMap[K]
      Returns any
- Optional options: boolean | EventListenerOptions
Returns void
Overrides BaseAudioContext.removeEventListener
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:2198
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void

resume

resume(): Promise<void>

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:2193
Returns Promise<void>

suspend

suspend(): Promise<void>

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:2194
Returns Promise<void>

Hierarchy

Index

Properties

Methods

Properties

BaseAudioContext

Type declaration

constructor: function

Returns BaseAudioContext

prototype: BaseAudioContext

audioWorklet

baseLatency

currentTime

destination

listener

onstatechange

outputLatency

sampleRate

state

Methods

addEventListener

Type parameters

K: keyof BaseAudioContextEventMap

Parameters

type: K

listener: function

Parameters

this: AudioContext

ev: BaseAudioContextEventMap[K]

Returns any

Optional options: boolean | AddEventListenerOptions

Returns void

Parameters

type: string

listener: EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

close

Returns Promise<void>

createAnalyser

Returns AnalyserNode

createBiquadFilter

Returns BiquadFilterNode

createBuffer

Parameters

numberOfChannels: number

length: number

sampleRate: number

Returns AudioBuffer

createBufferSource

Returns AudioBufferSourceNode

createChannelMerger

Parameters

Optional numberOfInputs: number

Returns ChannelMergerNode

createChannelSplitter

Parameters

Optional numberOfOutputs: number

Returns ChannelSplitterNode

createConstantSource

Returns ConstantSourceNode

createConvolver

Returns ConvolverNode

createDelay

Parameters

Optional maxDelayTime: number

Returns DelayNode

createDynamicsCompressor

Returns DynamicsCompressorNode

createGain

Returns GainNode

createIIRFilter

Parameters

feedforward: number[]

feedback: number[]

Returns IIRFilterNode

createMediaElementSource

Parameters

mediaElement: HTMLMediaElement

Returns MediaElementAudioSourceNode