AVFAudio · IOS API REFERENCE

AVAudioEngine

class · iOS 8.0+ · SDK 27.1

class AVAudioEngine

Members (45)

method · iOS 8.0+

attach

TypeScript

attach(node: AVAudioNode): void

Swift declaration

func attach(_ node: AVAudioNode)

method · iOS 8.0+ · Deprecated in iOS 27.0

connect

TypeScript

connectToFormat(node1: AVAudioNode, node2: AVAudioNode, format?: (AVAudioFormat) | null): void

Swift declaration

func connect(_ node1: AVAudioNode, to node2: AVAudioNode, format: AVAudioFormat?)

method · iOS 27.0+

connectNode

TypeScript

connectNodeToFormat(node1: AVAudioNode, node2: AVAudioNode, format?: (AVAudioFormat) | null): void

Swift declaration

func connectNode(_ node1: AVAudioNode, to node2: AVAudioNode, format: AVAudioFormat?) throws

method · iOS 8.0+ · Deprecated in iOS 27.0

connect

TypeScript

connectToFromBusToBusFormat(node1: AVAudioNode, node2: AVAudioNode, bus1: number, bus2: number, format?: (AVAudioFormat) | null): void

Swift declaration

func connect(_ node1: AVAudioNode, to node2: AVAudioNode, fromBus bus1: AVAudioNodeBus, toBus bus2: AVAudioNodeBus, format: AVAudioFormat?)

method · iOS 27.0+

connectNode

TypeScript

connectNodeToFromBusToBusFormat(node1: AVAudioNode, node2: AVAudioNode, bus1: number, bus2: number, format?: (AVAudioFormat) | null): void

Swift declaration

func connectNode(_ node1: AVAudioNode, to node2: AVAudioNode, fromBus bus1: AVAudioNodeBus, toBus bus2: AVAudioNodeBus, format: AVAudioFormat?) throws

method · iOS 9.0+ · Deprecated in iOS 27.0

connect

TypeScript

connectToFromBusFormat(sourceNode: AVAudioNode, destNodes: Array<AVAudioConnectionPoint>, sourceBus: number, format?: (AVAudioFormat) | null): void

Swift declaration

func connect(_ sourceNode: AVAudioNode, to destNodes: [AVAudioConnectionPoint], fromBus sourceBus: AVAudioNodeBus, format: AVAudioFormat?)

method · iOS 27.0+

connectNode

TypeScript

connectNodeToFromBusFormat(sourceNode: AVAudioNode, destNodes: Array<AVAudioConnectionPoint>, sourceBus: number, format?: (AVAudioFormat) | null): void

Swift declaration

func connectNode(_ sourceNode: AVAudioNode, to destNodes: [AVAudioConnectionPoint], fromBus sourceBus: AVAudioNodeBus, format: AVAudioFormat?) throws

method · iOS 27.0+

connectMIDI

TypeScript

connectMIDIToFormat(sourceNode: AVAudioNode, destinationNode: AVAudioNode, format?: (AVAudioFormat) | null): void

Swift declaration

func connectMIDI(_ sourceNode: AVAudioNode, to destinationNode: AVAudioNode, format: AVAudioFormat?, eventListProvider tapBlock: AVMIDIEventListBlock? = nil)

method · iOS 13.0+ · Deprecated in iOS 16.0

connectMIDI

TypeScript

connectMIDIToFormat86448(sourceNode: AVAudioNode, destinationNodes: Array<AVAudioNode>, format?: (AVAudioFormat) | null): void

Swift declaration

func connectMIDI(_ sourceNode: AVAudioNode, to destinationNodes: [AVAudioNode], format: AVAudioFormat?, block tapBlock: AUMIDIOutputEventBlock? = nil)

method · iOS 16.0+ · Deprecated in iOS 27.0

connectMIDI

TypeScript

connectMIDIToFormat39598(sourceNode: AVAudioNode, destinationNodes: Array<AVAudioNode>, format?: (AVAudioFormat) | null): void

Swift declaration

