AudioToolbox · IOS API REFERENCE

AUAudioUnit

class · iOS 9.0+ · SDK 27.1

class AUAudioUnit

Members (85)

static · iOS 9.0+

instantiate

TypeScript

static instantiate(componentDescription: AudioComponentDescription, options: AudioComponentInstantiationOptions, completionHandler: ((arg0: (AUAudioUnit) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

class func instantiate(with componentDescription: AudioComponentDescription, options: AudioComponentInstantiationOptions = []) async throws -> AUAudioUnit

static

registerSubclass

TypeScript

static registerSubclass(cls: string, componentDescription: AudioComponentDescription, name: string, version: number): void

Swift declaration

class func registerSubclass(_ cls: AnyClass, as componentDescription: AudioComponentDescription, name: String, version: UInt32)

method · iOS 9.0+

allocateRenderResources

TypeScript

allocateRenderResources(): void

Swift declaration

func allocateRenderResources() throws

method · iOS 9.0+

deallocateRenderResources

TypeScript

deallocateRenderResources(): void

Swift declaration

func deallocateRenderResources()

method · iOS 13.0+

deleteUserPreset

TypeScript

deleteUserPreset(userPreset: AUAudioUnitPreset): void

Swift declaration

func deleteUserPreset(_ userPreset: AUAudioUnitPreset) throws

method · iOS 12.0+

disableProfile

TypeScript

disableProfile(profile: _CoreMIDI_MIDICIProfile, cable: number, channel: number): void

Swift declaration

func disableProfile(_ profile: MIDICIProfile, cable: UInt8, onChannel channel: MIDIChannelNumber) throws

method · iOS 12.0+

enable

TypeScript

enable(profile: _CoreMIDI_MIDICIProfile, cable: number, channel: number): void

Swift declaration

func enable(_ profile: MIDICIProfile, cable: UInt8, onChannel channel: MIDIChannelNumber) throws

init · iOS 9.0+

init

TypeScript

static initComponentDescription(componentDescription: AudioComponentDescription): AUAudioUnit

Swift declaration

convenience init(componentDescription: AudioComponentDescription) throws

init · iOS 9.0+

init

TypeScript

static initComponentDescriptionOptions(componentDescription: AudioComponentDescription, options?: AudioComponentInstantiationOptions): AUAudioUnit

Swift declaration

init(componentDescription: AudioComponentDescription, options: AudioComponentInstantiationOptions = []) throws

method · iOS 16.0+

messageChannel

TypeScript

messageChannel(channelName: string): SDKHandle

Swift declaration

func messageChannel(for channelName: String) -> any AUMessageChannel

method · iOS 9.0+

parametersForOverview

TypeScript

parametersForOverview(count: number): Array<_Foundation_NSNumber>

Swift declaration

func parametersForOverview(withCount count: Int) -> [NSNumber]

method · iOS 13.0+

presetState

TypeScript

presetState(userPreset: AUAudioUnitPreset): Record<string, unknown>

Swift declaration

func presetState(for userPreset: AUAudioUnitPreset) throws -> [String : Any]

method · iOS 12.0+

profileState

TypeScript

profileState(cable: number, channel: number): _CoreMIDI_MIDICIProfileState

Swift declaration

func profileState(forCable cable: UInt8, channel: MIDIChannelNumber) -> MIDICIProfileState

method · iOS 9.0+

removeRenderObserver

TypeScript

removeRenderObserver(token: number): void

Swift declaration

func removeRenderObserver(_ token: Int)

method · iOS 9.0+

reset

TypeScript

reset(): void

Swift declaration

func reset()

method · iOS 13.0+

saveUserPreset

TypeScript

saveUserPreset(userPreset: AUAudioUnitPreset): void

Swift declaration

func saveUserPreset(_ userPreset: AUAudioUnitPreset) throws

method

setRenderResourcesAllocated

TypeScript

setRenderResourcesAllocated(flag: boolean): void

Swift declaration

func setRenderResourcesAllocated(_ flag: Bool)

method

shouldChange

TypeScript

shouldChange(format: _AVFAudio_AVAudioFormat, bus: AUAudioUnitBus): boolean

Swift declaration

func shouldChange(to format: AVAudioFormat, for bus: AUAudioUnitBus) -> Bool

method

startHardware

TypeScript

startHardware(): void

Swift declaration

func startHardware() throws

method

stopHardware

TypeScript

stopHardware(): void

Swift declaration

func stopHardware()

method · iOS 9.0+

token

TypeScript

token(observer: ((arg0: AudioUnitRenderActionFlags, arg1: SDKHandle, arg2: number, arg3: number) => void)): number

Swift declaration

func token(byAddingRenderObserver observer: @escaping AURenderObserver) -> Int

get · iOS 15.0+

audioUnitMIDIProtocol

TypeScript

get audioUnitMIDIProtocol(): _CoreMIDI_MIDIProtocolID

Swift declaration

var audioUnitMIDIProtocol: MIDIProtocolID { get }

get · iOS 11.0+

midiOutputBufferSizeHint

TypeScript

get midiOutputBufferSizeHint(): number

Swift declaration

var midiOutputBufferSizeHint: Int { get set }

set · iOS 11.0+

midiOutputBufferSizeHint

TypeScript

set midiOutputBufferSizeHint(value: number)

Swift declaration

var midiOutputBufferSizeHint: Int { get set }

get · iOS 11.0+

midiOutputEventBlock

TypeScript

get midiOutputEventBlock(): (((arg0: number, arg1: number, arg2: number, arg3: SDKHandle) => Promise<number>)) | null

Swift declaration

var midiOutputEventBlock: AUMIDIOutputEventBlock? { get set }

get · iOS 15.0+

midiOutputEventListBlock

TypeScript

get midiOutputEventListBlock(): (((arg0: number, arg1: number, arg2: SDKHandle) => Promise<number>)) | null

Swift declaration

var midiOutputEventListBlock: AUMIDIEventListBlock? { get set }

get · iOS 11.0+

midiOutputNames

TypeScript

get midiOutputNames(): Array<string>

Swift declaration

var midiOutputNames: [String] { get }

get · iOS 9.0+

allParameterValues

TypeScript

get allParameterValues(): boolean

Swift declaration

var allParameterValues: Bool { get }

get · iOS 9.0+

audioUnitName

TypeScript

get audioUnitName(): (string) | null

Swift declaration

var audioUnitName: String? { get }

get · iOS 11.0+

audioUnitShortName

TypeScript

get audioUnitShortName(): (string) | null

Swift declaration

var audioUnitShortName: String? { get }

get

canPerformInput

TypeScript

get canPerformInput(): boolean

Swift declaration

var canPerformInput: Bool { get }

get

canPerformOutput

TypeScript

get canPerformOutput(): boolean

Swift declaration

var canPerformOutput: Bool { get }

get · iOS 9.0+

canProcessInPlace

TypeScript

get canProcessInPlace(): boolean

Swift declaration

var canProcessInPlace: Bool { get }

get · iOS 9.0+

channelCapabilities

TypeScript

get channelCapabilities(): (Array<_Foundation_NSNumber>) | null

Swift declaration

var channelCapabilities: [NSNumber]? { get }

get · iOS 10.0+

channelMap

TypeScript

get channelMap(): (Array<_Foundation_NSNumber>) | null

Swift declaration

var channelMap: [NSNumber]? { get set }

set · iOS 10.0+

channelMap

TypeScript

set channelMap(value: (Array<_Foundation_NSNumber>) | null)

Swift declaration

var channelMap: [NSNumber]? { get set }

get · iOS 9.0+

component

TypeScript

get component(): SDKHandle

Swift declaration

var component: AudioComponent { get }

get · iOS 9.0+

componentDescription

TypeScript

get componentDescription(): AudioComponentDescription

Swift declaration

var componentDescription: AudioComponentDescription { get }

get · iOS 9.0+

componentName

TypeScript

get componentName(): (string) | null

Swift declaration

var componentName: String? { get }

get · iOS 9.0+

componentVersion

TypeScript

get componentVersion(): number

Swift declaration

var componentVersion: UInt32 { get }

get · iOS 9.0+

contextName

TypeScript

get contextName(): (string) | null

Swift declaration

var contextName: String? { get set }

set · iOS 9.0+

contextName

TypeScript

set contextName(value: (string) | null)

Swift declaration

var contextName: String? { get set }

get · iOS 9.0+

currentPreset

TypeScript

get currentPreset(): (AUAudioUnitPreset) | null

Swift declaration

var currentPreset: AUAudioUnitPreset? { get set }

set · iOS 9.0+

currentPreset

TypeScript

set currentPreset(value: (AUAudioUnitPreset) | null)

Swift declaration

var currentPreset: AUAudioUnitPreset? { get set }

get · iOS 9.0+

factoryPresets

TypeScript

get factoryPresets(): (Array<AUAudioUnitPreset>) | null

Swift declaration

var factoryPresets: [AUAudioUnitPreset]? { get }

get · iOS 9.0+

fullState

TypeScript

get fullState(): (Record<string, unknown>) | null

Swift declaration

var fullState: [String : Any]? { get set }

set · iOS 9.0+

fullState

TypeScript

set fullState(value: (Record<string, unknown>) | null)

Swift declaration

var fullState: [String : Any]? { get set }

get · iOS 9.0+

fullStateForDocument

TypeScript

get fullStateForDocument(): (Record<string, unknown>) | null

Swift declaration

var fullStateForDocument: [String : Any]? { get set }

set · iOS 9.0+

fullStateForDocument

TypeScript

set fullStateForDocument(value: (Record<string, unknown>) | null)

Swift declaration

var fullStateForDocument: [String : Any]? { get set }

get · iOS 15.0+

hostMIDIProtocol

TypeScript

get hostMIDIProtocol(): _CoreMIDI_MIDIProtocolID

Swift declaration

var hostMIDIProtocol: MIDIProtocolID { get set }

set · iOS 15.0+

hostMIDIProtocol

TypeScript

set hostMIDIProtocol(value: _CoreMIDI_MIDIProtocolID)

Swift declaration

var hostMIDIProtocol: MIDIProtocolID { get set }

get · iOS 9.0+

inputBusses

TypeScript

get inputBusses(): AUAudioUnitBusArray

Swift declaration

var inputBusses: AUAudioUnitBusArray { get }

get

isInputEnabled

TypeScript

get isInputEnabled(): boolean

Swift declaration

var isInputEnabled: Bool { get set }

set

isInputEnabled

TypeScript

set isInputEnabled(value: boolean)

Swift declaration

var isInputEnabled: Bool { get set }

get · iOS 9.0+

latency

TypeScript

get latency(): number

Swift declaration

var latency: TimeInterval { get }

get · iOS 9.0+

manufacturerName

TypeScript

get manufacturerName(): (string) | null

Swift declaration

var manufacturerName: String? { get }

get · iOS 9.0+

maximumFramesToRender

TypeScript

get maximumFramesToRender(): number

Swift declaration

var maximumFramesToRender: AUAudioFrameCount { get set }

set · iOS 9.0+

maximumFramesToRender

TypeScript

set maximumFramesToRender(value: number)

Swift declaration

var maximumFramesToRender: AUAudioFrameCount { get set }

get · iOS 16.0+

migrateFromPlugin

TypeScript

get migrateFromPlugin(): Array<unknown>

Swift declaration

var migrateFromPlugin: [Any] { get }

get · iOS 9.0+

isMusicDeviceOrEffect

TypeScript

get isMusicDeviceOrEffect(): boolean

Swift declaration

var isMusicDeviceOrEffect: Bool { get }

get · iOS 9.0+

musicalContextBlock

TypeScript

get musicalContextBlock(): (((arg0: (SDKHandle) | null, arg1: (SDKHandle) | null, arg2: (SDKHandle) | null, arg3: (SDKHandle) | null, arg4: (SDKHandle) | null, arg5: (SDKHandle) | null) => Promise<boolean>)) | null

Swift declaration

var musicalContextBlock: AUHostMusicalContextBlock? { get set }

get · iOS 9.0+

outputBusses

TypeScript

get outputBusses(): AUAudioUnitBusArray

Swift declaration

var outputBusses: AUAudioUnitBusArray { get }

get

isOutputEnabled

TypeScript

get isOutputEnabled(): boolean

Swift declaration

var isOutputEnabled: Bool { get set }

set

isOutputEnabled

TypeScript

set isOutputEnabled(value: boolean)

Swift declaration

var isOutputEnabled: Bool { get set }

get · iOS 9.0+

parameterTree

TypeScript

get parameterTree(): (AUParameterTree) | null

Swift declaration

var parameterTree: AUParameterTree? { get set }

set · iOS 9.0+

parameterTree

TypeScript

set parameterTree(value: (AUParameterTree) | null)

Swift declaration

var parameterTree: AUParameterTree? { get set }

get · iOS 12.0+

profileChangedBlock

TypeScript

get profileChangedBlock(): (((arg0: number, arg1: number, arg2: _CoreMIDI_MIDICIProfile, arg3: boolean) => Promise<void>)) | null

Swift declaration

var profileChangedBlock: AUMIDICIProfileChangedBlock? { get set }

set · iOS 12.0+

profileChangedBlock

TypeScript

set profileChangedBlock(value: (((arg0: number, arg1: number, arg2: _CoreMIDI_MIDICIProfile, arg3: boolean) => void)) | null)

Swift declaration

var profileChangedBlock: AUMIDICIProfileChangedBlock? { get set }

get · iOS 11.0+

providesUserInterface

TypeScript

get providesUserInterface(): boolean

Swift declaration

var providesUserInterface: Bool { get }

get · iOS 9.0+

renderQuality

TypeScript

get renderQuality(): number

Swift declaration

var renderQuality: Int { get set }

set · iOS 9.0+

renderQuality

TypeScript

set renderQuality(value: number)

Swift declaration

var renderQuality: Int { get set }

get · iOS 9.0+

renderResourcesAllocated

TypeScript

get renderResourcesAllocated(): boolean

Swift declaration

var renderResourcesAllocated: Bool { get }

get · iOS 9.0+

isRenderingOffline

TypeScript

get isRenderingOffline(): boolean

Swift declaration

var isRenderingOffline: Bool { get set }

set · iOS 9.0+

isRenderingOffline

TypeScript

set isRenderingOffline(value: boolean)

Swift declaration

var isRenderingOffline: Bool { get set }

get · iOS 11.0+

isRunning

TypeScript

get isRunning(): boolean

Swift declaration

var isRunning: Bool { get }

get · iOS 9.0+

scheduleMIDIEventBlock

TypeScript

get scheduleMIDIEventBlock(): (((arg0: number, arg1: number, arg2: number, arg3: SDKHandle) => Promise<void>)) | null

Swift declaration

var scheduleMIDIEventBlock: AUScheduleMIDIEventBlock? { get }

get · iOS 15.0+

scheduleMIDIEventListBlock

TypeScript

get scheduleMIDIEventListBlock(): (((arg0: number, arg1: number, arg2: SDKHandle) => Promise<number>)) | null

Swift declaration

var scheduleMIDIEventListBlock: AUMIDIEventListBlock? { get }

get · iOS 9.0+

scheduleParameterBlock

TypeScript

get scheduleParameterBlock(): ((arg0: number, arg1: number, arg2: number, arg3: number) => Promise<void>)

Swift declaration

var scheduleParameterBlock: AUScheduleParameterBlock { get }

get · iOS 9.0+

shouldBypassEffect

TypeScript

get shouldBypassEffect(): boolean

Swift declaration

var shouldBypassEffect: Bool { get set }

set · iOS 9.0+

shouldBypassEffect

TypeScript

set shouldBypassEffect(value: boolean)

Swift declaration

var shouldBypassEffect: Bool { get set }

get · iOS 10.0+

supportsMPE

TypeScript

get supportsMPE(): boolean

Swift declaration

var supportsMPE: Bool { get }

get · iOS 13.0+

supportsUserPresets

TypeScript

get supportsUserPresets(): boolean

Swift declaration

var supportsUserPresets: Bool { get }

get · iOS 9.0+

tailTime

TypeScript

get tailTime(): number

Swift declaration

var tailTime: TimeInterval { get }

get · iOS 13.0+

userPresets

TypeScript

get userPresets(): Array<AUAudioUnitPreset>

Swift declaration

var userPresets: [AUAudioUnitPreset] { get }

get · iOS 9.0+

virtualMIDICableCount

TypeScript

get virtualMIDICableCount(): number

Swift declaration

var virtualMIDICableCount: Int { get }

Skipped declarations

12 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

AUAudioUnit.internalRenderBlock

callback cannot propagate synchronous failure

AUAudioUnit.renderBlock

callback cannot propagate synchronous failure

AUAudioUnit.midiOutputEventBlock