Struct AUParameterTree

#[repr(C)]
pub struct AUParameterTree { /* private fields */ }

Available on crate feature AUParameters only.

The top level group node, representing all of an audio unit’s parameters.

An audio unit’s parameters are organized into a tree containing groups and parameters. Groups may be nested.

The tree is KVO-compliant. For example, if the tree contains a group named “LFO” , containing a parameter named rate, then “LFO.rate” refers to that parameter object, and “LFO.rate.value” refers to that parameter’s value.

An audio unit may choose to dynamically rearrange the tree. When doing so, it must issue a KVO notification on the audio unit’s parameterTree property. The tree’s elements are mostly immutable (except for values and implementor hooks); the only way to modify them is to publish a new tree.

See also Apple’s documentation

Implementations

impl AUParameterTree

Factory. Factory methods for building parameters, parameter groups, and parameter trees.

Note: In non-ARC code, “create” methods return unretained objects (unlike “create” C functions); the caller should generally retain them.

pub unsafe fn createParameterWithIdentifier_name_address_min_max_unit_unitName_flags_valueStrings_dependentParameters( identifier: &NSString, name: &NSString, address: AUParameterAddress, min: AUValue, max: AUValue, unit: AudioUnitParameterUnit, unit_name: Option<&NSString>, flags: AudioUnitParameterOptions, value_strings: Option<&NSArray<NSString>>, dependent_parameters: Option<&NSArray<NSNumber>>, ) -> Retained<AUParameter>

Available on crate features AUAudioUnitImplementation and AudioUnitProperties only.

Create an AUParameter. See AUParameter’s properties for descriptions of the arguments.

pub unsafe fn createGroupWithIdentifier_name_children( identifier: &NSString, name: &NSString, children: &NSArray<AUParameterNode>, ) -> Retained<AUParameterGroup>

Available on crate feature AUAudioUnitImplementation only.

Create an AUParameterGroup.

Parameter identifier: An identifier for the group (non-localized, persistent).

Parameter name: The group’s human-readable name (localized).

Parameter children: The group’s child nodes.

pub unsafe fn createGroupTemplate( children: &NSArray<AUParameterNode>, ) -> Retained<AUParameterGroup>

Available on crate feature AUAudioUnitImplementation only.

Create a template group which may be used as a prototype for further group instances.

Template groups provide a way to construct multiple instances of identical parameter groups, sharing certain immutable state between the instances.

Template groups may not appear in trees except at the root.

pub unsafe fn createGroupFromTemplate_identifier_name_addressOffset( template_group: &AUParameterGroup, identifier: &NSString, name: &NSString, address_offset: AUParameterAddress, ) -> Retained<AUParameterGroup>

Available on crate feature AUAudioUnitImplementation only.

Initialize a group as a copied instance of a template group.

Parameter templateGroup: A group to be used as a template and largely copied.

Parameter identifier: An identifier for the new group (non-localized, persistent).

Parameter name: The new group’s human-readable name (localized).

Parameter addressOffset: The new group’s parameters’ addresses will be offset from those in the template by this value.

pub unsafe fn createTreeWithChildren( children: &NSArray<AUParameterNode>, ) -> Retained<AUParameterTree>

Available on crate feature AUAudioUnitImplementation only.

Create an AUParameterTree.

Parameter children: The tree’s top-level child nodes.

impl AUParameterTree

pub unsafe fn parameterWithAddress( &self, address: AUParameterAddress, ) -> Option<Retained<AUParameter>>

Search a tree for a parameter with a specific address.

Returns: The parameter corresponding to the supplied address, or nil if no such parameter exists.

pub unsafe fn parameterWithID_scope_element( &self, param_id: AudioUnitParameterID, scope: AudioUnitScope, element: AudioUnitElement, ) -> Option<Retained<AUParameter>>

Available on crate feature AUComponent only.

Search a tree for a specific v2 audio unit parameter.

V2 audio units publish parameters identified by a parameter ID, scope, and element. A host that knows that it is dealing with a v2 unit can locate parameters using this method, for example, for the Apple-supplied system audio units.

Returns: The parameter corresponding to the supplied ID/scope/element, or nil if no such parameter exists, or if the audio unit is not a v2 unit.

impl AUParameterTree

Methods declared on superclass NSObject.

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

