Interface OfflineAudioContext
audioWorklet: AudioWorklet;
currentTime: number;
destination: AudioDestinationNode;
length: number;
listener: AudioListener;
oncomplete: ((this: OfflineAudioContext, ev: OfflineAudioCompletionEvent) => any);
onstatechange: ((this: BaseAudioContext, ev: Event) => any);
sampleRate: number;
state: AudioContextState;
addEventListener<K>(type: K, listener: ((this: OfflineAudioContext, ev: OfflineAudioContextEventMap[K]) => any), options?: boolean | AddEventListenerOptions): void;
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): 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, any, any>, feedback: Iterable<number, any, any>): IIRFilterNode;
createOscillator(): OscillatorNode;
createPanner(): PannerNode;
createPeriodicWave(real: number[] | Float32Array, imag: number[] | Float32Array, constraints?: PeriodicWaveConstraints): PeriodicWave;
createPeriodicWave(real: Iterable<number, any, any>, imag: Iterable<number, any, any>, 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;
removeEventListener<K>(type: K, listener: ((this: OfflineAudioContext, ev: OfflineAudioContextEventMap[K]) => any), options?: boolean | EventListenerOptions): void;
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
resume(): Promise<void>;
startRendering(): Promise<AudioBuffer>;
suspend(suspendTime: number): Promise<void>;
}
Hierarchy
- BaseAudioContext
- OfflineAudioContext (view full)
Index
Properties
Methods
Properties
ReadonlyaudioWorklet
Available only in secure contexts.
ReadonlycurrentTime
Readonlydestination
Readonlylength
Readonlylistener
oncomplete
onstatechange
ReadonlysampleRate
Readonlystate
Methods
addEventListener
- add
Event <K>(type, listener, options?): voidListener 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.
Type Parameters
- K extends keyof OfflineAudioContextEventMap
Parameters
- type: K
- listener: ((this: OfflineAudioContext, ev: OfflineAudioContextEventMap[K]) => any)
- (this, ev): any
Parameters
- this: OfflineAudioContext
- ev: OfflineAudioContextEventMap[K]
Returns any
Optionaloptions: boolean | AddEventListenerOptions
Returns void
- add
Event (type, listener, options?): voidListener 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.
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
Optionaloptions: boolean | AddEventListenerOptions
Returns void
createAnalyser
- create
Analyser (): AnalyserNode Returns AnalyserNode
createBiquadFilter
- create
Biquad (): BiquadFilterNodeFilter Returns BiquadFilterNode
createBuffer
- create
Buffer (numberOfChannels, length, sampleRate): AudioBuffer Parameters
- numberOfChannels: number
- length: number
- sampleRate: number
Returns AudioBuffer
createBufferSource
- create
Buffer (): AudioBufferSourceNodeSource Returns AudioBufferSourceNode
createChannelMerger
- create
Channel (numberOfInputs?): ChannelMergerNodeMerger Parameters
OptionalnumberOfInputs: number
Returns ChannelMergerNode
createChannelSplitter
- create
Channel (numberOfOutputs?): ChannelSplitterNodeSplitter Parameters
OptionalnumberOfOutputs: number
Returns ChannelSplitterNode
createConstantSource
- create
Constant (): ConstantSourceNodeSource Returns ConstantSourceNode
createConvolver
- create
Convolver (): ConvolverNode Returns ConvolverNode
createDelay
createDynamicsCompressor
- create
Dynamics (): DynamicsCompressorNodeCompressor Returns DynamicsCompressorNode
createGain
createIIRFilter
- createIIRFilter(feedforward, feedback): IIRFilterNode
Parameters
- feedforward: number[]
- feedback: number[]
Returns IIRFilterNode
- createIIRFilter(feedforward, feedback): IIRFilterNode
Returns IIRFilterNode
createOscillator
- create
Oscillator (): OscillatorNode Returns OscillatorNode
createPanner
- create
Panner (): PannerNode Returns PannerNode
createPeriodicWave
- create
Periodic (real, imag, constraints?): PeriodicWaveWave Parameters
- real: number[] | Float32Array
- imag: number[] | Float32Array
Optionalconstraints: PeriodicWaveConstraints
Returns PeriodicWave
- create
Periodic (real, imag, constraints?): PeriodicWaveWave Parameters
- real: Iterable<number, any, any>
- imag: Iterable<number, any, any>
Optionalconstraints: PeriodicWaveConstraints
Returns PeriodicWave
createScriptProcessor
- create
Script (bufferSize?, numberOfInputChannels?, numberOfOutputChannels?): ScriptProcessorNodeProcessor Parameters
OptionalbufferSize: numberOptionalnumberOfInputChannels: numberOptionalnumberOfOutputChannels: number
Returns ScriptProcessorNode
createStereoPanner
- create
Stereo (): StereoPannerNodePanner Returns StereoPannerNode
createWaveShaper
- create
Wave (): WaveShaperNodeShaper Returns WaveShaperNode
decodeAudioData
- decode
Audio (audioData, successCallback?, errorCallback?): Promise<AudioBuffer>Data Parameters
- audioData: ArrayBuffer
OptionalsuccessCallback: DecodeSuccessCallbackOptionalerrorCallback: DecodeErrorCallback
Returns Promise<AudioBuffer>
dispatchEvent
- dispatch
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.
Parameters
- event: Event
Returns boolean
removeEventListener
- remove
Event <K>(type, listener, options?): voidListener Removes the event listener in target's event listener list with the same type, callback, and options.
Type Parameters
- K extends keyof OfflineAudioContextEventMap
Parameters
- type: K
- listener: ((this: OfflineAudioContext, ev: OfflineAudioContextEventMap[K]) => any)
- (this, ev): any
Parameters
- this: OfflineAudioContext
- ev: OfflineAudioContextEventMap[K]
Returns any
Optionaloptions: boolean | EventListenerOptions
Returns void
- remove
Event (type, listener, options?): voidListener Removes the event listener in target's event listener list with the same type, callback, and options.
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
Optionaloptions: boolean | EventListenerOptions
Returns void
resume
startRendering
- start
Rendering (): Promise<AudioBuffer> Returns Promise<AudioBuffer>
An AudioContext interface representing an audio-processing graph built from linked together AudioNodes. In contrast with a standard AudioContext, an OfflineAudioContext doesn't render the audio to the device hardware; instead, it generates it, as fast as it can, and outputs the result to an AudioBuffer.
MDN Reference