Struct MediaStreamTrackAudioSourceNode

pub struct MediaStreamTrackAudioSourceNode { /* private fields */ }

An audio source from a MediaStreamTrack (e.g. the audio track of the microphone input)

Below is an example showing how to create and play a stream directly in the audio context. Take care: The media stream will be polled on the render thread which will have catastrophic effects if the iterator blocks or for another reason takes too much time to yield a new sample frame. Use a MediaElementAudioSourceNode for real time safe media playback.

Example

use web_audio_api::context::{AudioContext, BaseAudioContext};
use web_audio_api::{AudioBuffer, AudioBufferOptions};
use web_audio_api::node::AudioNode;
use web_audio_api::media_streams::MediaStreamTrack;

// create a new buffer: 512 samples of silence
let options = AudioBufferOptions {
    number_of_channels: 0,
    length: 512,
    sample_rate: 44_100.,
};
let silence = AudioBuffer::new(options);

// create a sequence of this buffer
let sequence = std::iter::repeat(silence).take(5);

// the sequence should actually yield `Result<AudioBuffer, _>`s
let sequence = sequence.map(|b| Ok(b));

// convert to a media track
let media = MediaStreamTrack::from_iter(sequence);

// use in the web audio context
let context = AudioContext::default();
let node = context.create_media_stream_track_source(&media);
node.connect(&context.destination());

loop {}

Implementations

impl MediaStreamTrackAudioSourceNode

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

Trait Implementations

impl AudioNode for MediaStreamTrackAudioSourceNode

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 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 set_channel_count_mode(&self, v: ChannelCountMode)

Update the channel_count_mode attribute

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_channel_count(&self, v: usize)

Update the channel_count attribute

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 MediaStreamTrackAudioSourceNode

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

Formats the value using the given formatter.