pub struct Simple { /* private fields */ }
Expand description

An opaque simple connection object.

Implementations§

source§

impl Simple

source

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

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

Writes some data to the server.

source

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

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

source

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.

source

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

Gets the playback or record latency.

source

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

Flushes the playback or record buffer.

This discards any audio in the buffer.

Trait Implementations§

source§

impl Drop for Simple

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl Send for Simple

source§

impl Sync for Simple

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.