AUAudioUnit Class

Definition

A subclass of AVAudioNode whose subclasses process audio.

[Foundation.Register("AUAudioUnit", true)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 9, 0, ObjCRuntime.PlatformArchitecture.All, null)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.MacOSX, 10, 11, ObjCRuntime.PlatformArchitecture.Arch64, null)]
public class AUAudioUnit : Foundation.NSObject
type AUAudioUnit = class
    inherit NSObject
Inheritance
AUAudioUnit
Attributes

Constructors

AUAudioUnit(AudioComponentDescription, AudioComponentInstantiationOptions, NSError)

Creates a new AUAudioUnit with the specified values.

AUAudioUnit(AudioComponentDescription, NSError)

Creates a new AUAudioUnit with the specified values.

AUAudioUnit(IntPtr)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

AUAudioUnit(NSObjectFlag)

Constructor to call on derived classes to skip initialization and merely allocate the object.

Properties

AllParameterValues

Gets a special value that is required for key-value observing notifications

AudioComponentInstanceInvalidationNotification

Notification constant for AudioComponentInstanceInvalidation

AudioComponentRegistrationsChangedNotification

Notification constant for AudioComponentRegistrationsChanged

AudioUnitName

Gets the name of the audio unit.

CanProcessInPlace

Gets a Boolean value that tells whether the audio unit can transform input to output without allocating a new buffer.

ChannelCapabilities

Gets an array that describes valid combinations of input and output channels.

ChannelMap

Gets or sets the channel map.

Class (Inherited from NSObject)
ClassHandle

The handle for this class.

Component

Gets the component from the description with which the audio unit was created.

ComponentDescription

Gets the component from the description with which the audio unit was created.

ComponentName

Gets the audio units component name.

ComponentVersion

Gets the version of the audio unit.

ContextName

Gets the name of the context to which the audio unit is connected.

CurrentPreset

Gets the most recently selected preset.

DebugDescription

A developer-meaningful description of this object.

(Inherited from NSObject)
Description

Description of the object, the Objective-C version of ToString.

(Inherited from NSObject)
FactoryPresets

Gets the factory presets for the audio unit.

FullState

Gets or sets the snapshot of the audio unit's entire state, for saving presets.

FullStateForDocument

Gets or sets the snapshot of the audio unit's entire state, for saving in a document.

Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from NSObject)
InputBusses

Gets an array that contains the input connections for the audio unit.

InternalRenderBlock

Gets the developer-provided block that performs audio rendering.

IsDirectBinding (Inherited from NSObject)
IsProxy (Inherited from NSObject)
Latency

Gets the latency of the audio unit, in seconds

ManufacturerName

Gets the manufacturer name for the audio unit.

MaximumFramesToRender

Gets or sets the maximum number of audio frames to render simultaneously.

MidiOutputBufferSizeHint
MidiOutputEventBlock
MidiOutputNames
MusicDeviceOrEffect

Gets a value that is true if the audio unit is either a music device or an effect.

OutputBusses

Gets an array that contains the output connections for the audio unit.

ParameterTree

Gets or sets the entire tree of output parameters.

ProfileChangedCallback
ProvidesUserInterface
RenderBlock

Gets the render block that is used for rendering audio.

RenderingOffline

Gets or sets a Boolean value that controls whether the audio unit is currently rendering offline.

RenderQuality

Gets or sets the rendering quality, a value in [0,127].

RenderResourcesAllocated

Gets a Boolean value that tells whether rendering resources have been allocated.

RetainCount

Returns the current Objective-C retain count for the object.

(Inherited from NSObject)
ScheduleParameterBlock

Block that schedules parameters.

Self (Inherited from NSObject)
ShortName
ShouldBypassEffect

Gets or sets a Boolean value that contols whether an effect should skip processing and go directly to the output.

Superclass (Inherited from NSObject)
SuperHandle

Handle used to represent the methods in the base class for this NSObject.

(Inherited from NSObject)
SupportsMpe

Gets a Boolean values that tells whether MPE audio is supported.

TailTime

Gets the tail time, in seconds, of the audio unit.

TransportStateBlock

A delegate block that provides information about its transport state.

VirtualMidiCableCount

Gets the number of virtual MIDI cables that are implemented by the device or effect.

Zone (Inherited from NSObject)

Methods

AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using NSString keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using string keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AllocateRenderResources(NSError)

Allocates the resources that are needed to render audio.

AwakeFromNib()

Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib().

