Package-level declarations

Types

Link copied to clipboard
open class AnalyserNode(context: BaseAudioContext, options: AnalyserOptions = definedExternally) : AudioNode

The AnalyserNode interface represents a node able to provide real-time frequency and time-domain analysis information.

Link copied to clipboard
Link copied to clipboard
open class AudioBuffer(options: AudioBufferOptions)

The AudioBuffer interface represents a short audio asset residing in memory, created from an audio file using the BaseAudioContext/decodeAudioData method, or from raw data using BaseAudioContext/createBuffer.

Link copied to clipboard
Link copied to clipboard

The AudioBufferSourceNode interface is an AudioScheduledSourceNode which represents an audio source consisting of in-memory audio data, stored in an AudioBuffer.

Link copied to clipboard
Link copied to clipboard
open class AudioContext(contextOptions: AudioContextOptions = definedExternally) : BaseAudioContext

The AudioContext interface represents an audio-processing graph built from audio modules linked together, each represented by an AudioNode.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed interface AudioContextState
Link copied to clipboard

The AudioDestinationNode interface represents the end destination of an audio graph in a given context — usually the speakers of your device.

Link copied to clipboard

The AudioListener interface represents the position and orientation of the unique person listening to the audio scene, and is used in audio spatialization.

Link copied to clipboard
open class AudioNode : EventTarget

The AudioNode interface is a generic interface for representing an audio processing module.

Link copied to clipboard
Link copied to clipboard

The Web Audio API's AudioParam interface represents an audio-related parameter, usually a parameter of an AudioNode (such as GainNode.gain).

Link copied to clipboard

The AudioParamMap interface of the Web Audio API represents an iterable and read-only set of multiple audio parameters.

Link copied to clipboard

The AudioScheduledSourceNode interface—part of the Web Audio API—is a parent interface for several types of audio source node interfaces which share the ability to be started and stopped, optionally at specified times.

Link copied to clipboard
interface AudioTimestamp
Link copied to clipboard

The AudioWorklet interface of the Web Audio API is used to supply custom audio processing scripts that execute in a separate thread to provide very low latency audio processing. Available only in secure contexts.

Link copied to clipboard

The AudioWorkletGlobalScope interface of the Web Audio API represents a global execution context for user-supplied code, which defines custom AudioWorkletProcessor-derived classes.

Link copied to clipboard
open class AudioWorkletNode(context: BaseAudioContext, name: String, options: AudioWorkletNodeOptions = definedExternally) : AudioNode

The AudioWorkletNode interface of the Web Audio API represents a base class for a user-defined AudioNode, which can be connected to an audio routing graph along with other nodes. Available only in secure contexts.

Link copied to clipboard

The AudioWorkletProcessor interface of the Web Audio API represents an audio processing code behind a custom AudioWorkletNode.

Link copied to clipboard
sealed interface AutomationRate
Link copied to clipboard

The BaseAudioContext interface of the Web Audio API acts as a base definition for online and offline audio-processing graphs, as represented by AudioContext and OfflineAudioContext respectively.

Link copied to clipboard
open class BiquadFilterNode(context: BaseAudioContext, options: BiquadFilterOptions = definedExternally) : AudioNode

The BiquadFilterNode interface represents a simple low-order filter, and is created using the BaseAudioContext/createBiquadFilter method.

Link copied to clipboard
Link copied to clipboard
sealed interface BiquadFilterType
Link copied to clipboard
sealed interface ChannelCountMode
Link copied to clipboard
sealed interface ChannelInterpretation
Link copied to clipboard
open class ChannelMergerNode(context: BaseAudioContext, options: ChannelMergerOptions = definedExternally) : AudioNode

The ChannelMergerNode interface, often used in conjunction with its opposite, ChannelSplitterNode, reunites different mono inputs into a single output.

Link copied to clipboard
Link copied to clipboard
open class ChannelSplitterNode(context: BaseAudioContext, options: ChannelSplitterOptions = definedExternally) : AudioNode

The ChannelSplitterNode interface, often used in conjunction with its opposite, ChannelMergerNode, separates the different channels of an audio source into a set of mono outputs.

Link copied to clipboard
Link copied to clipboard
open class ConstantSourceNode(context: BaseAudioContext, options: ConstantSourceOptions = definedExternally) : AudioScheduledSourceNode

