PadManager
#include "crosspad/pad/PadManager.hpp"Generated from crosspad/pad/PadManager.hpp in crosspad-core. Edit the header’s doxygen comments to change this page.
Recipes that use it: Pads and LEDs, Play a sample, MIDI out, Tempo and transport
Functions
Section titled “Functions”getPadManager
Section titled “getPadManager”PadManager & getPadManager()Platform-injected singleton accessor.
Used in Pads and LEDs, Tempo and transport.
Declared in crosspad/pad/PadManager.hpp:235.
crosspad::PadManager
Section titled “crosspad::PadManager”Portable pad manager — input handling, MIDI, LED coordination.
Manages pad interactions, note mapping, pad-logic-handler dispatch, and coordinates PadLedController + PadAnimator. Uses IMidiOutput and IEventBus for platform-independent MIDI output and event posting.
Used in Pads and LEDs, Play a sample, MIDI out, Tempo and transport.
Members
Methods
PadManager
Section titled “PadManager”PadManager() = defaultPlatform only The platform calls it once at start-up (crosspad_platform_init).
void init(PadLedController &ledController, PadAnimator &animator, IMidiOutput &midiOutput, IEventBus &eventBus, CrosspadSettings *settings, CrosspadStatus *status)Platform only The platform calls it once at start-up (crosspad_platform_init).
void begin()update
Section titled “update”Platform only The firmware calls it every 10 ms from its worker task.
void update()setInputSuppressed
Section titled “setInputSuppressed”void setInputSuppressed(bool suppressed)isInputSuppressed
Section titled “isInputSuppressed”bool isInputSuppressed() constallNotesOff
Section titled “allNotesOff”void allNotesOff()handlePadPress
Section titled “handlePadPress”Platform only The pad, MIDI-in and sequencer paths of the firmware and the simulator call it, and the Sampler for its previews. Your app gets presses through its IPadLogicHandler and never calls it.
void handlePadPress(uint8_t padIdx, uint8_t velocity=127, EventSource source=EventSource::PadManager)source says who pressed: a finger (PadManager, the default) or the loop recorder playing a take back (SequencerCallback).
It travels with the bus events, and pad logic reads it with pressSource().
handlePadRelease
Section titled “handlePadRelease”void handlePadRelease(uint8_t padIdx, EventSource source=EventSource::PadManager)setInputTap
Section titled “setInputTap”void setInputTap(InputTap tap, void *ctx)pressSource
Section titled “pressSource”EventSource pressSource(uint8_t padIdx) constWho made the last press or release of padIdx.
Per pad, not per call: a take playing pad 3 while a finger holds pad 5 answers each right.
Used in Play a sample.
handlePadPressure
Section titled “handlePadPressure”void handlePadPressure(uint8_t padIdx, uint8_t pressure)notifyPadPressure
Section titled “notifyPadPressure”void notifyPadPressure(uint8_t padIdx, uint8_t pressure)notifyPadPan
Section titled “notifyPadPan”void notifyPadPan(uint8_t padIdx, int8_t pan)getPadPan
Section titled “getPadPan”int8_t getPadPan(uint8_t padIdx)notifyNoteOn
Section titled “notifyNoteOn”void notifyNoteOn(uint8_t padIdx, uint8_t velocity, bool fromSampler=false)Used in Play a sample.
notifyNoteOff
Section titled “notifyNoteOff”void notifyNoteOff(uint8_t padIdx, bool fromSampler=false)Used in Play a sample.
notifySamplePlay
Section titled “notifySamplePlay”void notifySamplePlay(uint8_t padIdx, bool isPlaying)handleMidiNoteOn
Section titled “handleMidiNoteOn”void handleMidiNoteOn(uint8_t channel, uint8_t note, uint8_t velocity)handleMidiNoteOff
Section titled “handleMidiNoteOff”void handleMidiNoteOff(uint8_t channel, uint8_t note)handleMidiAftertouch
Section titled “handleMidiAftertouch”void handleMidiAftertouch(uint8_t channel, uint8_t note, uint8_t pressure)handleSamplePlay
Section titled “handleSamplePlay”void handleSamplePlay(uint8_t padIdx, bool isPlaying, uint8_t wavIdx=0)togglePadPlay
Section titled “togglePadPlay”void togglePadPlay(uint8_t padIdx)isPadPressed
Section titled “isPadPressed”bool isPadPressed(uint8_t padIdx)isPadPlaying
Section titled “isPadPlaying”bool isPadPlaying(uint8_t padIdx)setPadColor
Section titled “setPadColor”void setPadColor(uint8_t padIdx, RgbColor color)Used in Pads and LEDs, MIDI out, Tempo and transport.
setDefaultColor
Section titled “setDefaultColor”void setDefaultColor(RgbColor color)setPressedColor
Section titled “setPressedColor”void setPressedColor(RgbColor color)setPlayingColor
Section titled “setPlayingColor”void setPlayingColor(RgbColor color)setPadColor
Section titled “setPadColor”void setPadColor(uint8_t padIdx, uint8_t r, uint8_t g, uint8_t b)Used in Pads and LEDs, MIDI out, Tempo and transport.
clearPadColor
Section titled “clearPadColor”void clearPadColor(uint8_t padIdx)Used in Pads and LEDs, MIDI out, Tempo and transport.
setDefaultColor
Section titled “setDefaultColor”void setDefaultColor(uint8_t r, uint8_t g, uint8_t b)setPressedColor
Section titled “setPressedColor”void setPressedColor(uint8_t r, uint8_t g, uint8_t b)setPlayingColor
Section titled “setPlayingColor”void setPlayingColor(uint8_t r, uint8_t g, uint8_t b)getPadColor
Section titled “getPadColor”RgbColor getPadColor(uint8_t padIdx)getPressedColor
Section titled “getPressedColor”RgbColor getPressedColor(uint8_t padIdx)getPlayingColor
Section titled “getPlayingColor”RgbColor getPlayingColor(uint8_t padIdx)setBrightness
Section titled “setBrightness”void setBrightness(uint8_t brightness)getBrightness
Section titled “getBrightness”uint8_t getBrightness()setFeedbackMode
Section titled “setFeedbackMode”void setFeedbackMode(KeypadFeedbackMode mode)getFeedbackMode
Section titled “getFeedbackMode”KeypadFeedbackMode getFeedbackMode()setCustomColorCallback
Section titled “setCustomColorCallback”void setCustomColorCallback(KeypadCustomColorCallback callback)loadPadConfig
Section titled “loadPadConfig”void loadPadConfig(Pad *pads, uint8_t count)setPadNote
Section titled “setPadNote”void setPadNote(uint8_t padIdx, uint8_t note)getPadNote
Section titled “getPadNote”uint8_t getPadNote(uint8_t padIdx)setChordNote
Section titled “setChordNote”void setChordNote(uint8_t padIdx, uint8_t chordIdx, int8_t note)getChordNote
Section titled “getChordNote”int8_t getChordNote(uint8_t padIdx, uint8_t chordIdx)setPadChannel
Section titled “setPadChannel”void setPadChannel(uint8_t padIdx, uint8_t channel)getPadChannel
Section titled “getPadChannel”uint8_t getPadChannel(uint8_t padIdx)applyDefaultOffsetToPadNotes
Section titled “applyDefaultOffsetToPadNotes”void applyDefaultOffsetToPadNotes()getMidiNoteForPad
Section titled “getMidiNoteForPad”uint8_t getMidiNoteForPad(uint8_t padIdx)getPadForMidiNote
Section titled “getPadForMidiNote”uint8_t getPadForMidiNote(uint8_t note)getRGBCallbackManager
Section titled “getRGBCallbackManager”RGBCallbackManager & getRGBCallbackManager()registerPadLogic
Section titled “registerPadLogic”void registerPadLogic(const std::string &appName, std::shared_ptr< IPadLogicHandler > handler)Used in Pads and LEDs.
setActivePadLogic
Section titled “setActivePadLogic”Do not call With REGISTER_APP_PL the framework gives your pad logic the pads while the app is open and takes them back when it closes. Never call this yourself, and never from onActivate or onDeactivate.
void setActivePadLogic(const std::string &appName)Activate appName’s logic.
An empty name hands the pads to the base logic (see setBasePadLogic()), so they always have a handler.
setBasePadLogic
Section titled “setBasePadLogic”void setBasePadLogic(const std::string &appName)Install the system instrument: the logic that owns the pads whenever no app has claimed them, so pads keep playing outside any app.
Apps preempt it through pushPadLogic()/setActivePadLogic() and hand it back on teardown. Pass "" to remove it (pads go silent with no app again).
The handler must stay registered for as long as it is the base — do not unregisterPadLogic() a base handler on app teardown, or the fallback resolves to nothing.
getBasePadLogic
Section titled “getBasePadLogic”std::string getBasePadLogic() constUsed in Play a sample.
getActivePadLogic
Section titled “getActivePadLogic”std::string getActivePadLogic() constunregisterPadLogic
Section titled “unregisterPadLogic”void unregisterPadLogic(const std::string &appName)getRegisteredPadLogics
Section titled “getRegisteredPadLogics”std::vector< std::string > getRegisteredPadLogics() constgetPadLogic
Section titled “getPadLogic”std::shared_ptr< IPadLogicHandler > getPadLogic(const std::string &appName) constThe handler registered under appName, or null.
For a logic that plays through another an app that owns the pads but keeps the base instrument sounding under them.
Used in Play a sample.
pushPadLogic
Section titled “pushPadLogic”Do not call With REGISTER_APP_PL the framework pushes and pops your pad logic. Never call this yourself, and never from onActivate or onDeactivate.
void pushPadLogic(const std::string &appName)Save the currently active pad logic on an internal stack, then activate appName.
Pair with popPadLogic() — used by screens/apps that overlay a temporary logic and must hand control back on teardown.
Call popPadLogic() before you unregister your own handler.
Do not call pushPadLogic() or setActivePadLogic() from inside a handler’s onActivate() or onDeactivate().
popPadLogic
Section titled “popPadLogic”Do not call With REGISTER_APP_PL the framework pops your pad logic when the app closes. Never call this yourself, and never from onActivate or onDeactivate.
void popPadLogic()Re-activate the logic saved by the matching pushPadLogic().
No-op when the stack is empty. Same unregister-ordering and reentrancy caveats as pushPadLogic() apply — see its doc comment.
getLedController
Section titled “getLedController”PadLedController & getLedController()getAnimator
Section titled “getAnimator”PadAnimator & getAnimator()Declared in crosspad/pad/PadManager.hpp:30.