Struct libspa_sys::spa_io_buffers

#[repr(C)]
pub struct spa_io_buffers {
    pub status: i32,
    pub buffer_id: u32,
}

IO area to exchange buffers.

A set of buffers should first be configured on the node/port. Further references to those buffers will be made by using the id of the buffer.

If status is SPA_STATUS_OK, the host should ignore the io area.

If status is SPA_STATUS_NEED_DATA, the host should:

1. recycle the buffer in buffer_id, if possible
2. prepare a new buffer and place the id in buffer_id.

If status is SPA_STATUS_HAVE_DATA, the host should consume the buffer in buffer_id and set the state to SPA_STATUS_NEED_DATA when new data is requested.

If status is SPA_STATUS_STOPPED, some error occurred on the port.

If status is SPA_STATUS_DRAINED, data from the io area was used to drain.

Status can also be a negative errno value to indicate errors. such as: -EINVAL: buffer_id is invalid -EPIPE: no more buffers available

Fields

status: i32

< the status code

buffer_id: u32

< a buffer id

Trait Implementations

impl Clone for spa_io_buffers

fn clone(&self) -> spa_io_buffers

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for spa_io_buffers

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for spa_io_buffers

fn eq(&self, other: &spa_io_buffers) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for spa_io_buffers

impl Eq for spa_io_buffers

impl StructuralPartialEq for spa_io_buffers