Control Surface master
MIDI Control Surface library for Arduino
Public Member Functions | Public Attributes | List of all members
MIDIMessage Struct Reference

#include <MIDI_Parsers/MIDI_MessageTypes.hpp>

Detailed Description

Definition at line 85 of file MIDI_MessageTypes.hpp.

+ Inheritance diagram for MIDIMessage:
+ Collaboration diagram for MIDIMessage:

Public Member Functions

 MIDIMessage (uint8_t header, uint8_t data1, uint8_t data2, Cable cable=CABLE_1)
 Constructor. More...
 
 MIDIMessage (MIDIMessageType header, uint8_t data1, uint8_t data2, Cable cable=CABLE_1)
 Constructor. More...
 
bool operator== (MIDIMessage other) const
 Check for equality. More...
 
bool operator!= (MIDIMessage other) const
 Check for inequality. More...
 
MIDIMessageType getMessageType () const
 Get the MIDI message type. More...
 
void setMessageType (MIDIMessageType type)
 Set the MIDI message type. More...
 
uint8_t getData1 () const
 Get the first data byte. More...
 
uint8_t getData2 () const
 Get the second data byte. More...
 
void setData1 (uint8_t data)
 Set the first data byte. More...
 
void setData2 (uint8_t data)
 Set the second data byte. More...
 
Cable getCable () const
 Get the MIDI USB cable number of the message. More...
 
void setCable (Cable cable)
 Set the MIDI USB cable number of the message. More...
 
bool hasValidChannelMessageHeader () const
 Check whether the header is a valid header for a channel message. More...
 
bool hasValidSystemCommonHeader () const
 Check whether the header is a valid header for a System Common message. More...
 
uint16_t getData14bit () const
 If Data 1 and Data 2 represent a single 14-bit number, you can use this method to retrieve that number. More...
 
void setData14bit (uint16_t data)
 If Data 1 and Data 2 represent a single 14-bit number, you can use this method to set that number. More...
 
void sanitize ()
 Make sure that the status byte has the most significant bit set and the data bytes have the most significant bits cleared. More...
 

Public Attributes

uint8_t header
 MIDI status byte (message type and channel). More...
 
uint8_t data1
 First MIDI data byte. More...
 
uint8_t data2
 First MIDI data byte. More...
 
Cable cable
 USB MIDI cable number;. More...
 

Constructor & Destructor Documentation

◆ MIDIMessage() [1/2]

MIDIMessage ( uint8_t  header,
uint8_t  data1,
uint8_t  data2,
Cable  cable = CABLE_1 
)
inline

Constructor.

Definition at line 87 of file MIDI_MessageTypes.hpp.

◆ MIDIMessage() [2/2]

MIDIMessage ( MIDIMessageType  header,
uint8_t  data1,
uint8_t  data2,
Cable  cable = CABLE_1 
)
inline

Constructor.

Definition at line 92 of file MIDI_MessageTypes.hpp.

Member Function Documentation

◆ operator==()

bool operator== ( MIDIMessage  other) const
inline

Check for equality.

Definition at line 103 of file MIDI_MessageTypes.hpp.

◆ operator!=()

bool operator!= ( MIDIMessage  other) const
inline

Check for inequality.

Definition at line 108 of file MIDI_MessageTypes.hpp.

◆ getMessageType()

MIDIMessageType getMessageType ( ) const
inline

Get the MIDI message type.

Definition at line 111 of file MIDI_MessageTypes.hpp.

◆ setMessageType()

void setMessageType ( MIDIMessageType  type)
inline

Set the MIDI message type.

Note
Do not use this version for Channel Messages, it doesn't correctly handle the channel.

Definition at line 121 of file MIDI_MessageTypes.hpp.

◆ getData1()

uint8_t getData1 ( ) const
inline

Get the first data byte.

Examples
Mackie-Control-Universal-Reverse-Engineering.ino.

Definition at line 126 of file MIDI_MessageTypes.hpp.

◆ getData2()

uint8_t getData2 ( ) const
inline

Get the second data byte.

Examples
Mackie-Control-Universal-Reverse-Engineering.ino.

Definition at line 128 of file MIDI_MessageTypes.hpp.

◆ setData1()

void setData1 ( uint8_t  data)
inline

Set the first data byte.

Definition at line 130 of file MIDI_MessageTypes.hpp.

◆ setData2()

void setData2 ( uint8_t  data)
inline

Set the second data byte.

Definition at line 132 of file MIDI_MessageTypes.hpp.

◆ getCable()

Cable getCable ( ) const
inline

Get the MIDI USB cable number of the message.

Definition at line 135 of file MIDI_MessageTypes.hpp.

◆ setCable()

void setCable ( Cable  cable)
inline

Set the MIDI USB cable number of the message.

Definition at line 137 of file MIDI_MessageTypes.hpp.

◆ hasValidChannelMessageHeader()

bool hasValidChannelMessageHeader ( ) const
inline

Check whether the header is a valid header for a channel message.

Definition at line 140 of file MIDI_MessageTypes.hpp.

◆ hasValidSystemCommonHeader()

bool hasValidSystemCommonHeader ( ) const
inline

Check whether the header is a valid header for a System Common message.

Note
SysExEnd is considered a System Common message by the MIDI Standard, SysExStart is not.
Reserved System Common messages are also considered valid System Common messages.

Definition at line 150 of file MIDI_MessageTypes.hpp.

◆ getData14bit()

uint16_t getData14bit ( ) const
inline

If Data 1 and Data 2 represent a single 14-bit number, you can use this method to retrieve that number.

Definition at line 156 of file MIDI_MessageTypes.hpp.

◆ setData14bit()

void setData14bit ( uint16_t  data)
inline

If Data 1 and Data 2 represent a single 14-bit number, you can use this method to set that number.

Definition at line 161 of file MIDI_MessageTypes.hpp.

◆ sanitize()

void sanitize ( )
inline

Make sure that the status byte has the most significant bit set and the data bytes have the most significant bits cleared.

Definition at line 168 of file MIDI_MessageTypes.hpp.

Member Data Documentation

◆ header

uint8_t header

MIDI status byte (message type and channel).

Examples
MIDI-Input-Callback.ino, MIDI-Input.ino, and Mackie-Control-Universal-Reverse-Engineering.ino.

Definition at line 96 of file MIDI_MessageTypes.hpp.

◆ data1

uint8_t data1

◆ data2

uint8_t data2

◆ cable

Cable cable

USB MIDI cable number;.

Examples
MIDI-Input-Callback.ino, MIDI-Input.ino, and Mackie-Control-Universal-Reverse-Engineering.ino.

Definition at line 100 of file MIDI_MessageTypes.hpp.


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