validateAudioPlugin
Test MATLAB source code for audio plugin
Description
validateAudioPlugin
generates and runs a
Test Bench Procedure that exercises your
audio plugin class.classname
validateAudioPlugin
specifies options to modify the default Test Bench Procedure.options
classname
Examples
Validate Audio Plugin
validateAudioPlugin audiopluginexample.Echo
Checking plug-in class 'audiopluginexample.Echo'... passed. Generating testbench file 'testbench_Echo.m'... done. Running testbench... passed. Generating mex file 'testbench_Echo_mex.mexw64'... done. Running mex testbench... passed. Deleting testbench. Ready to generate audio plug-in.
Skip MEX Version of Test Bench
validateAudioPlugin -nomex audiopluginexample.Echo
Checking plug-in class 'audiopluginexample.Echo'... passed. Generating testbench file 'testbench_Echo.m'... done. Running testbench... passed. Skipping mex. Deleting testbench.
Keep Test Benches After Validation
validateAudioPlugin -keeptestbench audiopluginexample.Echo
Checking plug-in class 'audiopluginexample.Echo'... passed. Generating testbench file 'testbench_Echo.m'... done. Running testbench... passed. Generating mex file 'testbench_Echo_mex.mexw64'... done. Running mex testbench... passed. Keeping testbench. Ready to generate audio plug-in.
Two test benches are saved to your current folder:
testbench_Echo.m
testbench_Echo_mex.mexw64
Skip MEX Version and Keep Test Bench
validateAudioPlugin -keeptestbench -nomex audiopluginexample.Echo
Checking plug-in class 'audiopluginexample.Echo'... passed. Generating testbench file 'testbench_Echo.m'... done. Running testbench... passed. Skipping mex. Keeping testbench.
One test bench is saved to your current folder:
testbench_Echo.m
Input Arguments
options
— Options to modify test bench procedure
-nomex
| -keeptestbench
| -audioconfig cfg
Options to modify test bench procedure, specified as -nomex
,
-keeptestbench
, or -audioconfig
cfg
. Options can be specified together or separately, and in
any order.
You can also specify these options and validate plugins using the
generateAudioPlugin
user
interface (UI).
Option | generateAudioPlugin UI
Setting | Description |
---|---|---|
-nomex | Clear the Run a MEX version of the test bench option | Do not generate and run a MEX version of the test bench file. This option significantly reduces run time of the test bench procedure. |
-keeptestbench | Save test benches to output folder | Save the generated test benches to the current folder. In
the generateAudioPlugin UI, the test
benches are saved to the folder specified by
Output folder. |
-audioconfig
| Coder Configuration section | Specify deep learning and code replacement
configuration for coder. See |
classname
— Name of the plugin class to validate
plugin class
Name of the plugin class to validate. The plugin class must derive from
either the audioPlugin
class or the audioPluginSource
class. The
validateAudioPlugin
function exercises an instance
of the specified plugin class.
You can specify the plugin class to validate by specifying its class name or file name. For example, the following syntaxes perform equivalent operations:
validateAudioPlugin myPlugin
validateAudioPlugin myPlugin.m
If you want to specify the plugin class by file name, and your plugin class is inside a package, you must specify the package as a file path. For example, the following syntaxes perform equivalent operations:
validateAudioPlugin myPluginPackage.myPlugin
validateAudioPlugin +myPluginPackage/myPlugin.m
Limitations
The validateAudioPlugin
function is compatible with Windows® and Mac operating systems. It is not compatible with Linux®.
More About
Test Bench Procedure
The validateAudioPlugin
function uses dynamic testing to
find common audio plugin programming mistakes not found by the static checks
performed by generateAudioPlugin
. The function:
Runs a subset of error checks performed by
generateAudioPlugin
.Generates and runs a MATLAB® test bench to exercise the class.
Generates and runs a MEX version of the test bench.
Removes the generated test benches.
If the plugin class fails testing, step 4 is automatically omitted. To debug your plugin, step through the saved generated test bench.
If you use the -keeptestbench
option, or
if an error occurs during validation, the test bench files are saved
to your current folder.
Output File Name | Output File Type | Output File Name With File Extension |
---|---|---|
| MATLAB |
|
| MEX |
The MEX-file extension depends on your operating system. |
Version History
Introduced in R2016a
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)