Struct DelayNode

pub struct DelayNode { /* private fields */ }

Node that delays the incoming audio signal by a certain amount

The current implementation does not allow for zero delay. The minimum delay is one render quantum (e.g. ~2.9ms at 44.1kHz).

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

Usage

use std::fs::File;
use web_audio_api::context::{BaseAudioContext, AudioContext};
use web_audio_api::node::{AudioNode, AudioScheduledSourceNode};

// create an `AudioContext` and load a sound file
let context = AudioContext::default();
let file = File::open("samples/sample.wav").unwrap();
let audio_buffer = context.decode_audio_data_sync(file).unwrap();

// create a delay of 0.5s
let delay = context.create_delay(1.);
delay.delay_time().set_value(0.5);
delay.connect(&context.destination());

let mut src = context.create_buffer_source();
src.set_buffer(audio_buffer);
// connect to both delay and destination
src.connect(&delay);
src.connect(&context.destination());
src.start();

Examples

• cargo run --release --example simple_delay
• cargo run --release --example feedback_delay

Implementations

impl DelayNode

pub fn new<C: BaseAudioContext>(context: &C, options: DelayOptions) -> Self

Create a new DelayNode

Panics

Panics when the max delay value is smaller than zero or langer than three minutes.

pub fn delay_time(&self) -> &AudioParam

A-rate AudioParam representing the amount of delay (in seconds) to apply.

Trait Implementations

impl AudioNode for DelayNode

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.

Panics

This function will panic when

• the AudioContext of the source and destination does not match
• the source node was not connected to the destination node

fn disconnect_output(&self, output: usize)

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

Panics

This function will panic when

• if the output port is out of bounds for this node

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

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

Panics

This function will panic when

• the AudioContext of the source and destination does not match
• if the output port is out of bounds for the source node
• the source node was not connected to the destination node

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

Panics

This function will panic when

• the AudioContext of the source and destination does not match
• if the input port is out of bounds for the destination node
• if the output port is out of bounds for the source node
• the source node was not connected to the destination node

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 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 DelayNode

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

Formats the value using the given formatter.