(Inherited from NSObject)
BeginInvokeOnMainThread(Action) (Inherited from NSObject)
BeginInvokeOnMainThread(Selector, NSObject)

Invokes asynchrously the specified code on the main UI thread.

(Inherited from NSObject)
Bind(NSString, NSObject, String, NSDictionary) (Inherited from NSObject)
Bind(String, NSObject, String, NSDictionary) (Inherited from NSObject)
BindingInfo(String) (Inherited from NSObject)
BindingOptionDescriptions(String) (Inherited from NSObject)
BindingValueClass(String) (Inherited from NSObject)
CommitEditing() (Inherited from NSObject)
CommitEditing(NSObject, Selector, IntPtr) (Inherited from NSObject)
ConformsToProtocol(IntPtr)

Invoked to determine if this object implements the specified protocol.

(Inherited from NSObject)
Copy()

Performs a copy of the underlying Objective-C object.

(Inherited from NSObject)
DangerousAutorelease() (Inherited from NSObject)
DangerousRelease() (Inherited from NSObject)
DangerousRetain() (Inherited from NSObject)
DeallocateRenderResources()

Deallocates the resources that are needed to render audio.

DidChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates a change occurred to the indexes for a to-many relationship.

(Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet) (Inherited from NSObject)
DidChangeValue(String)

Indicates that a change occurred on the specified key.

(Inherited from NSObject)
Disable(MidiCIProfile, Byte, Byte, NSError)
Dispose()

Releases the resources used by the NSObject object.

(Inherited from NSObject)
Dispose(Boolean)

Releases the resources used by the NSObject object.

(Inherited from NSObject)
DoesNotRecognizeSelector(Selector)

Indicates that this object does not recognize the specified selector.

(Inherited from NSObject)
Enable(MidiCIProfile, Byte, Byte, NSError)
Equals(NSObject) (Inherited from NSObject)
Equals(Object) (Inherited from NSObject)
ExposedBindings() (Inherited from NSObject)
FromComponentDescription(AudioComponentDescription, AudioComponentInstantiationOptions, Action<AUAudioUnit,NSError>)

Asynchronously creates a AUAudioUnit.

FromComponentDescriptionAsync(AudioComponentDescription, AudioComponentInstantiationOptions)

Asynchronously creates a AUAudioUnit.

GetBindingInfo(NSString) (Inherited from NSObject)
GetBindingOptionDescriptions(NSString) (Inherited from NSObject)
GetBindingValueClass(NSString) (Inherited from NSObject)
GetDictionaryOfValuesFromKeys(NSString[])

Retrieves the values of the specified keys.

(Inherited from NSObject)
GetHashCode()

Generates a hash code for the current instance.

(Inherited from NSObject)
GetMethodForSelector(Selector) (Inherited from NSObject)
GetNativeField(String) (Inherited from NSObject)
GetNativeHash() (Inherited from NSObject)
GetParametersForOverview(nint)

Returns the count most important parameters.

GetProfileState(Byte, Byte)
Init() (Inherited from NSObject)
InitializeHandle(IntPtr) (Inherited from NSObject)
InitializeHandle(IntPtr, String) (Inherited from NSObject)
Invoke(Action, Double) (Inherited from NSObject)
Invoke(Action, TimeSpan) (Inherited from NSObject)
InvokeOnMainThread(Action) (Inherited from NSObject)
InvokeOnMainThread(Selector, NSObject)

Invokes synchrously the specified code on the main UI thread.

(Inherited from NSObject)
IsEqual(NSObject) (Inherited from NSObject)
IsKindOfClass(Class) (Inherited from NSObject)
IsMemberOfClass(Class) (Inherited from NSObject)
MarkDirty()

Promotes a regular peer object (IsDirectBinding is true) into a toggleref object.

(Inherited from NSObject)
MutableCopy()

Creates a mutable copy of the specified NSObject.

(Inherited from NSObject)
ObjectDidEndEditing(NSObject) (Inherited from NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr)

Indicates that the value at the specified keyPath relative to this object has changed.

(Inherited from NSObject)
PerformSelector(Selector) (Inherited from NSObject)
PerformSelector(Selector, NSObject) (Inherited from NSObject)
PerformSelector(Selector, NSObject, Double)

Invokes the selector on the current instance and if the obj is not null, it passes this as its single parameter.

(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[]) (Inherited from NSObject)
PerformSelector(Selector, NSObject, NSObject) (Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean) (Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) (Inherited from NSObject)
PrepareForInterfaceBuilder() (Inherited from NSObject)
RegisterSubclass(Class, AudioComponentDescription, String, UInt32)

