AVAudioSessionPortDescription

Наследование

NSObject
AVAudioSessionPortDescription

NSObject
AVAudioSessionPortDescription

Соответствует

AnyObject
CVarArgType
Equatable
Hashable
NSObjectProtocol
Печатаемый
NSObject

Оператор импорта

Swift

import AVFoundation

Objective C

@import AVFoundation;

Доступность

Доступный в iOS 6.0 и позже.

AVAudioSessionPortDescription объект описывает единственный порт ввода или вывода, связанный с аудио маршрутом. Можно использовать информацию в этом классе для получения информации о возможностях порта и аппаратных каналов, которые это поддерживает.

Примеры аудиопортов включают встроенный динамик устройства, микрофон на соединенной проводом гарнитуре и bluetooth-устройство, поддерживающее Усовершенствованный Аудио Профиль Распределения (A2DP).

Можно использовать описания порта с совместно используемым AVAudioSession объект:

Получить информацию о наборе использующихся в настоящее время портов ввода и вывода. (См. currentRoute.)
Вносить изменения в аудио маршрутизацию. (См. setPreferredInput:error:.)

Например, на устройстве с соединенной проводом присоединенной гарнитурой, аудио сеанс availableInputs массив может содержать два описания порта: один для микрофона гарнитуры и один для встроенного микрофона устройства. Можно использовать аудио сеанс setPreferredInput:error: метод для выбора гарнитуры или встроенного микрофона для аудиовхода.

Получение атрибутов порта

portName Свойство

Описательное имя для порта. (только для чтения)

Объявление

Swift

var portName: String! { get }

Objective C

@property(readonly) NSString *portName

Обсуждение

Это имя может быть выведено на экран пользователю.

Оператор импорта

Objective C

@import AVFoundation;

Swift

import AVFoundation

Доступность

Доступный в iOS 6.0 и позже.
portType Свойство

Тип порта. (только для чтения)

Объявление

Swift

var portType: String! { get }

Objective C

@property(readonly) NSString *portType

Обсуждение

Значение этого свойства может быть любой из констант, объявленных в “Input or Output Port Types”, “Input Port Types”, или “Output Port Types”.

Оператор импорта

Objective C

@import AVFoundation;

Swift

import AVFoundation

Доступность

Доступный в iOS 6.0 и позже.
channels Свойство

Массив объектов канала, описывающих каналы ввода или вывода порта. (только для чтения)

Объявление

Swift

var channels: [AnyObject]! { get }

Objective C

@property(readonly) NSArray *channels

Обсуждение

Массив AVAudioSessionChannelDescription объекты, каждый из которых представляет единственный аудиовход или канал вывода. Если количество каналов ввода или вывода изменяется для, содержание этого массива может измениться AVAudioSession объект, владеющий портом.

Оператор импорта

Objective C

@import AVFoundation;

Swift

import AVFoundation

Доступность

Доступный в iOS 6.0 и позже.
UID Свойство

Присвоенный системе уникальный идентификатор (UID) для порта. (только для чтения)

Объявление

Swift

var UID: String! { get }

Objective C

@property(readonly) NSString *UID

Обсуждение

Значение этого свойства соответствия тот из owningPortUID свойство каждого AVAudioSessionChannelDescription объект в порту channels массив.

Оператор импорта

Objective C

@import AVFoundation;

Swift

import AVFoundation

Доступность

Доступный в iOS 6.0 и позже.

Управление источниками данных порта

dataSources Свойство

Доступные источники данных для порта. (только для чтения)

Объявление

Swift

var dataSources: [AnyObject]! { get }

Objective C

@property(readonly) NSArray *dataSources

Обсуждение

Если nil, порт не поддерживает выбор между многократными источниками данных. Эта функция только поддерживается на определенных устройствах и периферийных устройствах; например, источники данных представляют переднюю сторону - и микрофоны, расположенные «против движения», на iPhone, оборудованном таким.

