audioPluginInterface

Задайте аудио сменный интерфейс

свернуть все на странице

Синтаксис

PluginInterface = audioPluginInterface
PluginInterface = audioPluginInterface(pluginParameters)
PluginInterface = audioPluginInterface(Name,Value)

Описание

пример

PluginInterface = audioPluginInterface возвращает объект, PluginInterface, который задает интерфейс аудио плагина в среде цифровой звуковой рабочей станции (DAW). Это также задает интерфейсные атрибуты, такие как именование для идентификации.

пример

PluginInterface = audioPluginInterface(pluginParameters) задает аудио сменные параметры, которые являются стоящими с пользователем переменными, сопоставленными с аудио сменными свойствами. Дополнительную информацию см. в audioPluginParameter.

пример

PluginInterface = audioPluginInterface(Name,Value) задает свойства audioPluginInterface с помощью одного или нескольких аргументов пары Name,Value.

Примеры

свернуть все

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

classdef myAudioPlugin < audioPlugin
    methods
        function out = process(~,in)
            out = in;
        end
    end 
end

Добавьте постоянное свойство, PluginInterface, который задан как объект audioPluginInterface.

classdef myAudioPlugin < audioPlugin
    properties (Constant)
        PluginInterface = audioPluginInterface;
    end
    methods
        function out = process(~,in)
            out = in;
        end
    end 
end

Создайте основной аудио сменный файл определения класса. Задайте свойство, Gain и функцию обработки, которая умножается введенный Gain.

classdef myAudioPlugin < audioPlugin
    properties
        Gain = 1;
    end
    methods
        function out = process(plugin,in)
            out = in*plugin.Gain;
        end
    end 
end

Добавьте постоянное свойство, PluginInterface, который задан как объект audioPluginInterface.

classdef myAudioPlugin < audioPlugin
    properties
        Gain = 1;
    end
    properties (Constant)
        PluginInterface = audioPluginInterface;
    end
    methods
        function out = process(plugin,in)
            out = in*plugin.Gain;
        end
    end 
end

Передайте audioPluginParameter audioPluginInterface. Чтобы сопоставить сменное свойство, Gain, к сменному параметру, задает первый аргумент audioPluginParameter как имя свойства, 'Gain'.

classdef myAudioPlugin < audioPlugin
    properties
        Gain = 1;
    end
    properties (Constant)
        PluginInterface = audioPluginInterface(...
            audioPluginParameter('Gain'));
    end
    methods
        function out = process(plugin,in)
            out = in*plugin.Gain;
        end
    end 
end

Если вы генерируете и развертываете myAudioPlugin на среде цифровой звуковой рабочей станции (DAW), сменное свойство, Gain, синхронизируется со стоящим с пользователем сменным параметром.

Создайте основной аудио сменный файл определения класса. Задайте сменное имя, имя поставщика, версию поставщика, уникальную идентификацию, количество входных каналов и количество выходных каналов.

classdef monoGain < audioPlugin
    properties
        Gain = 1;
    end
    properties (Constant)
        PluginInterface = audioPluginInterface(...
            audioPluginParameter('Gain'),...
            'PluginName','Simple Gain',...
            'VendorName','Cool Company',...
            'VendorVersion','1.0.0',...
            'UniqueId','1a1Z',...
            'InputChannels',1,...
            'OutputChannels',1);
    end
    methods
        function out = process(plugin,in)
            out = in*plugin.Gain;
        end
    end
end

Входные параметры

свернуть все

Аудио сменные параметры, заданные как один или несколько audioPluginParameter, возражают.

Чтобы создать аудио сменный параметр, используйте функцию audioPluginParameter. В среде цифровой звуковой рабочей станции (DAW) они синхронизируют сменные свойства класса со стоящими с пользователем параметрами.

Аргументы в виде пар имя-значение

Укажите необязательные аргументы в виде пар ""имя, значение"", разделенных запятыми. Имя (Name) — это имя аргумента, а значение (Value) — соответствующее значение. Name должен появиться в кавычках. Вы можете задать несколько аргументов в виде пар имен и значений в любом порядке, например: Name1, Value1, ..., NameN, ValueN.

Пример: 'PluginName','cool effect','VendorVersion','1.0.2' задает имя сгенерированного аудио плагина как 'cool effect' и версия поставщика как '1.0.2'.

Имя вашего сгенерированного плагина, как замечено аудиоприложением хоста, заданным как пара, разделенная запятой, состоящая из 'PluginName' и строка до 127 символов. Если 'PluginName' не задан, сгенерированному плагину дают имя аудио сменного класса, от которого это сгенерировано.

Имя поставщика сменного создателя, заданного как пара, разделенная запятой 'VendorName' и вектор символов до 127 символов.

Версия поставщика раньше отслеживала сменные релизы, заданные как пара, разделенная запятой, состоящая из 'VendorVersion' и разделенная от точки строка 1–3 целых чисел в области значений от 0 до 9.

Пример 1

Пример: '1.4'

Пример: '1.3.5'

Уникальный идентификатор для вашего плагина, заданного как пара, разделенная запятой, состоящая из 'UniqueID' и четырех символьных строк, используемых для распознавания в определенных средах цифровой звуковой рабочей станции (DAW).

Введите каналы, заданные как пара, разделенная запятой, состоящая из 'InputChannels' и целого числа или вектора целых чисел. input channels является количеством аргументов входных данных, и сопоставленные каналы (столбцы) передали функции обработки вашего аудио плагина.

Пример: 'InputChannels',3 вызывает функцию обработки с одним аргументом данных, содержащим 3 канала.

Пример: 'InputChannels',[2,4,1,5] вызывает функцию обработки с аргументами данных 4. Первый аргумент содержит каналы 2, второе содержит каналы 4, третье содержит канал 1, и четвертое содержит каналы 5.

Примечание

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

Выведите каналы, задал пару, разделенную запятой, состоящую из 'OutputChannels' и целого числа или вектора целых чисел. output channels является количеством аргументов входных данных, и сопоставленные каналы (столбцы) передали от функции обработки вашего аудио плагина.

Пример: 'OutputChannels',3 задает функцию обработки, чтобы вывести один аргумент данных, содержащий 3 канала.

Пример: 'OutputChannels',[2,4,1,5] задает функцию обработки к аргументам данных вывода 4. Первый аргумент содержит каналы 2, второе содержит каналы 4, третье содержит канал 1, и четвертое содержит каналы 5.

Расширенные возможности

Генерация кода C/C++
Генерация кода C и C++ с помощью MATLAB® Coder™.

Смотрите также

Классы

Функции

Темы

Введенный в R2016a

Документация Audio Toolbox
Поддержка
Для просмотра документации необходимо авторизоваться на сайте