Struct StreamHandle 

pub struct StreamHandle { /* private fields */ }

A handle to an opened RtAudio stream.

When this struct is dropped, the stream will automatically be stopped and closed.

Only one stream can exist at a time.

Implementations

impl StreamHandle

pub fn info(&self) -> &StreamInfo

Information about the stream.

pub fn has_started(&self) -> bool

Returns true if the stream has been started.

pub fn start<F>(&mut self, data_callback: F) -> Result<(), RtAudioError>

where F: FnMut(Buffers<'_>, &StreamInfo, StreamStatus) + Send + 'static,

Start the stream.

• data_callback - This gets called whenever there are new buffers to process.

If an error is returned, then it means that the stream failed to start.

Panics

Panics if the stream has already been started. (Use StreamHandle::has_started to check if it has been started already.)

pub fn stop(&mut self)

Stop the stream.

This will block the calling thread until the stream is stopped. After which the data_callback passed into Stream::start() will be dropped.

This does not close the stream.

pub fn close(self) -> Host

Close the stream.

If the stream is running, this will stop the stream first. In that case, this will block the calling thread until the stream is stopped. After which the data_callback passed into Stream::start() will be dropped.

Trait Implementations

impl Drop for StreamHandle

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.