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

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

Разработчик

Ссылка на протокол FxDynamicParameterAPI

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

На этой странице

FxDynamicParameterAPI

FxDynamicParameterAPI протокол реализован хост-приложением и указывает, как плагины создают параметры динамично.

Путем реализации этого протокола плагин может создать и удалить параметры за пределами FXBaseEffect протокол addParameters метод. Это может также получить и установить различные свойства параметров в течение времени выполнения также, такие как минимальные и максимальные допустимые значения.

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

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

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

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

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

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

Получение количества параметра
  • parameterCount - parameterCount Требуемый

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

    Объявление

    Objective C

    - (UInt32)parameterCount

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

    Число параметров.

Получение параметра ID
  • parameterIDAtIndex: - parameterIDAtIndex: Требуемый

    Возвращает ID параметра в данном индексе. (требуемый)

    Объявление

    Objective C

    - (UInt32)parameterIDAtIndex:(UInt32)index

    Параметры

    index

    0- основанный индекс параметра ID требуется.

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

    Параметр ID.

    Обсуждение

    Возможно динамично добавить и удалить параметры на лету. Для работы с динамическими параметрами, необходимо преобразовать index в параметр ID. Так как порядку параметров не гарантируют, этот метод позволяет выполнять итерации через параметры и преобразовывать index в идентификатор для определения местоположения желаемого параметра

    Во время addParameters Ваш плагин говорит узлу создавать параметры. Позже, при выполнении, плагин может создать новые параметры с помощью FxParameterCreationAPI протокол, или может удалить их использующий removeParameter: метод.

    Каждый параметр должен иметь уникальный идентификатор в плагине. IDs не должен быть последовательным или даже увеличение, например:

    Индекс

    ID

    Параметр

    0

    1

    Ползунок

    1

    1000

    Флажок

    2

    10

    Всплывающее меню

Удаление параметров
  • removeParameter: - removeParameter: Требуемый

    Удаляет параметр с указанным ID из списка плагинов параметров. (требуемый)

    Объявление

    Objective C

    - (NSError*)removeParameter:(UInt32)paramID

    Параметры

    paramID

    Параметр ID.

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

    NSError экземпляр, если с какими-либо ошибками встречаются, иначе nil.

Получение и установка названия параметра
  • parameter:name: - parameter:name: Требуемый

    Получите имя параметра с указанным ID. (требуемый)

    Объявление

    Objective C

    - (NSError*)parameter:(UInt32)paramID name:(NSString**)paramName

    Параметры

    paramID

    Параметр ID.

    paramName

    Указатель на название параметра.

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

    NSError экземпляр, если с какими-либо ошибками встречаются, иначе nil.

  • setParameter:name: - setParameter:name: Требуемый

    Определяет имя параметра, указанного параметром ID. (требуемый)

    Объявление

    Objective C

    - (NSError*)setParameter:(UInt32)paramID name:(NSString*)newName

    Параметры

    paramID

    Параметр ID.

    newName

    Название параметра.

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

    NSError экземпляр, если с какими-либо ошибками встречаются, иначе nil.

Создание всплывающего меню для параметра
  • setPopupMenuParameter:entries:defaultValue: - setPopupMenuParameter:entries:defaultValue: Требуемый

    Установите записи меню всплывающего меню параметра. (требуемый)

    Объявление

    Objective C

    - (NSError*)setPopupMenuParameter:(UInt32)paramID entries:(NSArray*)newEntries defaultValue:(UInt32)defaultIndex

    Параметры

    paramID

    Параметр ID.

    newEntries

    Массив, содержащий имена пункта меню.

    defaultIndex

    Индекс пункта меню по умолчанию.

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

    NSError экземпляр, если с какими-либо ошибками встречаются, иначе nil.

Получение и установка значений параметров для скольжения средств управления
  • parameter:floatMinimum:maximum:sliderMinimum:sliderMaximum: - parameter:floatMinimum:maximum:sliderMinimum:sliderMaximum: Требуемый

    Получает границы указанного параметра как значения с плавающей точкой. (требуемый)

    Объявление

    Objective C

    - (NSError*)parameter:(UInt32)paramID floatMinimum:(double*)min maximum:(double*)max sliderMinimum:(double*)sliderMin sliderMaximum:(double*)sliderMax

    Параметры

    paramID

    Параметр ID.

    min

    Указатель на минимальное значение с плавающей точкой.

    max

    Указатель на максимальное значение с плавающей точкой.

    sliderMin

    Указатель на минимальное значение управления ползунком.

    sliderMax

    Указатель на максимальное значение управления ползунком.

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

    NSError экземпляр, если с какими-либо ошибками встречаются, иначе nil.

  • setParameter:floatMinimum:maximum:sliderMinimum:sliderMaximum: - setParameter:floatMinimum:maximum:sliderMinimum:sliderMaximum: Требуемый

    Устанавливает границы указанного параметра как значения с плавающей точкой. (требуемый)

    Объявление

    Objective C

    - (NSError*)setParameter:(UInt32)paramID floatMinimum:(double)min maximum:(double)max sliderMinimum:(double)sliderMin sliderMaximum:(double)sliderMax

    Параметры

    paramID

    Параметр ID.

    min

    Минимальное значение с плавающей точкой.

    max

    Максимальное значение с плавающей точкой.

    sliderMin

    Указатель на минимальное значение управления ползунком.

    sliderMax

    Указатель на максимальное значение управления ползунком.

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

    NSError если с какими-либо ошибками встречаются, иначе nil.

  • parameter:intMinimum:maximum:sliderMinimum:sliderMaximum: - parameter:intMinimum:maximum:sliderMinimum:sliderMaximum: Требуемый

    Получает границы указанного параметра как целочисленные значения. (требуемый)

    Объявление

    Objective C

    - (NSError*)parameter:(UInt32)paramID intMinimum:(int *)min maximum:(int *)max sliderMinimum:(int *)sliderMin sliderMaximum:(int *)sliderMax

    Параметры

    paramID

    Параметр ID.

    min

    Указатель на минимальное целочисленное значение для этого параметра.

    max

    Указатель на максимальное целочисленное значение для этого параметра.

    sliderMin

    Указатель на минимальное значение управления ползунком.

    sliderMax

    Указатель на максимальное значение управления ползунком.

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

    NSError экземпляр, если с какими-либо ошибками встречаются, иначе nil.

  • setParameter:intMinimum:maximum:sliderMinimum:sliderMaximum: - setParameter:intMinimum:maximum:sliderMinimum:sliderMaximum: Требуемый

    Устанавливает границы указанного параметра как целочисленные значения. (требуемый)

    Объявление

    Objective C

    - (NSError*)setParameter:(UInt32)paramID intMinimum:(int)min maximum:(int)max sliderMinimum:(int)sliderMin sliderMaximum:(int)sliderMax

    Параметры

    paramID

    Параметр ID.

    min

    Минимальное значение параметра.

    max

    Максимальное значение параметра.

    sliderMin

    Минимальное значение управления ползунком.

    sliderMax

    Максимальное значение управления ползунком.

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

    NSError v, если с какими-либо ошибками встречаются, иначе nil.

Установка значений по умолчанию
  • setAsDefaultsAtTime: - setAsDefaultsAtTime: Требуемый

    Сообщите хост-приложению, что настройки в данное время нужно считать настройками по умолчанию для этого параметра. (требуемый)

    Объявление

    Objective C

    - (NSError*)setAsDefaultsAtTime:(double)time

    Параметры

    time

    Время в кадрах.

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

    NSError экземпляр, если с какими-либо ошибками встречаются, иначе nil.