Struct web_audio_api::worklet::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_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>

Trait Implementations

impl AudioNode for AudioWorkletNode

fn registration(&self) -> &AudioContextRegistration

fn channel_config(&self) -> &ChannelConfig

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_at<'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_from<'a>(&self, dest: &'a dyn AudioNode) -> &'a dyn AudioNode

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

fn disconnect(&self)

Disconnects all outgoing connections from the 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.