AVFAudio · IOS API REFERENCE

AVAudioFormat

class · iOS 8.0+ · SDK 27.1

class AVAudioFormat

Members (21)

init · iOS 8.0+

init

TypeScript

static initStandardFormatWithSampleRateChannelLayout(sampleRate: number, layout: AVAudioChannelLayout): AVAudioFormat

Swift declaration

init(standardFormatWithSampleRate sampleRate: Double, channelLayout layout: AVAudioChannelLayout)

init · iOS 8.0+

init

TypeScript

static initStandardFormatWithSampleRateChannels(sampleRate: number, channels: number): (AVAudioFormat) | null

Swift declaration

init?(standardFormatWithSampleRate sampleRate: Double, channels: AVAudioChannelCount)

init · iOS 9.0+ · Deprecated in iOS 27.0

init

TypeScript

static initCmAudioFormatDescription(formatDescription: _CoreMedia_CMFormatDescription): AVAudioFormat

Swift declaration

init(cmAudioFormatDescription formatDescription: CMAudioFormatDescription)

init · iOS 8.0+

init

TypeScript

static initCommonFormatSampleRateChannelsInterleaved(format: AVAudioCommonFormat, sampleRate: number, channels: number, interleaved: boolean): (AVAudioFormat) | null

Swift declaration

init?(commonFormat format: AVAudioCommonFormat, sampleRate: Double, channels: AVAudioChannelCount, interleaved: Bool)

init · iOS 8.0+

init

TypeScript

static initCommonFormatSampleRateInterleavedChannelLayout(format: AVAudioCommonFormat, sampleRate: number, interleaved: boolean, layout: AVAudioChannelLayout): AVAudioFormat

Swift declaration

init(commonFormat format: AVAudioCommonFormat, sampleRate: Double, interleaved: Bool, channelLayout layout: AVAudioChannelLayout)

init · iOS 27.0+

init

TypeScript

static initFormatDescription(formatDescription: _CoreMedia_CMFormatDescription): (AVAudioFormat) | null

Swift declaration

init?(formatDescription: CMAudioFormatDescription)

init · iOS 8.0+

init

TypeScript

static initSettings(settings: Record<string, unknown>): (AVAudioFormat) | null

Swift declaration

init?(settings: [String : Any])

init · iOS 8.0+

init

TypeScript

static initStreamDescription(asbd: SDKHandle): (AVAudioFormat) | null

Swift declaration

init?(streamDescription asbd: UnsafePointer<AudioStreamBasicDescription>)

init · iOS 8.0+

init

TypeScript

static initStreamDescriptionChannelLayout(asbd: SDKHandle, layout?: (AVAudioChannelLayout) | null): (AVAudioFormat) | null

Swift declaration

init?(streamDescription asbd: UnsafePointer<AudioStreamBasicDescription>, channelLayout layout: AVAudioChannelLayout?)

method · iOS 8.0+

isEqual

TypeScript

isEqual(object: unknown): boolean

Swift declaration

func isEqual(_ object: Any) -> Bool

get · iOS 8.0+

channelCount

TypeScript

get channelCount(): number

Swift declaration

var channelCount: AVAudioChannelCount { get }

get · iOS 8.0+

channelLayout

TypeScript

get channelLayout(): (AVAudioChannelLayout) | null

Swift declaration

var channelLayout: AVAudioChannelLayout? { get }

get · iOS 8.0+

commonFormat

TypeScript

get commonFormat(): AVAudioCommonFormat

Swift declaration

var commonFormat: AVAudioCommonFormat { get }

get · iOS 9.0+

formatDescription

TypeScript

get formatDescription(): _CoreMedia_CMFormatDescription

Swift declaration

var formatDescription: CMAudioFormatDescription { get }

get · iOS 8.0+

isInterleaved

TypeScript

get isInterleaved(): boolean

Swift declaration

var isInterleaved: Bool { get }

get · iOS 10.0+

magicCookie

TypeScript

get magicCookie(): (ArrayBuffer) | null

Swift declaration

var magicCookie: Data? { get set }

set · iOS 10.0+

magicCookie

TypeScript

set magicCookie(value: (ArrayBuffer) | null)

Swift declaration

var magicCookie: Data? { get set }

get · iOS 8.0+

sampleRate

TypeScript

get sampleRate(): number

Swift declaration

var sampleRate: Double { get }

get · iOS 8.0+

settings

TypeScript

get settings(): Record<string, unknown>

Swift declaration

var settings: [String : Any] { get }

get · iOS 8.0+

isStandard

TypeScript

get isStandard(): boolean

Swift declaration

var isStandard: Bool { get }

get · iOS 8.0+

streamDescription

TypeScript

get streamDescription(): SDKHandle

Swift declaration

var streamDescription: UnsafePointer<AudioStreamBasicDescription> { get }

Skipped declarations

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

AVAudioFormat.init()

inherited init: cannot prove legal (class declares 10 custom initializers)

All AVFAudio types →