Если режим изменяется для, содержание этого массива может измениться AVAudioSession объект, владеющий портом.

Оператор импорта

Objective C

@import AVFoundation;

Swift

import AVFoundation

Доступность

Доступный в iOS 7.0 и позже.
selectedDataSource Свойство

В настоящее время выбираемый источник аудиоданных для порта. (только для чтения)

Объявление

Swift

var selectedDataSource: AVAudioSessionDataSourceDescription! { get }

Objective C

@property(readonly) AVAudioSessionDataSourceDescription *selectedDataSource

Обсуждение

Если nil, порт не поддерживает выбор между многократными источниками данных.

Оператор импорта

Objective C

@import AVFoundation;

Swift

import AVFoundation

Доступность

Доступный в iOS 7.0 и позже.

См. также

preferredDataSource
– setPreferredDataSource:error:
preferredDataSource Свойство

Предпочтительный источник аудиоданных для порта. (только для чтения)

Объявление

Swift

var preferredDataSource: AVAudioSessionDataSourceDescription! { get }

Objective C

@property(readonly) AVAudioSessionDataSourceDescription *preferredDataSource

Обсуждение

Значение этого свойства указывает, что источник данных выбрал использование setPreferredDataSource:error: метод. Для наблюдения фактического источника данных используйте selectedDataSource свойство.

Если nil, порт не поддерживает выбор между многократными источниками данных, или никакой предпочтительный источник данных не был выбран.

Оператор импорта

Objective C

@import AVFoundation;

Swift

import AVFoundation

Доступность

Доступный в iOS 7.0 и позже.


    
    setPreferredDataSource (_: ошибка:)
    - setPreferredDataSource:error:

Устанавливает предпочтительный источник аудиоданных для порта.

Объявление

Swift

func setPreferredDataSource(_ dataSource: AVAudioSessionDataSourceDescription!, error outError: NSErrorPointer) -> Bool

Objective C

- (BOOL)setPreferredDataSource:(AVAudioSessionDataSourceDescription *)dataSource error:(NSError **)outError

Параметры

`dataSource`	Источник данных, который будет использоваться.
`outError`	На вводе, указателе на ошибочный объект. Если ошибка происходит, указатель установлен в `NSError` объект, описывающий ошибку. Если Вы не хотите информации об ошибке, передайте в `nil`.

Возвращаемое значение

YEStrue если запрос был успешно выполнен, или NOfalse иначе.

Обсуждение

Запрашивает изменение источника данных; чтобы определить, вступает ли изменение в силу, используйте selectedDataSource свойство. (См. “Конфигурирование Аудио Сеанса” в AVAudioSession ссылка класса для подробных данных.)

Если порт будет использоваться, то изменение этих настроек, вероятно, приведет к реконфигурированию маршрута.

Установите предпочтительный источник данных только после установки категории и режима аудио сеанса и активации сеанса.

Оператор импорта

Objective C

@import AVFoundation;

Swift

import AVFoundation

Доступность

Доступный в iOS 7.0 и позже.

Константы

Типы порта ввода или вывода
Устройства, которые могут использоваться для любого ввода или вывода.

Объявление

Swift

let AVAudioSessionPortBluetoothHFP: String let AVAudioSessionPortUSBAudio: String

Objective C

NSString *const AVAudioSessionPortBluetoothHFP; NSString *const AVAudioSessionPortUSBAudio;

Константы
- AVAudioSessionPortBluetoothHFP
  
  Устройство с поддержкой Bluetooth, поддерживающее Hands-Free Profile (HFP).
  
  Доступный в iOS 6.0 и позже.
- AVAudioSessionPortUSBAudio
  
  USB-устройство.
  
  Доступный в iOS 6.0 и позже.
Типы входного порта
Константы, указывающие аудиовход к устройству.

Объявление

Swift