Registers a component that has been implemented as a subclass of AudioUnit.

RemoveObserver(NSObject, NSString)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, NSString, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RemoveObserver(NSObject, String)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RemoveRenderObserver(nint)

Removes the observer block that is identified by token.

RequestViewController(Action<NSViewController>)
RequestViewController(Action<UIViewController>)

Requests the view controller for the audio unit and runs completionHandler when finished.

RequestViewControllerAsync()

Asynchronously requests the view controller for the audio unit.

Reset()

Resets rendering to its initial state.

RespondsToSelector(Selector)

Whether this object recognizes the specified selector.

(Inherited from NSObject)
SetNativeField(String, NSObject) (Inherited from NSObject)
SetNilValueForKey(NSString)

Sets the value of the specified key to null.

(Inherited from NSObject)
SetRenderResourcesAllocated(Boolean)

Sets the RenderResourcesAllocated property.

SetValueForKey(NSObject, NSString)

Sets the value of the property specified by the key to the specified value.

(Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

(Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString)

Sets the value of a property that can be reached using a keypath.

(Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString)

Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary)

Sets the values of this NSObject to those in the specified dictionary.

(Inherited from NSObject)
ShouldChangeToFormat(AVAudioFormat, AUAudioUnitBus)

Method that is called when the developer sets the bus format.

ToString()

Returns a string representation of the value of the current instance.

(Inherited from NSObject)
Unbind(NSString) (Inherited from NSObject)
Unbind(String) (Inherited from NSObject)
ValueForKey(NSString)

Returns the value of the property associated with the specified key.

(Inherited from NSObject)
ValueForKeyPath(NSString)

Returns the value of a property that can be reached using a keypath.

(Inherited from NSObject)
ValueForUndefinedKey(NSString)

Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates that the values of the specified indices in the specified key are about to change.

(Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet) (Inherited from NSObject)
WillChangeValue(String)

Indicates that the value of the specified key is about to change.

(Inherited from NSObject)

Extension Methods

ObjectDidBeginEditing(NSObject, INSEditor)
ObjectDidEndEditing(NSObject, INSEditor)
GetValidModes(NSObject, NSFontPanel)
ValidateToolbarItem(NSObject, NSToolbarItem)
CanPerformOutput(AUAudioUnit)

Returns a Boolean value that tells whether the audio unit can perform output operations.

GetCanPerformInput(AUAudioUnit)

Returns a Boolean value that tells whether the audio unit can perform input operations.

GetDeviceId(AUAudioUnit)
GetDeviceInputLatency(AUAudioUnit)
GetDeviceOutputLatency(AUAudioUnit)
GetInputHandler(AUAudioUnit)

Gets the input handler for this IO unit

GetOutputProvider(AUAudioUnit)

Gets the output provider for this IO unit.

IsInputEnabled(AUAudioUnit)

Returns a Boolean value that tells whether input is currently enabled on the audio unit.

IsOutputEnabled(AUAudioUnit)

Returns a Boolean value that tells whether input is currently enabled on the audio unit.

IsRunning(AUAudioUnit)
SetDeviceId(AUAudioUnit, UInt32, NSError)
SetInputEnabled(AUAudioUnit, Boolean)

Sets a Boolean value that controls whether input is enabled on the audio unit.

SetInputHandler(AUAudioUnit, AUInputHandler)

Sets the input handler to the specified value.

SetOutputEnabled(AUAudioUnit, Boolean)

Sets a Boolean value that controls whether output is enabled on the audio unit..

SetOutputProvider(AUAudioUnit, AURenderPullInputBlock)

Sets the output provider to the specified value.

StartHardware(AUAudioUnit, NSError)

Starts the audio unit's hardware.

StopHardware(AUAudioUnit)

Stops the audio unit's hardware.

GetSupportedViewConfigurations(AUAudioUnit, AUAudioUnitViewConfiguration[])
SelectViewConfiguration(AUAudioUnit, AUAudioUnitViewConfiguration)
GetDebugDescription(INSObjectProtocol)
AcceptsPreviewPanelControl(NSObject, QLPreviewPanel)
BeginPreviewPanelControl(NSObject, QLPreviewPanel)
EndPreviewPanelControl(NSObject, QLPreviewPanel)
GetAccessibilityCustomRotors(NSObject)

Gets the array of UIAccessibilityCustomRotor objects appropriate for this object.

SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])

Sets the array of UIAccessibilityCustomRotor objects appropriate for this object.

Applies to

See also