Control Surface new-input
MIDI Control Surface library for Arduino
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
GenericUSBMIDI_Interface< Backend > Class Template Reference

#include <MIDI_Interfaces/USBMIDI_Interface.hpp>

Detailed Description

template<class Backend>
class GenericUSBMIDI_Interface< Backend >

A class for MIDI interfaces sending MIDI messages over a USB MIDI connection.

Definition at line 19 of file USBMIDI_Interface.hpp.

+ Inheritance diagram for GenericUSBMIDI_Interface< Backend >:
+ Collaboration diagram for GenericUSBMIDI_Interface< Backend >:

Underlying USB communication

Backend backend
 The (platform-specific) backend used for MIDI over USB communication.
 

Reading incoming MIDI messages

MIDIReadEvent read ()
 Try reading and parsing a single incoming MIDI message. More...
 
ChannelMessage getChannelMessage () const
 Return the received channel voice message.
 
SysCommonMessage getSysCommonMessage () const
 Return the received system common message.
 
RealTimeMessage getRealTimeMessage () const
 Return the received real-time message.
 
SysExMessage getSysExMessage () const
 Return the received system exclusive message.
 

Buffering USB packets

bool alwaysSendsImmediately () const
 Check if this USB interface always sends its USB packets immediately after sending a MIDI message. More...
 
void neverSendImmediately ()
 Don't send the USB packets immediately after sending a MIDI message. More...
 
void alwaysSendImmediately ()
 Send the USB packets immediately after sending a MIDI message. More...
 

Default MIDI Interfaces

void setAsDefault ()
 Set this MIDI interface as the default interface.
 
static MIDI_InterfacegetDefault ()
 Return the default MIDI interface. More...
 

MIDI Input Callbacks

void setCallbacks (MIDI_Callbacks *cb)
 Set the callbacks that will be called when a MIDI message is received. More...
 
void setCallbacks (MIDI_Callbacks &cb)
 Set the callbacks that will be called when a MIDI message is received. More...
 

Connecting and disconnecting MIDI Pipes

void connectSourcePipe (MIDI_Pipe *source)
 Fully connect a source pipe to this sink.
 
void disconnectSourcePipes ()
 Disconnect all source pipes that sink to this sink (recursively).
 
bool disconnect (TrueMIDI_Source &source)
 Disconnect the given source from this sink. More...
 
bool disconnect (MIDI_Pipe &)=delete
 
bool hasSourcePipe () const
 Check if this sink is connected to a source pipe.
 
MIDI_PipegetSourcePipe ()
 Get a pointer to the pipe this sink is connected to, or nullptr if not connected.
 

Connecting and disconnecting MIDI Pipes

bool disconnect (TrueMIDI_Sink &sink)
 Disconnect the given sink from this source. More...
 
bool disconnect (MIDI_Pipe &)=delete
 
void connectSinkPipe (MIDI_Pipe *sink)
 Fully connect a sink pipe to this source.
 
void disconnectSinkPipes ()
 Disconnect all sink pipes that this source sinks to (recursively).
 
bool hasSinkPipe () const
 Check if this source is connected to a sink pipe.
 
MIDI_PipegetSinkPipe ()
 Get a pointer to the pipe this source is connected to, or nullptr if not connected.
 

Sending data over a MIDI Pipe

void sourceMIDItoPipe (ChannelMessage)
 Send a MIDI Channel Message down the pipe.
 
void sourceMIDItoPipe (SysExMessage)
 Send a MIDI System Exclusive message down the pipe.
 
void sourceMIDItoPipe (SysCommonMessage)
 Send a MIDI System Common message down the pipe.
 
void sourceMIDItoPipe (RealTimeMessage)
 Send a MIDI Real-Time message down the pipe.
 

Stalling the sink pipes and exclusive access

void stall (MIDIStaller *cause=eternal_stall)
 Stall this MIDI source. More...
 
void unstall (MIDIStaller *cause=eternal_stall)
 Un-stall the pipes connected to this source, so other sources are allowed to send again. More...
 
bool isStalled () const
 Check if this source can write to the sinks it connects to.
 
MIDIStallergetStaller () const
 Get a pointer to whatever is causing this MIDI source to be stalled. More...
 
