akasha.audio

Class OfflineAudioContext

java.lang.Object

akasha.core.JsObject

akasha.EventTarget

akasha.audio.BaseAudioContext

akasha.audio.OfflineAudioContext

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

The OfflineAudioContext interface 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.

See Also:

OfflineAudioContext - MDN, OfflineAudioContext - Web Audio API

Field Summary

Fields

Modifier and Type	Field and Description
OfflineAudioCompletionEventHandler	oncomplete When processing is complete, you might want to use the oncomplete handler the prompt the user that the audio can now be played, and enable the play button.

Fields inherited from class akasha.audio.BaseAudioContext

onstatechange

Constructor Summary

Constructors

Constructor and Description
OfflineAudioContext(int numberOfChannels, int length, float sampleRate) The OfflineAudioContext() constructor—part of the Web Audio API—creates and returns a new OfflineAudioContext object instance, which can then be used to render audio to an AudioBuffer rather than to an audio output device.
OfflineAudioContext(OfflineAudioContextOptions contextOptions) The OfflineAudioContext() constructor—part of the Web Audio API—creates and returns a new OfflineAudioContext object instance, which can then be used to render audio to an AudioBuffer rather than to an audio output device.

Method Summary

Modifier and Type	Method and Description
void	addCompleteListener(OfflineAudioCompletionEventListener callback)
void	addCompleteListener(OfflineAudioCompletionEventListener callback, AddEventListenerOptions options)
void	addCompleteListener(OfflineAudioCompletionEventListener callback, boolean useCapture)
int	length() The length property of the OfflineAudioContext interface returns an integer representing the size of the buffer in sample-frames.
void	removeCompleteListener(OfflineAudioCompletionEventListener callback)
void	removeCompleteListener(OfflineAudioCompletionEventListener callback, boolean useCapture)
void	removeCompleteListener(OfflineAudioCompletionEventListener callback, EventListenerOptions options)
Promise<java.lang.Void>	resume() The resume() method of the OfflineAudioContext interface resumes the progression of time in an audio context that has been suspended.
Promise<AudioBuffer>	startRendering() The startRendering() method of the OfflineAudioContext Interface starts rendering the audio graph, taking into account the current connections and the current scheduled changes.
Promise<java.lang.Void>	suspend(double suspendTime) 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.

Methods inherited from class akasha.audio.BaseAudioContext

audioWorklet, createAnalyser, createBiquadFilter, createBuffer, createBufferSource, createChannelMerger, createChannelMerger, createChannelSplitter, createChannelSplitter, createConstantSource, createConvolver, createDelay, createDelay, createDynamicsCompressor, createGain, createIIRFilter, createIIRFilter, createIIRFilter, createIIRFilter, createOscillator, createPanner, createPeriodicWave, createPeriodicWave, createPeriodicWave, createPeriodicWave, createPeriodicWave, createPeriodicWave, createPeriodicWave, createPeriodicWave, createScriptProcessor, createScriptProcessor, createScriptProcessor, createScriptProcessor, createStereoPanner, createWaveShaper, currentTime, decodeAudioData, decodeAudioData, decodeAudioData, destination, listener, sampleRate, state

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, is, isExtensible, isFrozen, isSealed, keys, preventExtensions, seal, setPrototypeOf, valueOf_, values

Methods inherited from class java.lang.Object

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

Field Detail

oncomplete

@Nullable
public OfflineAudioCompletionEventHandler oncomplete

When processing is complete, you might want to use the oncomplete handler the prompt the user that the audio can now be played, and enable the play button.

See Also:

OfflineAudioContext.oncomplete - MDN, oncomplete - Web Audio API

Constructor Detail

OfflineAudioContext

public OfflineAudioContext(@Nonnull
                           OfflineAudioContextOptions contextOptions)

The OfflineAudioContext() constructor—part of the Web Audio API—creates and returns a new OfflineAudioContext object instance, which can then be used to render audio to an AudioBuffer rather than to an audio output device.

See Also:

OfflineAudioContext.OfflineAudioContext - MDN, OfflineAudioContext() - Web Audio API

OfflineAudioContext

public OfflineAudioContext(int numberOfChannels,
                           int length,
                           float sampleRate)

The OfflineAudioContext() constructor—part of the Web Audio API—creates and returns a new OfflineAudioContext object instance, which can then be used to render audio to an AudioBuffer rather than to an audio output device.

See Also:

OfflineAudioContext.OfflineAudioContext - MDN, OfflineAudioContext() - Web Audio API

Method Detail

length

@JsProperty(name="length")
public int length()

The length property of the OfflineAudioContext interface returns an integer representing the size of the buffer in sample-frames.

See Also:

OfflineAudioContext.length - MDN, length - Web Audio API

resume

@Nonnull
public Promise<java.lang.Void> resume()

The resume() method of the OfflineAudioContext interface resumes the progression of time in an audio context that has been suspended. The promise resolves immediately because the OfflineAudioContext does not require the audio hardware. If the context is not currently suspended or the rendering has not started, the promise is rejected with InvalidStateError.

See Also:

OfflineAudioContext.resume - MDN, resume() - Web Audio API

startRendering

@Nonnull
public Promise<AudioBuffer> startRendering()

The startRendering() method of the OfflineAudioContext Interface starts rendering the audio graph, taking into account the current connections and the current scheduled changes.

See Also:

OfflineAudioContext.startRendering - MDN, startRendering() - Web Audio API

suspend

@Nonnull
public Promise<java.lang.Void> suspend(double suspendTime)

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.

See Also:

OfflineAudioContext.suspend - MDN, suspend() - Web Audio API

addCompleteListener

@JsOverlay
public final void addCompleteListener(@Nonnull
                                                 OfflineAudioCompletionEventListener callback,
                                                 @Nonnull
                                                 AddEventListenerOptions options)

addCompleteListener

@JsOverlay
public final void addCompleteListener(@Nonnull
                                                 OfflineAudioCompletionEventListener callback,
                                                 boolean useCapture)

addCompleteListener

@JsOverlay
public final void addCompleteListener(@Nonnull
                                                 OfflineAudioCompletionEventListener callback)

removeCompleteListener

@JsOverlay
public final void removeCompleteListener(@Nonnull
                                                    OfflineAudioCompletionEventListener callback,
                                                    @Nonnull
                                                    EventListenerOptions options)

removeCompleteListener

@JsOverlay
public final void removeCompleteListener(@Nonnull
                                                    OfflineAudioCompletionEventListener callback,
                                                    boolean useCapture)

removeCompleteListener

@JsOverlay
public final void removeCompleteListener(@Nonnull
                                                    OfflineAudioCompletionEventListener callback)