akasha.audio

Class BaseAudioContext

java.lang.Object

akasha.core.JsObject

akasha.EventTarget

akasha.audio.BaseAudioContext

Direct Known Subclasses:

AudioContext, OfflineAudioContext

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="BaseAudioContext")
public class BaseAudioContext
extends EventTarget

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. You wouldn't use BaseAudioContext directly — you'd use its features via one of these two inheriting interfaces.

See Also:

BaseAudioContext - MDN, # BaseAudioContext

Field Summary

Fields

Modifier and Type	Field and Description
@JsNullable EventHandler	onstatechange

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseAudioContext()

Method Summary

Modifier and Type	Method and Description
void	addStatechangeListener(EventListener callback)
void	addStatechangeListener(EventListener callback, AddEventListenerOptions options)
void	addStatechangeListener(EventListener callback, boolean useCapture)
AudioWorklet	audioWorklet() The audioWorklet read-only property of the BaseAudioContext interface returns an instance of AudioWorklet that can be used for adding AudioWorkletProcessor-derived classes which implement custom audio processing.
@JsNonNull AnalyserNode	createAnalyser() The createAnalyser() method of the BaseAudioContext interface creates an AnalyserNode, which can be used to expose audio time and frequency data and create data visualisations.
@JsNonNull BiquadFilterNode	createBiquadFilter() A BiquadFilterNode.
@JsNonNull AudioBuffer	createBuffer(int numberOfChannels, int length, float sampleRate) An AudioBuffer configured based on the specified options.
@JsNonNull AudioBufferSourceNode	createBufferSource() An AudioBufferSourceNode.
@JsNonNull ChannelMergerNode	createChannelMerger() A ChannelMergerNode.
@JsNonNull ChannelMergerNode	createChannelMerger(int numberOfInputs) A ChannelMergerNode.
@JsNonNull ChannelSplitterNode	createChannelSplitter() A ChannelSplitterNode.
@JsNonNull ChannelSplitterNode	createChannelSplitter(int numberOfOutputs) A ChannelSplitterNode.
@JsNonNull ConstantSourceNode	createConstantSource() The createConstantSource() property of the BaseAudioContext interface 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.
@JsNonNull ConvolverNode	createConvolver() A ConvolverNode.
@JsNonNull DelayNode	createDelay() The createDelay() method of the BaseAudioContext Interface is used to create a DelayNode, which is used to delay the incoming audio signal by a certain amount of time.
@JsNonNull DelayNode	createDelay(double maxDelayTime) The createDelay() method of the BaseAudioContext Interface is used to create a DelayNode, which is used to delay the incoming audio signal by a certain amount of time.
@JsNonNull DynamicsCompressorNode	createDynamicsCompressor() Compression lowers the volume of the loudest parts of the signal and raises the volume of the softest parts.
@JsNonNull GainNode	createGain() A GainNode which takes as input one or more audio sources and outputs audio whose volume has been adjusted in gain (volume) to a level specified by the node's GainNode.gain a-rate parameter.
@JsNonNull IIRFilterNode	createIIRFilter(double[] feedforward, double... feedback) 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.
@JsNonNull IIRFilterNode	createIIRFilter(JsArray<java.lang.Double> feedforward, JsArray<java.lang.Double> feedback) 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.
@JsNonNull OscillatorNode	createOscillator() The createOscillator() method of the BaseAudioContext interface creates an OscillatorNode, a source representing a periodic waveform.
@JsNonNull PannerNode	createPanner() The panner node is spatialized in relation to the AudioContext's AudioListener (defined by the AudioContext.listener attribute), which represents the position and orientation of the person listening to the audio.
@JsNonNull PeriodicWave	createPeriodicWave(double[] real, double... imag) 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.
@JsNonNull PeriodicWave	createPeriodicWave(double[] real, double[] imag, PeriodicWaveConstraints constraints) 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.
@JsNonNull PeriodicWave	createPeriodicWave(JsArray<java.lang.Double> real, JsArray<java.lang.Double> imag) 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.
@JsNonNull PeriodicWave	createPeriodicWave(JsArray<java.lang.Double> real, JsArray<java.lang.Double> imag, PeriodicWaveConstraints constraints) 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.
@JsNonNull ScriptProcessorNode	createScriptProcessor() A ScriptProcessorNode.
@JsNonNull ScriptProcessorNode	createScriptProcessor(int bufferSize) A ScriptProcessorNode.
@JsNonNull ScriptProcessorNode	createScriptProcessor(int bufferSize, int numberOfInputChannels) A ScriptProcessorNode.
@JsNonNull ScriptProcessorNode	createScriptProcessor(int bufferSize, int numberOfInputChannels, int numberOfOutputChannels) A ScriptProcessorNode.
@JsNonNull StereoPannerNode	createStereoPanner() A StereoPannerNode.
@JsNonNull WaveShaperNode	createWaveShaper() A WaveShaperNode.
double	currentTime() The currentTime read-only property of the BaseAudioContext interface returns a double representing an ever-increasing hardware timestamp in seconds that can be used for scheduling audio playback, visualizing timelines, etc.
@JsNonNull Promise<AudioBuffer>	decodeAudioData(ArrayBuffer audioData) The decodeAudioData() method of the BaseAudioContext Interface is used to asynchronously decode audio file data contained in an ArrayBuffer.
@JsNonNull Promise<AudioBuffer>	decodeAudioData(ArrayBuffer audioData, DecodeSuccessCallback successCallback) The decodeAudioData() method of the BaseAudioContext Interface is used to asynchronously decode audio file data contained in an ArrayBuffer.
@JsNonNull Promise<AudioBuffer>	decodeAudioData(ArrayBuffer audioData, DecodeSuccessCallback successCallback, DecodeErrorCallback errorCallback) The decodeAudioData() method of the BaseAudioContext Interface is used to asynchronously decode audio file data contained in an ArrayBuffer.
AudioDestinationNode	destination() An AudioDestinationNode.
AudioListener	listener() An AudioListener object.
void	removeStatechangeListener(EventListener callback)
void	removeStatechangeListener(EventListener callback, boolean useCapture)
void	removeStatechangeListener(EventListener callback, EventListenerOptions options)
float	sampleRate() The sampleRate property of the BaseAudioContext interface returns a floating point number representing the sample rate, in samples per second, used by all nodes in this audio context.
java.lang.String	state() A DOMString.

