CoreAudio · IOS API REFERENCE

ManagedAudioChannelLayout

struct · iOS 13.0+ · SDK 27.1

struct ManagedAudioChannelLayout

This structure is used to specify channel layouts in files and hardware.

Members (14)

get · iOS 13.0+

sizeInBytes

TypeScript

get sizeInBytes(): number

Swift declaration

var sizeInBytes: Int { get }

The size, in bytes, of the backing `AudioChannelLayout`.

method · iOS 13.0+

setAllToUnknown

TypeScript

setAllToUnknown(): void

Swift declaration

mutating func setAllToUnknown()

Sets all `AudioChannelDescriptions` to `kAudioChannelLabel_Unknown`.

get · iOS 13.0+

numberOfChannels

TypeScript

get numberOfChannels(): number

Swift declaration

var numberOfChannels: Int { get }

The number of channels described by this `ManagedAudioChannelLayout`.

method · iOS 13.0+

withUnsafePointer

TypeScript

withUnsafePointer(body: ((arg0: SDKHandle) => unknown)): unknown

Swift declaration

func withUnsafePointer<Result>(_ body: (UnsafePointer<AudioChannelLayout>) throws -> Result) rethrows -> Result

Calls a closure with a pointer to the backing `AudioChannelLayout`. - Parameter body: a closure that is called with a pointer to the backing `AudioChannelLayout`.

get · iOS 13.0+

channelDescriptions

TypeScript

get channelDescriptions(): ManagedAudioChannelLayout_ChannelDescriptions

Swift declaration

var channelDescriptions: ManagedAudioChannelLayout.ChannelDescriptions { get set }

The `AudioChannelDescription`s that describe the layout.

set · iOS 13.0+

channelDescriptions

TypeScript

set channelDescriptions(value: ManagedAudioChannelLayout_ChannelDescriptions)

Swift declaration

var channelDescriptions: ManagedAudioChannelLayout.ChannelDescriptions { get set }

The `AudioChannelDescription`s that describe the layout.

init · iOS 13.0+

init

TypeScript

static initChannelDescriptions(channelDescriptions: Array<_CoreAudioTypes_AudioChannelDescription>): ManagedAudioChannelLayout

Swift declaration

init(channelDescriptions: [AudioChannelDescription])

Creates a new `ManagedAudioChannelLayout` from an array of `AudioChannelDescription`. - Parameter channelDescriptions: An array of `AudioChannelDescription` that are set on this `ManagedAudioChannelLayout`.

init · iOS 13.0+

init

TypeScript

static initMaximumDescriptions(maximumDescriptions: number): ManagedAudioChannelLayout

Swift declaration

init(maximumDescriptions: Int)

Creates a new `ManagedAudioChannelLayout` that can hold up to `maximumDescriptions`. Use `ManagedAudioChannelLayout(tag:)` if no `AudioChannelDescription` are needed. - Parameter maximumDescriptions: The maximum number of `AudioChannelDescription` this `ManagedAudioChannelLayout` can hold. This must be greater than `0`.

method · iOS 13.0+

withUnsafeMutablePointer

TypeScript

withUnsafeMutablePointer(body: ((arg0: SDKHandle) => unknown)): unknown

Swift declaration

mutating func withUnsafeMutablePointer<Result>(_ body: (UnsafeMutablePointer<AudioChannelLayout>) throws -> Result) rethrows -> Result

Calls a closure with a mutable pointer to the backing `AudioChannelLayout`. - Parameter body: a closure that is called with a mutable pointer to the backing `AudioChannelLayout`. It is invalid to increase mNumberChannelDescriptions.

init · iOS 13.0+

init

TypeScript

static initTag(tag: number): ManagedAudioChannelLayout

Swift declaration

init(tag: AudioChannelLayoutTag)

Creates a new `ManagedAudioChannelLayout` with a given tag. - Parameter tag: The `AudioChannelLayoutTag` that indicates the layout.

get · iOS 13.0+

tag

TypeScript

get tag(): number

Swift declaration

var tag: AudioChannelLayoutTag { get set }

The `AudioChannelLayoutTag` that indicates the layout.

set · iOS 13.0+

tag

TypeScript

set tag(value: number)

Swift declaration

var tag: AudioChannelLayoutTag { get set }

The `AudioChannelLayoutTag` that indicates the layout.

get · iOS 13.0+

bitmap

TypeScript

get bitmap(): _CoreAudioTypes_AudioChannelBitmap

Swift declaration

var bitmap: AudioChannelBitmap { get set }

If `tag` is set to `kAudioChannelLayoutTag_UseChannelBitmap`, this is the channel usage bitmap.

set · iOS 13.0+

bitmap

TypeScript

set bitmap(value: _CoreAudioTypes_AudioChannelBitmap)

Swift declaration

var bitmap: AudioChannelBitmap { get set }

If `tag` is set to `kAudioChannelLayoutTag_UseChannelBitmap`, this is the channel usage bitmap.

Skipped declarations

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

ManagedAudioChannelLayout.init(audioChannelLayoutPointer:deallocator:)

This output pointer cannot safely be represented by the bridge.

All CoreAudio types →