Struct web_audio_api::context::AudioContext

pub struct AudioContext { /* fields omitted */ }

This interface represents an audio graph whose AudioDestinationNode is routed to a real-time output device that produces a signal directed at the user.

Implementations

impl AudioContext

pub fn new() -> Self

Creates and returns a new AudioContext object. This will play live audio on the default output

pub fn suspend(&self)

Suspends the progression of time in the audio context, temporarily halting audio hardware access and reducing CPU/battery usage in the process.

pub fn resume(&self)

Resumes the progression of time in an audio context that has previously been suspended/paused.

Trait Implementations

impl AsBaseAudioContext for AudioContext

fn base(&self) -> &BaseAudioContext

fn create_oscillator(&self) -> OscillatorNode<'_>

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

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_delay(&self) -> DelayNode<'_>

Creates a DelayNode, delaying the audio signal

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<M: MediaStream>(
    &self,
    media: MediaElement<M>
) -> 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_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 Default for AudioContext

fn default() -> Self

Returns the “default value” for a type.