AVAudioSessionChannelDescription Class Reference

Inherits from
Conforms to
Framework
/System/Library/Frameworks/AVFoundation.framework
Availability
Available in iOS 6.0 and later.
Declared in
AVAudioSession.h

Overview

The AVAudioSessionChannelDescription class provides descriptive information about a hardware channel on the current device. You typically do not create instances of this class yourself but can retrieve them from the port AVAudioSessionPortDescription object used to reference the intended input or output port.

Tasks

Getting the Channel Information

Properties

channelLabel

A description of the physical location of this channel. (read-only)

@property(readonly) AudioChannelLabel channelLabel
Availability
  • Available in iOS 7.0 and later.
Declared In
AVAudioSession.h

channelName

The descriptive name for the channel. (read-only)

@property(readonly) NSString *channelName
Availability
  • Available in iOS 6.0 and later.
Declared In
AVAudioSession.h

channelNumber

The index of this channel in its owning port’s array of channels. (read-only)

@property(readonly) NSUInteger channelNumber
Discussion

You can use the value in this property to identify the channel during audio routing. The value of this property is not guaranteed to persist across route changes, though.

Availability
  • Available in iOS 6.0 and later.
Declared In
AVAudioSession.h

owningPortUID

The unique identifier (UID) for this channel’s owning port. (read-only)

@property(readonly) NSString *owningPortUID
Discussion

You can use the value of this property along with the value of the channelNumber property to communicate with specific hardware channels.

Availability
  • Available in iOS 6.0 and later.
Declared In
AVAudioSession.h