Struct AudioWorkletNode

pub struct AudioWorkletNode { /* private fields */ }

A user-defined AudioNode which lives in the control thread

• MDN documentation: https://developer.mozilla.org/en-US/docs/Web/API/AudioWorkletNode
• specification: https://webaudio.github.io/web-audio-api/#AudioWorkletNode

Examples

• cargo run --release --example worklet
• cargo run --release --example worklet_message_port
• cargo run --release --example worklet_bitcrusher

Implementations

impl AudioWorkletNode

pub fn new<P: AudioWorkletProcessor + 'static>( context: &impl BaseAudioContext, options: AudioWorkletNodeOptions<P::ProcessorOptions>, ) -> Self

Construct a new AudioWorkletNode

Panics

This function panics when

• the number of inputs and the number of outputs of the supplied options are both equal to zero.
• any of the output channel counts is equal to zero or larger than 32 (MAX_CHANNELS)

pub fn parameters(&self) -> &HashMap<String, AudioParam>

Collection of AudioParam objects with associated names of this node

This map is populated from a list of AudioParamDescriptors in the AudioWorkletProcessor class constructor at the instantiation.

pub fn port(&self) -> MessagePort<'_>

Message port to the processor in the render thread

Every AudioWorkletNode has an associated port which is the MessagePort. It is connected to the port on the corresponding AudioWorkletProcessor object allowing bidirectional communication between the AudioWorkletNode and its AudioWorkletProcessor.

Trait Implementations

impl AudioNode for AudioWorkletNode

fn registration(&self) -> &AudioContextRegistration

Handle of the associated BaseAudioContext.

fn channel_config(&self) -> &ChannelConfig

Config for up/down-mixing of input channels for this node.

fn number_of_inputs(&self) -> usize

The number of inputs feeding into the AudioNode. For source nodes, this will be 0.

fn number_of_outputs(&self) -> usize

The number of outputs coming out of the AudioNode.

fn context(&self) -> &ConcreteBaseAudioContext

The BaseAudioContext concrete type which owns this AudioNode.

fn connect<'a>(&self, dest: &'a dyn AudioNode) -> &'a dyn AudioNode

Connect the output of this AudioNode to the input of another node.

fn connect_from_output_to_input<'a>( &self, dest: &'a dyn AudioNode, output: usize, input: usize, ) -> &'a dyn AudioNode

Connect a specific output of this AudioNode to a specific input of another node.

fn disconnect(&self)

Disconnects all outgoing connections from the AudioNode.

fn disconnect_dest(&self, dest: &dyn AudioNode)

Disconnects all outputs of the AudioNode that go to a specific destination AudioNode.

fn disconnect_output(&self, output: usize)

Disconnects all outgoing connections at the given output port from the AudioNode.

fn disconnect_dest_from_output(&self, dest: &dyn AudioNode, output: usize)

Disconnects a specific output of the AudioNode to a specific destination AudioNode

fn disconnect_dest_from_output_to_input( &self, dest: &dyn AudioNode, output: usize, input: usize, )

Disconnects a specific output of the AudioNode to a specific input of some destination AudioNode

fn channel_count_mode(&self) -> ChannelCountMode

Represents an enumerated value describing the way channels must be matched between the node’s inputs and outputs.

fn set_channel_count_mode(&self, v: ChannelCountMode)

Update the channel_count_mode attribute

fn channel_interpretation(&self) -> ChannelInterpretation

Represents an enumerated value describing the meaning of the channels. This interpretation will define how audio up-mixing and down-mixing will happen.

fn set_channel_interpretation(&self, v: ChannelInterpretation)

Update the channel_interpretation attribute

fn channel_count(&self) -> usize

Represents an integer used to determine how many channels are used when up-mixing and down-mixing connections to any inputs to the node.

fn set_channel_count(&self, v: usize)

Update the channel_count attribute

fn set_onprocessorerror( &self, callback: Box<dyn FnOnce(ErrorEvent) + Send + 'static>, )

Register callback to run when an unhandled exception occurs in the audio processor.

fn clear_onprocessorerror(&self)

Unset the callback to run when an unhandled exception occurs in the audio processor.

impl Debug for AudioWorkletNode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.