Struct cubeb_core::DeviceInfoRef

pub struct DeviceInfoRef(/* private fields */);

Implementations

impl DeviceInfoRef

pub unsafe fn from_ptr<'a>(ptr: *mut cubeb_device_info) -> &'a Self

Safety

This function is unsafe because it dereferences the given ptr pointer. The caller should ensure that pointer is valid.

pub unsafe fn from_ptr_mut<'a>(ptr: *mut cubeb_device_info) -> &'a mut Self

Safety

This function is unsafe because it dereferences the given ptr pointer. The caller should ensure that pointer is valid.

pub fn as_ptr(&self) -> *mut cubeb_device_info

impl DeviceInfoRef

pub fn devid(&self) -> DeviceId

Device identifier handle.

pub fn device_id(&self) -> Option<&str>

Device identifier which might be presented in a UI.

pub fn device_id_bytes(&self) -> Option<&[u8]>

pub fn friendly_name(&self) -> Option<&str>

Friendly device name which might be presented in a UI.

pub fn friendly_name_bytes(&self) -> Option<&[u8]>

pub fn group_id(&self) -> Option<&str>

Two devices have the same group identifier if they belong to the same physical device; for example a headset and microphone.

pub fn group_id_bytes(&self) -> Option<&[u8]>

pub fn vendor_name(&self) -> Option<&str>

Optional vendor name, may be None.

pub fn vendor_name_bytes(&self) -> Option<&[u8]>

pub fn device_type(&self) -> DeviceType

Type of device (Input/Output).

pub fn state(&self) -> DeviceState

State of device disabled/enabled/unplugged.

pub fn preferred(&self) -> DevicePref

Preferred device.

pub fn format(&self) -> DeviceFormat

Sample format supported.

pub fn default_format(&self) -> DeviceFormat

The default sample format for this device.

pub fn max_channels(&self) -> u32

Channels.

pub fn default_rate(&self) -> u32

Default/Preferred sample rate.

pub fn max_rate(&self) -> u32

Maximum sample rate supported.

pub fn min_rate(&self) -> u32

Minimum sample rate supported.

pub fn latency_lo(&self) -> u32

Lowest possible latency in frames.

pub fn latency_hi(&self) -> u32

Higest possible latency in frames.

Trait Implementations

impl AsRef<DeviceInfoRef> for DeviceInfo

fn as_ref(&self) -> &DeviceInfoRef

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<DeviceInfoRef> for DeviceInfo

fn borrow(&self) -> &DeviceInfoRef

Immutably borrows from an owned value.

impl Debug for DeviceInfoRef

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

Formats the value using the given formatter.