FxParameterRetrievalAPI_v3

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

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

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

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

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

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

FxParameterRetrievalAPI_v2

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

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

Получение пользовательских значений параметров


    
    getCustomParameterValue:fromParm:atTime:
    - getCustomParameterValue:fromParm:atTime:

Требуемый

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

Объявление

Objective C

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

Параметры

`value`	Возвраты, ссылкой, значение параметра в данное время.
`parmId`	ID параметра для получения значения для.
`time`	Время, в которое можно получить значение параметра.

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

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

Обсуждение

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

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

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

См. также

– setCustomParameterValue:toParm:atTime: (Протокол FxParameterRetrievalAPI_v3)


    
    getPathID:fromParm:atTime:
    - getPathID:fromParm:atTime:

Требуемый

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

Объявление

Objective C

- (BOOL)getPathID:(FxPathID*)pathID fromParm:(UInt32)parmId atTime:(double)time

Параметры

`pathID`	Получает путь ID параметра в данное время
`parmId`	ID параметра, значение которого должно быть получено.
`time`	Время, в которое можно получить значение параметра.

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

Возвраты YEStrue если путь ID получен успешно; иначе NOfalse.