The ConstantSourceNode interface—part of the Web Audio API—represents an audio source (based upon AudioScheduledSourceNode) whose output is single unchanging value.

Link copied to clipboard
Link copied to clipboard
open class ConvolverNode(context: BaseAudioContext, options: ConvolverOptions = definedExternally) : AudioNode

The ConvolverNode interface is an AudioNode that performs a Linear Convolution on a given AudioBuffer, often used to achieve a reverb effect.

Link copied to clipboard
Link copied to clipboard
typealias DecodeErrorCallback = (error: DOMException) -> Unit
Link copied to clipboard
typealias DecodeSuccessCallback = (decodedData: AudioBuffer) -> Unit
Link copied to clipboard
open class DelayNode(context: BaseAudioContext, options: DelayOptions = definedExternally) : AudioNode

The DelayNode interface represents a delay-line; an AudioNode audio-processing module that causes a delay between the arrival of an input data and its propagation to the output.

Link copied to clipboard
Link copied to clipboard
sealed interface DistanceModelType
Link copied to clipboard
open class DynamicsCompressorNode(context: BaseAudioContext, options: DynamicsCompressorOptions = definedExternally) : AudioNode

The DynamicsCompressorNode interface provides a compression effect, which lowers the volume of the loudest parts of the signal in order to help prevent clipping and distortion that can occur when multiple sounds are played and multiplexed together at once.

Link copied to clipboard
open class GainNode(context: BaseAudioContext, options: GainOptions = definedExternally) : AudioNode

The GainNode interface represents a change in volume.

Link copied to clipboard
Link copied to clipboard
open class IIRFilterNode(context: BaseAudioContext, options: IIRFilterOptions) : AudioNode

The IIRFilterNode interface of the Web Audio API is a AudioNode processor which implements a general infinite impulse response (IIR) filter; this type of filter can be used to implement tone control devices and graphic equalizers as well.

Link copied to clipboard
Link copied to clipboard

The MediaElementAudioSourceNode interface represents an audio source consisting of an HTML audio or video element.

Link copied to clipboard
open class MediaStreamAudioDestinationNode(context: AudioContext, options: AudioNodeOptions = definedExternally) : AudioNode

The MediaStreamAudioDestinationNode interface represents an audio destination consisting of a WebRTC MediaStream with a single AudioMediaStreamTrack, which can be used in a similar way to a MediaStream obtained from MediaDevices.getUserMedia.

Link copied to clipboard

The MediaStreamAudioSourceNode interface is a type of AudioNode which operates as an audio source whose media is received from a MediaStream obtained using the WebRTC or Media Capture and Streams APIs.

Link copied to clipboard

The Web Audio API OfflineAudioCompletionEvent interface represents events that occur when the processing of an OfflineAudioContext is terminated.

Link copied to clipboard

The OfflineAudioContext interface is an AudioContext interface representing an audio-processing graph built from linked together AudioNodes.

Link copied to clipboard
Link copied to clipboard
open class OscillatorNode(context: BaseAudioContext, options: OscillatorOptions = definedExternally) : AudioScheduledSourceNode

The OscillatorNode interface represents a periodic waveform, such as a sine wave.

Link copied to clipboard
Link copied to clipboard
sealed interface OscillatorType
Link copied to clipboard
sealed interface OverSampleType
Link copied to clipboard
open class PannerNode(context: BaseAudioContext, options: PannerOptions = definedExternally) : AudioNode

The PannerNode interface defines an audio-processing object that represents the location, direction, and behavior of an audio source signal in a simulated physical space.

Link copied to clipboard
Link copied to clipboard
sealed interface PanningModelType
Link copied to clipboard
open class PeriodicWave(context: BaseAudioContext, options: PeriodicWaveOptions = definedExternally)

The PeriodicWave interface defines a periodic waveform that can be used to shape the output of an OscillatorNode.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open class StereoPannerNode(context: BaseAudioContext, options: StereoPannerOptions = definedExternally) : AudioNode

The StereoPannerNode interface of the Web Audio API represents a simple stereo panner node that can be used to pan an audio stream left or right.

Link copied to clipboard
Link copied to clipboard
open class WaveShaperNode(context: BaseAudioContext, options: WaveShaperOptions = definedExternally) : AudioNode

The WaveShaperNode interface represents a non-linear distorter.

Link copied to clipboard