Spec-Zone .ru
спецификации, руководства, описания, API

Библиотека Разработчика iOS

Разработчик

Ссылочная системная ссылка служб звука платформы AudioToolbox

Опции
Развертывание Target:

На этой странице
Язык:

Системная ссылка служб звука

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

Не применимый

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

Не применимый

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

Swift

import AudioToolbox

Objective C

@import AudioToolbox;

System Sound Services обеспечивает интерфейс C для игры коротких звуков и для вызова вибрации на устройствах на iOS та вибрация поддержки.

Можно использовать System Sound Services для игры короткий (30 секунд или короче) звуки. Интерфейс не обеспечивает уровень, расположение, цикличное выполнение или синхронизацию управления, и не поддерживает одновременное воспроизведение: можно играть только один звук за один раз. Можно использовать System Sound Services для обеспечения слышимых предупреждений. На некоторых устройствах на iOS предупреждения могут включать вибрацию.

Для получения информации об использовании для iOS обратитесь к Использованию Аудио в Мультимедийном Руководстве по программированию.

Функции

Создание и избавление от системных объектов звука
  • AudioServicesCreateSystemSoundID (_: _:) AudioServicesCreateSystemSoundID

    Создает системный объект звука.

    Объявление

    Swift

    func AudioServicesCreateSystemSoundID(_ inFileURL: CFURL!, _ outSystemSoundID: UnsafeMutablePointer<SystemSoundID>) -> OSStatus

    Objective C

    OSStatus AudioServicesCreateSystemSoundID ( CFURLRef inFileURL, SystemSoundID *outSystemSoundID );

    Параметры

    inFileURL

    URL аудиофайла для игры.

    outSystemSoundID

    На выводе системный объект звука связался с указанным аудиофайлом.

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

    Код результата.

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

    Objective C

    @import AudioToolbox;

    Swift

    import AudioToolbox

    Доступность

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

    См. также

    AudioServicesDisposeSystemSoundID

  • AudioServicesDisposeSystemSoundID (_:) AudioServicesDisposeSystemSoundID

    Избавляется от системного объекта звука и связанных ресурсов.

    Объявление

    Swift

    func AudioServicesDisposeSystemSoundID(_ inSystemSoundID: SystemSoundID) -> OSStatus

    Objective C

    OSStatus AudioServicesDisposeSystemSoundID ( SystemSoundID inSystemSoundID );

    Параметры

    inSystemSoundID

    Системный звук возражает для избавления.

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

    Код результата.

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

    Objective C

    @import AudioToolbox;

    Swift

    import AudioToolbox

    Доступность

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

    См. также

    AudioServicesCreateSystemSoundID

