Spec-Zone .ru
спецификации, руководства, описания, API
ADC домой > Ссылочная библиотека> Ссылка> Аудио> Core Audio> Ссылка Платформы Core MIDI

 

MIDISetup.h

Включает:

Обзор

Этот заголовок определяет функции, управляющие и настраивающие глобальную переменную

состояние системы MIDI. Эти функции обычно только необходимы приложениям, хотящим позволить пользователю некоторую гибкость в как

состояние системы MIDI представлено, и драйверами MIDI, которые могут динамично изменить системное состояние, поскольку аппаратные средства подключаются и

разъединенный.


Функции

MIDIDeviceAddEntity
MIDIDeviceRemoveEntity
MIDIEntityAddOrRemoveEndpoints
MIDIExternalDeviceCreate

Создайте новое внешнее MIDI-устройство.

MIDIGetSerialPortDrivers

Возвращает список установленных драйверов MIDI для MIDI-устройств последовательного порта.

MIDIGetSerialPortOwner

Возвращает драйвер MIDI, которому принадлежит последовательный порт.

MIDISetSerialPortOwner

Указывает драйвер MIDI, которому принадлежит последовательный порт.

MIDISetupAddDevice

Добавляет MIDI-устройство владельца драйвера к текущему MIDISetup

MIDISetupAddExternalDevice

Добавляет внешнее MIDI-устройство к текущему MIDISetup

MIDISetupCreate

Драйверы опросов, для обнаружения, какие аппаратные средства присутствуют.

С CoreMIDI 1.1 обычно не необходимо вызвать эту функцию, поскольку CoreMIDI управляет персистентным синглом

Сам MIDISetup.

MIDISetupDispose

Расположите объект MIDISetup.

С CoreMIDI 1.1 обычно не необходимо вызвать эту функцию, поскольку CoreMIDI управляет персистентным синглом

Сам MIDISetup.

MIDISetupFromData

Создайте объект MIDISetup из потока XML.

С CoreMIDI 1.1 обычно не необходимо вызвать эту функцию, поскольку CoreMIDI управляет персистентным синглом

Сам MIDISetup.

MIDISetupGetCurrent

Возвратите текущий MIDISetup системы.

С CoreMIDI 1.1 обычно не необходимо вызвать эту функцию, поскольку CoreMIDI управляет персистентным синглом

Сам MIDISetup.

MIDISetupInstall

Установите MIDISetup как текущее состояние системы.

Клиент может создать объект MIDISetup использование MIDISetupCreate или MIDISetupFromData. Эта функция будет

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

С CoreMIDI 1.1 обычно не необходимо вызвать

эта функция, поскольку CoreMIDI управляет самим единственным персистентным MIDISetup.

MIDISetupRemoveDevice

Удаляет MIDI-устройство находившееся в собственности драйвера из текущего MIDISetup

MIDISetupRemoveExternalDevice

Удаляет внешнее MIDI-устройство из текущего MIDISetup

MIDISetupToData

Создайте представление XML объекта MIDISetup.

С CoreMIDI 1.1 обычно не необходимо вызвать эту функцию, поскольку CoreMIDI управляет персистентным синглом

Сам MIDISetup.

MIDIDeviceAddEntity

extern OSStatus MIDIDeviceAddEntity(
    MIDIDeviceRef device,
    CFStringRef name, 
    Boolean embedded,
    ItemCount numSourceEndpoints, 
    ItemCount numDestinationEndpoints,
    MIDIEntityRef *newEntity) ;
Параметры
device

Устройство, к которому должен быть добавлен объект.

name

Имя нового объекта.

embedded

Истина, если этот объект в устройстве, ложь, если объект просто состоит из внешних коннекторов к который

другие устройства могут быть присоединены.

numSourceEndpoints

Число исходных конечных точек объект имеет.

numDestinationEndpoints

Число целевых конечных точек объект имеет.

newEntity

