Exponenta Banner

audioPluginInterface

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

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

Синтаксис

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

Описание

пример

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

пример

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

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

пример

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, ...
            'BackgroundColor','y');
    end
    methods
        function out = process(plugin,in)
            out = in*plugin.Gain;
        end
    end
end

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

свернуть все

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

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

Аудио сменное размещение сетки, заданное как audioPluginGridLayout объект.

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

Задайте дополнительные разделенные запятой пары Name,Value аргументы. 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 каналов.

Цвет используется в фоне графический интерфейса пользователя, заданном как короткая или длинная строка названия цвета или триплет RGB. Смотрите ColorSpec (Color Specification) для деталей.

Пример: 'BackgroundColor',[1 1 0] задает фон графический интерфейса пользователя, чтобы быть желтым.

Пример: 'BackgroundColor','y' задает фон графический интерфейса пользователя, чтобы быть желтым.

Пример: 'BackgroundColor','yellow' задает фон графический интерфейса пользователя, чтобы быть желтым.

Типы данных: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical | char | string

Изображение используется в фоне графический интерфейса пользователя, заданном его именем файла с помощью или вектора символов или строки. Если файл не находится на пути, необходимо задать полный путь к файлу. Поддерживаемыми типами файлов является PNG, GIF и JPG.

Фоновое изображение может включать диапозитивы, в этом случае BackgroundColor используется.

Пример: 'BackgroundImage','Sunrise.png' задает фоновое изображение графический интерфейса пользователя, чтобы быть 'Sunrise' изображение.

Пример: 'BackgroundImage',fullfile(matlabroot,"mySkins","Sunset.jpg") задает фон графический интерфейса пользователя, чтобы быть 'Sunset' изображение.

Типы данных: char | string

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

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

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

| | | | |

Темы

Введенный в R2016a

Документация Audio Toolbox
Поддержка