Struct web_audio_api::node::StereoPannerNode

pub struct StereoPannerNode { /* private fields */ }

StereoPannerNode positions an incoming audio stream in a stereo image

Implementations

impl StereoPannerNode

StereoPannerNode can be used to pan an audio stream left or right.

It is an audio-processing module that positions an incoming audio stream in a stereo image using a low-cost panning algorithm.

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

Usage

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

// create an `AudioContext`
let context = AudioContext::default();
// load and decode a soundfile
let panner = context.create_stereo_panner();
panner.connect(&context.destination());
// position source on the left
panner.pan().set_value(-1.);

// pipe an oscillator into the stereo panner
let osc = context.create_oscillator();
osc.frequency().set_value(200.);
osc.connect(&panner);
osc.start();

Examples

• cargo run --release --example stereo_panner

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

returns a StereoPannerNode instance

Arguments

• context - audio context in which the audio node will live.
• options - stereo panner options

Panics

Will panic if:

• options.channel_config.count is greater than 2
• options.channel_config.mode is ChannelCountMode::Max

pub fn pan(&self) -> &AudioParam

Returns the pan audio paramter

Trait Implementations

impl AudioNode for StereoPannerNode

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 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, mode: ChannelCountMode)

Update the channel_count_mode attribute

fn set_channel_count(&self, count: usize)

Update the channel_count 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_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_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.