Struct web_audio_api::node::ConstantSourceNode
source · pub struct ConstantSourceNode { /* private fields */ }
Expand description
Audio source whose output is nominally a constant value. A ConstantSourceNode
can be used as a constructible AudioParam
by automating the value of its offset.
- MDN documentation: https://developer.mozilla.org/en-US/docs/Web/API/ConstantSourceNode
- specification: https://webaudio.github.io/web-audio-api/#ConstantSourceNode
- see also:
BaseAudioContext::create_constant_source
Usage
use web_audio_api::context::{BaseAudioContext, AudioContext};
use web_audio_api::node::AudioNode;
let audio_context = AudioContext::default();
let gain1 = audio_context.create_gain();
gain1.gain().set_value(0.);
let gain2 = audio_context.create_gain();
gain2.gain().set_value(0.);
let automation = audio_context.create_constant_source();
automation.offset().set_value(0.);
automation.connect(gain1.gain());
automation.connect(gain2.gain());
// control both `GainNode`s with 1 automation
automation.offset().set_target_at_time(1., audio_context.current_time(), 0.1);
Example
cargo run --release --example constant_source
Implementations§
source§impl ConstantSourceNode
impl ConstantSourceNode
pub fn new<C: BaseAudioContext>(
context: &C,
options: ConstantSourceOptions
) -> Self
pub fn offset(&self) -> &AudioParam
Trait Implementations§
source§impl AudioNode for ConstantSourceNode
impl AudioNode for ConstantSourceNode
fn registration(&self) -> &AudioContextRegistration
fn channel_config(&self) -> &ChannelConfig
source§fn number_of_inputs(&self) -> usize
fn number_of_inputs(&self) -> usize
The number of inputs feeding into the AudioNode. For source nodes, this will be 0.
source§fn number_of_outputs(&self) -> usize
fn number_of_outputs(&self) -> usize
The number of outputs coming out of the AudioNode.
source§fn context(&self) -> &ConcreteBaseAudioContext
fn context(&self) -> &ConcreteBaseAudioContext
The
BaseAudioContext
concrete type which owns this
AudioNode.source§fn connect<'a>(&self, dest: &'a dyn AudioNode) -> &'a dyn AudioNode
fn connect<'a>(&self, dest: &'a dyn AudioNode) -> &'a dyn AudioNode
Connect the output of this AudioNode to the input of another node. Read more
source§fn connect_at<'a>(
&self,
dest: &'a dyn AudioNode,
output: usize,
input: usize
) -> &'a dyn AudioNode
fn connect_at<'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. Read more
source§fn disconnect_from<'a>(&self, dest: &'a dyn AudioNode) -> &'a dyn AudioNode
fn disconnect_from<'a>(&self, dest: &'a dyn AudioNode) -> &'a dyn AudioNode
Disconnects all outputs of the AudioNode that go to a specific destination AudioNode.
source§fn disconnect(&self)
fn disconnect(&self)
Disconnects all outgoing connections from the AudioNode.
source§fn channel_count_mode(&self) -> ChannelCountMode
fn channel_count_mode(&self) -> ChannelCountMode
Represents an enumerated value describing the way channels must be matched between the
node’s inputs and outputs.
source§fn set_channel_count_mode(&self, v: ChannelCountMode)
fn set_channel_count_mode(&self, v: ChannelCountMode)
Update the
channel_count_mode
attributesource§fn channel_interpretation(&self) -> ChannelInterpretation
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.
source§fn set_channel_interpretation(&self, v: ChannelInterpretation)
fn set_channel_interpretation(&self, v: ChannelInterpretation)
Update the
channel_interpretation
attributesource§fn channel_count(&self) -> usize
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.
source§fn set_channel_count(&self, v: usize)
fn set_channel_count(&self, v: usize)
Update the
channel_count
attributesource§impl AudioScheduledSourceNode for ConstantSourceNode
impl AudioScheduledSourceNode for ConstantSourceNode
source§fn set_onended<F: FnOnce(Event) + Send + 'static>(&self, callback: F)
fn set_onended<F: FnOnce(Event) + Send + 'static>(&self, callback: F)
Register callback to run when the source node has stopped playing Read more
source§fn clear_onended(&self)
fn clear_onended(&self)
Unset the callback to run when the source node has stopped playing