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

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

Разработчик

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

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

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

FxParameterRetrievalAPI

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

Это - версия 1 FxParameterRetrievalAPI протокол.

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

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

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

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

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

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

Получение значений параметров
  • getBitmap:layerOffsetX:layerOffsetY:requestInfo:fromParm:atTime: - getBitmap:layerOffsetX:layerOffsetY:requestInfo:fromParm:atTime: Требуемый

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

    Объявление

    Objective C

    - (BOOL)getBitmap:(FxBitmap **)image layerOffsetX:(double *)offsetX layerOffsetY:(double *)offsetY requestInfo:(FxRenderInfo)info fromParm:(UInt32)parmId atTime:(double)time

    Параметры

    image

    Возвраты, ссылкой, растровый объект.

    offsetX

    Возвраты, ссылкой, эти X значений для левого нижнего угла этого изображения в пространстве уровня. Если этот указатель NULL, никакой перевод не вычисляется.

    offsetY

    Возвраты, ссылкой, Y оценивают за левый нижний угол этого изображения в пространстве уровня. Если этот указатель NULL, никакой перевод не вычисляется.

    info

    Информация о требуемом изображении, включая качество, масштаб и битовую глубину.

    parmId

    Уникальный идентификатор для параметра.

    time

    Умиротворенное время, выраженное в канонических кадрах, для получения изображения.

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

    YEStrue если извлечение изображения успешно; иначе NOfalse. Если неуспешный image будет NIL.

    Обсуждение

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

    В зависимости от хост-приложения временная стоимость может быть относительно запуска временной шкалы или к запуску клипа. См. Тип Timebase для получения дополнительной информации.

  • getBoolValue:fromParm:atTime: - getBoolValue:fromParm:atTime: Требуемый

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

    Объявление

    Objective C

    - (BOOL)getBoolValue:(BOOL *)value fromParm:(UInt32)parmId atTime:(double)time

    Параметры

    value

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

    parmId

    Уникальный идентификатор для параметра.

    time

    Требуемое время, выраженное в канонических кадрах, для получения значения.

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

    YEStrue если значение получено успешно; иначе NOfalse.

    Обсуждение

    В зависимости от хост-приложения временная стоимость может быть относительно запуска временной шкалы или к запуску клипа. См. Тип Timebase для получения дополнительной информации.

    См. также

    – setBoolValue:toParm:atTime: (Протокол FxParameterSettingAPI)

  • getCustomParameterValue:fromParm: - getCustomParameterValue:fromParm: Требуемый

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

    Объявление

    Objective C

    - (BOOL)getCustomParameterValue:(id <NSCoding> *)value fromParm:(UInt32)parmId

    Параметры

    value

    Возвраты, ссылкой, непрозрачный объект значения.

    parmId

    Уникальный идентификатор для параметра.

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

    YEStrue если значение получено успешно; иначе NOfalse.

    Обсуждение

    Когда плагин поддерживает сложные типы параметра, которые хост-приложение исходно не понимает, типы, которые не являются целыми числами, плаваниями или строками, сменный разработчик должен записать код для обработки создания, хранения и управления теми типами объектов.

    value объект является непрозрачным объектом, содержащим пользовательские данные, что плагину нужен документ хост-приложения хранилищу.

    См. также

    – SetCustomParameterValue:toParm: (Протокол FxParameterSettingAPI)

  • getFloatValue:fromParm:atTime: - getFloatValue:fromParm:atTime: Требуемый

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

    Объявление

    Objective C

    - (BOOL)getFloatValue:(double *)value fromParm:(UInt32)parmId atTime:(double)time

    Параметры

    value

    Возвраты, ссылкой, значение плавающее.

    parmId

    Уникальный идентификатор для параметра.

    time

    Требуемое время, выраженное в канонических кадрах, для получения значения.

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

    YEStrue если значение получено успешно; иначе NOfalse.

    Обсуждение

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

    В зависимости от хост-приложения временная стоимость может быть относительно запуска временной шкалы или к запуску клипа. См. Тип Timebase для получения дополнительной информации.

    В FxPlug SDK 1.2 документация для этого метода неправильно утвердила, что угловые значения были возвращены в радианах.

    См. также

    – setFloatValue:toParm:atTime: (Протокол FxParameterSettingAPI)

  • getIntValue:fromParm:atTime: - getIntValue:fromParm:atTime: Требуемый

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

    Объявление

    Objective C

    - (BOOL)getIntValue:(int *)value fromParm:(UInt32)parmId atTime:(double)time

    Параметры

    value

    Возвраты, ссылкой, целочисленное значение.

    parmId

    Уникальный идентификатор для параметра.

    time

    Требуемое время, выраженное в канонических кадрах, для получения значения.

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

    YEStrue если значение получено успешно; иначе NOfalse.

    Обсуждение

    В зависимости от хост-приложения временная стоимость может быть относительно запуска временной шкалы или к запуску клипа. См. Тип Timebase

    См. также

    – setIntValue:toParm:atTime: (Протокол FxParameterSettingAPI)

  • getParameterFlags:fromParm: - getParameterFlags:fromParm: Требуемый

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

    Объявление

    Objective C

    - (BOOL)getParameterFlags:(FxParameterFlags *)flags fromParm:(UInt32)parmId

    Параметры

    flags

    Возвращает указатель на флаги, кодирующие различные значения состояния для параметра.

    parmId

    Уникальный идентификатор для параметра.

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

    YEStrue если информация состояния получена успешно; иначе NOfalse.

    Обсуждение

    Если плагин изменяет флаги параметра, он должен вызвать setParameterFlags:toParm: метод для приложения, которое будет информировано об изменении.

    См. также

    – setParameterFlags:toParm: (Протокол FxParameterSettingAPI)

  • getRedValue:greenValue:blueValue:alphaValue:fromParm:atTime: - getRedValue:greenValue:blueValue:alphaValue:fromParm:atTime: Требуемый

    Получает значение цвета RGBA (в 0,0 - 1,0 плавающих точки) от параметра. (требуемый)

    Объявление

    Objective C

    - (BOOL)getRedValue:(double *)red greenValue:(double *)green blueValue:(double *)blue alphaValue:(double *)alpha fromParm:(UInt32)parmId atTime:(double)time

    Параметры

    red

    Возвраты, ссылкой, значение компонента красного цвета.

    green

    Возвраты, ссылкой, зеленое значение компонента цвета.

    blue

    Возвраты, ссылкой, синее значение компонента цвета.

    alpha

    Возвраты, ссылкой, альфа-значение компонента цвета.

    parmId

    Уникальный идентификатор для параметра.

    time

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

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

    YEStrue если значения получены успешно; иначе NOfalse.

    Обсуждение

    В зависимости от хост-приложения временная стоимость может быть относительно запуска временной шкалы или к запуску клипа. См. Тип Timebase для получения дополнительной информации.

    См. также

    – setRedValue:greenValue:blueValue:alphaValue:toParm:atTime: (Протокол FxParameterSettingAPI)

  • getRedValue:greenValue:blueValue:fromParm:atTime: - getRedValue:greenValue:blueValue:fromParm:atTime: Требуемый

    Получает значения цвета RGB (в 0,0 - 1,0 плавающих точки) от параметра. (требуемый)

    Объявление

    Objective C

    - (BOOL)getRedValue:(double *)red greenValue:(double *)green blueValue:(double *)blue fromParm:(UInt32)parmId atTime:(double)time

    Параметры

    red

    Возвраты, ссылкой, значение для значения компонента красного цвета.

    green

    Возвраты, ссылкой, значение для зеленого значения компонента цвета.

    blue

    Возвраты, ссылкой, значение для синего значения компонента цвета.

    parmId

    Уникальный идентификатор для параметра.

    time

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

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

    YEStrue если значения получены успешно; иначе NOfalse.

    Обсуждение

    В зависимости от хост-приложения временная стоимость может быть относительно запуска временной шкалы или к запуску клипа. См. Тип Timebase для получения дополнительной информации.

    См. также

    – setRedValue:RedValue:GreenValue:BlueValue:toParm:atTime: (Протокол FxParameterSettingAPI)

  • getRedValue:GreenValue:BlueValue:AlphaValue:fromParm:atTime: - getRedValue:GreenValue:BlueValue:AlphaValue:fromParm:atTime:

    Получает значение цвета RGBA (в 0,0 - 1,0 плавающих точки) от параметра. (требуемый)

    Осуждаемое использование getRedValue:greenValue:blueValue:fromParm:atTime: вместо этого.

    Объявление

    Objective C

    - (BOOL)getRedValue:(double *)red GreenValue:(double *)green BlueValue:(double *)blue AlphaValue:(double *)alpha fromParm:(UInt32)parmId atTime:(double)time

    Параметры

    red

    Возвраты, ссылкой, значение компонента красного цвета.

    green

    Возвраты, ссылкой, зеленое значение компонента цвета.

    blue

    Возвраты, ссылкой, синее значение компонента цвета.

    alpha

    Возвраты, ссылкой, альфа-значение компонента цвета.

    parmId

    Уникальный идентификатор для параметра.

    time

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

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

    YEStrue если значения получены успешно; иначе NOfalse.

    Обсуждение

    В зависимости от хост-приложения временная стоимость может быть относительно запуска временной шкалы или к запуску клипа. См. Тип Timebase для получения дополнительной информации.

  • getRedValue:GreenValue:BlueValue:fromParm:atTime: - getRedValue:GreenValue:BlueValue:fromParm:atTime:

    Получает значения цвета RGB (в 0,0 - 1,0 плавающих точки) от параметра. (требуемый)

    Осуждаемое использование getRedValue:greenValue:blueValue:fromParm:atTime: вместо этого.

    Объявление

    Objective C

    - (BOOL)getRedValue:(double *)red GreenValue:(double *)green BlueValue:(double *)blue fromParm:(UInt32)parmId atTime:(double)time

    Параметры

    red

    Возвраты, ссылкой, значение для значения компонента красного цвета.

    green

    Возвраты, ссылкой, значение для зеленого значения компонента цвета.

    blue

    Возвраты, ссылкой, значение для синего значения компонента цвета.

    parmId

    Уникальный идентификатор для параметра.

    time

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

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

    YEStrue если значения получены успешно; иначе NOfalse.

    Обсуждение

    В зависимости от хост-приложения временная стоимость может быть относительно запуска временной шкалы или к запуску клипа. См. Тип Timebase для получения дополнительной информации.

  • getTexture:layerOffsetX:layerOffsetY:requestInfo:fromParm:atTime: - getTexture:layerOffsetX:layerOffsetY:requestInfo:fromParm:atTime: Требуемый

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

    Объявление

    Objective C

    - (BOOL)getTexture:(FxTexture **)image layerOffsetX:(double *)offsetX layerOffsetY:(double *)offsetY requestInfo:(FxRenderInfo)info fromParm:(UInt32)parmId atTime:(double)time

    Параметры

    image

    Возвраты, ссылкой, изображение текстуры.

    offsetX

    Возвраты, ссылкой, эти X значений для левого нижнего угла этого изображения в пространстве уровня. Если этот указатель NULL, никакой перевод не вычисляется.

    offsetY

    Возвраты, ссылкой, Y оценивают за левый нижний угол этого изображения в пространстве уровня. Если этот указатель NULL, никакой перевод не вычисляется.

    info

    Информация о требуемом изображении, включая качество, масштаб и битовую глубину.

    parmId

    Уникальный идентификатор для параметра.

    time

    Требуемое время, выраженное в канонических кадрах, для получения изображения.

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

    YEStrue если извлечение изображения неуспешно; иначе NOfalse и image параметр будет NIL.

    Обсуждение

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

    В зависимости от хост-приложения временная стоимость может быть относительно запуска временной шкалы или к запуску клипа. См. Тип Timebase.

  • getXValue:YValue:fromParm:atTime: - getXValue:YValue:fromParm:atTime: Требуемый

    Получает x, y значение позиции (в 0,0 - 1,0 плавающих точки) от параметра. (требуемый)

    Объявление

    Objective C

    - (BOOL)getXValue:(double *)x YValue:(double *)y fromParm:(UInt32)parmId atTime:(double)time

    Параметры

    x

    Возвраты, ссылкой, эти X значений.

    y

    Возвраты, ссылкой, значение Y.

    parmId

    Уникальный идентификатор для параметра.

    time

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

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

    YEStrue если значения получены успешно; иначе NOfalse.

    Обсуждение

    В зависимости от хост-приложения временная стоимость может быть относительно запуска временной шкалы или к запуску клипа. См. Тип Timebase для получения дополнительной информации.

    См. также

    – setXValue:YValue:toParm:atTime: (Протокол FxParameterSettingAPI)

