Meziantou.Framework.WebPlatform.WebAudio namespace

Classes

NameDescription
AnalyserNodeA node that provides the time-domain and frequency-domain data of its input (https://webaudio.github.io/web-audio-api/#AnalyserNode). Its output is its input.
AnalyserOptionsThe options of an AnalyserNode (https://webaudio.github.io/web-audio-api/#AnalyserOptions).
AudioBufferAn audio asset in memory (https://webaudio.github.io/web-audio-api/#AudioBuffer): one or more channels of linear PCM samples (32-bit floats, nominally between -1 and 1), at a sample rate.
AudioBufferOptionsThe options of an AudioBuffer (https://webaudio.github.io/web-audio-api/#AudioBufferOptions).
AudioBufferSourceNodeA source that plays an AudioBuffer (https://webaudio.github.io/web-audio-api/#AudioBufferSourceNode), with a playback rate, a detune, a loop, and sub-sample accurate start and stop times (the samples are linearly interpolated).
AudioBufferSourceOptionsThe options of an AudioBufferSourceNode (https://webaudio.github.io/web-audio-api/#AudioBufferSourceOptions).
AudioContextAn audio context that renders its graph in real time (https://webaudio.github.io/web-audio-api/#AudioContext). There is no audio device: the audio is rendered and discarded, at the pace of the clock of the event loop (DomEventLoop.TimeProvider), so that the time of the context progresses as in a browser.
AudioContextOptionsThe options of an AudioContext (https://webaudio.github.io/web-audio-api/#AudioContextOptions).
AudioDestinationNodeThe final destination of the audio of a context (https://webaudio.github.io/web-audio-api/#AudioDestinationNode): the rendered buffer of an OfflineAudioContext, or the (virtual) audio device of an AudioContext. Its output is its input.
AudioListenerThe position and the orientation of the listener of the spatialization of the PannerNode objects of a context (https://webaudio.github.io/web-audio-api/#AudioListener).
AudioNodeA node of the audio routing graph of a BaseAudioContext (https://webaudio.github.io/web-audio-api/#AudioNode): a source, a destination or a processing module, with inputs and outputs that are connected to other nodes and to the AudioParam of other nodes.
AudioNodeOptionsThe channel options of a node (https://webaudio.github.io/web-audio-api/#AudioNodeOptions).
AudioParamA parameter of an AudioNode (https://webaudio.github.io/web-audio-api/#AudioParam): its value can be set directly, automated with events scheduled on the timeline of the context, and modulated by the outputs of nodes connected to it (summed with the intrinsic value).
AudioParamDescriptorThe description of a parameter of an AudioWorkletProcessor (https://webaudio.github.io/web-audio-api/#AudioParamDescriptor).
AudioParamMapThe parameters of an AudioWorkletNode, by name (https://webaudio.github.io/web-audio-api/#AudioParamMap): a read-only map.
AudioPlaybackStatsThe statistics of the playback of an AudioContext (https://webaudio.github.io/web-audio-api/#AudioPlaybackStats). As there is no audio device, the played duration is the time during which the context is running, and the underruns are the times skipped by a late rendering.
AudioProcessingEventThe audioprocess event of a ScriptProcessorNode (https://webaudio.github.io/web-audio-api/#AudioProcessingEvent).
AudioProcessingEventInitThe initialization dictionary of an AudioProcessingEvent (https://webaudio.github.io/web-audio-api/#AudioProcessingEventInit).
AudioScheduledSourceNodeThe base of the source nodes that are started and stopped at times of the context (https://webaudio.github.io/web-audio-api/#AudioScheduledSourceNode): they output silence before they start and after they stop, and fire ended when they stop.
AudioSinkInfoThe audio output without device of an AudioContext (https://webaudio.github.io/web-audio-api/#AudioSinkInfo).
AudioSinkOptionsThe options of an audio output without device (https://webaudio.github.io/web-audio-api/#AudioSinkOptions).
AudioTimestampA time of an AudioContext and the corresponding time of the performance timeline (https://webaudio.github.io/web-audio-api/#AudioTimestamp).
AudioWorkletThe worklet of the AudioWorkletProcessor classes of a context (https://webaudio.github.io/web-audio-api/#AudioWorklet): its module scripts register the processors of the AudioWorkletNode objects.
AudioWorkletGlobalScopeThe global scope of an AudioWorkletGlobalScope.AudioWorklet (https://webaudio.github.io/web-audio-api/#AudioWorkletGlobalScope): the module scripts register the AudioWorkletProcessor classes with AudioWorkletGlobalScope.RegisterProcessor.
AudioWorkletNodeA node whose processing is implemented by a script (https://webaudio.github.io/web-audio-api/#AudioWorkletNode): its AudioWorkletProcessor, registered in the BaseAudioContext.AudioWorklet of its context.
AudioWorkletNodeOptionsThe options of an AudioWorkletNode (https://webaudio.github.io/web-audio-api/#AudioWorkletNodeOptions).
AudioWorkletProcessorThe base class of the audio processors of the scripts (https://webaudio.github.io/web-audio-api/#AudioWorkletProcessor): a processor is constructed in the AudioWorkletGlobalScope for each AudioWorkletNode, and its process() method is called for each render quantum.
BaseAudioContextThe base of the audio contexts (https://webaudio.github.io/web-audio-api/#BaseAudioContext): a graph of AudioNode objects rendered in blocks of sample frames (render quanta) to its BaseAudioContext.Destination, with a time that starts at 0 and advances as the graph is rendered.
BiquadFilterNodeA second-order filter (https://webaudio.github.io/web-audio-api/#BiquadFilterNode): lowpass, highpass, bandpass, shelves, peaking, notch or allpass, with the coefficients of the Audio EQ Cookbook.
BiquadFilterOptionsThe options of a BiquadFilterNode (https://webaudio.github.io/web-audio-api/#BiquadFilterOptions).
ChannelMergerNodeA node that combines its inputs, each down-mixed to mono, into the channels of its output (https://webaudio.github.io/web-audio-api/#ChannelMergerNode).
ChannelMergerOptionsThe options of a ChannelMergerNode (https://webaudio.github.io/web-audio-api/#ChannelMergerOptions).
ChannelSplitterNodeA node whose outputs are the channels of its input (https://webaudio.github.io/web-audio-api/#ChannelSplitterNode).
ChannelSplitterOptionsThe options of a ChannelSplitterNode (https://webaudio.github.io/web-audio-api/#ChannelSplitterOptions).
ConstantSourceNodeA source whose output is the value of its ConstantSourceNode.Offset parameter (https://webaudio.github.io/web-audio-api/#ConstantSourceNode).
ConstantSourceOptionsThe options of a ConstantSourceNode (https://webaudio.github.io/web-audio-api/#ConstantSourceOptions).
ConvolverNodeA node that convolves its input with an impulse response (https://webaudio.github.io/web-audio-api/#ConvolverNode).
ConvolverOptionsThe options of a ConvolverNode (https://webaudio.github.io/web-audio-api/#ConvolverOptions).
DelayNodeA node that delays its input (https://webaudio.github.io/web-audio-api/#DelayNode): the output at a time is the input at that time minus the delay time (linearly interpolated). A delay node in a cycle of the graph delays by at least one render quantum.
DelayOptionsThe options of a DelayNode (https://webaudio.github.io/web-audio-api/#DelayOptions).
DynamicsCompressorNodeA dynamics compressor (https://webaudio.github.io/web-audio-api/#DynamicsCompressorNode): it lowers the level of the loud parts of its input, with a fixed look-ahead delay, a soft knee, and a makeup gain.
DynamicsCompressorOptionsThe options of a DynamicsCompressorNode (https://webaudio.github.io/web-audio-api/#DynamicsCompressorOptions).
GainNodeA node that multiplies its input by a gain (https://webaudio.github.io/web-audio-api/#GainNode).
GainOptionsThe options of a GainNode (https://webaudio.github.io/web-audio-api/#GainOptions).
IIRFilterNodeA general infinite impulse response filter (https://webaudio.github.io/web-audio-api/#IIRFilterNode).
IIRFilterOptionsThe options of an IIRFilterNode (https://webaudio.github.io/web-audio-api/#IIRFilterOptions).
OfflineAudioCompletionEventThe complete event of an OfflineAudioContext (https://webaudio.github.io/web-audio-api/#OfflineAudioCompletionEvent).
OfflineAudioCompletionEventInitThe completion event of an OfflineAudioContext (https://webaudio.github.io/web-audio-api/#OfflineAudioCompletionEventInit).
OfflineAudioContextAn audio context that renders its graph to AudioBuffer objects as fast as possible (https://webaudio.github.io/web-audio-api/#OfflineAudioContext), deterministically.
OfflineAudioContextOptionsThe options of an OfflineAudioContext (https://webaudio.github.io/web-audio-api/#OfflineAudioContextOptions).
OscillatorNodeA source of a periodic waveform (https://webaudio.github.io/web-audio-api/#OscillatorNode): a sine, square, sawtooth or triangle wave, or a PeriodicWave, band-limited to the Nyquist frequency.
OscillatorOptionsThe options of an OscillatorNode (https://webaudio.github.io/web-audio-api/#OscillatorOptions).
PannerNodeA node that spatializes its input relative to the BaseAudioContext.Listener (https://webaudio.github.io/web-audio-api/#PannerNode): its output is stereo, panned by the azimuth (equal power, or a structural head-related transfer function), and attenuated by the distance and the sound cone.
PannerOptionsThe options of a PannerNode (https://webaudio.github.io/web-audio-api/#PannerOptions).
PeriodicWaveAn arbitrary periodic waveform for an OscillatorNode (https://webaudio.github.io/web-audio-api/#PeriodicWave), defined by the coefficients of its Fourier series.
PeriodicWaveConstraintsThe normalization options of a PeriodicWave (https://webaudio.github.io/web-audio-api/#PeriodicWaveConstraints).
PeriodicWaveOptionsThe options of a PeriodicWave (https://webaudio.github.io/web-audio-api/#PeriodicWaveOptions).
ScriptProcessorNodeA node that processes its input with a script (https://webaudio.github.io/web-audio-api/#ScriptProcessorNode, deprecated): each time a buffer of input frames is collected, an audioprocess event gives it to the script with a buffer to fill, which is played two buffers later.
StereoPannerNodeA node that pans its input in a stereo image with an equal-power law (https://webaudio.github.io/web-audio-api/#StereoPannerNode).
StereoPannerOptionsThe options of a StereoPannerNode (https://webaudio.github.io/web-audio-api/#StereoPannerOptions).
WaveShaperNodeA node that applies a non-linear distortion curve to its input (https://webaudio.github.io/web-audio-api/#WaveShaperNode).
WaveShaperOptionsThe options of a WaveShaperNode (https://webaudio.github.io/web-audio-api/#WaveShaperOptions).

Structs

NameDescription
AudioContextLatencyHintThe (AudioContextLatencyCategory or double) union of the latency hint of an AudioContext (https://webaudio.github.io/web-audio-api/#dom-audiocontextoptions-latencyhint): a category, or a latency in seconds.
AudioContextRenderSizeHintThe (AudioContextRenderSizeCategory or unsigned long) union of the render quantum size hint of a context (https://webaudio.github.io/web-audio-api/#dom-audiocontextoptions-rendersizehint).
StringOrAudioSinkInfoThe (DOMString or AudioSinkInfo) union of the audio output device of an AudioContext (https://webaudio.github.io/web-audio-api/#dom-audiocontext-sinkid): the identifier of a device (the empty string for the default device), or the information of a sink without device.
StringOrAudioSinkOptionsThe (DOMString or AudioSinkOptions) union of the audio output device requested for an AudioContext (https://webaudio.github.io/web-audio-api/#dom-audiocontextoptions-sinkid): the identifier of a device (the empty string for the default device), or the options of a sink without device.

Enums

NameDescription
AudioContextLatencyCategoryThe categories of latency of an AudioContext (https://webaudio.github.io/web-audio-api/#enumdef-audiocontextlatencycategory).
AudioContextRenderSizeCategoryThe categories of render quantum sizes (https://webaudio.github.io/web-audio-api/#enumdef-audiocontextrendersizecategory).
AudioContextStateThe states of an audio context (https://webaudio.github.io/web-audio-api/#enumdef-audiocontextstate).
AudioSinkTypeThe types of audio output devices of an AudioSinkOptions (https://webaudio.github.io/web-audio-api/#enumdef-audiosinktype).
AutomationRateThe automation rates of an AudioParam (https://webaudio.github.io/web-audio-api/#enumdef-automationrate).
BiquadFilterTypeThe types of a BiquadFilterNode (https://webaudio.github.io/web-audio-api/#enumdef-biquadfiltertype).
ChannelCountModeHow the number of channels of an input is computed (https://webaudio.github.io/web-audio-api/#enumdef-channelcountmode).
ChannelInterpretationHow the channels are up-mixed and down-mixed (https://webaudio.github.io/web-audio-api/#enumdef-channelinterpretation).
DistanceModelTypeThe distance models of a PannerNode (https://webaudio.github.io/web-audio-api/#enumdef-distancemodeltype).
OscillatorTypeThe waveforms of an OscillatorNode (https://webaudio.github.io/web-audio-api/#enumdef-oscillatortype).
OverSampleTypeThe oversampling of a WaveShaperNode (https://webaudio.github.io/web-audio-api/#enumdef-oversampletype).
PanningModelTypeThe spatialization algorithms of a PannerNode (https://webaudio.github.io/web-audio-api/#enumdef-panningmodeltype).

Delegates

NameDescription
DecodeErrorCallbackThe callback of a failed BaseAudioContext.DecodeAudioDataArray (https://webaudio.github.io/web-audio-api/#callbackdef-decodeerrorcallback).
DecodeSuccessCallbackThe callback of a successful BaseAudioContext.DecodeAudioDataArray (https://webaudio.github.io/web-audio-api/#callbackdef-decodesuccesscallback).