Struct CATapDescription 

pub struct CATapDescription { /* private fields */ }

Available on crate features AudioHardware and objc2 only.

This class describes a tap object that contains an input stream. The input stream is a mix of all of the specified processes output audio.

See also Apple’s documentation

Implementations

impl CATapDescription

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

pub unsafe fn initStereoMixdownOfProcesses( this: Allocated<Self>, processes_object_i_ds_to_include_in_tap: &NSArray<NSNumber>, ) -> Retained<Self>

Available on crate feature objc2-foundation only.

Mix all given process audio streams down to stereo. Mono sources will be duplicated in both right and left channels.

Parameter processesObjectIDsToIncludeInTap: An NSArray of NSNumbers where each NSNumber holds an AudioObjectID of the process object to include in the tap

pub unsafe fn initStereoGlobalTapButExcludeProcesses( this: Allocated<Self>, processes_object_i_ds_to_exclude_from_tap: &NSArray<NSNumber>, ) -> Retained<Self>

Available on crate feature objc2-foundation only.

Mix all processes to a stereo stream except the given processes. Mono sources will be duplicated in both right and left channels.

Parameter processesObjectIDsToExcludeFromTap: An NSArray of NSNumbers where each NSNumber holds an AudioObjectID of the process object to exclude from the tap. All other processes that output audio will be included in the tap.

pub unsafe fn initMonoMixdownOfProcesses( this: Allocated<Self>, processes_object_i_ds_to_include_in_tap: &NSArray<NSNumber>, ) -> Retained<Self>

Available on crate feature objc2-foundation only.

Mix all given process audio streams audio to mono.

Parameter processesObjectIDsToIncludeInTap: An NSArray of NSNumbers where each NSNumber holds an AudioObjectID of the process object to include in the tap

pub unsafe fn initMonoGlobalTapButExcludeProcesses( this: Allocated<Self>, processes_object_i_ds_to_exclude_from_tap: &NSArray<NSNumber>, ) -> Retained<Self>

Available on crate feature objc2-foundation only.

Mix all processes to a mono stream except the given processes

Parameter processesObjectIDsToExcludeFromTap: An NSArray of NSNumbers where each NSNumber holds an AudioObjectID of the process object to exclude from the tap. All other processes that output audio will be included in the tap.

pub unsafe fn initWithProcesses_andDeviceUID_withStream( this: Allocated<Self>, processes_object_i_ds_to_include_in_tap: &NSArray<NSNumber>, device_uid: &NSString, stream: NSInteger, ) -> Retained<Self>

Available on crate feature objc2-foundation only.

Mix all given process audio streams destined for the selected device stream

Parameter processesObjectIDsToIncludeInTap: An NSArray of NSNumbers where each NSNumber holds an AudioObjectID of the process object to exclude from the tap. All other processes that output audio will be included in the tap.

Parameter deviceUID: The device UID of the output device whose audio will be captured

Parameter stream: NSInteger that represents the index of the stream on the device whose audio will be captured. The format of the tap will match the format of this stream.

pub unsafe fn initExcludingProcesses_andDeviceUID_withStream( this: Allocated<Self>, processes_object_i_ds_to_exclude_from_tap: &NSArray<NSNumber>, device_uid: &NSString, stream: NSInteger, ) -> Retained<Self>

Available on crate feature objc2-foundation only.

Mix all process audio streams destined for the selected device stream except the given processes

Parameter processesObjectIDsToExcludeFromTap: An NSArray of NSNumbers where each NSNumber holds an AudioObjectID of the process object to exclude from the tap. All other processes that output audio will be included in the tap.

Parameter deviceUID: The device UID of the output device whose audio will be captured

Parameter stream: NSInteger that represents the index of the stream on the device whose audio will be captured. The format of the tap will match the format of this stream.

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

Available on crate feature objc2-foundation only.

Human readable name of this tap.

pub unsafe fn setName(&self, name: &NSString)

