akasha.audio

Class AudioWorkletNode

java.lang.Object

akasha.core.JsObject

akasha.EventTarget

akasha.audio.AudioNode

akasha.audio.AudioWorkletNode

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="AudioWorkletNode")
public class AudioWorkletNode
extends 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. It has an associated AudioWorkletProcessor, which does the actual audio processing in a Web Audio rendering thread.

See Also:

AudioWorkletNode - MDN, # AudioWorkletNode

Field Summary

Fields

Modifier and Type	Field and Description
@JsNullable EventHandler	onprocessorerror The onprocessorerror property of the AudioWorkletNode interface defines an event handler function to be called when the processorerror event fires.

Fields inherited from class akasha.audio.AudioNode

channelCount, channelCountMode, channelInterpretation

Constructor Summary

Constructors

Constructor and Description
AudioWorkletNode(BaseAudioContext context, java.lang.String name) The AudioWorkletNode() constructor creates a new AudioWorkletNode object, which represents an AudioNode that uses a JavaScript function to perform custom audio processing.
AudioWorkletNode(BaseAudioContext context, java.lang.String name, AudioWorkletNodeOptions options) The AudioWorkletNode() constructor creates a new AudioWorkletNode object, which represents an AudioNode that uses a JavaScript function to perform custom audio processing.

Method Summary

Modifier and Type	Method and Description
void	addProcessorerrorListener(EventListener callback)
void	addProcessorerrorListener(EventListener callback, AddEventListenerOptions options)
void	addProcessorerrorListener(EventListener callback, boolean useCapture)
AudioParamMap	parameters() The read-only parameters property of the AudioWorkletNode interface returns the associated AudioParamMap — that is, a Map-like collection of AudioParam objects.
MessagePort	port() The read-only port property of the AudioWorkletNode interface returns the associated MessagePort.
void	removeProcessorerrorListener(EventListener callback)
void	removeProcessorerrorListener(EventListener callback, boolean useCapture)
void	removeProcessorerrorListener(EventListener callback, EventListenerOptions options)

Methods inherited from class akasha.audio.AudioNode

connect, connect, connect, connect, connect, context, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, disconnect, numberOfInputs, numberOfOutputs

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

onprocessorerror

public @JsNullable EventHandler onprocessorerror

The onprocessorerror property of the AudioWorkletNode interface defines an event handler function to be called when the processorerror event fires. This occurs when the underlying AudioWorkletProcessor behind the node throws an exception in its constructor, the process method, or any user-defined class method.

See Also:

AudioWorkletNode.onprocessorerror - MDN, onprocessorerror - Web Audio API

Constructor Detail

AudioWorkletNode

public AudioWorkletNode(@Nonnull
                        BaseAudioContext context,
                        @Nonnull
                        java.lang.String name,
                        @Nonnull
                        AudioWorkletNodeOptions options)

The AudioWorkletNode() constructor creates a new AudioWorkletNode object, which represents an AudioNode that uses a JavaScript function to perform custom audio processing.

See Also:

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

AudioWorkletNode

public AudioWorkletNode(@Nonnull
                        BaseAudioContext context,
                        @Nonnull
                        java.lang.String name)

The AudioWorkletNode() constructor creates a new AudioWorkletNode object, which represents an AudioNode that uses a JavaScript function to perform custom audio processing.

See Also:

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

Method Detail

parameters

@JsProperty(name="parameters")
 @Nonnull
public AudioParamMap parameters()

The read-only parameters property of the AudioWorkletNode interface returns the associated AudioParamMap — that is, a Map-like collection of AudioParam objects. They are instantiated during creation of the underlying AudioWorkletProcessor according to its parameterDescriptors static getter.

See Also:

AudioWorkletNode.parameters - MDN, parameters - Web Audio API

port

@JsProperty(name="port")
 @Nonnull
public MessagePort port()

The read-only port property of the AudioWorkletNode interface returns the associated MessagePort. It can be used to communicate between the node and its associated AudioWorkletProcessor.

See Also:

AudioWorkletNode.port - MDN, port - Web Audio API

addProcessorerrorListener

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

addProcessorerrorListener

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

addProcessorerrorListener

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

removeProcessorerrorListener

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

removeProcessorerrorListener

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

removeProcessorerrorListener

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