Methods inherited from class akasha.EventTarget

addEventListener, addEventListener, addEventListener, dispatchEvent, removeEventListener, removeEventListener, removeEventListener

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toString_, valueOf_, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

onstatechange

public @JsNullable EventHandler onstatechange

Constructor Detail

BaseAudioContext

protected BaseAudioContext()

Method Detail

audioWorklet

@JsProperty(name="audioWorklet")
 @Nonnull
public AudioWorklet audioWorklet()

The audioWorklet read-only property of the BaseAudioContext interface returns an instance of AudioWorklet that can be used for adding AudioWorkletProcessor-derived classes which implement custom audio processing.

See Also:

BaseAudioContext.audioWorklet - MDN, audioWorklet - Web Audio API

currentTime

@JsProperty(name="currentTime")
public double currentTime()

The currentTime read-only property of the BaseAudioContext interface 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.

See Also:

BaseAudioContext.currentTime - MDN, currentTime - Web Audio API

destination

@JsProperty(name="destination")
 @Nonnull
public AudioDestinationNode destination()

An AudioDestinationNode.

See Also:

BaseAudioContext.destination - MDN, destination - Web Audio API

listener

@JsProperty(name="listener")
 @Nonnull
public AudioListener listener()

An AudioListener object.

See Also:

BaseAudioContext.listener - MDN, listener - Web Audio API

sampleRate

@JsProperty(name="sampleRate")
public float sampleRate()

The sampleRate property of the BaseAudioContext interface returns a floating point number representing the sample rate, in samples per second, used by all nodes in this audio context.

See Also:

BaseAudioContext.sampleRate - MDN, sampleRate - Web Audio API

state

@JsProperty(name="state")
 @Nonnull
 @AudioContextState
public java.lang.String state()

A DOMString. Possible values are:

See Also:

BaseAudioContext.state - MDN, state - Web Audio API

createAnalyser

public @JsNonNull AnalyserNode createAnalyser()

The createAnalyser() method of the BaseAudioContext interface creates an AnalyserNode, which can be used to expose audio time and frequency data and create data visualisations.

See Also:

BaseAudioContext.createAnalyser - MDN, createAnalyser() - Web Audio API

createBiquadFilter

public @JsNonNull BiquadFilterNode createBiquadFilter()

A BiquadFilterNode.

See Also:

BaseAudioContext.createBiquadFilter - MDN, createBiquadFilter() - Web Audio API

createBuffer

public @JsNonNull AudioBuffer createBuffer(int numberOfChannels,
                                           int length,
                                           float sampleRate)

An AudioBuffer configured based on the specified options.

See Also:

BaseAudioContext.createBuffer - MDN, createBuffer() - Web Audio API

createBufferSource

public @JsNonNull AudioBufferSourceNode createBufferSource()

An AudioBufferSourceNode.

See Also:

BaseAudioContext.createBufferSource - MDN, createBufferSource() - Web Audio API

createChannelMerger

public @JsNonNull ChannelMergerNode createChannelMerger(int numberOfInputs)

A ChannelMergerNode.

See Also:

BaseAudioContext.createChannelMerger - MDN, createChannelMerger() - Web Audio API

createChannelMerger