const char * getStallerName () const
 Get the name of whatever is causing this MIDI source to be stalled. More...
 
void handleStallers () const
 Give the code that is stalling the MIDI sink pipes the opportunity to do its job and un-stall the pipes.
 

Sending MIDI Channel Voice messages

void send (ChannelMessage message)
 Send a MIDI Channel Voice message.
 
void sendChannelMessage (MIDIMessageType m, Channel c, uint8_t d1, uint8_t d2, Cable cable=CABLE_1)
 Send a 3-byte MIDI Channel Voice message. More...
 
void sendChannelMessage (MIDIMessageType m, Channel c, uint8_t d1, Cable cable=CABLE_1)
 Send a 2-byte MIDI Channel Voice message. More...
 
void sendNoteOn (MIDIAddress address, uint8_t velocity)
 Send a MIDI Note On event.
 
void sendNoteOff (MIDIAddress address, uint8_t velocity)
 Send a MIDI Note Off event.
 
void sendKeyPressure (MIDIAddress address, uint8_t pressure)
 Send a MIDI Key Pressure event.
 
void sendControlChange (MIDIAddress address, uint8_t value)
 Send a MIDI Control Change event.
 
void sendProgramChange (MIDIAddress address)
 Send a MIDI Program Change event.
 
void sendProgramChange (MIDIChannelCable address, uint8_t value)
 Send a MIDI Program Change event.
 
void sendChannelPressure (MIDIChannelCable address, uint8_t pressure)
 Send a MIDI Channel Pressure event.
 
void sendPitchBend (MIDIChannelCable address, uint16_t value)
 Send a MIDI Pitch Bend event.
 

Sending MIDI System Common messages

void send (SysCommonMessage message)
 Send a MIDI System Common message.
 
void sendSysCommon (MIDIMessageType m, Cable cable=CABLE_1)
 Send a MIDI System Common message.
 
void sendSysCommon (MIDIMessageType m, uint8_t data1, Cable cable=CABLE_1)
 Send a MIDI System Common message.
 
void sendSysCommon (MIDIMessageType m, uint8_t data1, uint8_t data2, Cable cable=CABLE_1)
 Send a MIDI System Common message.
 
void sendMTCQuarterFrame (uint8_t data, Cable cable=CABLE_1)
 Send a MIDI Time Code Quarter Frame.
 
void sendMTCQuarterFrame (uint8_t messageType, uint8_t values, Cable cable=CABLE_1)
 Send a MIDI Time Code Quarter Frame.
 
void sendSongPositionPointer (uint16_t spp, Cable cable=CABLE_1)
 Send a MIDI Song Position Pointer message.
 
void sendSongSelect (uint8_t song, Cable cable=CABLE_1)
 Send a MIDI Song Select message.
 
void sendTuneRequest (Cable cable=CABLE_1)
 Send a MIDI Tune Request.
 

Sending MIDI System Exclusive messages

void send (SysExMessage message)
 Send a MIDI System Exclusive message.
 
void sendSysEx (const uint8_t(&sysexdata)[N], Cable cable=CABLE_1)
 Send a MIDI System Exclusive message.
 
void sendSysEx (const uint8_t *data, uint16_t length, Cable cable=CABLE_1)
 Send a MIDI System Exclusive message.
 

Sending MIDI Real-Time messages

void send (RealTimeMessage message)
 Send a MIDI Real-Time message.
 
void sendRealTime (MIDIMessageType rt, Cable cable=CABLE_1)
 Send a MIDI Real-Time message.
 
void sendRealTime (uint8_t rt, Cable cable=CABLE_1)
 Send a MIDI Real-Time message.
 
void sendTimingClock (Cable cable=CABLE_1)
 Send a MIDI Timing Clock message.
 
void sendStart (Cable cable=CABLE_1)
 Send a MIDI Start message.
 
void sendContinue (Cable cable=CABLE_1)
 Send a MIDI Continue message.
 
void sendStop (Cable cable=CABLE_1)
 Send a MIDI Stop message.
 
void sendActiveSensing (Cable cable=CABLE_1)
 Send a MIDI Active Sensing message.
 
void sendSystemReset (Cable cable=CABLE_1)
 Send a MIDI System Reset message.
 

Flusing the MIDI send buffer

