Exponenta Banner
exponenta event banner

audioPluginInterface

Укажите интерфейс аудиоплагина

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

Синтаксис

PluginInterface = audioPluginInterface
PluginInterface = audioPluginInterface (pluginParameters)
PluginInterface = audioPluginInterface (pluginParameters, gridLayout)
PluginInterface = audioPluginInterface (___, имя, значение)

Описание

пример

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' и целое число или вектор целых чисел. Входные каналы - это количество входных аргументов данных и связанных с ними каналов (столбцов), передаваемых функции обработки аудиоплагина.

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

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

Примечание

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

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

Пример: '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++ с помощью MATLAB ® Coder™

.

См. также

| | | | |

Темы

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

Документация по панели инструментов Audio

Поддержка