Modules Preferences

From Audacity Development Manual
Jump to: navigation, search


Modules Preferences lists all modules detected by Audacity, and allows them to be enabled, if supported.
Warning icon Audacity does not currently ship any pre-built modules, though some experimental modules are available in the source code.


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.


Optional Modules

There are currently no modules included in the release binaries. Information about experimental modules may be found on the Modules page.


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 mod-nyq-bench.so (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 in the Tools Menu (or whatever feature the module enables).

Warning icon Modules should be built on the same day as Audacity, otherwise the module will fail to load. If you see a "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.