Struct Simple 

pub struct Simple { /* private fields */ }

An opaque simple connection object.

Implementations

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>

Creates 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>

Writes some data to the server.

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

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

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

Reads 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) -> Result<MicroSeconds, PAErr>

Gets the playback or record latency.

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

Flushes 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.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Send for Simple

impl Sync for Simple