Struct DynamicsCompressorNode

pub struct DynamicsCompressorNode { /* private fields */ }

DynamicsCompressorNode provides a compression effect.

It lowers the volume of the loudest parts of the signal and raises the volume of the softest parts. Overall, a louder, richer, and fuller sound can be achieved. It is especially important in games and musical applications where large numbers of individual sounds are played simultaneous to control the overall signal level and help avoid clipping (distorting) the audio output to the speakers.

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

Usage

use std::fs::File;
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 into an audio buffer
let file = File::open("samples/sample.wav").unwrap();
let buffer = context.decode_audio_data_sync(file).unwrap();

// create compressor and connect to destination
let compressor = context.create_dynamics_compressor();
compressor.connect(&context.destination());

// pipe the audio source in the compressor
let mut src = context.create_buffer_source();
src.connect(&compressor);
src.set_buffer(buffer.clone());
src.start();

Examples

• cargo run --release --example compressor

Implementations

impl DynamicsCompressorNode

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

pub fn attack(&self) -> &AudioParam

pub fn knee(&self) -> &AudioParam

pub fn ratio(&self) -> &AudioParam

pub fn release(&self) -> &AudioParam

pub fn threshold(&self) -> &AudioParam

pub fn reduction(&self) -> f32

Trait Implementations

impl AudioNode for DynamicsCompressorNode

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, count: usize)

Update the channel_count attribute

fn set_channel_count_mode(&self, mode: 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 DynamicsCompressorNode

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

Formats the value using the given formatter.