void sendNow ()
 Causes all buffered messages to be sent immediately. More...
 

Deprecated

void sendKP (MIDIAddress address, uint8_t pressure)
 Send a MIDI Key Pressure event. More...
 
void sendCC (MIDIAddress address, uint8_t value)
 Send a MIDI Control Change event. More...
 
void sendPC (MIDIAddress address)
 Send a MIDI Program Change event. More...
 
void sendPC (MIDIChannelCable address, uint8_t value)
 Send a MIDI Program Change event. More...
 
void sendCP (MIDIChannelCable address, uint8_t pressure)
 Send a MIDI Channel Pressure event. More...
 
void sendPB (MIDIChannelCable address, uint16_t value)
 Send a MIDI Pitch Bend event. More...
 

Enabling and disabling updatables

void enable ()
 Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
 
void disable ()
 Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
 
bool isEnabled () const
 Check if this updatable is enabled. More...
 
void moveDown ()
 Move down this element in the list.
 
static void enable (UpdatableCRTP *element)
 Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...
 
static void enable (UpdatableCRTP &element)
 Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...
 
template<class U , size_t N>
static void enable (U(&array)[N])
 Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...
 
static void disable (UpdatableCRTP *element)
 Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...
 
static void disable (UpdatableCRTP &element)
 Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...
 
template<class U , size_t N>
static void disable (U(&array)[N])
 Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...
 

Main initialization and updating methods

static void beginAll ()
 Begin all enabled instances of this class. More...
 
static void updateAll ()
 Update all enabled instances of this class. More...
 

Classes

struct  Sender
 Functor to send USB MIDI packets. More...
 

Public Member Functions

template<class... Args>
 GenericUSBMIDI_Interface (Args &&...args)
 Construct a new GenericUSBMIDI_Interface.
 
void update () override
 Read the MIDI interface and call the callback if a message was received. More...
 
void begin () override
 Initialize the MIDI Interface. More...
 

Static Public Member Functions

static void swap (MIDI_Sink &a, MIDI_Sink &b)
 
static void swap (MIDI_Source &a, MIDI_Source &b)
 

Protected Member Functions

void sinkMIDIfromPipe (ChannelMessage msg) override
 Accept an incoming MIDI Channel message from the source pipe. More...
 
void sinkMIDIfromPipe (SysExMessage msg) override
 Accept an incoming MIDI System Exclusive message from the source pipe. More...
 
void sinkMIDIfromPipe (SysCommonMessage msg) override
 Accept an incoming MIDI System Common message from the source pipe. More...
 
void sinkMIDIfromPipe (RealTimeMessage msg) override
 Accept an incoming MIDI Real-Time message from the source pipe. More...
 
void onChannelMessage (ChannelMessage message)
 Call the channel message callback and send the message to the sink pipe.
 
void onSysExMessage (SysExMessage message)
 Call the SysEx message callback and send the message to the sink pipe.
 
void onSysCommonMessage (SysCommonMessage message)
 Call the System Common message callback and send the message to the sink pipe.
 
void onRealTimeMessage (RealTimeMessage message)
 Call the real-time message callback and send the message to the sink pipe.
 
virtual const char * getName () const
 Get the staller's name for debugging purposes.
 

Static Protected Member Functions

template<class MIDIInterface_t >
static void updateIncoming (MIDIInterface_t *iface)
 Read, parse and dispatch incoming MIDI messages on the given interface.
 
template<class MIDIInterface_t >
static void dispatchIncoming (MIDIInterface_t *iface, MIDIReadEvent event)
 Dispatch the given type of MIDI message from the given interface.
 
template<class MIDIInterface_t >
static void handleStall (MIDIInterface_t *iface)
 Un-stall the given MIDI interface. More...
 
static const char * getNameNull (MIDIStaller *s)
 Get the staller's name for debugging purposes. More...
 

Protected Attributes

MIDI_PipesourcePipe = nullptr
 
MIDI_PipesinkPipe = nullptr
 
Derived * next
 
Derived * previous
 

Static Protected Attributes

static DoublyLinkedList< Derived > updatables
 

Private Member Functions

void sendChannelMessageImpl (ChannelMessage) override
 Low-level function for sending a MIDI channel voice message. More...
 