Типы данных

  • Флаги параметра Флаги параметра

    Битовые флаги, привыкшие к регулировочным характеристикам параметров. Не все флаги применяются обоснованно ко всем типам параметра. Единственные флаги, например, которые применяются к параметрам Группы, kFxParameterFlag_COLLAPSED, kFxParameterFlag_DONT_DISPLAY_IN_DASHBOARD, kFxParameterFlag_HIDDEN, и kFxParameterFlag_DISABLED. Вы не можете дать параметру группы пользовательский UI.

    Объявление

    Objective C

    enum { kFxParameterFlag_DEFAULT = 0, kFxParameterFlag_NOT_ANIMATABLE = 1 << 0, kFxParameterFlag_HIDDEN = 1 << 1, kFxParameterFlag_DISABLED = 1 << 2, kFxParameterFlag_COLLAPSED = 1 << 3, kFxParameterFlag_DONT_SAVE = 1 << 4, kFxParameterFlag_DONT_DISPLAY_IN_DASHBOARD = 1 << 5, kFxParameterFlag_CUSTOM_UI = 1 << 6, kFxParameterFlag_IGNORE_MINMAX = 1 << 8, }; typedef UInt32 FxParameterFlags;

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

Константы
  • Расширенный флаг параметра

    Следующая константа предоставлена для обратной совместимости: FxPlug 1.0 неверно назвал флаг, указывающий, что разрушен параметр группы.

    Объявление

    Objective C

    #define kFxParameterFlag_EXPANDED kFxParameterFlag_COLLAPSED

    Константы

    • kFxParameterFlag_EXPANDED

      kFxParameterFlag_EXPANDED

      Новые плагины должны использовать kFxParameterFlag_COLLAPSED вместо kFxParameterFlag_EXPANDED.