Struct libpulse_simple_binding::Simple

pub struct Simple { /* fields omitted */ }

An opaque simple connection object. This acts as a safe Rust wrapper for the actual C object.

Methods

impl Simple

pub fn new(     server: Option<&str>,     name: &str,     dir: Direction,     dev: Option<&str>,     stream_name: &str,     ss: &Spec,     map: Option<&Map>,     attr: Option<&BufferAttr> ) -> Result<Self, PAErr>

Create a new connection to the server.

Params

• server: Server name, or None for default.
• name: A descriptive name for this client (application name, ...).
• dir: Open this stream for recording or playback?
• dev: Sink (resp. source) name, or None for default.
• stream_name: A descriptive name for this stream (application name, song title, ...).
• ss: The sample type to use.
• map: The channel map to use, or None for default.
• attr: Buffering attributes, or None for default.

pub fn write(&self, data: &[u8]) -> Result<(), PAErr>

Write some data to the server.

pub fn drain(&self) -> Result<(), PAErr>

Wait until all data already written is played by the daemon.

pub fn read(&self, data: &mut [u8]) -> Result<(), PAErr>

Read some data from the server.

This function blocks until data.len() amount of data has been received from the server, or until an error occurs.

pub fn get_latency(&self) -> Option<MicroSeconds>

Return the playback or record latency.

pub fn flush(&self) -> Result<(), PAErr>

Flush the playback or record buffer. This discards any audio in the buffer.

Trait Implementations

impl Drop for Simple

fn drop(&mut self)

Executes the destructor for this type.