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

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

Разработчик

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

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

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

FxParameterSettingAPI

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

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

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


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

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


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

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


Не применимый не применимый
  • Устанавливает булево значение для параметра. (требуемый)

    Объявление

    Objective C

    - (BOOL)setBoolValue:(BOOL)value toParm:(UInt32)parmId atTime:(double)time

    Параметры

    value

    Булево значение.

    parmId

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

    time

    Время, в которое можно установить значение параметра.

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

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

    Обсуждение

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

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

    Объявление

    Objective C

    - (BOOL)setCustomParameterValue:(id <NSCoding>)value toParm:(UInt32)parmId

    Параметры

    value

    Непрозрачный объект значения.

    parmId

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

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

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

    Обсуждение

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

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

    См. также

    – getCustomParameterValue:fromParm: (Протокол FxParameterRetrievalAPI)

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

    Объявление

    Objective C

    - (BOOL)setFloatValue:(double)value toParm:(UInt32)parmId atTime:(double)time

    Параметры

    value

    Значение плавающее.

    parmId

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

    time

    Время, в которое можно установить значение параметра.

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

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

    Обсуждение

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

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

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

    См. также

    – getFloatValue:fromParm:atTime: (Протокол FxParameterRetrievalAPI)

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

    Объявление

    Objective C

    - (BOOL)setIntValue:(int)value toParm:(UInt32)parmId atTime:(double)time

    Параметры

    value

    Целочисленное значение.

    parmId

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

    time

    Время, в которое можно установить значение параметра.

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

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

    Обсуждение

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

    См. также

    – getIntValue:fromParm:atTime: (Протокол FxParameterRetrievalAPI)

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

    Объявление

    Objective C

    - (BOOL)setParameterFlags:(FxParameterFlags)flags toParm:(UInt32)parmId

    Параметры

    flags

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

    parmId

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

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

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

    Обсуждение

    Установка или сброс kFxParameterFlag_HIDDEN флаг на параметре подгруппы параметра также скроет или покажет все средства управления в группе.

    Аналогично, изменение kFxParameterFlag_HIDDEN флаговое значение влияет на все средства управления в группе также.

    См. также

    – getParameterFlags:fromParm: (Протокол FxParameterRetrievalAPI)

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

    Объявление

    Objective C

    - (BOOL)setRedValue:(double)red greenValue:(double)green blueValue:(double)blue alphaValue:(double)alpha toParm:(UInt32)parmId atTime:(double)time

    Параметры

    red

    Значение компонента красного цвета.

    green

    Зеленое значение компонента цвета.

    blue

    Синее значение компонента цвета.

    alpha

    Альфа-значение компонента цвета.

    parmId

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

    time

    Время, в которое можно установить значение параметра.

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

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

    Обсуждение

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

    См. также

    – getRedValue:greenValue:blueValue:alphaValue:fromParm:atTime: (Протокол FxParameterRetrievalAPI)

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

    Используйте setRedValue:greenValue:blueValue:alphaValue:toParm:atTime: метод вместо этого.

    Объявление

    Objective C

    - (BOOL)setRedValue:(double)red GreenValue:(double)green BlueValue:(double)blue AlphaValue:(double)alpha toParm:(UInt32)parmId atTime:(double)time

    Параметры

    red

    Значение компонента красного цвета.

    green

    Зеленое значение компонента цвета.

    blue

    Синее значение компонента цвета.

    alpha

    Альфа-значение компонента цвета.

    parmId

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

    time

    Время, в которое можно установить значение параметра.

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

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

    Обсуждение

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

    См. также

    – getRedValue:greenValue:blueValue:alphaValue:fromParm:atTime: (Протокол FxParameterRetrievalAPI)

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

    Объявление

    Objective C

    - (BOOL)setRedValue:(double)red greenValue:(double)green blueValue:(double)blue toParm:(UInt32)parmId atTime:(double)time

    Параметры

    red

    Значение компонента красного цвета.

    green

    Зеленое значение компонента цвета.

    blue

    Синее значение компонента цвета.

    parmId

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

    time

    Время, в которое можно установить значение параметра.

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

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

    Обсуждение

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

    См. также

    – getRedValue:greenValue:blueValue:fromParm:atTime: (Протокол FxParameterRetrievalAPI)

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

    Используйте setRedValue:greenValue:blueValue:toParm:atTime: метод вместо этого.

    Объявление

    Objective C

    - (BOOL)setRedValue:(double)red GreenValue:(double)green BlueValue:(double)blue toParm:(UInt32)parmId atTime:(double)time

    Параметры

    red

    Значение компонента красного цвета.

    green

    Зеленое значение компонента цвета.

    blue

    Синее значение компонента цвета.

    parmId

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

    time

    Время, в которое можно установить значение параметра.

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

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

    Обсуждение

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

    См. также

    – getRedValue:greenValue:blueValue:fromParm:atTime: (Протокол FxParameterRetrievalAPI)

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

    Объявление

    Objective C

    - (BOOL)setXValue:(double)x YValue:(double)y toParm:(UInt32)parmId atTime:(double)time

    Параметры

    x

    Эти X значений.

    y

    Значение Y.

    parmId

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

    time

    Время, в которое можно установить значение параметра.

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

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

    Обсуждение

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

    См. также

    – getXValue:YValue:fromParm:atTime: (Протокол FxParameterRetrievalAPI)