Guides for developers
GitHub repositoryHomepage
  • Getting started
  • Core
    • Glossary
    • The structure of the LMMS core
      • Initializations and cleanups
        • For core
      • Accessing to core classes
    • The structure of an LMMS project
    • Tracks and track containers
      • Tracks and clips
      • Track containers
    • The pattern system
    • Play handles
      • NotePlayHandle
      • InstrumentPlayHandle
      • SamplePlayHandle
    • Instruments
      • The type of instruments
      • Processing in instruments
        • Per-note processing
    • Audio effects
    • Automation and controllers
      • Automation
        • Processing automation
      • Controllers
    • Controlling playback
    • The audio rendering engine of LMMS
      • Stage 1: collect play handles and process automation
      • Stage 2: render notes and instruments
      • Step 3: mix and master
    • Threading and synchronization
    • Data serialization
      • Overview
      • Relevant classes
      • Upgrading data files
    • Internal routing of events and signals
      • Audio signals
      • MIDI events
    • Audio and MIDI I/O
      • Supported backends and features
  • GUI
    • The initialization process of LMMS GUI
    • UI components of LMMS
  • Build system
    • CMake and LMMS
    • Source directory structure
    • Useful variables/macros
  • Plugin system
    • Plugin types
    • Plugin API
      • Sub-plugin API
    • Loading plugins from LMMS
  • Unit tests
    • Writing unit tests
Powered by GitBook
On this page
  • Plugin descriptor
  • Sub-plugins

Was this helpful?

  1. Plugin system

Plugin API

PreviousPlugin typesNextSub-plugin API

Last updated 4 years ago

Was this helpful?

Plugin descriptor

Every plugin has its descriptor. A plugin descriptor is an instance of Plugin::Descriptor which contains some information like name, author, type, supported file types and sub-plugin feature.

Sub-plugins

The subPluginFeatures field of a plugin descriptor is optional. If a plugin defines this field, the Plugin::Descriptor::SubPluginFeatures object handles listing and querying its sub-plugins.

Please see page for details of Plugin::Descriptor::SubPluginFeatures.

Sub-plugin API