Struct libaudioverse::nodes::buffer_node::BufferNode
[−]
[src]
pub struct BufferNode { /* fields omitted */ }This node plays a buffer. The output of this node will have as many channels as the buffer does, so connecting it directly to the server will have the desired effect.
This node has no inputs.
Outputs:
| index | channels | description |
|---|---|---|
| 0 | Depends on the currently playing buffer. | The output from the buffer being played. |
Methods
impl BufferNode[src]
fn new(server: &Server) -> Result<BufferNode>[src]
Creates a new buffer node.
fn buffer(&self) -> BufferProperty[src]
Returns the currently playing buffer. Setting this property will reset position.
fn ended_count(&self) -> IntProperty[src]
Returns the ended_count property.
Range: [0, MAX_INT]
Default value: 0
Increments every time the buffer reaches it’s end. If the buffer is not looping, this can be used to determine when the buffer is ended, without using the callback. if the buffer is configured to loop, the counter will count up every time the end of a loop is reached. You can write to this property to reset it.
fn looping(&self) -> BoolProperty[src]
Returns the looping property.
Default value: False
If true, this node continues playing the same buffer from the beginning after it reaches the end.
fn position(&self) -> DoubleProperty[src]
Returns the position property.
Range: dynamic
Default value: 0.0
The position of playback, in seconds. The range of this property corresponds to the total duration of the buffer.
fn rate(&self) -> DoubleProperty[src]
Returns the rate property.
Range: [0, INFINITY]
Default value: 1.0
A multiplier that applies to playback rate. 1.0 is identity. Values less than 1.0 cause a decrease in pitch and values greater than 1.0 cause an increase in pitch.
Trait Implementations
impl Node for BufferNode[src]
fn connect(&self, output: i32, destination: &Node, input: i32) -> Result<()>[src]
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. Read more
fn connect_property(
&self,
output: i32,
destination: &Node,
slot: i32
) -> Result<()>[src]
&self,
output: i32,
destination: &Node,
slot: i32
) -> Result<()>
Connect a node’s output to an automatable property.
fn connect_server(&self, output: i32) -> Result<()>[src]
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. Read more
fn disconnect(&self, output: i32, destination: &Node, input: i32) -> Result<()>[src]
Disconnect the output of the specified node.
fn get_input_connection_count(&self) -> Result<u32>[src]
Get the number of inputs this node has.
fn get_output_connection_count(&self) -> Result<u32>[src]
Get the number of outputs this node has.
fn isolate(&self) -> Result<()>[src]
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<()>[src]
Reset a node. What this means depends on the node in question. Properties are not touched by node resetting.
fn add(&self) -> FloatProperty[src]
Returns the add property. Read more
fn mul(&self) -> FloatProperty[src]
Returns the mul property. Read more
fn state(&self) -> NodeStateProperty[src]
Returns the state property. Read more