One Logo Pool Ball
AVFAudio · IOS API REFERENCE

AVAudioNode

class · iOS 8.0+ · SDK 27.1

class AVAudioNode

Members (17)

init

init

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

inputFormat

TypeScript
inputFormat(bus: number): AVAudioFormat
Swift declaration
func inputFormat(forBus bus: AVAudioNodeBus) -> AVAudioFormat
method · iOS 8.0+ · Deprecated in iOS 27.0

installTap

TypeScript
installTap(bus: number, bufferSize: number, format: (AVAudioFormat) | null, tapBlock: ((arg0: AVAudioPCMBuffer, arg1: AVAudioTime) => void)): void
Swift declaration
func installTap(onBus bus: AVAudioNodeBus, bufferSize: AVAudioFrameCount, format: AVAudioFormat?, block tapBlock: @escaping AVAudioNodeTapBlock)
method · iOS 8.0+

name

TypeScript
nameForInputBus(bus: number): (string) | null
Swift declaration
func name(forInputBus bus: AVAudioNodeBus) -> String?
method · iOS 8.0+

name

TypeScript
nameForOutputBus(bus: number): (string) | null
Swift declaration
func name(forOutputBus bus: AVAudioNodeBus) -> String?
method · iOS 8.0+

outputFormat

TypeScript
outputFormat(bus: number): AVAudioFormat
Swift declaration
func outputFormat(forBus bus: AVAudioNodeBus) -> AVAudioFormat
method · iOS 8.0+

removeTap

TypeScript
removeTap(bus: number): void
Swift declaration
func removeTap(onBus bus: AVAudioNodeBus)
method · iOS 8.0+

reset

TypeScript
reset(): void
Swift declaration
func reset()
get · iOS 8.0+

engine

TypeScript
get engine(): (AVAudioEngine) | null
Swift declaration
var engine: AVAudioEngine? { get }
get · iOS 8.0+

lastRenderTime

TypeScript
get lastRenderTime(): (AVAudioTime) | null
Swift declaration
var lastRenderTime: AVAudioTime? { get }
get · iOS 11.0+

latency

TypeScript
get latency(): number
Swift declaration
var latency: TimeInterval { get }
get · iOS 8.0+

numberOfInputs

TypeScript
get numberOfInputs(): number
Swift declaration
var numberOfInputs: Int { get }
get · iOS 8.0+

numberOfOutputs

TypeScript
get numberOfOutputs(): number
Swift declaration
var numberOfOutputs: Int { get }
get · iOS 11.0+

outputPresentationLatency

TypeScript
get outputPresentationLatency(): number
Swift declaration
var outputPresentationLatency: TimeInterval { get }
get · iOS 11.0+ · Deprecated in iOS 27.0

auAudioUnit

TypeScript
get auAudioUnit(): _AudioToolbox_AUAudioUnit
Swift declaration
@export(implementation) var auAudioUnit: AUAudioUnit { get }
method · iOS 27.0+

installAudioTap

TypeScript
installAudioTap(bus: number, bufferSize: number, format: (AVAudioFormat) | null, tapProvider: ((arg0: AVReadOnlyAudioPCMBuffer, arg1: AVAudioTime) => void)): void
Swift declaration
func installAudioTap(onBus bus: AVAudioNodeBus, bufferSize: AVAudioFrameCount, format: AVAudioFormat?, tapProvider: @escaping @Sendable (AVReadOnlyAudioPCMBuffer, AVAudioTime) -> Void) throws

Install a tap on a bus using a sendable block This method installs a tap that receives read-only buffers safe for concurrent use. The tap block is sendable and can be safely called from any isolation domain. - Parameters: - bus: The node output bus to which to attach the tap - bufferSize: The requested size of incoming buffers in sample frames. Supported range is [100, 400] ms. - format: If non-nil, attempts to apply this as the format of the specified output bus - tapProvider: A sendable closure to be called with read-only audio buffers Only one tap may be installed on any bus. Taps may be safely installed and removed while the engine is running.

method · iOS 27.0+

withAUAudioUnit

TypeScript
withAUAudioUnit(body: ((arg0: _AudioToolbox_AUAudioUnit) => unknown)): unknown
Swift declaration
func withAUAudioUnit<R, E>(_ body: (borrowing AUAudioUnit) throws(E) -> R) throws(E) -> R where E : Error

Provides scoped access to the node's AUAudioUnit This method provides thread-safe, scoped access to the underlying AUAudioUnit. 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 AUAudioUnit 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 →