Игра звуков
  • AudioServicesPlayAlertSound (_:) AudioServicesPlayAlertSound

    Играет системный звук как предупреждение.

    Объявление

    Swift

    func AudioServicesPlayAlertSound(_ inSystemSoundID: SystemSoundID)

    Objective C

    void AudioServicesPlayAlertSound ( SystemSoundID inSystemSoundID );

    Параметры

    inSystemSoundID

    Системный звук возражает для игры как предупреждение.

    Перед использованием этой функции вызовите AudioServicesCreateSystemSoundID функция для получения системного звука.

    Обсуждение

    В зависимости от определенного устройства на iOS эта функция играет короткий звук и может вызвать вибрацию. Вызывание этой функции делает следование различных устройств на iOS:

    • iPhone — играет указанный звук. Если пользователь сконфигурировал приложение Настроек для вибрации на кольце, также вызывает вибрацию. Если аудио сеанс Вашего приложения сконфигурирован с, Однако устройство не вибрирует AVAudioSessionCategoryPlayAndRecord или AVAudioSessionCategoryRecord аудио категория сеанса. Это гарантирует, что вибрация не вмешивается в аудиозапись. Для объяснения аудио категорий сеанса посмотрите Экспресс Категорий Аудио Роли.

    • iPod touch, исходный — играет короткую предупредительную мелодию.

    • iPod touch, второе поколение и более новый — играют указанный звук.

    В iOS продолжительность звука, который будет играться, не должна составлять больше чем 30 секунд.

    В OS X, когда пользователь сконфигурировал Установки системы для высвечивания экрана для предупреждений, или если звук не может быть представлен, вызвав эту функцию, приведет к экранному высвечиванию. В OS X передайте константу kSystemSoundID_UserPreferredAlert играть предупредительный звук, выбранный пользователем в Установках системы. В iOS нет никакого предпочтительного пользовательского звука предупреждения.

    Для игры короткого звука, не используемого в качестве предупреждения, использовать AudioServicesPlaySystemSound.

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

    Objective C

    @import AudioToolbox;

    Swift

    import AudioToolbox

    Доступность

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

    См. также

    AudioServicesCreateSystemSoundID
    AudioServicesPlaySystemSound

  • AudioServicesPlaySystemSound (_:) AudioServicesPlaySystemSound

    Играет системный объект звука.

    Объявление

    Swift

    func AudioServicesPlaySystemSound(_ inSystemSoundID: SystemSoundID)

    Objective C

    void AudioServicesPlaySystemSound ( SystemSoundID inSystemSoundID );

    Параметры

    inSystemSoundID

    Системный звук для игры. Перед использованием этой функции вызовите AudioServicesCreateSystemSoundID функция для получения системного звука.

    Обсуждение

    Эта функция играет короткий звук (30 секунд или меньше в продолжительности). Поскольку звук мог бы играть в течение нескольких секунд, эта функция выполняется асинхронно. Для знания, когда звук закончит играть вызовите AudioServicesAddSystemSoundCompletion функционируйте для регистрации функции обратного вызова.

    На некоторых устройствах на iOS можно передать kSystemSoundID_Vibrate постоянный для вызова вибрации. На других устройствах на iOS, вызывая эту функцию, с которой постоянный ничего не делает.

    Звуковые файлы, что Вы играете использование этой функции, должны быть:

    • Больше, чем 30 секунд в продолжительности

    • В линейном PCM или IMA4 (IMA/ADPCM) формат

    • Упакованный в a .caf, .aif, или .wav файл

    Кроме того, когда Вы используете AudioServicesPlaySystemSound функция:

    • Звуки играют в громкости существующей системы без программируемого доступного регулятора громкости

    • Звуки сразу играют

    • Цикличное выполнение и расположение стерео недоступны

    • Одновременное воспроизведение недоступно: можно играть только один звук за один раз

    • Звук играется локально на динамиках устройства; это не использует аудио маршрутизацию.

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

    Objective C

    @import AudioToolbox;

    Swift

    import AudioToolbox

    Доступность

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

    См. также

    AudioServicesCreateSystemSoundID
    AudioServicesAddSystemSoundCompletion
    AudioServicesPlayAlertSound

Добавление и удаление системных обратных вызовов звука
  • AudioServicesAddSystemSoundCompletion (_: _: _: _: _:) AudioServicesAddSystemSoundCompletion

    Регистрирует функцию обратного вызова, вызывающуюся, когда указанный системный звук заканчивает играть.

    Объявление

    Swift

    func AudioServicesAddSystemSoundCompletion(_ inSystemSoundID: SystemSoundID, _ inRunLoop: CFRunLoop!, _ inRunLoopMode: CFString!, _ inCompletionRoutine: AudioServicesSystemSoundCompletionProc, _ inClientData: UnsafeMutablePointer<Void>) -> OSStatus

    Objective C

    OSStatus AudioServicesAddSystemSoundCompletion ( SystemSoundID inSystemSoundID, CFRunLoopRef inRunLoop, CFStringRef inRunLoopMode, AudioServicesSystemSoundCompletionProc inCompletionRoutine, void *inClientData );

    Параметры

    inSystemSoundID

    Системный звук, на который должна ответить Ваша функция обратного вызова.

    inRunLoop

    Цикл выполнения, в котором должна работать функция обратного вызова. Передача NULL использовать основной цикл выполнения.

    inRunLoopMode

    Режим для цикла выполнения, в котором должны работать функции обратного вызова. Передача NULL использовать выполненный режим цикла по умолчанию.

    inCompletionRoutine

    Функция обратного вызова, которая будет вызвана, когда указанный системный звук закончил играть.

    inClientData

    Данные приложения, которые будут переданы Вашей функции обратного вызова, когда это вызывается. Может быть NULL.

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

    Код результата.

    Обсуждение

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

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

    Objective C

    @import AudioToolbox;

    Swift

    import AudioToolbox

    Доступность

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

    См. также

    AudioServicesCreateSystemSoundID
    AudioServicesSystemSoundCompletionProc
    AudioServicesRemoveSystemSoundCompletion

  • AudioServicesRemoveSystemSoundCompletion (_:) AudioServicesRemoveSystemSoundCompletion

    Нерегистры любые функции обратного вызова завершения, зарегистрированные для указанного системного звука.

    Объявление

    Swift

    func AudioServicesRemoveSystemSoundCompletion(_ inSystemSoundID: SystemSoundID)

    Objective C

    void AudioServicesRemoveSystemSoundCompletion ( SystemSoundID inSystemSoundID );

    Параметры

    inSystemSoundID

    Системный звук, для которого должны быть удалены функции обратного вызова.

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

    Objective C

    @import AudioToolbox;

    Swift

    import AudioToolbox

    Доступность

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

    См. также

    AudioServicesAddSystemSoundCompletion