По успешному возврату, точкам к недавно создаваемому объекту.

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

OSStatus заканчивается код.

Обсуждение

Драйверы вызывают эту функцию для указания одного из объектов, включающих устройство.

Недрайверы могут вызвать эту функцию с CoreMIDI 1.1, к

добавьте объекты к внешним устройствам.

Доступность
Представленный в OS X v10.0.

MIDIDeviceRemoveEntity

extern OSStatus MIDIDeviceRemoveEntity(
    MIDIDeviceRef device,
    MIDIEntityRef entity) ;
Параметры
device

Устройство, из которого должен быть удален объект.

entity

Объект, который будет удален.

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

OSStatus заканчивается код.

Обсуждение

Драйверы могут вызвать эту функцию для удаления одного из объектов устройства.

Новый для CoreMIDI 1.1.

Доступность
Представленный в OS X v10.1.

MIDIEntityAddOrRemoveEndpoints

extern OSStatus MIDIEntityAddOrRemoveEndpoints(
    MIDIEntityRef entity,
    ItemCount numSourceEndpoints, 
    ItemCount numDestinationEndpoints);
Параметры
entity

Объект, конечными точками которого нужно управлять.

numSourceEndpoints

Желаемое новое число исходных конечных точек.

numDestinationEndpoints

Желаемое новое число целевых конечных точек.

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

OSStatus заканчивается код.

Обсуждение

Драйверы и редакторы конфигураций могут вызвать эту функцию, чтобы добавить к или удалить конечные точки объекта.

Новый для CoreMIDI 1.3.

Доступность
Представленный в OS X v10.2

MIDIExternalDeviceCreate

Создайте новое внешнее MIDI-устройство. 

extern OSStatus MIDIExternalDeviceCreate(
    CFStringRef name,
    CFStringRef manufacturer, 
    CFStringRef model,
    MIDIDeviceRef *outDevice) ;
Параметры
name

Имя нового устройства.

manufacturer

Имя производителя устройства.

model

Имя модели устройства.

outDevice

По успешному возврату, точкам к недавно создаваемому устройству.

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

OSStatus заканчивается код.

Обсуждение

Недрайверы могут вызвать эту функцию с CoreMIDI 1.1, для создания внешних устройств.

Новое устройство не добавляется к текущему MIDISetupRef;

чтобы сделать это, используйте MIDISetupAddExternalDevice.

Доступность
Представленный в OS X v10.1.

MIDIGetSerialPortDrivers

Возвращает список установленных драйверов MIDI для MIDI-устройств последовательного порта.

extern OSStatus MIDIGetSerialPortDrivers(
    CFArrayRef *outDriverNames );
Параметры
outDriverNames

На выходе, CFArrayRef, содержащий список CFStringRef, которые являются именами последовательного порта драйверы MIDI.

Массив должен быть выпущен вызывающей стороной.

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

OSStatus заканчивается код.

Обсуждение

Используйте это для определения, какой из установленных драйверов MIDI является для устройств, которые могут присоединить к последовательным портам.

Новый для CoreMIDI 1.1.

Доступность
Представленный в OS X v10.1.

MIDIGetSerialPortOwner

Возвращает драйвер MIDI, которому принадлежит последовательный порт. 

extern OSStatus MIDIGetSerialPortOwner(
    CFStringRef portName, 
    CFStringRef *outDriverName );
Параметры
portName

Имя последовательного порта.

outDriverName

На выходе, имени драйвера, владеющего портом или NULL, если никакому драйверу не принадлежит он.

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

OSStatus заканчивается код.

Обсуждение

Текущий MIDISetup отслеживает владение последовательных портов к одному из драйверов MIDI, установленных в системе.

Последовательные порты могут быть перечислены с помощью IOServiceMatching (

kIOSerialBSDServiceValue). Уникальное имя порта является kIOTTYDeviceKey свойством IOSERVICE.

Новый для CoreMIDI 1.1.

