Struct StreamBox

pub struct StreamBox<'c> { /* private fields */ }

Implementations

impl<'c> StreamBox<'c>

pub fn new( core: &'c Core, name: &str, properties: PropertiesBox, ) -> Result<StreamBox<'c>, Error>

Create a StreamBox

Initialises a new stream with the given name and properties.

pub fn new_cstr( core: &'c Core, name: &CStr, properties: PropertiesBox, ) -> Result<StreamBox<'c>, Error>

Initialises a new stream with the given name as C String and properties.

pub unsafe fn from_raw(raw: NonNull<pw_stream>) -> StreamBox<'c>

Create a StreamBox by taking ownership of a raw pw_stream.

Safety

The provided pointer must point to a valid, well aligned pw_stream.

The raw stream must not be manually destroyed or moved, as the new StreamBox takes ownership of it.

The lifetime of the returned box is unbounded. The caller is responsible to make sure that the core used with this stream outlives the stream.

pub fn into_raw(self) -> NonNull<pw_stream>

Methods from Deref<Target = Stream>

pub fn as_raw(&self) -> &pw_stream

pub fn as_raw_ptr(&self) -> *mut pw_stream

pub fn add_local_listener_with_user_data<D>( &self, user_data: D, ) -> ListenerLocalBuilder<'_, D>

Add a local listener builder

pub fn add_local_listener<D: Default>(&self) -> ListenerLocalBuilder<'_, D>

Add a local listener builder. User data is initialized with its default value

pub fn connect( &self, direction: Direction, id: Option<u32>, flags: StreamFlags, params: &mut [&Pod], ) -> Result<(), Error>

Connect the stream

Tries to connect to the node id in the given direction. If no node is provided then any suitable node will be used.

pub fn update_params(&self, params: &mut [&Pod]) -> Result<(), Error>

Update Parameters

Call from the param_changed callback to negotiate a new set of parameters for the stream.

pub fn set_active(&self, active: bool) -> Result<(), Error>

Activate or deactivate the stream

pub unsafe fn dequeue_raw_buffer(&self) -> *mut pw_buffer

Take a Buffer from the Stream

Removes a buffer from the stream. If this is an input stream the buffer will contain data ready to process. If this is an output stream it can be filled.

Safety

The pointer returned could be NULL if no buffer is available. The buffer should be returned to the stream once processing is complete.

pub fn dequeue_buffer(&self) -> Option<Buffer<'_>>

pub unsafe fn queue_raw_buffer(&self, buffer: *mut pw_buffer)

Return a Buffer to the Stream

Give back a buffer once processing is complete. Use this to queue up a frame for an output stream, or return the buffer to the pool ready to receive new data for an input stream.

Safety

The buffer pointer should be one obtained from this stream instance by a call to Self::dequeue_raw_buffer().

pub fn disconnect(&self) -> Result<(), Error>

Disconnect the stream

pub fn flush(&self, drain: bool) -> Result<(), Error>

Flush the stream. When drain is true, the drained callback will be called when all data is played or recorded.

pub fn set_control(&self, id: u32, values: &[f32]) -> Result<(), Error>

pub fn name(&self) -> String

Get the name of the stream.

pub fn state(&self) -> StreamState

Get the current state of the stream.

pub fn properties(&self) -> &Properties

Get the properties of the stream.

pub fn node_id(&self) -> u32

Get the node ID of the stream.

Trait Implementations

impl<'c> Debug for StreamBox<'c>

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

Formats the value using the given formatter.

impl<'c> Deref for StreamBox<'c>

type Target = Stream

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'c> Drop for StreamBox<'c>

fn drop(&mut self)

Executes the destructor for this type.