Modules

From Audacity Development Manual
Jump to: navigation, search
Audacity has experimental support for "modules", which are a type of plug-in, usually written in C++, that integrate closely with the main Audacity application. There are currently no modules included in the release binaries, but there are four experimental modules included in the code base (and included in the Linux tarballs). Before any of these modules can be used, they must be built from the source code. Previous experience building C++ projects is recommended.
Tip Modules should be built on the same date as Audacity, otherwise the version string check will prevent the module loading.

Mod-script pipe

This is a GUI plug-in that allows Audacity to be driven from an external script, using any scripting language that supports named pipes (Python3 is the recommended language). 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.


Mod-null

This is a bare bones demonstration module.


Installing modules

To install a module, a new folder should be created and named "modules", and the built module placed directly inside it.

  • Windows: the "modules" folder should be in the same location as audacity.exe
  • Mac: the "modules" folder should be in the "Contents" folder.
  • Linux: the "modules" folder can most easily be created in the home folder as ~/.audacity-files/modules

The module may then be enabled in Preferences. Restarting Audacity is required after enabling.