Предыдущая версия этой документации указала неправильное

ключ для получения уникального имени порта (IOTTYBaseName).

Доступность
Представленный в OS X v10.1.

MIDISetSerialPortOwner

Указывает драйвер MIDI, которому принадлежит последовательный порт. 

extern OSStatus MIDISetSerialPortOwner(
    CFStringRef portName, 
    CFStringRef driverName );
Параметры
portName

Имя последовательного порта.

driverName

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

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

OSStatus заканчивается код.

Обсуждение

Используйте это для присвоения владения последовательного порта к одному из драйверов MIDI, установленных в системе.

Новый для CoreMIDI 1.1.

Доступность
Представленный в OS X v10.1.

MIDISetupAddDevice

Добавляет MIDI-устройство владельца драйвера к текущему MIDISetup 

extern OSStatus MIDISetupAddDevice(
    MIDIDeviceRef device );
Параметры
device

Устройство, которое будет добавлено.

Обсуждение

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

Новый для CoreMIDI 1.1.

Доступность
Представленный в OS X v10.1.

MIDISetupAddExternalDevice

Добавляет внешнее MIDI-устройство к текущему MIDISetup 

extern OSStatus MIDISetupAddExternalDevice(
    MIDIDeviceRef device );
Параметры
device

Устройство, которое будет добавлено.

Обсуждение

Полезный для студийного редактора конфигураций. Новый для CoreMIDI 1.1.

Доступность
Представленный в OS X v10.1.

MIDISetupCreate

Драйверы опросов, для обнаружения, какие аппаратные средства присутствуют.

С CoreMIDI 1.1 обычно не необходимо вызвать эту функцию, поскольку CoreMIDI управляет персистентным синглом

Сам MIDISetup. 

extern OSStatus MIDISetupCreate(
    MIDISetupRef *outSetup );
Параметры
outSetup

По успешному возврату, точкам к недавно создаваемому объекту MIDISetup. Вызывающая сторона ответственна за расположение его,

или возвращение владения объекта к системе, с MIDISetupInstall.

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

OSStatus заканчивается код.

Доступность
Представленный в OS X v10.0.

MIDISetupDispose

Расположите объект MIDISetup.

С CoreMIDI 1.1 обычно не необходимо вызвать эту функцию, поскольку CoreMIDI управляет персистентным синглом

Сам MIDISetup. 

extern OSStatus MIDISetupDispose(
    MIDISetupRef setup );
Параметры
setup

MIDISetup, который будет расположен.

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

OSStatus заканчивается код.

Доступность
Представленный в OS X v10.0.

MIDISetupFromData

Создайте объект MIDISetup из потока XML.

С CoreMIDI 1.1 обычно не необходимо вызвать эту функцию, поскольку CoreMIDI управляет персистентным синглом

Сам MIDISetup. 

extern OSStatus MIDISetupFromData(
    CFDataRef data, 
    MIDISetupRef *outSetup);
Параметры
data

Текст XML, из которого состоит в том, чтобы быть создан объект MIDISetup.

outSetup

По успешному возврату, точкам к недавно создаваемому объекту MIDISetup. Вызывающая сторона ответственна за расположение его, или

возвращение владения объекта к системе, с MIDISetupInstall.

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

OSStatus заканчивается код.

Доступность
Представленный в OS X v10.0.

MIDISetupGetCurrent

Возвратите текущий MIDISetup системы.

С CoreMIDI 1.1 обычно не необходимо вызвать эту функцию, поскольку CoreMIDI управляет персистентным синглом

Сам MIDISetup. 

extern OSStatus MIDISetupGetCurrent(
    MIDISetupRef *outSetup );
Параметры
outSetup

По успешному возврату, точкам к последний раз установленному MIDISetup системы. Система сохраняет

владение объекта; клиент не должен избавляться от этого MIDISetup.

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

OSStatus заканчивается код.

Доступность
Представленный в OS X v10.0.

