Steinberg::Vst::IMidiLearn Class Reference

#include <ivstmidilearn.h>

Inheritance diagram for Steinberg::Vst::IMidiLearn:

Public Member Functions
virtual tresult PLUGIN_API	onLiveMIDIControllerInput (int32 busIndex, int16 channel, CtrlNumber midiCC)=0
Public Member Functions inherited from Steinberg::FUnknown
virtual tresult PLUGIN_API	queryInterface (const TUID _iid, void **obj)=0
virtual uint32 PLUGIN_API	addRef ()=0
virtual uint32 PLUGIN_API	release ()=0

Static Public Attributes
static const FUID	iid
Static Public Attributes inherited from Steinberg::FUnknown
static const FUID	iid

Detailed Description

MIDI Learn interface: Vst::IMidiLearn

• [plug imp]
• [extends IEditController]
• [released: 3.6.12]
• [optional]

If this interface is implemented by the edit controller, the host will call this method whenever there is live MIDI-CC input for the plug-in. This way, the plug-in can change its MIDI-CC parameter mapping and inform the host via the IComponentHandler::restartComponent with the kMidiCCAssignmentChanged flag. Use this if you want to implement custom MIDI-Learn functionality in your plug-in.

//------------------------------------------------
// in MyController class declaration
class MyController : public Vst::EditController, public Vst::IMidiLearn
{
        // ...
        //--- IMidiLearn ---------------------------------
        tresult PLUGIN_API onLiveMIDIControllerInput (int32 busIndex, int16 channel,
                                                                                                  CtrlNumber midiCC) SMTG_OVERRIDE;
        // ...
 
        OBJ_METHODS (MyController, Vst::EditController)
        DEFINE_INTERFACES
                // ...
                DEF_INTERFACE (Vst::IMidiLearn)
        END_DEFINE_INTERFACES (Vst::EditController)
        //...
}
 
//------------------------------------------------
// in mycontroller.cpp
#include "pluginterfaces/vst/ivstmidilearn.h
 
namespace Steinberg {
        namespace Vst {
                DEF_CLASS_IID (IMidiLearn)
        }
}
 
//------------------------------------------------------------------------
tresult PLUGIN_API MyController::onLiveMIDIControllerInput (int32 busIndex, 
                                                        int16 channel, CtrlNumber midiCC)
{
        // if we are not in doMIDILearn (triggered by a UI button for example) 
        // or wrong channel then return
        if (!doMIDILearn || busIndex != 0 || channel != 0 || midiLearnParamID == InvalidParamID)
                return kResultFalse;
 
        // adapt our internal MIDICC -> parameterID mapping
        midiCCMapping[midiCC] = midiLearnParamID;
 
        // new mapping then inform the host that our MIDI assignment has changed
        if (auto componentHandler = getComponentHandler ())
        {
                componentHandler->restartComponent (kMidiCCAssignmentChanged);
        }
        return kResultTrue;
}

Member Function Documentation

onLiveMIDIControllerInput()

virtual tresult PLUGIN_API Steinberg::Vst::IMidiLearn::onLiveMIDIControllerInput ( int32 busIndex, int16 channel, CtrlNumber midiCC )

pure virtual

Called on live input MIDI-CC change associated to a given bus index and MIDI channel

Member Data Documentation

iid

const FUID Steinberg::Vst::IMidiLearn::iid

static

---

The documentation for this class was generated from the following file:

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/includes/vst3sdk/pluginterfaces/vst/ivstmidilearn.h