Управление системными свойствами служб звука
  • AudioServicesGetPropertyInfo (_: _: _: _: _:) AudioServicesGetPropertyInfo

    Получает информацию о свойстве System Sound Services.

    Объявление

    Swift

    func AudioServicesGetPropertyInfo(_ inPropertyID: AudioServicesPropertyID, _ inSpecifierSize: UInt32, _ inSpecifier: UnsafePointer<Void>, _ outPropertyDataSize: UnsafeMutablePointer<UInt32>, _ outWritable: UnsafeMutablePointer<Boolean>) -> OSStatus

    Objective C

    OSStatus AudioServicesGetPropertyInfo ( AudioServicesPropertyID inPropertyID, UInt32 inSpecifierSize, const void *inSpecifier, UInt32 *outPropertyDataSize, Boolean *outWritable );

    Параметры

    inPropertyID

    Свойство Вы хотите информацию о.

    inSpecifierSize

    Размер буфера, на который указывают inSpecifier параметр. Передача 0 если не требуется никакой буфер спецификатора.

    inSpecifier

    Указатель на буфер спецификатора, если такой буфер требуется свойством, о котором Вы хотите информацию. Передача NULL если не требуется никакой спецификатор.

    outPropertyDataSize

    На выводе, размере, в байтах, значения свойства. Для получения значения свойства Вам нужен буфер, по крайней мере, этого размера.

    outWritable

    На выводе, true если свойство перезаписываемо, или false если свойство только для чтения.

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

    Код результата.

    Обсуждение

    Свойства System Sound Services перечислены и описаны в Идентификаторах Свойства System Sound Services.

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

    Objective C

    @import AudioToolbox;

    Swift

    import AudioToolbox

    Доступность

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

    См. также

    AudioServicesGetProperty

  • AudioServicesGetProperty (_: _: _: _: _:) AudioServicesGetProperty

    Получает указанное значение свойства System Sound Services.

    Объявление

    Swift

    func AudioServicesGetProperty(_ inPropertyID: AudioServicesPropertyID, _ inSpecifierSize: UInt32, _ inSpecifier: UnsafePointer<Void>, _ ioPropertyDataSize: UnsafeMutablePointer<UInt32>, _ outPropertyData: UnsafeMutablePointer<Void>) -> OSStatus

    Objective C

    OSStatus AudioServicesGetProperty ( AudioServicesPropertyID inPropertyID, UInt32 inSpecifierSize, const void *inSpecifier, UInt32 *ioPropertyDataSize, void *outPropertyData );

    Параметры

    inPropertyID

    Свойство, значение которого Вы хотите.

    inSpecifierSize

    Размер буфера, на который указывают inSpecifier параметр. Передача 0 если не требуется никакой буфер спецификатора.

    inSpecifier

    Указатель на буфер спецификатора, если такой буфер требуется свойством, о котором Вы хотите информацию. Передача NULL если не требуется никакой спецификатор.

    ioPropertyDataSize

    На вводе, размере, в байтах, буфера, на который указывают outPropertyData параметр. Вызовите AudioServicesGetPropertyInfo функция для обнаружения размера, требуемого для этого буфера. На выводе, числе байтов, записанных в буфер.

    outPropertyData

    На выводе, значении свойства.

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

    Код результата.

    Обсуждение

    Свойства System Sound Services перечислены и описаны в Идентификаторах Свойства System Sound Services.

    Специальные замечания

    Некоторые значения свойств Core Audio являются типами C, и другие являются Базовыми объектами Основы.

    Если Вы вызываете эту функцию для получения значения, которое является Базовым объектом Основы, то эта функция — несмотря на использование «Get» на его имя — копирует объект. Вы ответственны за выпуск объекта, как описано в Создать Правиле в Руководстве по программированию управления памятью для Базовой Основы.

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

    Objective C

    @import AudioToolbox;

    Swift

    import AudioToolbox

    Доступность

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

    См. также

    AudioServicesGetPropertyInfo
    AudioServicesSetProperty

  • AudioServicesSetProperty (_: _: _: _: _:) AudioServicesSetProperty

    Устанавливает значение для указанного свойства System Sound Services.

    Объявление

    Swift

    func AudioServicesSetProperty(_ inPropertyID: AudioServicesPropertyID, _ inSpecifierSize: UInt32, _ inSpecifier: UnsafePointer<Void>, _ inPropertyDataSize: UInt32, _ inPropertyData: UnsafePointer<Void>) -> OSStatus

    Objective C

    OSStatus AudioServicesSetProperty ( AudioServicesPropertyID inPropertyID, UInt32 inSpecifierSize, const void *inSpecifier, UInt32 inPropertyDataSize, const void *inPropertyData );

    Параметры

    inPropertyID

    Свойство, значение которого Вы хотите установить.

    inSpecifierSize

    Размер буфера, на который указывают inSpecifier параметр. Передача 0 если не требуется никакой буфер спецификатора.

    inSpecifier

    Указатель на буфер спецификатора, если такой буфер требуется свойством, о котором Вы хотите информацию. Передача NULL если не требуется никакой спецификатор.

    inPropertyDataSize

    Размер, в байтах, буфера, на который указывают inPropertyData параметр.

    inPropertyData

    Значение свойства Вы хотите установить.

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

    Код результата.

    Обсуждение

    Свойства System Sound Services перечислены и описаны в Идентификаторах Свойства System Sound Services.

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

    Objective C

    @import AudioToolbox;

    Swift

    import AudioToolbox

    Доступность

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

    См. также

    AudioServicesGetProperty

