Aurora-for-Audacity / Aurora-for-Audacity

Angelo Farina's Aurora audio processing plugin suite for Audacity host application.
https://aurora-plugins.forumfree.it
0 stars 0 forks source link

Module Init and "Scripter" Documentation #9

Closed mhamilt closed 1 year ago

mhamilt commented 1 year ago

There is a comment within the Aurora ModuleDispatch function just before the ModuleInitialize case which states

https://github.com/Aurora-for-Audacity/Aurora-for-Audacity/blob/a5a3ee3176df53ec5b6eac0d655c1f1b690daa80/src/Common/src/AuroraModule.cpp#L233-L241

we have a special function for the scripter

Is there any chance this could elaborated on or covered somewhere within the documentation?

mhamilt commented 1 year ago

Ah, never mind, this seems to have been copied over from the mod-script-pipe module example

https://github.com/audacity/audacity/blob/1322b40a9c76409793c68fab761b92f56409840d/lib-src/mod-script-pipe/ScripterCallback.cpp#L108-L113

extern int DLL_API  ModuleDispatch(ModuleDispatchTypes type);
// ModuleDispatch
// is called by Audacity to initialize/terminate the module
// We don't (yet) do anything in this, since we have a special function for the scripter
// all we need to do is return 1.
int ModuleDispatch(ModuleDispatchTypes type){