Struct web_audio_api::context::BaseAudioContext

pub struct BaseAudioContext { /* fields omitted */ }

The BaseAudioContext interface represents an audio-processing graph built from audio modules linked together, each represented by an AudioNode. An audio context controls both the creation of the nodes it contains and the execution of the audio processing, or decoding.

Implementations

impl BaseAudioContext

pub fn sample_rate(&self) -> SampleRate

The sample rate (in sample-frames per second) at which the AudioContext handles audio.

pub fn current_time(&self) -> f64

This is the time in seconds of the sample frame immediately following the last sample-frame in the block of audio most recently processed by the context’s rendering graph.

pub fn channels(&self) -> u32

Number of channels for the audio destination

pub fn register<T: AudioNode, F: FnOnce(AudioContextRegistration) -> (T, Box<dyn AudioProcessor>)>(
    &self,
    f: F
) -> T

Construct a new pair of node::AudioNode and AudioProcessor

The AudioNode lives in the user-facing control thread. The Processor is sent to the render thread.

Panics

Will panic if:

• Message send to the render thread is not received in less than 10 ms

Trait Implementations

impl AsBaseAudioContext for BaseAudioContext

fn base(&self) -> &BaseAudioContext

retrieves the BaseAudioContext associated with the concrete AudioContext

fn create_oscillator(&self) -> OscillatorNode

Creates an OscillatorNode, a source representing a periodic waveform. It basically generates a tone.

fn create_stereo_panner(&self) -> StereoPannerNode

Creates an StereoPannerNode to pan a stereo output

fn create_gain(&self) -> GainNode

Creates an GainNode, to control audio volume

fn create_constant_source(&self) -> ConstantSourceNode

Creates an ConstantSourceNode, a source representing a constant value

fn create_iir_filter(
    &self,
    feedforward: Vec<f64>,
    feedback: Vec<f64>
) -> IirFilterNode

Creates an IirFilterNode

fn create_delay(&self, max_delay_time: f32) -> DelayNode

Creates a DelayNode, delaying the audio signal

fn create_biquad_filter(&self) -> BiquadFilterNode

Creates an BiquadFilterNode which implements a second order filter

fn create_wave_shaper(&self) -> WaveShaperNode

Creates a WaveShaperNode

fn create_channel_splitter(&self, number_of_outputs: u32) -> ChannelSplitterNode

Creates a ChannelSplitterNode

fn create_channel_merger(&self, number_of_inputs: u32) -> ChannelMergerNode

Creates a ChannelMergerNode

fn create_media_stream_source<M: MediaStream>(
    &self,
    media: M
) -> MediaStreamAudioSourceNode

Creates a MediaStreamAudioSourceNode from a MediaElement

fn create_media_element_source(
    &self,
    media: MediaElement
) -> MediaElementAudioSourceNode

Creates a MediaElementAudioSourceNode from a MediaElement

fn create_buffer_source(&self) -> AudioBufferSourceNode

Creates an AudioBufferSourceNode

fn create_panner(&self) -> PannerNode

Creates a PannerNode

fn create_analyser(&self) -> AnalyserNode

Creates a AnalyserNode

fn create_periodic_wave(
    &self,
    options: Option<PeriodicWaveOptions>
) -> PeriodicWave

Creates a periodic wave

fn create_audio_param(
    &self,
    opts: AudioParamOptions,
    dest: &AudioNodeId
) -> (AudioParam, AudioParamId)

Create an AudioParam.

fn destination(&self) -> DestinationNode

Returns an AudioDestinationNode representing the final destination of all audio in the context. It can be thought of as the audio-rendering device.

fn listener(&self) -> AudioListener

Returns the AudioListener which is used for 3D spatialization

fn sample_rate(&self) -> SampleRate

The sample rate (in sample-frames per second) at which the AudioContext handles audio.

fn current_time(&self) -> f64

This is the time in seconds of the sample frame immediately following the last sample-frame in the block of audio most recently processed by the context’s rendering graph.

impl Clone for BaseAudioContext

fn clone(&self) -> BaseAudioContext

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<BaseAudioContext> for BaseAudioContext

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.