audioPluginGridLayout
Specify layout for audio plugin UI
Description
gridLayout = audioPluginGridLayoutgridLayout, as an argument to audioPluginInterface in your plugin class definition.
audioPluginGridLayout specifies only the grid. The placement of
individual graphical elements is specified using audioPluginParameter.
To learn how to design a graphic user interface, see Design User Interface for Audio Plugin.
For example plugins, see Audio Plugin Example Gallery.
gridLayout = audioPluginGridLayout(Name,Value)audioPluginGridLayout properties using one or more
Name,Value pair arguments.
Examples
The default audio plugin grid layout specifies a 2-by-2 grid. Call audioPluginGridLayout with no arguments to view the default settings.
audioPluginGridLayout
ans =
audioPluginGridLayout with properties:
RowHeight: [100 100]
ColumnWidth: [100 100]
RowSpacing: 10
ColumnSpacing: 10
Padding: [10 10 10 10]
noisifyClassic uses a default grid layout by passing audioPluginGridLayout, without any arguments, to audioPluginInterface. When you use audioPluginGridLayout, you must specify the position of each audioPluginParameter on the grid using Layout. Display names corresponding to parameters occupy cells on the grid also. The default grid contains only four cells and noisifyClassic has four parameters, so you must set DisplayNameLocation to none to fit all elements on the grid. audioPluginGridLayout is passed to the audioPluginInterface. Save noisifyClassic to your current folder.
classdef noisifyClassic < audioPlugin properties DropoutLeft = false DropoutRight = false NoiseLeftGain = 0 NoiseRightGain = 0 end properties (Constant) PluginInterface = audioPluginInterface( ... audioPluginParameter('DropoutLeft', ... 'Layout',[2,1], ... 'DisplayNameLocation','none'), ... audioPluginParameter('DropoutRight', ... 'Layout',[2,2], ... 'DisplayNameLocation','none'), ... audioPluginParameter('NoiseLeftGain', ... 'Layout',[1,1], ... 'DisplayNameLocation','none'), ... audioPluginParameter('NoiseRightGain', ... 'Layout',[1,2], ... 'DisplayNameLocation','none'), ... ... audioPluginGridLayout) end methods function out = process(plugin,in) r = size(in,1); dropRate = 0.1; if plugin.DropoutLeft idx = randperm(r,round(r*dropRate)); in(idx,1) = 0; end if plugin.DropoutRight idx = randperm(r,round(r*dropRate)); in(idx,2) = 0; end in(:,1) = in(:,1) + plugin.NoiseLeftGain*(2*rand(r,1,'like',in)-1); in(:,2) = in(:,2) + plugin.NoiseRightGain*(2*rand(r,1,'like',in)-1); out = in; end end end
You can quickly iterate on your UI design by using parameterTuner to visualize the plugin UI. Call parameterTuner on noisifyClassic.
parameterTuner(noisifyClassic)
The example plugin, noisify, adds noise to your audio signal channel-wise at a specified gain (per channel) and dropout rate.
classdef noisifyOriginal < audioPlugin properties DropoutLeft = false; DropoutRight = false; NoiseLeftGain = 0; NoiseRightGain = 0; DropoutRate = 0.1; end properties (Constant) PluginInterface = audioPluginInterface(... audioPluginParameter('DropoutLeft'), ... audioPluginParameter('DropoutRight'), ... audioPluginParameter('NoiseLeftGain'), ... audioPluginParameter('NoiseRightGain'), ... audioPluginParameter('DropoutRate')) end methods function out = process(plugin,in) r = size(in,1); if plugin.DropoutLeft idx = randperm(r,round(r*plugin.DropoutRate)); in(idx,1) = 0; end if plugin.DropoutRight idx = randperm(r,round(r*plugin.DropoutRate)); in(idx,2) = 0; end in(:,1) = in(:,1) + plugin.NoiseLeftGain*randn(r,1,'like',in); in(:,2) = in(:,2) + plugin.NoiseRightGain*randn(r,1,'like',in); out = in; end end end
To see the corresponding UI for the plugin, call parameterTuner with the plugin. When you generate an audio plugin and deploy it to a DAW, the DAW uses a default UI that is similar to the default UI of parameterTuner.
parameterTuner(noisifyOriginal)
You can create a more intuitive and visually pleasing UI using audioPluginInterface, audioPluginGridLayout, and audioPluginParameter. For example, to create a more intuitive UI for noisyOriginal, you could update the audioPluginInterface as follows:
classdef noisify < audioPlugin properties DropoutLeft = false; DropoutRight = false; NoiseLeftGain = 0; NoiseRightGain = 0; DropoutRate = 0.1; end properties (Constant) PluginInterface = audioPluginInterface(... audioPluginParameter('DropoutLeft', ... 'Layout',[4,1], ... 'DisplayName','Dropout (L)', ... 'DisplayNameLocation','above', ... 'Style','vrocker'), ... audioPluginParameter('DropoutRight', ... 'Layout',[4,4], ... 'DisplayName','Dropout (R)', ... 'DisplayNameLocation','above', ... 'Style','vrocker'), ... audioPluginParameter('NoiseLeftGain', ... 'DisplayName','Noise Gain (L)', ... 'Layout',[2,1;2,2], ... 'DisplayNameLocation','above', ... 'Style','rotaryknob'), ... audioPluginParameter('NoiseRightGain', ... 'Layout',[2,3;2,4], ... 'DisplayName','Noise Gain (R)', ... 'DisplayNameLocation','above', ... 'Style','rotaryknob'), ... audioPluginParameter('DropoutRate', ... 'Layout',[4,2;4,3], ... 'DisplayName','Droput Rate', ... 'DisplayNameLocation','below', ... 'Style','vslider'), ... ... audioPluginGridLayout( ... 'RowHeight',[15,150,15,150,15], ... 'ColumnWidth',[100,40,40,100], ... 'RowSpacing',30)) end methods function out = process(plugin,in) r = size(in,1); if plugin.DropoutLeft idx = randperm(r,round(r*plugin.DropoutRate)); in(idx,1) = 0; end if plugin.DropoutRight idx = randperm(r,round(r*plugin.DropoutRate)); in(idx,2) = 0; end in(:,1) = in(:,1) + plugin.NoiseLeftGain*randn(r,1,'like',in); in(:,2) = in(:,2) + plugin.NoiseRightGain*randn(r,1,'like',in); out = in; end end end
You can quickly iterate on your UI design by using parameterTuner to visualize incremental changes. Call parameterTuner on noisify. When you generate an audio plugin and deploy it to a DAW, the DAW uses the enhanced UI.
parameterTuner(noisify)
Name-Value Arguments
Version History
Introduced in R2019b