MIDISetupInstall

Установите MIDISetup как текущее состояние системы.

Клиент может создать объект MIDISetup использование MIDISetupCreate или MIDISetupFromData. Эта функция будет

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

С CoreMIDI 1.1 обычно не необходимо вызвать

эта функция, поскольку CoreMIDI управляет самим единственным персистентным MIDISetup.

extern OSStatus MIDISetupInstall(
    MIDISetupRef setup );
Параметры
setup

MIDISetup возражают для установки. Владение этого объекта передается от клиента системе;

клиент не должен избавляться от этого MIDISetup.

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

OSStatus заканчивается код.

Доступность
Представленный в OS X v10.0.

MIDISetupRemoveDevice

Удаляет MIDI-устройство находившееся в собственности драйвера из текущего MIDISetup 

extern OSStatus MIDISetupRemoveDevice(
    MIDIDeviceRef device );
Параметры
device

Устройство, которое будет добавлено.

Обсуждение

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

указал как являющийся постоянно недостающим.

Вместо того, чтобы удалить устройства из установки, драйверы должны установить kMIDIPropertyOffline устройства в 1 так, чтобы если

устройство вновь появляется позже, ни одно из его свойств не потеряно.

Новый для CoreMIDI 1.1.

Доступность
Представленный в OS X v10.1.

MIDISetupRemoveExternalDevice

Удаляет внешнее MIDI-устройство из текущего MIDISetup 

extern OSStatus MIDISetupRemoveExternalDevice(
    MIDIDeviceRef device );
Параметры
device

Устройство, которое будет удалено.

Обсуждение

Полезный для студийного редактора конфигураций. Новый для CoreMIDI 1.1.

Доступность
Представленный в OS X v10.1.

MIDISetupToData

Создайте представление XML объекта MIDISetup.

С CoreMIDI 1.1 обычно не необходимо вызвать эту функцию, поскольку CoreMIDI управляет персистентным синглом

Сам MIDISetup. 

extern OSStatus MIDISetupToData(
    MIDISetupRef setup, 
    CFDataRef *outData );
Параметры
setup

MIDISetup возражают, чье представление XML должно быть возвращено.

outData

По успешному возврату, точкам к недавно создаваемому CFDataRef, содержащему текст XML. Клиент ответственен за

выпуск этого CFData возражает, когда сделано с ним.

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

OSStatus заканчивается код.

Доступность
Представленный в OS X v10.0.

Определения типов

MIDISetupRef

#if __LP64__ 
typedef MIDIObjectRef MIDISetupRef;  
#else 
typedef struct OpaqueMIDISetup * MIDISetupRef;  
#endif
Обсуждение

Происходит из MIDIObjectRef, не сделал, чтобы возразил владелец.

Это представляет глобальное состояние системы MIDI, содержа списки MIDI-устройств и последовательного порта

владельцы.

Обычно только драйверы MIDI и специализированные редакторы конфигураций должны будут управлять объектами MIDISetup, не

среднее клиентское приложение MIDI. С CoreMIDI 1.1 MIDIServer поддерживает единственный глобальный MIDISetupRef, сохраненный

постоянно в предпочтительном файле.

MIDISetupRef

#if __LP64__ 
typedef MIDIObjectRef MIDISetupRef;  
#else 
typedef struct OpaqueMIDISetup * MIDISetupRef;  
#endif
Обсуждение

Происходит из MIDIObjectRef, не сделал, чтобы возразил владелец.

Это представляет глобальное состояние системы MIDI, содержа списки MIDI-устройств и последовательного порта

владельцы.

Обычно только драйверы MIDI и специализированные редакторы конфигураций должны будут управлять объектами MIDISetup, не

среднее клиентское приложение MIDI. С CoreMIDI 1.1 MIDIServer поддерживает единственный глобальный MIDISetupRef, сохраненный

постоянно в предпочтительном файле.

Последнее обновление: 06.06.2008