func connectMIDI(_ sourceNode: AVAudioNode, to destinationNodes: [AVAudioNode], format: AVAudioFormat?, eventListBlock tapBlock: AUMIDIEventListBlock? = nil)

method · iOS 8.0+

detach

TypeScript

detach(node: AVAudioNode): void

Swift declaration

func detach(_ node: AVAudioNode)

method · iOS 11.0+

disableManualRenderingMode

TypeScript

disableManualRenderingMode(): void

Swift declaration

func disableManualRenderingMode()

method · iOS 12.0+

disconnectMIDI

TypeScript

disconnectMIDIFrom(sourceNode: AVAudioNode, destinationNode: AVAudioNode): void

Swift declaration

func disconnectMIDI(_ sourceNode: AVAudioNode, from destinationNode: AVAudioNode)

method · iOS 12.0+

disconnectMIDI

TypeScript

disconnectMIDIFrom21581(sourceNode: AVAudioNode, destinationNodes: Array<AVAudioNode>): void

Swift declaration

func disconnectMIDI(_ sourceNode: AVAudioNode, from destinationNodes: [AVAudioNode])

method · iOS 12.0+

disconnectMIDIInput

TypeScript

disconnectMIDIInput(node: AVAudioNode): void

Swift declaration

func disconnectMIDIInput(_ node: AVAudioNode)

method · iOS 12.0+

disconnectMIDIOutput

TypeScript

disconnectMIDIOutput(node: AVAudioNode): void

Swift declaration

func disconnectMIDIOutput(_ node: AVAudioNode)

method · iOS 8.0+

disconnectNodeInput

TypeScript

disconnectNodeInput(node: AVAudioNode): void

Swift declaration

func disconnectNodeInput(_ node: AVAudioNode)

method · iOS 8.0+

disconnectNodeInput

TypeScript

disconnectNodeInputBus(node: AVAudioNode, bus: number): void

Swift declaration

func disconnectNodeInput(_ node: AVAudioNode, bus: AVAudioNodeBus)

method · iOS 8.0+

disconnectNodeOutput

TypeScript

disconnectNodeOutput(node: AVAudioNode): void

Swift declaration

func disconnectNodeOutput(_ node: AVAudioNode)

method · iOS 8.0+

disconnectNodeOutput

TypeScript

disconnectNodeOutputBus(node: AVAudioNode, bus: number): void

Swift declaration

func disconnectNodeOutput(_ node: AVAudioNode, bus: AVAudioNodeBus)

method · iOS 11.0+

enableManualRenderingMode

TypeScript

enableManualRenderingMode(mode: AVAudioEngineManualRenderingMode, pcmFormat: AVAudioFormat, maximumFrameCount: number): void

Swift declaration

func enableManualRenderingMode(_ mode: AVAudioEngineManualRenderingMode, format pcmFormat: AVAudioFormat, maximumFrameCount: AVAudioFrameCount) throws

init · iOS 8.0+

init

TypeScript

static init(): AVAudioEngine

Swift declaration

init()

method · iOS 9.0+

inputConnectionPoint

TypeScript

inputConnectionPoint(node: AVAudioNode, bus: number): (AVAudioConnectionPoint) | null

Swift declaration

func inputConnectionPoint(for node: AVAudioNode, inputBus bus: AVAudioNodeBus) -> AVAudioConnectionPoint?

method · iOS 9.0+

outputConnectionPoints

TypeScript

outputConnectionPoints(node: AVAudioNode, bus: number): Array<AVAudioConnectionPoint>

Swift declaration

func outputConnectionPoints(for node: AVAudioNode, outputBus bus: AVAudioNodeBus) -> [AVAudioConnectionPoint]

method · iOS 8.0+

pause

TypeScript

pause(): void

Swift declaration

func pause()

method · iOS 8.0+

prepare

TypeScript

prepare(): void

Swift declaration

func prepare()

method · iOS 11.0+

renderOffline

TypeScript

renderOffline(numberOfFrames: number, buffer: AVAudioPCMBuffer): AVAudioEngineManualRenderingStatus