Available on crate feature objc2-foundation only.

Setter for name.

This is [copied][objc2_foundation::NSCopying::copy] when set.

pub unsafe fn UUID(&self) -> Retained<NSUUID>

Available on crate feature objc2-foundation only.

UID of this tap.

pub unsafe fn setUUID(&self, uuid: &NSUUID)

Available on crate feature objc2-foundation only.

Setter for UUID.

This is [copied][objc2_foundation::NSCopying::copy] when set.

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

Available on crate feature objc2-foundation only.

An NSArray of NSNumbers where each NSNumber holds the AudioObjectID of a process object to tap or exclude.

pub unsafe fn setProcesses(&self, processes: &NSArray<NSNumber>)

Available on crate feature objc2-foundation only.

Setter for processes.

This is [copied][objc2_foundation::NSCopying::copy] when set.

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

Available on crate feature objc2-foundation only.

An Array of Strings where each String holds the bundle ID of a process to tap or exclude.

pub unsafe fn setBundleIDs(&self, bundle_i_ds: &NSArray<NSString>)

Available on crate feature objc2-foundation only.

Setter for bundleIDs.

This is [copied][objc2_foundation::NSCopying::copy] when set.

pub unsafe fn isMono(&self) -> bool

True if this description is a mono mixdown of channels.

pub unsafe fn setMono(&self, mono: bool)

Setter for isMono.

pub unsafe fn isExclusive(&self) -> bool

True if this description should tap all processes except the process listed in the ‘processes’ property.

pub unsafe fn setExclusive(&self, exclusive: bool)

Setter for isExclusive.

pub unsafe fn isMixdown(&self) -> bool

True if this description is a mono or stereo mix of the tapped device’s channels.

pub unsafe fn setMixdown(&self, mixdown: bool)

Setter for isMixdown.

pub unsafe fn isPrivate(&self) -> bool

True if this tap is only visible to the client process that created the tap.

pub unsafe fn setPrivate(&self, private_tap: bool)

Setter for isPrivate.

pub unsafe fn isProcessRestoreEnabled(&self) -> bool

True if this tap should save tapped processes by bundle ID when they exit, and restore them to the tap when they start up again.

pub unsafe fn setProcessRestoreEnabled(&self, process_restore_enabled: bool)

Setter for isProcessRestoreEnabled.

pub unsafe fn isMuted(&self) -> CATapMuteBehavior

Set the tap’s mute behavior. See CATapMuteBehavior above.

pub unsafe fn setMuteBehavior(&self, mute_behavior: CATapMuteBehavior)

Setter for isMuted.

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

Available on crate feature objc2-foundation only.

An optional deviceUID that will have a value if this tap only taps a specific hardware device

pub unsafe fn setDeviceUID(&self, device_uid: Option<&NSString>)

Available on crate feature objc2-foundation only.

Setter for deviceUID.

This is [copied][objc2_foundation::NSCopying::copy] when set.

pub unsafe fn stream(&self) -> Option<Retained<NSNumber>>

Available on crate feature objc2-foundation only.

An optional NSNumber that will have a value if this tap taps a specific device stream. The value represents the index of the hardware stream.

pub unsafe fn setStream(&self, stream: Option<&NSNumber>)

Available on crate feature objc2-foundation only.

Setter for stream.

This is [copied][objc2_foundation::NSCopying::copy] when set.

impl CATapDescription

Methods declared on superclass NSObject.

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

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<AnyObject> for CATapDescription

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CATapDescription> for CATapDescription

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for CATapDescription

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for CATapDescription

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for CATapDescription

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for CATapDescription

const NAME: &'static str = "CATapDescription"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<CATapDescription 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 CATapDescription

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

Formats the value using the given formatter.

impl Deref for CATapDescription

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for CATapDescription

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 CATapDescription

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for CATapDescription

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 PartialEq for CATapDescription

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 CATapDescription

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

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

impl DowncastTarget for CATapDescription

impl Eq for CATapDescription