exponenta event banner

getParameter

Класс: externalAudioPlugin

Получение нормализованного значения и информации о параметре

Синтаксис

value = getParameter(hostedPlugin,parameter)
[value, parameterInformation] = getParameter(hostedPlugin,parameter)

Описание

value = getParameter(hostedPlugin,parameter) возвращает нормализованное значение parameter из hostedPlugin. Можно указать параметр по его имени как символьный вектор, строку или по его индексу. Например:

  • getParameter(hostedPlugin,'Gain') возвращает нормализованное значение параметра размещенного подключаемого модуля с именем 'Gain'. Если имя параметра не является уникальным, getParameter возвращает ошибку.

  • getParameter(hostedPlugin,2) возвращает информацию о параметре, указанном индексом 2.

[value, parameterInformation] = getParameter(hostedPlugin,parameter) возвращает структуру, содержащую дополнительную информацию об указанном параметре размещенного плагина.

ОбластьОписание
DisplayNameОтображаемое имя или подсказка параметра плагина, возвращаемого в виде символьного вектора. Отображаемое имя предназначено для отображения в пользовательском интерфейсе (UI) плагина.
DisplayValueОтображаемое значение параметра плагина, возвращаемое в виде символьного вектора. Параметр DisplayValue соответствует нормированному параметру value неизвестным сопоставлением с размещенным плагином. Как правило, отображаемое значение отражает значение, используемое плагином для обработки, в то время как нормализованное значение параметра соответствует положению элемента управления MIDI или виджета в пользовательском интерфейсе.
LabelМетка, предназначенная для отображения с DisplayValue в пользовательском интерфейсе плагина, возвращенном в виде символьного вектора. Типовые этикетки включают dB и Hz.

Представлен в R2016b