Trait web_audio_api::node::AudioNode

source · [−]
pub trait AudioNode {

Show 17 methods    fn registration(&self) -> &AudioContextRegistration;

    fn channel_config_raw(&self) -> &ChannelConfig;

    fn number_of_inputs(&self) -> u32;

    fn number_of_outputs(&self) -> u32;

    fn id(&self) -> &AudioNodeId { ... }

    fn channel_config_cloned(&self) -> ChannelConfig { ... }

    fn context(&self) -> &ConcreteBaseAudioContext { ... }

    fn connect<'a>(&self, dest: &'a dyn AudioNode) -> &'a dyn AudioNode { ... }

    fn connect_at<'a>(
        &self, 
        dest: &'a dyn AudioNode, 
        output: u32, 
        input: u32
    ) -> &'a dyn AudioNode { ... }

    fn disconnect_from<'a>(&self, dest: &'a dyn AudioNode) -> &'a dyn AudioNode { ... }

    fn disconnect(&self) { ... }

    fn channel_count_mode(&self) -> ChannelCountMode { ... }

    fn set_channel_count_mode(&self, v: ChannelCountMode) { ... }

    fn channel_interpretation(&self) -> ChannelInterpretation { ... }

    fn set_channel_interpretation(&self, v: ChannelInterpretation) { ... }

    fn channel_count(&self) -> usize { ... }

    fn set_channel_count(&self, v: usize) { ... }

}
Expand description

This interface represents audio sources, the audio destination, and intermediate processing modules.

These modules can be connected together to form processing graphs for rendering audio to the audio hardware. Each node can have inputs and/or outputs.

Note that the AudioNode is typically constructed together with an AudioProcessor (the object that lives the render thread). See ConcreteBaseAudioContext::register.

Required methods

The number of inputs feeding into the AudioNode. For source nodes, this will be 0.

The number of outputs coming out of the AudioNode.

Provided methods

The BaseAudioContext which owns this AudioNode.

Connect the output of this AudioNode to the input of another node.

Panics

This function will panic when

  • the AudioContext of the source and destination does not match

Connect a specific output of this AudioNode to a specific input of another node.

Panics

This function will panic when

  • the AudioContext of the source and destination does not match
  • if the input port is out of bounds for the destination node
  • if the output port is out of bounds for the source node

Disconnects all outputs of the AudioNode that go to a specific destination AudioNode.

Disconnects all outgoing connections from the AudioNode.

Represents an enumerated value describing the way channels must be matched between the node’s inputs and outputs.

Represents an enumerated value describing the meaning of the channels. This interpretation will define how audio up-mixing and down-mixing will happen.

Represents an integer used to determine how many channels are used when up-mixing and down-mixing connections to any inputs to the node.

Implementors