pub unsafe fn new() -> Retained<Self>

Methods from Deref<Target = AUParameterGroup>

pub unsafe fn children(&self) -> Retained<NSArray<AUParameterNode>>

The group’s child nodes (AUParameterGroupNode).

pub unsafe fn allParameters(&self) -> Retained<NSArray<AUParameter>>

Returns a flat array of all parameters in the group, including those in child groups.

Methods from Deref<Target = AUParameterNode>

pub unsafe fn implementorValueObserver(&self) -> AUImplementorValueObserver

Available on crate features AUAudioUnitImplementation and block2 only.

Called when a parameter changes value.

This block, used only in an audio unit implementation, receives all externally-generated changes to parameter values. It should store the new value in its audio signal processing state (assuming that that state is separate from the AUParameter object).

pub unsafe fn setImplementorValueObserver( &self, implementor_value_observer: AUImplementorValueObserver, )

Available on crate features AUAudioUnitImplementation and block2 only.

Setter for implementorValueObserver.

pub unsafe fn implementorValueProvider(&self) -> AUImplementorValueProvider

Available on crate features AUAudioUnitImplementation and block2 only.

Called when a value of a parameter in the tree is known to have a stale value needing to be refreshed.

The audio unit should return the current value for this parameter; the AUParameterNode will store the value.

pub unsafe fn setImplementorValueProvider( &self, implementor_value_provider: AUImplementorValueProvider, )

Available on crate features AUAudioUnitImplementation and block2 only.

Setter for implementorValueProvider.

pub unsafe fn implementorStringFromValueCallback( &self, ) -> AUImplementorStringFromValueCallback

Available on crate features AUAudioUnitImplementation and block2 only.

Called to provide string representations of parameter values. If value is nil, the callback uses the current value of the parameter.

pub unsafe fn setImplementorStringFromValueCallback( &self, implementor_string_from_value_callback: AUImplementorStringFromValueCallback, )

Available on crate features AUAudioUnitImplementation and block2 only.

Setter for implementorStringFromValueCallback.

pub unsafe fn implementorValueFromStringCallback( &self, ) -> AUImplementorValueFromStringCallback

Available on crate features AUAudioUnitImplementation and block2 only.

Called to convert string to numeric representations of parameter values.

pub unsafe fn setImplementorValueFromStringCallback( &self, implementor_value_from_string_callback: AUImplementorValueFromStringCallback, )

Available on crate features AUAudioUnitImplementation and block2 only.

Setter for implementorValueFromStringCallback.

pub unsafe fn implementorDisplayNameWithLengthCallback( &self, ) -> AUImplementorDisplayNameWithLengthCallback

Available on crate features AUAudioUnitImplementation and block2 only.

Called to obtain an abbreviated version of a parameter or group name.

pub unsafe fn setImplementorDisplayNameWithLengthCallback( &self, implementor_display_name_with_length_callback: AUImplementorDisplayNameWithLengthCallback, )

Available on crate features AUAudioUnitImplementation and block2 only.

Setter for implementorDisplayNameWithLengthCallback.

pub unsafe fn identifier(&self) -> Retained<NSString>

A non-localized, permanent name for a parameter or group.

The identifier must be unique for all child nodes under any given parent. From release to release, an audio unit must not change its parameters’ identifiers; this will invalidate any hosts’ documents that refer to the parameters.

pub unsafe fn keyPath(&self) -> Retained<NSString>

Generated by concatenating the identifiers of a node’s parents with its own.

Unless an audio unit specifically documents that its parameter addresses are stable and persistent, hosts, when recording parameter values, should bind to the keyPath.

The individual node identifiers in a key path are separated by periods. (“.”)

Passing a node’s keyPath to -[tree valueForKeyPath:] should return the same node.

pub unsafe fn displayName(&self) -> Retained<NSString>

A localized name to display for the parameter.

pub unsafe fn displayNameWithLength( &self, maximum_length: NSInteger, ) -> Retained<NSString>

A version of displayName possibly abbreviated to the given desired length, in characters.

The default implementation simply returns displayName.

pub unsafe fn tokenByAddingParameterObserver( &self, observer: AUParameterObserver, ) -> AUParameterObserverToken

Available on crate feature block2 only.

Add an observer for a parameter or all parameters in a group/tree.

