Struct web_audio_api::AudioParam

pub struct AudioParam { /* private fields */ }

AudioParam controls an individual aspect of an AudioNode’s functionality, such as volume.

Implementations

impl AudioParam

pub fn automation_rate(&self) -> AutomationRate

Current value of the automation rate of the AudioParam

pub fn set_automation_rate(&self, value: AutomationRate)

Update the current value of the automation rate of the AudioParam

Panics

Some nodes have automation rate constraints and may panic when updating the value.

pub fn default_value(&self) -> f32

pub fn min_value(&self) -> f32

pub fn max_value(&self) -> f32

pub fn value(&self) -> f32

Retrieve the current value of the AudioParam.

pub fn set_value(&self, value: f32) -> &Self

Set the value of the AudioParam.

Is equivalent to calling the set_value_at_time method with the current AudioContext’s currentTime

pub fn set_value_at_time(&self, value: f32, start_time: f64) -> &Self

Schedules a parameter value change at the given time.

Panics

Will panic if start_time is negative

pub fn linear_ramp_to_value_at_time(&self, value: f32, end_time: f64) -> &Self

Schedules a linear continuous change in parameter value from the previous scheduled parameter value to the given value.

Panics

Will panic if end_time is negative

pub fn exponential_ramp_to_value_at_time( &self, value: f32, end_time: f64, ) -> &Self

Schedules an exponential continuous change in parameter value from the previous scheduled parameter value to the given value.

Panics

Will panic if:

• value is zero
• end_time is negative

pub fn set_target_at_time( &self, value: f32, start_time: f64, time_constant: f64, ) -> &Self

Start exponentially approaching the target value at the given time with a rate having the given time constant.

Panics

Will panic if:

• start_time is negative
• time_constant is negative

pub fn cancel_scheduled_values(&self, cancel_time: f64) -> &Self

Cancels all scheduled parameter changes with times greater than or equal to cancel_time.

Panics

Will panic if cancel_time is negative

pub fn cancel_and_hold_at_time(&self, cancel_time: f64) -> &Self

Cancels all scheduled parameter changes with times greater than or equal to cancel_time and the automation value that would have happened at that time is then propagated for all future time.

Panics

Will panic if cancel_time is negative

pub fn set_value_curve_at_time( &self, values: &[f32], start_time: f64, duration: f64, ) -> &Self

Sets an array of arbitrary parameter values starting at the given time for the given duration.

Panics

Will panic if:

• value length is less than 2
• start_time is negative
• duration is negative or equal to zero

Trait Implementations

impl AudioNode for AudioParam

fn registration(&self) -> &AudioContextRegistration

Handle of the associated BaseAudioContext.

fn channel_config(&self) -> &'static 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 set_channel_interpretation(&self, _v: ChannelInterpretation)

Update the channel_interpretation 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 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 Clone for AudioParam

fn clone(&self) -> AudioParam

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AudioParam

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

Formats the value using the given formatter.