One Logo Pool Ball
AVFAudio · IOS API REFERENCE

AVAudioUnit

class · iOS 8.0+ · SDK 27.1

class AVAudioUnit

Members (9)

static · iOS 9.0+

instantiate

TypeScript
static instantiate(audioComponentDescription: _AudioToolbox_AudioComponentDescription, options: _AudioToolbox_AudioComponentInstantiationOptions, completionHandler: ((arg0: (AVAudioUnit) | null, arg1: (NativeError) | null) => void)): void
Swift declaration
class func instantiate(with audioComponentDescription: AudioComponentDescription, options: AudioComponentInstantiationOptions = []) async throws -> AVAudioUnit
init

init

TypeScript
static init(): AVAudioUnit
Swift declaration
init()
method · iOS 8.0+

loadPreset

TypeScript
loadPreset(url: string): void
Swift declaration
func loadPreset(at url: URL) throws
get · iOS 8.0+

audioComponentDescription

TypeScript
get audioComponentDescription(): _AudioToolbox_AudioComponentDescription
Swift declaration
var audioComponentDescription: AudioComponentDescription { get }
get · iOS 8.0+

manufacturerName

TypeScript
get manufacturerName(): string
Swift declaration
var manufacturerName: String { get }
get · iOS 8.0+

name

TypeScript
get name(): string
Swift declaration
var name: String { get }
get · iOS 8.0+

version

TypeScript
get version(): number
Swift declaration
var version: Int { get }
get · iOS 8.0+ · Deprecated in iOS 27.0

audioUnit

TypeScript
get audioUnit(): SDKHandle
Swift declaration
@export(implementation) var audioUnit: AudioUnit { get }
method · iOS 27.0+

withAudioUnit

TypeScript
withAudioUnit(body: ((arg0: SDKHandle) => unknown)): unknown
Swift declaration
func withAudioUnit<R, E>(_ body: (borrowing AudioUnit) throws(E) -> R) throws(E) -> R where E : Error

Provides scoped access to the audio unit's AudioUnit This method provides thread-safe, scoped access to the underlying AudioUnit. The audio unit reference is only valid within the closure and must not be retained or accessed outside of it. - Parameter body: A closure that receives the AudioUnit instance - Returns: The value returned by the closure - Throws: Rethrows any error thrown by the closure

Skipped declarations

No declarations were skipped in this snapshot.

All AVFAudio types →