iOS Developer Library

Developer

AVFoundation Framework Reference AVAudioSessionChannelDescription Class Reference

Options
Deployment Target:

On This Page
Language:

AVAudioSessionChannelDescription

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.

Inheritance


  • NSObject
  • AVAudioSessionChannelDescription
  • NSObject
  • AVAudioSessionChannelDescription

Conforms To


Import Statement


import AVFoundation @import AVFoundation;

Availability


Available in iOS 6.0 and later.
  • The descriptive name for the channel. (read-only)

    Declaration

    Swift

    var channelName: String! { get }

    Objective-C

    @property(readonly) NSString *channelName

    Import Statement

    import AVFoundation

    Availability

    Available in iOS 6.0 and later.

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

    Declaration

    Swift

    var channelNumber: Int { get }

    Objective-C

    @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.

    Import Statement

    import AVFoundation

    Availability

    Available in iOS 6.0 and later.

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

    Declaration

    Swift

    var owningPortUID: String! { get }

    Objective-C

    @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.

    Import Statement

    import AVFoundation

    Availability

    Available in iOS 6.0 and later.

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

    Declaration

    Swift

    var channelLabel: AudioChannelLabel { get }

    Objective-C

    @property(readonly) AudioChannelLabel channelLabel

    Import Statement

    import AVFoundation

    Availability

    Available in iOS 7.0 and later.