Struct libaudioverse::nodes::gain_node::GainNode

pub struct GainNode { /* fields omitted */ }

This node is essentially in instantiated generic node, offering only the functionality therein. Its purpose is to allow changing the gain or adding offset to a large collection of nodes. One possible use is as a simple mixer: point all the nodes to be mixed at the input, set mul, and then point the output at the destination for the mixed audio.

Inputs:

index	channels	description
0	Depends on arguments to this node’s constructor.	The signal whose gain is to be changed.

Outputs:

index	channels	description
0	Depends on arguments to this node’s constructor.	The signal with its gain changed.

Methods

impl GainNode

fn new(server: &Server, channels: i32) -> Result<GainNode>

Creates a new gain node.

Trait Implementations

impl Node for GainNode

fn connect(&self, output: i32, destination: &Node, input: i32) -> Result<()>

Connect the specified output of the specified node to the specified input of the specified node. It is an error if this would cause a cycle in the graph of nodes.

fn connect_property(
    &self,
    output: i32,
    destination: &Node,
    slot: i32
) -> Result<()>

Connect a node’s output to an automatable property.

fn connect_server(&self, output: i32) -> Result<()>

Connect the specified output of the specified node to the server’s input. Any node which is connected directly or indirectly to the server will remain alive even if your program lets go of it. For more details on the subject of node lifetimes, see the Libaudioverse manual.

fn disconnect(&self, output: i32, destination: &Node, input: i32) -> Result<()>

Disconnect the output of the specified node.

fn get_input_connection_count(&self) -> Result<u32>

Get the number of inputs this node has.

fn get_output_connection_count(&self) -> Result<u32>

Get the number of outputs this node has.

fn isolate(&self) -> Result<()>

Equivalent to disconnecting all of the outputs of this node. After a call to isolate, this node will no longer be affecting audio in any way.

fn reset(&self) -> Result<()>

Reset a node. What this means depends on the node in question. Properties are not touched by node resetting.

fn add(&self) -> FloatProperty

Returns the add property.

fn mul(&self) -> FloatProperty

Returns the mul property.

fn state(&self) -> NodeStateProperty

Returns the state property.