void sendSysCommonImpl (SysCommonMessage) override
 Low-level function for sending a MIDI system common message. More...
 
void sendSysExImpl (SysExMessage) override
 Low-level function for sending a system exclusive MIDI message. More...
 
void sendRealTimeImpl (RealTimeMessage) override
 Low-level function for sending a MIDI real-time message. More...
 
void sendNowImpl () override
 Low-level function for sending any buffered outgoing MIDI messages. More...
 
void handleStall () override
 Call back that should finish any MIDI messages that are in progress, and un-stall the pipe or MIDI source as quickly as possible. More...
 
virtual void stallDownstream (MIDIStaller *, MIDI_Source *)
 Base case for recursive stall function. More...
 
virtual void unstallDownstream (MIDIStaller *, MIDI_Source *)
 Base case for recursive un-stall function. More...
 
virtual MIDI_SinkgetFinalSink ()
 Base case for recursive function. More...
 
void disconnectSourcePipesShallow ()
 Disconnect only the first pipe connected to this sink. More...
 
virtual void stallUpstream (MIDIStaller *, MIDI_Sink *)
 Base case for recursive stall function. More...
 
virtual void unstallUpstream (MIDIStaller *, MIDI_Sink *)
 Base case for recursive un-stall function. More...
 
virtual MIDI_SourcegetInitialSource ()
 Base case for recursive function. More...
 
void disconnectSinkPipesShallow ()
 Disconnect only the first pipe connected to this source. More...
 

Private Attributes

USBMIDI_Parser parser
 Parses USB packets into MIDI messages.
 
USBMIDI_Sender sender
 Sends USB MIDI messages.
 
bool alwaysSendImmediately_ = true
  More...
 
MIDI_Callbackscallbacks = nullptr
 

Static Private Attributes

static MIDI_InterfaceDefaultMIDI_Interface = nullptr
 

Member Function Documentation

◆ sendChannelMessageImpl()

void sendChannelMessageImpl ( ChannelMessage  )
overrideprivatevirtual

Low-level function for sending a MIDI channel voice message.

Implements MIDI_Interface.

Definition at line 55 of file USBMIDI_Interface.ipp.

◆ sendSysCommonImpl()

void sendSysCommonImpl ( SysCommonMessage  )
overrideprivatevirtual

Low-level function for sending a MIDI system common message.

Implements MIDI_Interface.

Definition at line 63 of file USBMIDI_Interface.ipp.

◆ sendSysExImpl()

void sendSysExImpl ( SysExMessage  )
overrideprivatevirtual

Low-level function for sending a system exclusive MIDI message.

Implements MIDI_Interface.

Definition at line 71 of file USBMIDI_Interface.ipp.

◆ sendRealTimeImpl()

void sendRealTimeImpl ( RealTimeMessage  )
overrideprivatevirtual

Low-level function for sending a MIDI real-time message.

Implements MIDI_Interface.

Definition at line 78 of file USBMIDI_Interface.ipp.

◆ sendNowImpl()

void sendNowImpl ( )
inlineoverrideprivatevirtual

Low-level function for sending any buffered outgoing MIDI messages.

Implements MIDI_Interface.

Definition at line 35 of file USBMIDI_Interface.hpp.

◆ handleStall() [1/2]

void handleStall ( )
overrideprivatevirtual

Call back that should finish any MIDI messages that are in progress, and un-stall the pipe or MIDI source as quickly as possible.

Implements MIDIStaller.

Definition at line 23 of file USBMIDI_Interface.ipp.

◆ update()

void update ( )
overridevirtual

Read the MIDI interface and call the callback if a message was received.

Implements MIDI_Interface.

Definition at line 18 of file USBMIDI_Interface.ipp.

◆ read()

Try reading and parsing a single incoming MIDI message.

Returns
Returns the type of the read message, or MIDIReadEvent::NO_MESSAGE if no MIDI message was available.

Definition at line 9 of file USBMIDI_Interface.ipp.

◆ alwaysSendsImmediately()

bool alwaysSendsImmediately ( ) const
inline

Check if this USB interface always sends its USB packets immediately after sending a MIDI message.

The default value depends on the MIDI USB backend being used: true for the MIDIUSB library, and false for the Teensy Core USB MIDI functions (because they have a short timeout).

