Struct AudioObjectId 

#[repr(transparent)]
pub struct AudioObjectId(pub u32);

A Core Audio object identifier.

Layout-compatible with the C AudioObjectID (u32). AudioObjectId::UNKNOWN (0) is the reserved “no object” sentinel; AudioObjectId::PLUGIN (1) is the fixed id the HAL uses to address the plug-in object itself. Every other id is minted by the plug-in as it creates boxes, devices, and streams.

Tuple Fields

0: u32

Implementations

impl AudioObjectId

pub const UNKNOWN: Self

kAudioObjectUnknown — the reserved “no object” id.

pub const PLUGIN: Self

kAudioObjectPlugInObject — the fixed id by which the HAL addresses the plug-in object. The plug-in does not mint this id; it is assigned by Core Audio before the first property call.

pub const FIRST_DYNAMIC: Self

The first id the plug-in is free to mint for its own objects. Ids 0 and 1 are reserved (see Self::UNKNOWN and Self::PLUGIN).

pub const fn from_u32(value: u32) -> Self

Wrap a raw AudioObjectID.

pub const fn as_u32(self) -> u32

The raw u32, ready for the FFI boundary.

pub const fn is_unknown(self) -> bool

true iff this is Self::UNKNOWN.

pub const fn is_plugin(self) -> bool

true iff this is Self::PLUGIN.

Trait Implementations

impl Clone for AudioObjectId

fn clone(&self) -> AudioObjectId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AudioObjectId

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

Formats the value using the given formatter.

impl From<AudioObjectId> for DeviceId

fn from(value: AudioObjectId) -> Self

Converts to this type from the input type.

impl From<AudioObjectId> for u32

fn from(value: AudioObjectId) -> Self

Converts to this type from the input type.

impl From<u32> for AudioObjectId

fn from(value: u32) -> Self

Converts to this type from the input type.

impl Hash for AudioObjectId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for AudioObjectId

fn cmp(&self, other: &AudioObjectId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for AudioObjectId

fn eq(&self, other: &AudioObjectId) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for AudioObjectId

fn partial_cmp(&self, other: &AudioObjectId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for AudioObjectId

impl Eq for AudioObjectId

impl StructuralPartialEq for AudioObjectId