AudioContext
Values
addEventListener
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.Read more on MDN
letaddEventListener: (WebAPI.WebAudioAPI.audioContext,WebAPI.EventAPI.eventType,WebAPI.EventAPI.eventListener<'event>,~options:WebAPI.EventAPI.addEventListenerOptions=?,)=>unitParameters
WebAPI.WebAudioAPI.audioContextWebAPI.EventAPI.eventTypeWebAPI.EventAPI.eventListener option<WebAPI.EventAPI.addEventListenerOptions >Return type
unitaddEventListenerWithCapture
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.Read more on MDN
letaddEventListenerWithCapture: (WebAPI.WebAudioAPI.audioContext,WebAPI.EventAPI.eventType,WebAPI.EventAPI.eventListener<'event>,)=>unitParameters
WebAPI.WebAudioAPI.audioContextWebAPI.EventAPI.eventTypeWebAPI.EventAPI.eventListenerReturn type
unitasBaseAudioContext
letasBaseAudioContext:WebAPI.WebAudioAPI.audioContext=>WebAPI.WebAudioAPI.baseAudioContextasEventTarget
letasEventTarget:WebAPI.WebAudioAPI.audioContext=>WebAPI.EventAPI.eventTargetclose
letclose:WebAPI.WebAudioAPI.audioContext=>promise<unit>createAnalyser
letcreateAnalyser:WebAPI.WebAudioAPI.audioContext=>WebAPI.WebAudioAPI.analyserNodecreateBiquadFilter
letcreateBiquadFilter:WebAPI.WebAudioAPI.audioContext=>WebAPI.WebAudioAPI.biquadFilterNodecreateBuffer
letcreateBuffer: (WebAPI.WebAudioAPI.audioContext,~numberOfChannels:int,~length:int,~sampleRate:float,)=>WebAPI.WebAudioAPI.audioBuffercreateBufferSource
letcreateBufferSource:WebAPI.WebAudioAPI.audioContext=>WebAPI.WebAudioAPI.audioBufferSourceNodecreateChannelMerger
letcreateChannelMerger: (WebAPI.WebAudioAPI.audioContext,~numberOfInputs:int=?,)=>WebAPI.WebAudioAPI.channelMergerNodeParameters
WebAPI.WebAudioAPI.audioContext option< int >Return type
WebAPI.WebAudioAPI.channelMergerNodecreateChannelSplitter
letcreateChannelSplitter: (WebAPI.WebAudioAPI.audioContext,~numberOfOutputs:int=?,)=>WebAPI.WebAudioAPI.channelSplitterNodeParameters
WebAPI.WebAudioAPI.audioContext option< int >Return type
WebAPI.WebAudioAPI.channelSplitterNodecreateConstantSource
letcreateConstantSource:WebAPI.WebAudioAPI.audioContext=>WebAPI.WebAudioAPI.constantSourceNodecreateConvolver
letcreateConvolver:WebAPI.WebAudioAPI.audioContext=>WebAPI.WebAudioAPI.convolverNodecreateDelay
letcreateDelay: (WebAPI.WebAudioAPI.audioContext,~maxDelayTime:float=?,)=>WebAPI.WebAudioAPI.delayNodecreateDynamicsCompressor
letcreateDynamicsCompressor:WebAPI.WebAudioAPI.audioContext=>WebAPI.WebAudioAPI.dynamicsCompressorNodecreateGain
letcreateGain:WebAPI.WebAudioAPI.audioContext=>WebAPI.WebAudioAPI.gainNodecreateIIRFilter
letcreateIIRFilter: (WebAPI.WebAudioAPI.audioContext,~feedforward:array<float>,~feedback:array<float>,)=>WebAPI.WebAudioAPI.iirFilterNodeParameters
WebAPI.WebAudioAPI.audioContext array< float > array< float >Return type
WebAPI.WebAudioAPI.iirFilterNodecreateMediaElementSource
letcreateMediaElementSource: (WebAPI.WebAudioAPI.audioContext,WebAPI.DOMAPI.htmlMediaElement,)=>WebAPI.WebAudioAPI.mediaElementAudioSourceNodecreateMediaStreamDestination
letcreateMediaStreamDestination:WebAPI.WebAudioAPI.audioContext=>WebAPI.WebAudioAPI.mediaStreamAudioDestinationNodeParameters
WebAPI.WebAudioAPI.audioContextReturn type
WebAPI.WebAudioAPI.mediaStreamAudioDestinationNodecreateMediaStreamSource
letcreateMediaStreamSource: (WebAPI.WebAudioAPI.audioContext,WebAPI.MediaCaptureAndStreamsAPI.mediaStream,)=>WebAPI.WebAudioAPI.mediaStreamAudioSourceNodecreateOscillator
letcreateOscillator:WebAPI.WebAudioAPI.audioContext=>WebAPI.WebAudioAPI.oscillatorNodecreatePanner
letcreatePanner:WebAPI.WebAudioAPI.audioContext=>WebAPI.WebAudioAPI.pannerNodecreatePeriodicWave
letcreatePeriodicWave: (WebAPI.WebAudioAPI.audioContext,~real:array<float>,~imag:array<float>,~constraints:WebAPI.WebAudioAPI.periodicWaveConstraints=?,)=>WebAPI.WebAudioAPI.periodicWaveParameters
WebAPI.WebAudioAPI.audioContext array< float > array< float > option<WebAPI.WebAudioAPI.periodicWaveConstraints >Return type
WebAPI.WebAudioAPI.periodicWavecreateStereoPanner
letcreateStereoPanner:WebAPI.WebAudioAPI.audioContext=>WebAPI.WebAudioAPI.stereoPannerNodecreateWaveShaper
letcreateWaveShaper:WebAPI.WebAudioAPI.audioContext=>WebAPI.WebAudioAPI.waveShaperNodedecodeAudioData
letdecodeAudioData: (WebAPI.WebAudioAPI.audioContext,~audioData:ArrayBuffer.t,~successCallback:WebAPI.WebAudioAPI.decodeSuccessCallback=?,~errorCallback:WebAPI.WebAudioAPI.decodeErrorCallback=?,)=>promise<WebAPI.WebAudioAPI.audioBuffer>Parameters
WebAPI.WebAudioAPI.audioContext Stdlib.ArrayBuffer.t option<WebAPI.WebAudioAPI.decodeSuccessCallback > option<WebAPI.WebAudioAPI.decodeErrorCallback >Return type
promise<WebAPI.WebAudioAPI.audioBuffer >dispatchEvent
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.Read more on MDN
letdispatchEvent: (WebAPI.WebAudioAPI.audioContext,WebAPI.EventAPI.event,)=>boolgetOutputTimestamp
letgetOutputTimestamp:WebAPI.WebAudioAPI.audioContext=>WebAPI.WebAudioAPI.audioTimestampmake
letmake: (~contextOptions:WebAPI.WebAudioAPI.audioContextOptions=?,)=>WebAPI.WebAudioAPI.audioContextParameters
option<WebAPI.WebAudioAPI.audioContextOptions >Return type
WebAPI.WebAudioAPI.audioContextremoveEventListener
Removes the event listener in target's event listener list with the same type, callback, and options.Read more on MDN
letremoveEventListener: (WebAPI.WebAudioAPI.audioContext,WebAPI.EventAPI.eventType,WebAPI.EventAPI.eventListener<'event>,~options:WebAPI.EventAPI.eventListenerOptions=?,)=>unitParameters
WebAPI.WebAudioAPI.audioContextWebAPI.EventAPI.eventTypeWebAPI.EventAPI.eventListener option<WebAPI.EventAPI.eventListenerOptions >Return type
unitremoveEventListener_useCapture
Removes the event listener in target's event listener list with the same type, callback, and options.Read more on MDN
letremoveEventListener_useCapture: (WebAPI.WebAudioAPI.audioContext,WebAPI.EventAPI.eventType,WebAPI.EventAPI.eventListener<'event>,)=>unitParameters
WebAPI.WebAudioAPI.audioContextWebAPI.EventAPI.eventTypeWebAPI.EventAPI.eventListenerReturn type
unitresume
letresume:WebAPI.WebAudioAPI.audioContext=>promise<unit>suspend
letsuspend:WebAPI.WebAudioAPI.audioContext=>promise<unit>