Definition at line 98 of file USBMIDI_Interface.hpp.

◆ neverSendImmediately()

void neverSendImmediately ( )
inline

Don't send the USB packets immediately after sending a MIDI message.

By disabling immediate transmission, packets are buffered until you call sendNow() or until a timeout is reached, so multiple MIDI messages can be transmitted in a single USB packet. This is more efficient and results in a higher maximum bandwidth, but it could increase latency when used incorrectly.

Definition at line 105 of file USBMIDI_Interface.hpp.

◆ alwaysSendImmediately()

void alwaysSendImmediately ( )
inline

Send the USB packets immediately after sending a MIDI message.

See also
neverSendImmediately()

Definition at line 108 of file USBMIDI_Interface.hpp.

◆ begin()

void begin ( )
inlineoverridevirtualinherited

◆ getDefault()

MIDI_Interface * getDefault ( )
staticinherited

Return the default MIDI interface.

If the default MIDI interface was configured explicitly using setAsDefault(), that interface is returned. If it wasn't set, or if that MIDI interface no longer exists, this function returns the newest MIDI interface, the one that was constructed most recently. If no MIDI interfaces exist, nullptr is returned.

Definition at line 23 of file MIDI_Interface.cpp.

◆ setCallbacks() [1/2]

void setCallbacks ( MIDI_Callbacks cb)
inlineinherited

Set the callbacks that will be called when a MIDI message is received.

Parameters
cbA pointer to the callback object.
Examples
MIDI-Input-Fine-Grained-All-Callbacks.ino, MIDI-Input-Fine-Grained.ino, MIDI-Input.ino, and SysEx-Send-Receive.ino.

Definition at line 58 of file MIDI_Interface.hpp.

◆ setCallbacks() [2/2]

void setCallbacks ( MIDI_Callbacks cb)
inlineinherited

Set the callbacks that will be called when a MIDI message is received.

Parameters
cbA reference to the callback object.

Definition at line 62 of file MIDI_Interface.hpp.

◆ sinkMIDIfromPipe() [1/4]

void sinkMIDIfromPipe ( ChannelMessage  msg)
inlineoverrideprotectedvirtualinherited

Accept an incoming MIDI Channel message from the source pipe.

Implements MIDI_Sink.

Definition at line 81 of file MIDI_Interface.hpp.

◆ sinkMIDIfromPipe() [2/4]

void sinkMIDIfromPipe ( SysExMessage  msg)
inlineoverrideprotectedvirtualinherited

Accept an incoming MIDI System Exclusive message from the source pipe.

Implements MIDI_Sink.

Definition at line 83 of file MIDI_Interface.hpp.

◆ sinkMIDIfromPipe() [3/4]

void sinkMIDIfromPipe ( SysCommonMessage  msg)
inlineoverrideprotectedvirtualinherited

Accept an incoming MIDI System Common message from the source pipe.

Implements MIDI_Sink.

Definition at line 85 of file MIDI_Interface.hpp.

◆ sinkMIDIfromPipe() [4/4]

void sinkMIDIfromPipe ( RealTimeMessage  msg)
inlineoverrideprotectedvirtualinherited

Accept an incoming MIDI Real-Time message from the source pipe.

Implements MIDI_Sink.

Definition at line 87 of file MIDI_Interface.hpp.

◆ handleStall() [2/2]

void handleStall ( MIDIInterface_t *  iface)
staticprotectedinherited

Un-stall the given MIDI interface.

Assumes the interface has been stalled because of a chunked SysEx messages. Waits untill that message is finished.

Definition at line 165 of file MIDI_Interface.hpp.

◆ disconnect() [1/2]

bool disconnect ( TrueMIDI_Source source)
inherited

Disconnect the given source from this sink.

Leaves other sources connected. Returns true if the source was found and disconnected, false if the given source was not a direct or indirect source to this sink.

Definition at line 40 of file MIDI_Pipes.cpp.

◆ disconnect() [2/2]

bool disconnect ( TrueMIDI_Sink sink)
inherited

Disconnect the given sink from this source.

Leaves other sinks connected. Returns true if the sink was found and disconnected, false if the given sink was not a direct or indirect sink of this source.

Definition at line 99 of file MIDI_Pipes.cpp.

◆ stallDownstream()

