Skip to main content

Developing an audio effect

tip

Consider reading the app guide before this section.

Audio apps must be module-based. Audio apps may have additional properties in their manifest:

PropertyTypeDescription
hasAudioInputbooleanREQUIRED FOR ALL AUDIO EFFECT APPS - registers app as an audio effect app
hideBypassButtonbooleanWhether to hide the bypass button on the top left corner of the window
hideAudioIOButtonbooleanWhether to hide the Audio IO settings button in the top right of the window

Extended app object

Audio apps extend the app object with the following properties:

PropertyTypeDescription
mixerAudioMixerunknown
contextunknownunknown
audioPipeunknownunknown
initPipeunknownShould not be used, this is done automatically.