public @JsNonNull ChannelMergerNode createChannelMerger()

A ChannelMergerNode.

See Also:

BaseAudioContext.createChannelMerger - MDN, createChannelMerger() - Web Audio API

createChannelSplitter

public @JsNonNull ChannelSplitterNode createChannelSplitter(int numberOfOutputs)

A ChannelSplitterNode.

See Also:

BaseAudioContext.createChannelSplitter - MDN, createChannelSplitter() - Web Audio API

createChannelSplitter

public @JsNonNull ChannelSplitterNode createChannelSplitter()

A ChannelSplitterNode.

See Also:

BaseAudioContext.createChannelSplitter - MDN, createChannelSplitter() - Web Audio API

createConstantSource

public @JsNonNull ConstantSourceNode createConstantSource()

The createConstantSource() property of the BaseAudioContext interface 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.

See Also:

BaseAudioContext.createConstantSource - MDN, createConstantSource() - Web Audio API

createConvolver

public @JsNonNull ConvolverNode createConvolver()

A ConvolverNode.

See Also:

BaseAudioContext.createConvolver - MDN, createConvolver() - Web Audio API

createDelay

public @JsNonNull DelayNode createDelay(double maxDelayTime)

The createDelay() method of the BaseAudioContext Interface is used to create a DelayNode, which is used to delay the incoming audio signal by a certain amount of time.

See Also:

BaseAudioContext.createDelay - MDN, createDelay() - Web Audio API

createDelay

public @JsNonNull DelayNode createDelay()

The createDelay() method of the BaseAudioContext Interface is used to create a DelayNode, which is used to delay the incoming audio signal by a certain amount of time.

See Also:

BaseAudioContext.createDelay - MDN, createDelay() - Web Audio API

createDynamicsCompressor

public @JsNonNull DynamicsCompressorNode createDynamicsCompressor()

Compression lowers the volume of the loudest parts of the signal and raises the volume of the softest parts. Overall, a louder, richer, and fuller sound can be achieved. It is especially important in games and musical applications where large numbers of individual sounds are played simultaneously, where you want to control the overall signal level and help avoid clipping (distorting) of the audio output.

See Also:

BaseAudioContext.createDynamicsCompressor - MDN, createDynamicsCompressor() - Web Audio API

createGain

public @JsNonNull GainNode createGain()

A GainNode which takes as input one or more audio sources and outputs audio whose volume has been adjusted in gain (volume) to a level specified by the node's GainNode.gain a-rate parameter.

See Also:

BaseAudioContext.createGain - MDN, createGain() - Web Audio API

createIIRFilter

public @JsNonNull IIRFilterNode createIIRFilter(@Nonnull
                                                JsArray<java.lang.Double> feedforward,
                                                @Nonnull
                                                JsArray<java.lang.Double> feedback)

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.

See Also:

BaseAudioContext.createIIRFilter - MDN

createIIRFilter

@JsOverlay
public final @JsNonNull IIRFilterNode createIIRFilter(@Nonnull
                                                                 double[] feedforward,
                                                                 @Nonnull
                                                                 double... feedback)

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.

See Also:

BaseAudioContext.createIIRFilter - MDN

createOscillator

public @JsNonNull OscillatorNode createOscillator()

The createOscillator() method of the BaseAudioContext interface creates an OscillatorNode, a source representing a periodic waveform. It basically generates a constant tone.

See Also:

BaseAudioContext.createOscillator - MDN, createOscillator - Web Audio API

createPanner

public @JsNonNull PannerNode createPanner()

The panner node is spatialized in relation to the AudioContext's AudioListener (defined by the AudioContext.listener attribute), which represents the position and orientation of the person listening to the audio.

See Also:

BaseAudioContext.createPanner - MDN, createPanner() - Web Audio API

createPeriodicWave

public @JsNonNull PeriodicWave createPeriodicWave(@Nonnull
                                                  JsArray<java.lang.Double> real,
                                                  @Nonnull
                                                  JsArray<java.lang.Double> imag,
                                                  @Nonnull
                                                  PeriodicWaveConstraints constraints)

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.

See Also:

BaseAudioContext.createPeriodicWave - MDN, createPeriodicWave - Web Audio API

createPeriodicWave

public @JsNonNull PeriodicWave createPeriodicWave(@Nonnull
                                                  double[] real,
                                                  @Nonnull
                                                  double[] imag,
                                                  @Nonnull
                                                  PeriodicWaveConstraints constraints)

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.

See Also:

BaseAudioContext.createPeriodicWave - MDN, createPeriodicWave - Web Audio API

createPeriodicWave

public @JsNonNull PeriodicWave createPeriodicWave(@Nonnull
                                                  JsArray<java.lang.Double> real,
                                                  @Nonnull
                                                  JsArray<java.lang.Double> imag)

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.

See Also:

