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) задает сетку для размещения пользовательского интерфейса параметра audio plugin.

пример

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

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

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

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

Название цветаКраткое имяТриплет RGBШестнадцатеричный цветовой кодВнешность
'red''r'[1 0 0]'#FF0000'

'green''g'[0 1 0]'#00FF00'

'blue''b'[0 0 1]'#0000FF'

'cyan' 'c'[0 1 1]'#00FFFF'

'magenta''m'[1 0 1]'#FF00FF'

'yellow''y'[1 1 0]'#FFFF00'

'black''k'[0 0 0]'#000000'

'white''w'[1 1 1]'#FFFFFF'

Вот триплеты RGB и шестнадцатеричные цветовые коды для цветов по умолчанию MATLAB® использует на многих типах графиков.

Триплет RGBШестнадцатеричный цветовой кодВнешность
[0 0.4470 0.7410]'#0072BD'

[0.8500 0.3250 0.0980]'#D95319'

[0.9290 0.6940 0.1250]'#EDB120'

[0.4940 0.1840 0.5560]'#7E2F8E'

[0.4660 0.6740 0.1880]'#77AC30'

[0.3010 0.7450 0.9330]'#4DBEEE'

[0.6350 0.0780 0.1840]'#A2142F'

Типы данных: 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++ с помощью Coder™ MATLAB ®

.

См. также

| | | | |

Темы

Введенный в R2016a

Документация Audio Toolbox

Поддержка

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