virtual void stallDownstream ( MIDIStaller ,
MIDI_Source  
)
inlineprivatevirtualinherited

Base case for recursive stall function.

See also
MIDI_Pipe::stallDownstream

Reimplemented in MIDI_Pipe.

Definition at line 127 of file MIDI_Pipes.hpp.

◆ unstallDownstream()

virtual void unstallDownstream ( MIDIStaller ,
MIDI_Source  
)
inlineprivatevirtualinherited

Base case for recursive un-stall function.

See also
MIDI_Pipe::unstallDownstream

Reimplemented in MIDI_Pipe.

Definition at line 130 of file MIDI_Pipes.hpp.

◆ getFinalSink()

virtual MIDI_Sink* getFinalSink ( )
inlineprivatevirtualinherited

Base case for recursive function.

See also
MIDI_Pipe::getFinalSink

Reimplemented in MIDI_Pipe.

Definition at line 133 of file MIDI_Pipes.hpp.

◆ disconnectSourcePipesShallow()

void disconnectSourcePipesShallow ( )
privateinherited

Disconnect only the first pipe connected to this sink.

Leaves the other pipes connected to the original pipe, which doesn't have a sink anymore when this function finishes. Used to disconnect a MIDI_Pipe while preserving the connections of its “through” inputs.

Definition at line 33 of file MIDI_Pipes.cpp.

◆ stall()

void stall ( MIDIStaller cause = eternal_stall)
inherited

Stall this MIDI source.

This means that this becomes the only source that can sink to the sinks connected to this source. Other sources have to wait until this source un-stalls the pipe before they can send again.

Parameters
causePointer to the reason for this stall, can be called back to un-stall the pipes.

Definition at line 157 of file MIDI_Pipes.cpp.

◆ unstall()

void unstall ( MIDIStaller cause = eternal_stall)
inherited

Un-stall the pipes connected to this source, so other sources are allowed to send again.

Parameters
causePointer to the reason for the stall (this has to be the same one that was used to stall).

Definition at line 162 of file MIDI_Pipes.cpp.

◆ getStaller()

MIDIStaller * getStaller ( ) const
inherited

Get a pointer to whatever is causing this MIDI source to be stalled.

There could be multiple stallers, this function just returns one.

Definition at line 173 of file MIDI_Pipes.cpp.

◆ getStallerName()

const char * getStallerName ( ) const
inherited

Get the name of whatever is causing this MIDI source to be stalled.

There could be multiple stallers, this function just returns one.

Definition at line 179 of file MIDI_Pipes.cpp.

◆ stallUpstream()

virtual void stallUpstream ( MIDIStaller ,
MIDI_Sink  
)
inlineprivatevirtualinherited

Base case for recursive stall function.

See also
MIDI_Pipe::stallUpstream

Reimplemented in MIDI_Pipe.

Definition at line 241 of file MIDI_Pipes.hpp.

◆ unstallUpstream()

virtual void unstallUpstream ( MIDIStaller ,
MIDI_Sink  
)
inlineprivatevirtualinherited

Base case for recursive un-stall function.

See also
MIDI_Pipe::unstallUpstream

Reimplemented in MIDI_Pipe.

Definition at line 244 of file MIDI_Pipes.hpp.

◆ getInitialSource()

virtual MIDI_Source* getInitialSource ( )
inlineprivatevirtualinherited

Base case for recursive function.

See also
MIDI_Pipe::getInitialSource

Reimplemented in MIDI_Pipe.

Definition at line 247 of file MIDI_Pipes.hpp.

◆ disconnectSinkPipesShallow()

void disconnectSinkPipesShallow ( )
privateinherited

Disconnect only the first pipe connected to this source.

Leaves the other pipes connected to the original pipe, which doesn't have a source anymore when this function finishes. Used to disconnect a MIDI_Pipe while preserving the connections of its “through” outputs.

Definition at line 92 of file MIDI_Pipes.cpp.

◆ sendChannelMessage() [1/2]

void sendChannelMessage ( MIDIMessageType  m,
Channel  c,
uint8_t  d1,
uint8_t  d2,
Cable  cable = CABLE_1 
)
inherited

Send a 3-byte MIDI Channel Voice message.