Swift declaration

func renderOffline(_ numberOfFrames: AVAudioFrameCount, to buffer: AVAudioPCMBuffer) throws -> AVAudioEngineManualRenderingStatus

method · iOS 8.0+

reset

TypeScript

reset(): void

Swift declaration

func reset()

method · iOS 8.0+

start

TypeScript

start(): void

Swift declaration

func start() throws

method · iOS 8.0+

stop

TypeScript

stop(): void

Swift declaration

func stop()

get · iOS 13.0+

attachedNodes

TypeScript

get attachedNodes(): Array<AVAudioNode>

Swift declaration

var attachedNodes: Set<AVAudioNode> { get }

get · iOS 11.0+

isAutoShutdownEnabled

TypeScript

get isAutoShutdownEnabled(): boolean

Swift declaration

var isAutoShutdownEnabled: Bool { get set }

set · iOS 11.0+

isAutoShutdownEnabled

TypeScript

set isAutoShutdownEnabled(value: boolean)

Swift declaration

var isAutoShutdownEnabled: Bool { get set }

get · iOS 8.0+

inputNode

TypeScript

get inputNode(): AVAudioInputNode

Swift declaration

var inputNode: AVAudioInputNode { get }

get · iOS 11.0+

isInManualRenderingMode

TypeScript

get isInManualRenderingMode(): boolean

Swift declaration

var isInManualRenderingMode: Bool { get }

get · iOS 8.0+

mainMixerNode

TypeScript

get mainMixerNode(): AVAudioMixerNode

Swift declaration

var mainMixerNode: AVAudioMixerNode { get }

get · iOS 11.0+

manualRenderingBlock

TypeScript

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

Swift declaration

var manualRenderingBlock: AVAudioEngineManualRenderingBlock { get }

get · iOS 11.0+

manualRenderingFormat

TypeScript

get manualRenderingFormat(): AVAudioFormat

Swift declaration

var manualRenderingFormat: AVAudioFormat { get }

get · iOS 11.0+

manualRenderingMaximumFrameCount

TypeScript

get manualRenderingMaximumFrameCount(): number

Swift declaration

var manualRenderingMaximumFrameCount: AVAudioFrameCount { get }

get · iOS 11.0+

manualRenderingMode

TypeScript

get manualRenderingMode(): AVAudioEngineManualRenderingMode

Swift declaration

var manualRenderingMode: AVAudioEngineManualRenderingMode { get }

get · iOS 11.0+

manualRenderingSampleTime

TypeScript

get manualRenderingSampleTime(): number

Swift declaration

var manualRenderingSampleTime: AVAudioFramePosition { get }

get · iOS 8.0+

outputNode

TypeScript

get outputNode(): AVAudioOutputNode

Swift declaration

var outputNode: AVAudioOutputNode { get }

get · iOS 8.0+

isRunning

TypeScript

get isRunning(): boolean

Swift declaration

var isRunning: Bool { get }

get · iOS 8.0+ · Deprecated in iOS 27.0

musicSequence

TypeScript

get musicSequence(): (SDKHandle) | null

Swift declaration

@export(implementation) var musicSequence: MusicSequence? { get }

method · iOS 27.0+

withMusicSequence

TypeScript

withMusicSequence(body: ((arg0: (SDKHandle) | null) => unknown)): unknown

Swift declaration

func withMusicSequence<R, E>(_ body: (borrowing MusicSequence?) throws(E) -> R) throws(E) -> R where E : Error

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

Skipped declarations

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

AVAudioEngine.connectMIDI(_:to:format:block:)

The iOS SDK compiler rejected this binding: ambiguous use of 'connectMIDI'

AVAudioEngine.connectMIDI(_:to:format:eventListBlock:)

The iOS SDK compiler rejected this binding: ambiguous use of 'connectMIDI'

AVAudioEngine.connectMIDI(_:to:format:eventListProvider:)

The iOS SDK compiler rejected this binding: ambiguous use of 'connectMIDI'

All AVFAudio types →