Struct miniaudio::Context

pub struct Context(_);

An atomically reference counted context.

Implementations

impl Context

pub fn new(
    backends: &[Backend],
    config: Option<&ContextConfig>
) -> Result<Context, Error>

Methods from Deref<Target = RawContext>

pub fn get_device_info(
    &self,
    device_type: DeviceType,
    device_id: &DeviceId,
    share_mode: ShareMode
) -> Result<DeviceInfo, Error>

Returns information like name, format, and sample rate, ect. about a device with the given ID.

pub fn set_device_info(
    &self,
    device_type: DeviceType,
    device_id: &DeviceId,
    share_mode: ShareMode,
    device_info: &mut DeviceInfo
) -> Result<(), Error>

Returns information like name, format, and sample rate, ect. about a device with the given ID. This will place the gathered information into the passed in device_info reference.

pub fn backend(&self) -> Backend

pub fn thread_priority(&self) -> ThreadPriority

pub fn device_info_capacity(&self) -> u32

pub fn playback_device_count(&self) -> u32

Returns the number of found playback devices.

pub fn capture_device_count(&self) -> u32

Returns the number of found capture devices.

pub fn playback_devices(&self) -> &[DeviceIdAndName]

Returns a slice containing the name and IDs of all found playback devices.

pub fn capture_devices(&self) -> &[DeviceIdAndName]

Returns a slice containing the name and IDs of all found capture devices.

pub fn is_backend_asynchronous(&self) -> bool

pub fn with_devices<F>(&self, f: F) -> Result<(), Error> where
    F: FnOnce(&[DeviceIdAndName], &[DeviceIdAndName]), 

Retrieves basic information about every active playback and capture device. This function will allocate memory internally for device lists. This function will not call the closure if an error occurred.

pub fn with_playback_devices<F>(&self, f: F) -> Result<(), Error> where
    F: FnOnce(&[DeviceIdAndName]), 

Retrieves basic information about every active playback device. This function will allocate memory internally for device lists. This function will not call the closure if an error occurred.

pub fn with_capture_devices<F>(&self, f: F) -> Result<(), Error> where
    F: FnOnce(&[DeviceIdAndName]), 

Retrieves basic information about every active capture device. This function will allocate memory internally for device lists. This function will not call the closure if an error occurred.

pub unsafe fn enumerate_devices<F>(&self, callback: F) -> Result<(), Error> where
    F: for<'r, 's> FnMut(&'r RawContext, DeviceType, &'s DeviceIdAndName) -> bool, 

Safety

DO NOT call get_device_info or set_device_info while inside of the callback.

Trait Implementations

impl Clone for Context

fn clone(&self) -> Context

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Deref for Context

type Target = RawContext

The resulting type after dereferencing.

fn deref(&self) -> &RawContext

Dereferences the value.