BaseAudioContext.createPeriodicWave - MDN, createPeriodicWave - Web Audio API

createPeriodicWave

@JsOverlay
public final @JsNonNull PeriodicWave createPeriodicWave(@Nonnull
                                                                   double[] real,
                                                                   @Nonnull
                                                                   double... imag)

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.

See Also:

BaseAudioContext.createPeriodicWave - MDN, createPeriodicWave - Web Audio API

createScriptProcessor

public @JsNonNull ScriptProcessorNode createScriptProcessor(int bufferSize,
                                                            int numberOfInputChannels,
                                                            int numberOfOutputChannels)

A ScriptProcessorNode.

See Also:

BaseAudioContext.createScriptProcessor - MDN, createScriptProcessor - Web Audio API

createScriptProcessor

public @JsNonNull ScriptProcessorNode createScriptProcessor(int bufferSize,
                                                            int numberOfInputChannels)

A ScriptProcessorNode.

See Also:

BaseAudioContext.createScriptProcessor - MDN, createScriptProcessor - Web Audio API

createScriptProcessor

public @JsNonNull ScriptProcessorNode createScriptProcessor(int bufferSize)

A ScriptProcessorNode.

See Also:

BaseAudioContext.createScriptProcessor - MDN, createScriptProcessor - Web Audio API

createScriptProcessor

public @JsNonNull ScriptProcessorNode createScriptProcessor()

A ScriptProcessorNode.

See Also:

BaseAudioContext.createScriptProcessor - MDN, createScriptProcessor - Web Audio API

createStereoPanner

public @JsNonNull StereoPannerNode createStereoPanner()

A StereoPannerNode.

See Also:

BaseAudioContext.createStereoPanner - MDN, createStereoPanner() - Web Audio API

createWaveShaper

public @JsNonNull WaveShaperNode createWaveShaper()

A WaveShaperNode.

See Also:

BaseAudioContext.createWaveShaper - MDN, createWaveShaper() - Web Audio API

decodeAudioData

public @JsNonNull Promise<AudioBuffer> decodeAudioData(@Nonnull
                                                       ArrayBuffer audioData,
                                                       @Nullable
                                                       DecodeSuccessCallback successCallback,
                                                       @Nullable
                                                       DecodeErrorCallback errorCallback)

The decodeAudioData() method of the BaseAudioContext Interface is used to asynchronously decode audio file data contained in an ArrayBuffer. In this case the ArrayBuffer is loaded from XMLHttpRequest and FileReader. The decoded AudioBuffer is resampled to the AudioContext's sampling rate, then passed to a callback or promise.

See Also:

BaseAudioContext.decodeAudioData - MDN, decodeAudioData() - Web Audio API

decodeAudioData

public @JsNonNull Promise<AudioBuffer> decodeAudioData(@Nonnull
                                                       ArrayBuffer audioData,
                                                       @Nullable
                                                       DecodeSuccessCallback successCallback)

The decodeAudioData() method of the BaseAudioContext Interface is used to asynchronously decode audio file data contained in an ArrayBuffer. In this case the ArrayBuffer is loaded from XMLHttpRequest and FileReader. The decoded AudioBuffer is resampled to the AudioContext's sampling rate, then passed to a callback or promise.

See Also:

BaseAudioContext.decodeAudioData - MDN, decodeAudioData() - Web Audio API

decodeAudioData

public @JsNonNull Promise<AudioBuffer> decodeAudioData(@Nonnull
                                                       ArrayBuffer audioData)

The decodeAudioData() method of the BaseAudioContext Interface is used to asynchronously decode audio file data contained in an ArrayBuffer. In this case the ArrayBuffer is loaded from XMLHttpRequest and FileReader. The decoded AudioBuffer is resampled to the AudioContext's sampling rate, then passed to a callback or promise.

See Also:

BaseAudioContext.decodeAudioData - MDN, decodeAudioData() - Web Audio API

addStatechangeListener

@JsOverlay
public final void addStatechangeListener(@Nonnull
                                                    EventListener callback,
                                                    @Nonnull
                                                    AddEventListenerOptions options)

addStatechangeListener

@JsOverlay
public final void addStatechangeListener(@Nonnull
                                                    EventListener callback,
                                                    boolean useCapture)

addStatechangeListener

@JsOverlay
public final void addStatechangeListener(@Nonnull
                                                    EventListener callback)

removeStatechangeListener

@JsOverlay
public final void removeStatechangeListener(@Nonnull
                                                       EventListener callback,
                                                       @Nonnull
                                                       EventListenerOptions options)

removeStatechangeListener

@JsOverlay
public final void removeStatechangeListener(@Nonnull
                                                       EventListener callback,
                                                       boolean useCapture)

removeStatechangeListener

@JsOverlay
public final void removeStatechangeListener(@Nonnull
                                                       EventListener callback)