Обратные вызовы

Системные обратные вызовы служб звука
  • AudioServicesSystemSoundCompletionProc

    Вызванный, когда системный звук заканчивает играть.

    Объявление

    Swift

    typealias AudioServicesSystemSoundCompletionProc = CFunctionPointer<((SystemSoundID, UnsafeMutablePointer<Void>) -> Void)>

    Objective C

    typedef void (*AudioServicesSystemSoundCompletionProc) ( SystemSoundID ssID, void *clientData );

    Параметры

    ssID

    Системный звук, закончивший играть.

    clientData

    Данные приложения, которые Вы указали при регистрации функции обратного вызова.

    Обсуждение

    Поскольку системный звук может играть в течение максимум 30 секунд, AudioServicesPlaySystemSound функция выполняется асинхронно (т.е. она сразу возвращается). Когда указанный системный звук закончил играть, этот обратный вызов вызывается. В то время как первый звук все еще играет, можно использовать этот обратный вызов, например, чтобы помочь Вам избежать играть второй звук.

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

    Objective C

    @import AudioToolbox;

    Swift

    import AudioToolbox

    Доступность

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

    См. также

    AudioServicesCreateSystemSoundID
    AudioServicesAddSystemSoundCompletion
    AudioServicesRemoveSystemSoundCompletion
    AudioServicesPlaySystemSound

