Struct Runtime

pub struct Runtime { /* private fields */ }

The audio runtime.

This is necessary to use with asynchronous audio-related APIs.

To run an asynchronous task inside of the audio runtime, we use the wrap function.

Examples

let runtime = audio_device::runtime::Runtime::new()?;
runtime.wrap(task()).await;

Implementations

impl Runtime

pub fn new() -> Result<Self>

Construct a new audio runtime.

pub fn enter(&self) -> RuntimeGuard<'_>

Construct a runtime guard that when in scope will provide thread-local access to runtime drivers.

pub async fn wrap<F>(&self, f: F) -> F::Output

where F: Future,

Run the given asynchronous task inside of the runtime.

Examples

let runtime = audio_device::runtime::Runtime::new()?;
runtime.wrap(task()).await;

pub fn join(self)

Shutdown and join the runtime.