Struct Server

pub struct Server { /* private fields */ }

Represents a server, the main entry point to Libaudioverse. All libaudioverse nodes must be passed a server at creation time as the first argument to their constructor and cannot migrate between them. Furthermore, it is an error to try to connect objects from different servers. By default, Libaudioverse will use one thread per core on the current system for audio mixing. This may be changed via Lav_serverSetThreads. For full details of this class, see the Libaudioverse manual.

Implementations

impl Server

pub fn new() -> Result<Server>

Creates a new server with a default sampling rate of 44,100 and a block size of 1024. This is sufficient and performant for most applications.

Examples found in repository

examples/file_playback.rs (line 10)

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 construct(sampling_rate: u32, block_size: u32) -> Result<Server>

create a new server with the specified sampling rate and block size. The block size is the number of samples to process at once, and must be a multiple of 4.

pub fn set_output_device(&self) -> Result<()>

Set the output of the server to the system’s default audio device with 2 channels and 2 mixahead.

Examples found in repository

examples/file_playback.rs (line 11)

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 set_output_device_details( &self, identifier: &CString, channels: i32, mixahead: i32, ) -> Result<()>

Set the output device of the server. Use the literal string “default” for the default audio device. Note that it is possible to change the output device of a server even after it has been set. After the output device has been set, calls to Lav_serverGetBlock will error.