Modules Preferences

From Audacity Development Manual
Jump to: navigation, search

Accessed by: Edit > Preferences > Modules    (on a Mac Audacity > Preferences > Modules )
Devices PreferencesPlayback PreferencesRecording PreferencesMIDI Devices PreferencesQuality PreferencesInterface PreferencesTracks PreferencesTracks Behaviors PreferencesSpectrograms PreferencesImport/Export PreferencesExtended Import PreferencesProjects PreferencesLibraries PreferencesDirectories PreferencesWarnings PreferencesEffects PreferencesKeyboard PreferencesMouse PreferencesModules PreferencesClick on this in Audacity to get helpPreferences Modules.png
Click for details
Click in the left column for other preferences
Modules Preferences.


No modules are yet shipped with Audacity.

Nyquist Workbench provides the ability to create and run arbitrary Nyquist code in Audacity from a graphical editor. The Workbench can be compiled from our source code. Nyquist Workbench is recommended (though not essential) for anyone interested in writing Nyquist plug-ins for Audacity - good functionality to test Nyquist plug-ins is also available in Nyquist Prompt.

Nyquist Workbench with notch.ny plug-in loaded in Script window.

Current Workbench features include:

  • Full support for Generate, Process and Analyze effects
  • Auto load last file
  • Built-in output/debug screen
  • Parentheses matching.

Mod-script pipe can only be compiled from our source code. This is a GUI plug-in that allows Audacity to be driven from an external Perl script, or using any other scripting language that supports named pipes. Please be aware of the security implications of allowing other applications or processes to control Audacity. For more information, see Scripting.

Mod-track-panel: This is the start of an experiment that will ultimately provide a more flexible panel for the audio, label, MIDI and note tracks. It is currently only of value to developers and must be compiled from the latest Audacity source code.

Loading modules into Audacity

To use an experimental module such as Nyquist Workbench:

  1. Add a "modules" folder to the Audacity installation folder
  2. Add the file such as mod-nyq-bench.dll (Windows) or (Mac) to the Modules folder, restart Audacity and open Modules Preferences
  3. You should see that file is marked as "New":
    Mod nyq bench new.png
  4. Click the dropdown menu for the item, change it to "Enabled", press OK then restart Audacity.

When you restart Audacity, you should now see an additional "Nyquist Workbench" entry at the bottom of View Menu (or whatever feature the module enables).

Warning icon If you compile a module yourself on some other day than when you compiled Audacity, you will see a "Module Unsuitable" error after enabling the module and restarting Audacity. The only exception to this is if you build a final Audacity release.

If you see the "Module Unsuitable" error you will need to rebuild Audacity and the module, launch Audacity, change the entry for the module from "Failed" to "Enabled", then restart Audacity.