Struct BufferNode

pub struct BufferNode { /* private fields */ }

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.

Implementations

impl BufferNode

pub fn new(server: &Server) -> Result<BufferNode>

Creates a new buffer node.

Examples found in repository

examples/file_playback.rs (line 21)

fn main() {
    libaudioverse::initialize().unwrap();
    
    // server initialization
    let server = Server::new().unwrap();
    server.set_output_device().expect("Could not create default audio device");
    
    // create a new buffer
    let buf = Buffer::new(&server).unwrap();
    let path = CString::new("test.ogg").unwrap();
    
    // load audio data from test.ogg into this buffer
    buf.load_from_file(&path).unwrap();
    
    // create a Buffer node, associate it with the buffer just created, and play it
    let buf_node = BufferNode::new(&server).unwrap();
    buf_node.buffer().set(&buf).unwrap();
    buf_node.connect_server(0).unwrap();
    
    // wait for the whole file to finish playing
    let duration = buf_node.position().get_range().unwrap().1.ceil() as u64;
    thread::sleep(time::Duration::from_secs(duration));
    
    libaudioverse::shutdown().unwrap();
}

pub fn buffer(&self) -> BufferProperty

Returns the currently playing buffer. Setting this property will reset position.

Examples found in repository

examples/file_playback.rs (line 22)

fn main() {
    libaudioverse::initialize().unwrap();
    
    // server initialization
    let server = Server::new().unwrap();
    server.set_output_device().expect("Could not create default audio device");
    
    // create a new buffer
    let buf = Buffer::new(&server).unwrap();
    let path = CString::new("test.ogg").unwrap();
    
    // load audio data from test.ogg into this buffer
    buf.load_from_file(&path).unwrap();
    
    // create a Buffer node, associate it with the buffer just created, and play it
    let buf_node = BufferNode::new(&server).unwrap();
    buf_node.buffer().set(&buf).unwrap();
    buf_node.connect_server(0).unwrap();
    
    // wait for the whole file to finish playing
    let duration = buf_node.position().get_range().unwrap().1.ceil() as u64;
    thread::sleep(time::Duration::from_secs(duration));
    
    libaudioverse::shutdown().unwrap();
}

pub fn ended_count(&self) -> IntProperty

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.

pub fn looping(&self) -> BoolProperty

Returns the looping property.

Default value: False

If true, this node continues playing the same buffer from the beginning after it reaches the end.

pub fn position(&self) -> DoubleProperty

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.

Examples found in repository

examples/file_playback.rs (line 26)

fn main() {
    libaudioverse::initialize().unwrap();
    
    // server initialization
    let server = Server::new().unwrap();
    server.set_output_device().expect("Could not create default audio device");
    
    // create a new buffer
    let buf = Buffer::new(&server).unwrap();
    let path = CString::new("test.ogg").unwrap();
    
    // load audio data from test.ogg into this buffer
    buf.load_from_file(&path).unwrap();
    
    // create a Buffer node, associate it with the buffer just created, and play it
    let buf_node = BufferNode::new(&server).unwrap();
    buf_node.buffer().set(&buf).unwrap();
    buf_node.connect_server(0).unwrap();
    
    // wait for the whole file to finish playing
    let duration = buf_node.position().get_range().unwrap().1.ceil() as u64;
    thread::sleep(time::Duration::from_secs(duration));
    
    libaudioverse::shutdown().unwrap();
}

pub fn rate(&self) -> DoubleProperty

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

fn connect(&self, output: i32, destination: &dyn 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: &dyn 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: &dyn 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.