SysCommonMessage Struct Reference

#include <MIDI_Parsers/MIDI_MessageTypes.hpp>

Detailed Description

Examples

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

Definition at line 234 of file MIDI_MessageTypes.hpp.

Inheritance diagram for SysCommonMessage:

Collaboration diagram for SysCommonMessage:

Public Member Functions
	SysCommonMessage (MIDIMessageType type, uint8_t data1=0x00, uint8_t data2=0x00, Cable cable=CABLE_1)
	Constructor.
	SysCommonMessage (MIDIMessageType type, uint8_t data1, Cable cable)
	Constructor.
	SysCommonMessage (MIDIMessageType type, Cable cable)
	Constructor.
	SysCommonMessage (const MIDIMessage &msg)
MIDIMessageType	getMessageType () const
	Get the MIDI message type.
uint8_t	getNumberOfDataBytes () const
	Get the number of data bytes of this type of System Common message.
	MIDIMessage (uint8_t header, uint8_t data1, uint8_t data2, Cable cable=CABLE_1)
	Constructor.
	MIDIMessage (MIDIMessageType header, uint8_t data1, uint8_t data2, Cable cable=CABLE_1)
	Constructor.
bool	operator== (MIDIMessage other) const
	Check for equality.
bool	operator!= (MIDIMessage other) const
	Check for inequality.
void	setMessageType (MIDIMessageType type)
	Set the MIDI message type. More...
uint8_t	getData1 () const
	Get the first data byte.
uint8_t	getData2 () const
	Get the second data byte.
void	setData1 (uint8_t data)
	Set the first data byte.
void	setData2 (uint8_t data)
	Set the second data byte.
Cable	getCable () const
	Get the MIDI USB cable number of the message.
void	setCable (Cable cable)
	Set the MIDI USB cable number of the message.
bool	hasValidChannelMessageHeader () const
	Check whether the header is a valid header for a channel message.
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.
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.
void	sanitize ()
	Make sure that the status byte has the most significant bit set and the data bytes have the most significant bits cleared.

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

Static Public Attributes
constexpr static auto	MTC_QUARTER_FRAME
	More...
constexpr static auto	SONG_POSITION_POINTER
	More...
constexpr static auto	SONG_SELECT = MIDIMessageType::SONG_SELECT
constexpr static auto	UNDEFINED_SYSCOMMON_1
	More...
constexpr static auto	UNDEFINED_SYSCOMMON_2
	More...
constexpr static auto	TUNE_REQUEST = MIDIMessageType::TUNE_REQUEST

Member Function Documentation

setMessageType()

void setMessageType ( MIDIMessageType  type )

inlineinherited

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.

hasValidSystemCommonHeader()

bool hasValidSystemCommonHeader ( ) const

inlineinherited

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.

Member Data Documentation

MTC_QUARTER_FRAME

constexpr static auto MTC_QUARTER_FRAME

staticconstexpr

Initial value:

=
        MIDIMessageType::MTC_QUARTER_FRAME

Definition at line 265 of file MIDI_MessageTypes.hpp.

SONG_POSITION_POINTER

constexpr static auto SONG_POSITION_POINTER

staticconstexpr

Initial value:

=
        MIDIMessageType::SONG_POSITION_POINTER

Definition at line 267 of file MIDI_MessageTypes.hpp.

UNDEFINED_SYSCOMMON_1

constexpr static auto UNDEFINED_SYSCOMMON_1

staticconstexpr

Initial value:

=
        MIDIMessageType::UNDEFINED_SYSCOMMON_1

Definition at line 270 of file MIDI_MessageTypes.hpp.

UNDEFINED_SYSCOMMON_2

constexpr static auto UNDEFINED_SYSCOMMON_2

staticconstexpr

Initial value:

=
        MIDIMessageType::UNDEFINED_SYSCOMMON_2

Definition at line 272 of file MIDI_MessageTypes.hpp.

---

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

• MIDI_MessageTypes.hpp