Struct web_audio_api::node::AudioDestinationNode

pub struct AudioDestinationNode { /* private fields */ }

The AudioDestinationNode interface represents the terminal node of an audio graph in a given context. usually the speakers of your device, or the node that will “record” the audio data with an OfflineAudioContext.

The output of a AudioDestinationNode is produced by summing its input, allowing to capture the output of an AudioContext into, for example, a MediaStreamAudioDestinationNode, or a MediaRecorder.

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

Usage

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

let context = AudioContext::default();

let mut osc = context.create_oscillator();
osc.connect(&context.destination());
osc.start();

Implementations

impl AudioDestinationNode

pub fn max_channel_count(&self) -> usize

The maximum number of channels that the channelCount attribute can be set to (the max number of channels that the hardware is capable of supporting). https://www.w3.org/TR/webaudio/#dom-audiodestinationnode-maxchannelcount

Trait Implementations

impl AudioNode for AudioDestinationNode

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 set_channel_count(&self, v: usize)

Update the channel_count attribute

fn set_channel_count_mode(&self, v: ChannelCountMode)

Update the channel_count_mode attribute

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 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_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 AudioDestinationNode

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

Formats the value using the given formatter.