smokephil/ardour
1
0
Fork 0
mirror of https://github.com/Ardour/ardour.git synced 2025-12-13 01:56:34 +01:00
Code Issues Projects Releases Wiki Activity

update doxygen doc

Browse source
This commit is contained in:
Robin Gareus 2016-10-05 04:19:32 +02:00
parent b233a56a80
commit f1080c352a
1 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

14
libs/ardour/ardour/lua_api.h
View file

@ -178,19 +178,19 @@ namespace ARDOUR { namespace LuaAPI {
~Vamp (); ~Vamp ();
::Vamp::Plugin* plugin () { return _plugin; } ::Vamp::Plugin* plugin () { return _plugin; }
/* high-level abstraction to process a single channel of the given Readable. /** high-level abstraction to process a single channel of the given Readable.
* *
* If the plugin is not yet initialized, initialize() is called. * If the plugin is not yet initialized, initialize() is called.
* *
* if @cb is not nil, it is called with the immediate * if @cb is not nil, it is called with the immediate
* Vamp::Plugin::Features on every process call. * Vamp::Plugin::Features on every process call.
* *
* @r readable * @param r readable
* @channel channel to process * @param channel channel to process
* @cb lua callback function * @param fn lua callback function
* @return 0 on success * @return 0 on success
*/ */
int analyze (boost::shared_ptr<ARDOUR::Readable>, uint32_t channel, luabridge::LuaRef fn); int analyze (boost::shared_ptr<ARDOUR::Readable> r, uint32_t channel, luabridge::LuaRef fn);
/** call plugin():reset() and clear intialization flag */ /** call plugin():reset() and clear intialization flag */
void reset (); void reset ();
@ -218,10 +218,10 @@ namespace ARDOUR { namespace LuaAPI {
* *
* This is a lua-binding for vamp:plugin():process () * This is a lua-binding for vamp:plugin():process ()
* *
* @d audio-data, the vector must match the configured channel count * @param d audio-data, the vector must match the configured channel count
* and hold a complete buffer for every channel as set during * and hold a complete buffer for every channel as set during
* plugin():initialise() * plugin():initialise()
* @rt timestamp matching the provided buffer. * @param rt timestamp matching the provided buffer.
* @returns features extracted from that data (if the plugin is causal) * @returns features extracted from that data (if the plugin is causal)
*/ */
::Vamp::Plugin::FeatureSet process (const std::vector<float*>& d, ::Vamp::RealTime rt); ::Vamp::Plugin::FeatureSet process (const std::vector<float*>& d, ::Vamp::RealTime rt);