let AVAudioSessionPortLineIn: String let AVAudioSessionPortBuiltInMic: String let AVAudioSessionPortHeadsetMic: String

Objective C

NSString *const AVAudioSessionPortLineIn; NSString *const AVAudioSessionPortBuiltInMic; NSString *const AVAudioSessionPortHeadsetMic;

Константы
- AVAudioSessionPortLineIn
  
  Линейный уровень вводится от коннектора прикрепления.
  
  Доступный в iOS 6.0 и позже.
- AVAudioSessionPortBuiltInMic
  
  Встроенный микрофон на устройстве.
  
  Доступный в iOS 6.0 и позже.
- AVAudioSessionPortHeadsetMic
  
  Микрофон, который встроен к соединенной проводом гарнитуре.
  
  Доступный в iOS 6.0 и позже.
Типы выходного порта
Константы, указывающие аудиовыход от устройства.

Объявление

Swift

let AVAudioSessionPortLineOut: String let AVAudioSessionPortHeadphones: String let AVAudioSessionPortBluetoothA2DP: String let AVAudioSessionPortBuiltInReceiver: String let AVAudioSessionPortBuiltInSpeaker: String let AVAudioSessionPortHDMI: String let AVAudioSessionPortAirPlay: String let AVAudioSessionPortBluetoothLE: String

Objective C

NSString *const AVAudioSessionPortLineOut; NSString *const AVAudioSessionPortHeadphones; NSString *const AVAudioSessionPortBluetoothA2DP; NSString *const AVAudioSessionPortBuiltInReceiver; NSString *const AVAudioSessionPortBuiltInSpeaker; NSString *const AVAudioSessionPortHDMI; NSString *const AVAudioSessionPortAirPlay; NSString *const AVAudioSessionPortBluetoothLE;

Константы
- AVAudioSessionPortLineOut
  
  Вывод линейного уровня к коннектору прикрепления.
  
  Доступный в iOS 6.0 и позже.
- AVAudioSessionPortHeadphones
  
  Вывод к соединенной проводом гарнитуре.
  
  Доступный в iOS 6.0 и позже.
- AVAudioSessionPortBluetoothA2DP
  
  Вывод к устройству Bluetooth A2DP.
  
  Доступный в iOS 6.0 и позже.
- AVAudioSessionPortBuiltInReceiver
  
  Вывод динамику намеревался быть сохраненным около уха. Как правило, этот динамик доступен только на устройствах iPhone.
  
  Доступный в iOS 6.0 и позже.
- AVAudioSessionPortBuiltInSpeaker
  
  Вывод встроенному динамику устройства.
  
  Доступный в iOS 6.0 и позже.
- AVAudioSessionPortHDMI
  
  Вывод к устройству через спецификацию High-Definition Multimedia Interface (HDMI).
  
  Доступный в iOS 6.0 и позже.
- AVAudioSessionPortAirPlay
  
  Вывод к удаленному устройству по AirPlay.
  
  Доступный в iOS 6.0 и позже.
- AVAudioSessionPortBluetoothLE
  
  Вывод к низкоэнергетическому периферийному устройству Bluetooth.
  
  Доступный в iOS 7.0 и позже.

AVAudioSessionPortDescription

Получение атрибутов порта

Объявление

Обсуждение

Оператор импорта

Доступность

Объявление

Обсуждение

Оператор импорта

Доступность

Объявление

Обсуждение

Оператор импорта

Доступность

Объявление

Обсуждение

Оператор импорта

Доступность

Управление источниками данных порта

Объявление

Обсуждение

Оператор импорта

Доступность

Объявление

Обсуждение

Оператор импорта

Доступность

См. также

Объявление

Обсуждение

Оператор импорта

Доступность

Объявление

Параметры

Возвращаемое значение

Обсуждение

Оператор импорта

Доступность

Константы

Объявление

Константы

Объявление

Константы

Объявление

Константы