Parameters
mMIDI message type. [0x80, 0xE0]
cThe MIDI channel. [1, 16]
d1The first data byte. [0, 127]
d2The second data byte. [0, 127]
cableThe MIDI Cable Number. [CABLE_1, CABLE_16]

Definition at line 33 of file MIDI_Sender.ipp.

◆ sendChannelMessage() [2/2]

void sendChannelMessage ( MIDIMessageType  m,
Channel  c,
uint8_t  d1,
Cable  cable = CABLE_1 
)
inherited

Send a 2-byte MIDI Channel Voice message.

Parameters
mMIDI message type. [0x80, 0xE0]
cThe MIDI channel. [1, 16]
d1The first data byte. [0, 127]
cableThe MIDI Cable Number. [1, 16]

Definition at line 48 of file MIDI_Sender.ipp.

◆ sendNow()

void sendNow
inherited

Causes all buffered messages to be sent immediately.

Note
Doesn't necessarily wait until all data has been sent, it just triggers the transmission, so everything will be transmitted as soon as possible.

Definition at line 142 of file MIDI_Sender.ipp.

◆ sendKP()

void sendKP ( MIDIAddress  address,
uint8_t  pressure 
)
inherited

Send a MIDI Key Pressure event.

Definition at line 152 of file MIDI_Sender.ipp.

◆ sendCC()

void sendCC ( MIDIAddress  address,
uint8_t  value 
)
inherited

Send a MIDI Control Change event.

Definition at line 156 of file MIDI_Sender.ipp.

◆ sendPC() [1/2]

void sendPC ( MIDIAddress  address)
inherited

Send a MIDI Program Change event.

Definition at line 160 of file MIDI_Sender.ipp.

◆ sendPC() [2/2]

void sendPC ( MIDIChannelCable  address,
uint8_t  value 
)
inherited

Send a MIDI Program Change event.

Definition at line 164 of file MIDI_Sender.ipp.

◆ sendCP()

void sendCP ( MIDIChannelCable  address,
uint8_t  pressure 
)
inherited

Send a MIDI Channel Pressure event.

Definition at line 168 of file MIDI_Sender.ipp.

◆ sendPB()

void sendPB ( MIDIChannelCable  address,
uint16_t  value 
)
inherited

Send a MIDI Pitch Bend event.

Definition at line 172 of file MIDI_Sender.ipp.

◆ beginAll()

static void beginAll ( )
inlinestaticinherited

Begin all enabled instances of this class.

See also
begin()
Examples
MIDI-Monitor.ino.

Definition at line 186 of file Updatable.hpp.

◆ updateAll()

static void updateAll ( )
inlinestaticinherited

Update all enabled instances of this class.

See also
update()
Examples
MIDI-Monitor.ino.

Definition at line 190 of file Updatable.hpp.

◆ enable() [1/3]

static void enable ( UpdatableCRTP< Derived > *  element)
inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 129 of file Updatable.hpp.

◆ enable() [2/3]

static void enable ( UpdatableCRTP< Derived > &  element)
inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 131 of file Updatable.hpp.

◆ enable() [3/3]

static void enable ( U(&)  array[N])
inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 134 of file Updatable.hpp.

◆ disable() [1/3]

static void disable ( UpdatableCRTP< Derived > *  element)
inlinestaticinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 140 of file Updatable.hpp.

◆ disable() [2/3]

static void disable ( UpdatableCRTP< Derived > &  element)
inlinestaticinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 142 of file Updatable.hpp.

◆ disable() [3/3]

static void disable ( U(&)  array[N])
inlinestaticinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 145 of file Updatable.hpp.

◆ isEnabled()

bool isEnabled ( ) const
inlineinherited

Check if this updatable is enabled.

Note
Assumes that the updatable is not added to a different linked list by the user.

Definition at line 124 of file Updatable.hpp.

◆ getNameNull()

const char * getNameNull ( MIDIStaller s)
staticinherited

Get the staller's name for debugging purposes.

Correctly deals with null pointers or eternal stallers.

Definition at line 354 of file MIDI_Pipes.cpp.

Member Data Documentation

◆ alwaysSendImmediately_

bool alwaysSendImmediately_ = true
private
See also
neverSendImmediately()

Definition at line 88 of file USBMIDI_Interface.hpp.


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