An audio unit view can use an AUParameterObserver to be notified of changes to a single parameter, or to all parameters in a group/tree.

These callbacks are throttled so as to limit the rate of redundant notifications in the case of frequent changes to a single parameter.

This block is called in an arbitrary thread context. It is responsible for thread-safety. It must not make any calls to add or remove other observers, including itself; this will deadlock.

An audio unit’s implementation should interact with the parameter object via implementorValueObserver and implementorValueProvider.

Parameter observers are bound to a specific parameter instance. If this parameter is destroyed, e.g. if the parameter tree is re-constructed, the previously set parameter observers will no longer be valid. Clients can observe changes to the parameter tree via KVO. See the discussion of -[AUAudioUnit parameterTree].

Parameter observer: A block to call after the value of a parameter has changed.

Returns: A token which can be passed to removeParameterObserver: or to -[AUParameter setValue:originator:]

pub unsafe fn tokenByAddingParameterRecordingObserver( &self, observer: AUParameterRecordingObserver, ) -> AUParameterObserverToken

Available on crate feature block2 only.

Add a recording observer for a parameter or all parameters in a group/tree.

This is a variant of tokenByAddingParameterAutomationObserver where the callback receives AURecordedParameterEvents instead of AUParameterAutomationEvents.

This will be deprecated in favor of tokenByAddingParameterAutomationObserver in a future release.

pub unsafe fn tokenByAddingParameterAutomationObserver( &self, observer: AUParameterAutomationObserver, ) -> AUParameterObserverToken

Available on crate feature block2 only.

Add a recording observer for a parameter or all parameters in a group/tree.

An audio unit host can use an AUParameterAutomationObserver or AUParameterRecordingObserver to capture a series of changes to a parameter value, including the timing of the events, as generated by a UI gesture in a view, for example.

Unlike AUParameterObserver, these callbacks are not throttled.

This block is called in an arbitrary thread context. It is responsible for thread-safety. It must not make any calls to add or remove other observers, including itself; this will deadlock.

An audio unit’s engine should interact with the parameter object via implementorValueObserver and implementorValueProvider.

Parameter observer: A block to call to record the changing of a parameter value.

Returns: A token which can be passed to removeParameterObserver: or to -[AUParameter setValue:originator:]

pub unsafe fn removeParameterObserver(&self, token: AUParameterObserverToken)

Remove an observer created with tokenByAddingParameterObserver, tokenByAddingParameterRecordingObserver, or tokenByAddingParameterAutomationObserver.

This call will remove the callback corresponding to the supplied token. Note that this will block until any callbacks currently in flight have completed.

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations

impl AsRef<AUParameterGroup> for AUParameterTree

fn as_ref(&self) -> &AUParameterGroup

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

impl AsRef<AUParameterNode> for AUParameterTree

fn as_ref(&self) -> &AUParameterNode

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

impl AsRef<AUParameterTree> for AUParameterTree

fn as_ref(&self) -> &Self

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

impl AsRef<AnyObject> for AUParameterTree

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for AUParameterTree

fn as_ref(&self) -> &NSObject

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

impl Borrow<AUParameterGroup> for AUParameterTree

fn borrow(&self) -> &AUParameterGroup

Immutably borrows from an owned value.

impl Borrow<AUParameterNode> for AUParameterTree

fn borrow(&self) -> &AUParameterNode

Immutably borrows from an owned value.

impl Borrow<AnyObject> for AUParameterTree

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for AUParameterTree

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for AUParameterTree

const NAME: &'static str = "AUParameterTree"

The name of the Objective-C class that this type represents.

type Super = AUParameterGroup

The superclass of this class.

type ThreadKind = <<AUParameterTree as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl Debug for AUParameterTree

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

Formats the value using the given formatter.

impl Deref for AUParameterTree

type Target = AUParameterGroup

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for AUParameterTree

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 Message for AUParameterTree

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for AUParameterTree

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl NSSecureCoding for AUParameterTree

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for AUParameterTree

fn eq(&self, other: &Self) -> 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 RefEncode for AUParameterTree

const ENCODING_REF: Encoding = <AUParameterGroup as ::objc2::RefEncode>::ENCODING_REF

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

impl DowncastTarget for AUParameterTree

impl Eq for AUParameterTree

impl NSCoding for AUParameterTree