Struct AVAudioUnitComponent

Source

pub struct AVAudioUnitComponent { /* private fields */ }

Available on crate feature AVAudioUnitComponent only.

Expand description

Provides details about an audio unit such as type, subtype, manufacturer, location etc. User tags can be added to the AVAudioUnitComponent which can be queried later for display.

Implementations§

Source §

impl AVAudioUnitComponent

Source

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

the name of an audio component

Source

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

standard audio component types returned as strings

Source

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

localized string of typeName for display

Source

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

the manufacturer name, extracted from the manufacturer key defined in Info.plist dictionary

Source

pub unsafe fn version(&self) -> NSUInteger

version number comprised of a hexadecimal number with major, minor, dot-release format: 0xMMMMmmDD

Source

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

version number as string

Source

pub unsafe fn componentURL(&self) -> Option<Retained<NSURL>>

👎Deprecated

URL representing location of component

Source

pub unsafe fn availableArchitectures(&self) -> Retained<NSArray<NSNumber>>

NSArray of NSNumbers each of which corresponds to one of the constants in Mach-O Architecture in NSBundle Class Reference

Source

pub unsafe fn isSandboxSafe(&self) -> bool

On OSX, YES if the AudioComponent can be loaded into a sandboxed process otherwise NO. On iOS, this is always YES.

Source

pub unsafe fn hasMIDIInput(&self) -> bool

YES if AudioComponent has midi input, otherwise NO

Source

pub unsafe fn hasMIDIOutput(&self) -> bool

YES if AudioComponent has midi output, otherwise NO

Source

pub unsafe fn audioComponent(&self) -> AudioComponent

Available on crate feature objc2-audio-toolbox and non-watchOS only.

the audioComponent that can be used in AudioComponent APIs.

Source

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

User tags represent the tags from the current user.

Source

pub unsafe fn setUserTagNames(&self, user_tag_names: &NSArray<NSString>)

Setter for userTagNames.

This is copied when set.

Source

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

represent the tags from the current user and the system tags defined by AudioComponent.

Source

pub unsafe fn audioComponentDescription(&self) -> AudioComponentDescription

Available on crate feature objc2-audio-toolbox and non-watchOS only.

description of the audio component that can be used in AudioComponent APIs.

Source

pub unsafe fn iconURL(&self) -> Option<Retained<NSURL>>

A URL that will specify the location of an icon file that can be used when presenting UI for this audio component.

Source

pub unsafe fn passesAUVal(&self) -> bool

YES if the AudioComponent has passed the AU validation tests, otherwise NO

Source

pub unsafe fn hasCustomView(&self) -> bool

YES if the AudioComponent provides custom view, otherwise NO

Source

pub unsafe fn configurationDictionary( &self, ) -> Retained<NSDictionary<NSString, AnyObject>>

A NSDictionary that contains information describing the capabilities of the AudioComponent. The specific information depends on the type and the keys are defined in AudioUnitProperties.h

Source

pub unsafe fn supportsNumberInputChannels_outputChannels( &self, num_input_channels: NSInteger, num_output_channels: NSInteger, ) -> bool

returns YES if the AudioComponent supports the input/output channel configuration

Source §

impl AVAudioUnitComponent

Methods declared on superclass NSObject.

Source

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

Source

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

Methods from Deref<Target = NSObject>§

Source

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

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());

Source

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.

Source

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`
    }
}