Типы данных

  • AudioServicesPropertyID

    Тип данных для системы звучит как идентификатор свойства.

    Объявление

    Swift

    typealias AudioServicesPropertyID = UInt32

    Objective C

    typedef UInt32 AudioServicesPropertyID;

    Обсуждение

    Свойства System Audio Services перечислены в Идентификаторах Свойства System Sound Services.

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

    Objective C

    @import AudioToolbox;

    Swift

    import AudioToolbox

    Доступность

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

  • SystemSoundID

    Системный объект звука, идентифицированный со звуковым файлом, Вы хотите играть.

    Объявление

    Swift

    typealias SystemSoundID = UInt32

    Objective C

    typedef UInt32 SystemSoundID;

    Обсуждение

    Вызовите AudioServicesCreateSystemSoundID функция для получения системы звучит как объект.

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

    Objective C

    @import AudioToolbox;

    Swift

    import AudioToolbox

    Доступность

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

Константы

  • Предупредительные звуковые идентификаторы

    Идентификаторы для предупредительных звуков и альтернатив звукам, для использования с AudioServicesPlayAlertSound функция.

    Объявление

    Swift

    var kSystemSoundID_Vibrate: Int { get }

    Objective C

    enum { kSystemSoundID_Vibrate = 0x00000FFF };

    Константы

    • kSystemSoundID_Vibrate

      На iPhone используйте эту константу с AudioServicesPlayAlertSound функция для вызова краткой вибрации. На iPod touch, ничего не делает.

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

  • Системные идентификаторы свойства служб звука

    Идентификаторы свойства, используемые при игре предупреждений с System Sound Services.

    Объявление

    Swift

    var kAudioServicesPropertyIsUISound: Int { get } var kAudioServicesPropertyCompletePlaybackIfAppDies: Int { get }

    Objective C

    enum { kAudioServicesPropertyIsUISound = 'isui', kAudioServicesPropertyCompletePlaybackIfAppDies = 'ifdi' };

    Константы

    • kAudioServicesPropertyIsUISound

      A UInt32 значение, где 1 средние значения, что, для аудиофайла, указанного системой, звучат переданными в inSpecifier когда пользователь выключает звуковые эффекты, параметр, Системный сервер Звука уважает пользователя, устанавливающего в предпочтении Звуковых эффектов, и тих.

      Это свойство установлено в 1 по умолчанию. Установите его в 0 поскольку система звучит, чтобы всегда играть, когда передано AudioServicesPlaySystemSound, независимо от установки пользователя в звуковых предпочтениях.

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

    • kAudioServicesPropertyCompletePlaybackIfAppDies

      A UInt32 значение, где 1 средние значения, что аудиофайл, указанный системой, звучит переданным в inSpecifier даже если клиентское приложение завершается, параметр должен закончить играть. Это могло произойти, например, если пользовательские выходы или приложение завершаются неожиданно, в то время как играет звук. Значение по умолчанию 0. Т.е. необходимо явно установить значение этого свойства в 1 если Вы хотите, чтобы звук завершил игру, даже если завершается приложение.

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

Коды результата

Эта таблица приводит коды результата, определенные для System Sound Services.

  • kAudioServicesNoError

    Никакая ошибка не произошла.

    Значение

    0

    Описание

    Никакая ошибка не произошла.

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

  • kAudioServicesUnsupportedPropertyError

    Свойство не поддерживается.

    Значение

    'имущество?'

    Описание

    Свойство не поддерживается.

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

  • kAudioServicesBadPropertySizeError

    Размер данных свойства не был корректен.

    Значение

    '! siz'

    Описание

    Размер данных свойства не был корректен.

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

  • kAudioServicesBadSpecifierSizeError

    Размер данных спецификатора не был корректен.

    Значение

    '! SPC'

    Описание

    Размер данных спецификатора не был корректен.

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

  • kAudioServicesSystemSoundUnspecifiedError

    Неустановленная ошибка произошла.

    Значение

    - 1500

    Описание

    Неустановленная ошибка произошла.

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

  • kAudioServicesSystemSoundClientTimedOutError

    Системное клиентское сообщение звука испытало таймаут.

    Значение

    - 1501

    Описание

    Системное клиентское сообщение звука испытало таймаут.

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