OfflineAudioContext class abstract
The OfflineAudioContext is 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.
API documentation sourced from MDN Web Docs.
- Implemented types
Constructors
Properties
- audioWorklet → AudioWorklet
-
The
audioWorkletread-only property of the BaseAudioContext returns an instance of AudioWorklet that can be used for adding AudioWorkletProcessor-derived classes which implement custom audio processing.no setterinherited - currentTime → TauTime
-
The
currentTimeread-only property of the BaseAudioContext returns a double representing an ever-increasing hardware timestamp in seconds that can be used for scheduling audio playback, visualizing timelines, etc. It starts at 0.no setterinherited - destination → AudioDestinationNode
-
The
destinationproperty of the BaseAudioContext returns an AudioDestinationNode representing the final destination of all audio in the context. It often represents an actual audio-rendering device such as your device's speakers.no setterinherited - hashCode → int
-
The hash code for this object.
no setterinherited
- length → int
-
The
lengthproperty of the OfflineAudioContext returns an integer representing the size of the buffer in sample-frames.no setter - listener → AudioListener
-
The
listenerproperty of the BaseAudioContext interface returns an AudioListener object that can then be used for implementing 3D audio spatialization.no setterinherited - oncomplete ↔ EventHandler
-
getter/setter pair
- onstatechange ↔ EventHandler
-
getter/setter pairinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sampleRate → TauSampleRate
-
The
sampleRateproperty of the BaseAudioContext returns a floating point number representing the sample rate, in samples per second, used by all nodes in this audio context. This limitation means that sample-rate converters are not supported.no setterinherited - state → AudioContextState
-
The
stateread-only property of the BaseAudioContext returns the current state of theAudioContext.no setterinherited
Methods
-
createAnalyser(
) → AnalyserNode -
The
createAnalyser()method of the BaseAudioContext creates an AnalyserNode, which can be used to expose audio time and frequency data and create data visualizations.inherited -
createBiquadFilter(
) → BiquadFilterNode -
The
createBiquadFilter()method of the BaseAudioContext creates a BiquadFilterNode, which represents a second order filter configurable as several different common filter types.inherited -
createBuffer(
int numberOfChannels, int length, TauSampleRate sampleRate) → AudioBuffer -
The
createBuffer()method of the BaseAudioContext is used to create a new, empty AudioBuffer object, which can then be populated by data, and played via an AudioBufferSourceNode.inherited -
createBufferSource(
) → AudioBufferSourceNode -
The
createBufferSource()method of the BaseAudioContext is used to create a new AudioBufferSourceNode, which can be used to play audio data contained within an AudioBuffer object. AudioBuffers are created using BaseAudioContext.createBuffer or returned by BaseAudioContext.decodeAudioData when it successfully decodes an audio track.inherited -
createChannelMerger(
[int numberOfInputs]) → ChannelMergerNode -
The
createChannelMerger()method of the BaseAudioContext interface creates a ChannelMergerNode, which combines channels from multiple audio streams into a single audio stream.inherited -
createChannelSplitter(
[int numberOfOutputs]) → ChannelSplitterNode -
The
createChannelSplitter()method of the BaseAudioContext Interface is used to create a ChannelSplitterNode, which is used to access the individual channels of an audio stream and process them separately.inherited -
createConstantSource(
) → ConstantSourceNode -
The
createConstantSource()property of the BaseAudioContext creates a ConstantSourceNode object, which is an audio source that continuously outputs a monaural (one-channel) sound signal whose samples all have the same value.inherited -
createConvolver(
) → ConvolverNode -
The
createConvolver()method of the BaseAudioContext creates a ConvolverNode, which is commonly used to apply reverb effects to your audio. See the spec definition of Convolution for more information.inherited -
createDelay(
[TauTime maxDelayTime]) → DelayNode -
The
createDelay()method of the BaseAudioContext is used to create a DelayNode, which is used to delay the incoming audio signal by a certain amount of time.inherited -
createDynamicsCompressor(
) → DynamicsCompressorNode -
The
createDynamicsCompressor()method of the BaseAudioContext is used to create a DynamicsCompressorNode, which can be used to apply compression to an audio signal.inherited -
createGain(
) → GainNode -
The
createGain()method of the BaseAudioContext creates a GainNode, which can be used to control the overall gain (or volume) of the audio graph.inherited -
createIIRFilter(
TauArray< TauNumber> feedforward, TauArray<TauNumber> feedback) → IIRFilterNode -
The
createIIRFilter()method of the BaseAudioContext interface creates an IIRFilterNode, which represents a general infinite impulse response (IIR) filter which can be configured to serve as various types of filter.inherited -
createOscillator(
) → OscillatorNode -
The
createOscillator()method of the BaseAudioContext creates an OscillatorNode, a source representing a periodic waveform. It basically generates a constant tone.inherited -
createPanner(
) → PannerNode -
The
createPanner()method of the BaseAudioContext is used to create a new PannerNode, which is used to spatialize an incoming audio stream in 3D space.inherited -
createPeriodicWave(
TauArray< TauNumber> real, TauArray<TauNumber> imag, [PeriodicWaveConstraints constraints]) → PeriodicWave -
The
createPeriodicWave()method of the BaseAudioContext Interface is used to create a PeriodicWave, which is used to define a periodic waveform that can be used to shape the output of an OscillatorNode.inherited -
createScriptProcessor(
[int bufferSize, int numberOfInputChannels, int numberOfOutputChannels]) → ScriptProcessorNode -
The
createScriptProcessor()method of the BaseAudioContext interface creates a ScriptProcessorNode used for direct audio processing.inherited -
createStereoPanner(
) → StereoPannerNode -
The
createStereoPanner()method of the BaseAudioContext interface creates a StereoPannerNode, which can be used to apply stereo panning to an audio source. It positions an incoming audio stream in a stereo image using a low-cost panning algorithm.inherited -
createWaveShaper(
) → WaveShaperNode -
The
createWaveShaper()method of the BaseAudioContext creates a WaveShaperNode, which represents a non-linear distortion. It is used to apply distortion effects to your audio.inherited -
decodeAudioData(
TauArrayBuffer audioData, [DecodeSuccessCallback? successCallback, DecodeErrorCallback? errorCallback]) → TauPromise< AudioBuffer> -
The
decodeAudioData()method of the BaseAudioContext is used to asynchronously decode audio file data contained in anArrayBufferthat is loaded fromfetch,XMLHttpRequest, or FileReader. The decoded AudioBuffer is resampled to the AudioContext's sampling rate, then passed to a callback or promise.inherited -
dispose(
) → void -
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
resume(
) → TauPromise< TauAny?> -
The
resume()method of the OfflineAudioContext resumes the progression of time in an audio context that has been suspended. The promise resolves immediately because theOfflineAudioContextdoes not require the audio hardware. -
startRendering(
) → TauPromise< AudioBuffer> -
The
startRendering()method of the OfflineAudioContext Interface starts rendering the audio graph, taking into account the current connections and the current scheduled changes. -
suspend(
TauTime suspendTime) → TauPromise< TauAny?> -
The
suspend()method of the OfflineAudioContext interface schedules a suspension of the time progression in the audio context at the specified time and returns a promise. This is generally useful at the time of manipulating the audio graph synchronously on OfflineAudioContext. -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited