Struct AudioUnitParameterOptions

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

Available on crate feature AudioUnitProperties only.

Bit positions 18, 17, and 16 are set aside for display scales. Bit 19 is reserved.

This flag provides a hint to a host that this parameter should be controlled through the highest resolution if the host has limitations on the control resolution of parameter values. Generally this means that controlling this parameter with a single MIDI Control message (i.e. 128 values) is too course a grain for that parameter, and a finer control resolution should be used if possible. If this flag is not set, then a host can assume that a 7-bit control quantization is acceptable. Ideally, parameters should be controlled in the fullest resolution that they are published with.

Changing the parameter in real-time will cause a glitch or otherwise undesirable effect.

If set, the parameter can be ramped.

If set, the parameter is obscure (hint to UI to only display in expert mode).

In the original ParameterInfo a C string only was specified. With MacOS 10.2 and later, the last four bytes of this string are reserved for a CFStringRef, which gives the ability to used Unicode encoding, necessary for providing a name in languages using non-ASCII characters. If this flag bit is set, the CFStringRef is valid.

If set, changing this parameter may change any number of others in the AudioUnit.

If set, changing this parameter may change others in the same element as the current parameter.

See also Apple’s documentation

Tuple Fields

0: u32

Implementations

impl AudioUnitParameterOptions

pub const Flag_CFNameRelease: Self

pub const Flag_OmitFromPresets: Self

pub const Flag_PlotHistory: Self

pub const Flag_MeterReadOnly: Self

pub const Flag_DisplayMask: Self

pub const Flag_DisplaySquareRoot: Self

pub const Flag_DisplaySquared: Self

pub const Flag_DisplayCubed: Self

pub const Flag_DisplayCubeRoot: Self

pub const Flag_DisplayExponential: Self

pub const Flag_HasClump: Self

pub const Flag_ValuesHaveStrings: Self

pub const Flag_DisplayLogarithmic: Self

pub const Flag_IsHighResolution: Self

pub const Flag_NonRealTime: Self

pub const Flag_CanRamp: Self

pub const Flag_ExpertMode: Self

pub const Flag_HasCFNameString: Self

pub const Flag_IsGlobalMeta: Self

pub const Flag_IsElementMeta: Self

pub const Flag_IsReadable: Self

pub const Flag_IsWritable: Self

impl AudioUnitParameterOptions

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u32) -> Option<Self>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u32) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: Self) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

pub const fn contains(&self, other: Self) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: Self, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl AudioUnitParameterOptions

pub const fn iter(&self) -> Iter<AudioUnitParameterOptions>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<AudioUnitParameterOptions>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for AudioUnitParameterOptions

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

Formats the value using the given formatter.

impl BitAnd for AudioUnitParameterOptions

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

The bitwise and (&) of the bits in two flags values.

type Output = AudioUnitParameterOptions

The resulting type after applying the & operator.

impl BitAndAssign for AudioUnitParameterOptions

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for AudioUnitParameterOptions

fn bitor(self, other: AudioUnitParameterOptions) -> Self

The bitwise or (|) of the bits in two flags values.

type Output = AudioUnitParameterOptions

The resulting type after applying the | operator.

impl BitOrAssign for AudioUnitParameterOptions

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for AudioUnitParameterOptions

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

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = AudioUnitParameterOptions

The resulting type after applying the ^ operator.

impl BitXorAssign for AudioUnitParameterOptions

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for AudioUnitParameterOptions

fn clone(&self) -> AudioUnitParameterOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AudioUnitParameterOptions

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

Formats the value using the given formatter.

impl Encode for AudioUnitParameterOptions

const ENCODING: Encoding = u32::ENCODING

The Objective-C type-encoding for this type.

impl Extend<AudioUnitParameterOptions> for AudioUnitParameterOptions

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for AudioUnitParameterOptions

const FLAGS: &'static [Flag<AudioUnitParameterOptions>]

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> AudioUnitParameterOptions

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<AudioUnitParameterOptions> for AudioUnitParameterOptions

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

impl Hash for AudioUnitParameterOptions

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 IntoIterator for AudioUnitParameterOptions

type Item = AudioUnitParameterOptions

The type of the elements being iterated over.

type IntoIter = Iter<AudioUnitParameterOptions>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for AudioUnitParameterOptions

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

Formats the value using the given formatter.

impl Not for AudioUnitParameterOptions

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = AudioUnitParameterOptions

The resulting type after applying the ! operator.

impl Octal for AudioUnitParameterOptions

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

Formats the value using the given formatter.

impl Ord for AudioUnitParameterOptions

fn cmp(&self, other: &AudioUnitParameterOptions) -> 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 AudioUnitParameterOptions

fn eq(&self, other: &AudioUnitParameterOptions) -> 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 AudioUnitParameterOptions

fn partial_cmp(&self, other: &AudioUnitParameterOptions) -> 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 RefEncode for AudioUnitParameterOptions

const ENCODING_REF: Encoding

The Objective-C type-encoding for a reference of this type.

impl Sub for AudioUnitParameterOptions

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = AudioUnitParameterOptions

The resulting type after applying the - operator.

impl SubAssign for AudioUnitParameterOptions

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for AudioUnitParameterOptions

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

Formats the value using the given formatter.

impl Copy for AudioUnitParameterOptions

impl Eq for AudioUnitParameterOptions

impl StructuralPartialEq for AudioUnitParameterOptions