#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. More...

	SysCommonMessage (MIDIMessageType type, uint8_t data1, Cable cable)
	Constructor. More...

	SysCommonMessage (MIDIMessageType type, Cable cable)
	Constructor. More...

	SysCommonMessage (const MIDIMessage &msg)

MIDIMessageType	getMessageType () const
	Get the MIDI message type. More...

uint8_t	getNumberOfDataBytes () const
	Get the number of data bytes of this type of System Common message. More...

	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...

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...

Static Public Attributes
static constexpr auto	MTC_QUARTER_FRAME

static constexpr auto	SONG_POSITION_POINTER

static constexpr auto	SONG_SELECT = MIDIMessageType::SONG_SELECT

static constexpr auto	UNDEFINED_SYSCOMMON_1

static constexpr auto	UNDEFINED_SYSCOMMON_2

static constexpr auto	TUNE_REQUEST = MIDIMessageType::TUNE_REQUEST

Constructor & Destructor Documentation

◆ SysCommonMessage() [1/4]

SysCommonMessage	(	MIDIMessageType	type,
		uint8_t	data1 = `0x00`,
		uint8_t	data2 = `0x00`,
		Cable	cable = `CABLE_1`
	)

inline

Constructor.

Definition at line 238 of file MIDI_MessageTypes.hpp.

◆ SysCommonMessage() [2/4]

SysCommonMessage	(	MIDIMessageType	type,
		uint8_t	data1,
		Cable	cable
	)

inline

Constructor.

Definition at line 242 of file MIDI_MessageTypes.hpp.

◆ SysCommonMessage() [3/4]

SysCommonMessage	(	MIDIMessageType	type,
		Cable	cable
	)

inline

Constructor.

Definition at line 245 of file MIDI_MessageTypes.hpp.

◆ SysCommonMessage() [4/4]

SysCommonMessage ( const MIDIMessage & msg )

inlineexplicit

Definition at line 248 of file MIDI_MessageTypes.hpp.

Member Function Documentation

◆ getMessageType()

MIDIMessageType getMessageType ( ) const

inline

Get the MIDI message type.

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

Definition at line 251 of file MIDI_MessageTypes.hpp.

◆ getNumberOfDataBytes()

uint8_t getNumberOfDataBytes ( ) const

inline

Get the number of data bytes of this type of System Common message.

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

Definition at line 256 of file MIDI_MessageTypes.hpp.

◆ 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.

◆ operator==()

bool operator== ( MIDIMessage other ) const

inlineinherited

Check for equality.

Definition at line 103 of file MIDI_MessageTypes.hpp.

◆ operator!=()

bool operator!= ( MIDIMessage other ) const

inlineinherited

Check for inequality.

Definition at line 108 of file MIDI_MessageTypes.hpp.

◆ 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.

◆ getData1()

uint8_t getData1 ( ) const

inlineinherited

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

inlineinherited

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 )

inlineinherited

Set the first data byte.

Definition at line 130 of file MIDI_MessageTypes.hpp.

◆ setData2()

void setData2 ( uint8_t data )

inlineinherited

Set the second data byte.

Definition at line 132 of file MIDI_MessageTypes.hpp.

◆ getCable()

Cable getCable ( ) const

inlineinherited

Get the MIDI USB cable number of the message.

Definition at line 135 of file MIDI_MessageTypes.hpp.

◆ setCable()

void setCable ( Cable cable )

inlineinherited

Set the MIDI USB cable number of the message.

Definition at line 137 of file MIDI_MessageTypes.hpp.

◆ hasValidChannelMessageHeader()

bool hasValidChannelMessageHeader ( ) const

inlineinherited

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

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.

◆ getData14bit()

uint16_t getData14bit ( ) const

inlineinherited

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 )

inlineinherited

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 ( )

inlineinherited

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

◆ MTC_QUARTER_FRAME

constexpr auto MTC_QUARTER_FRAME

staticconstexpr

Initial value:

=

MIDIMessageType::MTC_QUARTER_FRAME

@ MTC_QUARTER_FRAME

Definition at line 265 of file MIDI_MessageTypes.hpp.

◆ SONG_POSITION_POINTER

constexpr auto SONG_POSITION_POINTER

staticconstexpr

Initial value:

=

MIDIMessageType::SONG_POSITION_POINTER

@ SONG_POSITION_POINTER

Definition at line 267 of file MIDI_MessageTypes.hpp.

◆ SONG_SELECT

constexpr auto SONG_SELECT = MIDIMessageType::SONG_SELECT

staticconstexpr

Definition at line 269 of file MIDI_MessageTypes.hpp.

◆ UNDEFINED_SYSCOMMON_1

constexpr auto UNDEFINED_SYSCOMMON_1

staticconstexpr

Initial value:

=

MIDIMessageType::UNDEFINED_SYSCOMMON_1

@ UNDEFINED_SYSCOMMON_1

Definition at line 270 of file MIDI_MessageTypes.hpp.

◆ UNDEFINED_SYSCOMMON_2

constexpr auto UNDEFINED_SYSCOMMON_2

staticconstexpr

Initial value:

=

MIDIMessageType::UNDEFINED_SYSCOMMON_2

@ UNDEFINED_SYSCOMMON_2

Definition at line 272 of file MIDI_MessageTypes.hpp.

◆ TUNE_REQUEST

constexpr auto TUNE_REQUEST = MIDIMessageType::TUNE_REQUEST

staticconstexpr

Definition at line 274 of file MIDI_MessageTypes.hpp.

◆ header

uint8_t header

inherited

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

inherited

First MIDI data byte.

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

Definition at line 97 of file MIDI_MessageTypes.hpp.

◆ data2

uint8_t data2

inherited

First MIDI data byte.

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

Definition at line 98 of file MIDI_MessageTypes.hpp.

◆ cable

Cable cable

inherited

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:

MIDI_MessageTypes.hpp

Detailed Description

Public Member Functions

Public Attributes

Static Public Attributes

Constructor & Destructor Documentation

◆ SysCommonMessage() [1/4]

◆ SysCommonMessage() [2/4]

◆ SysCommonMessage() [3/4]

◆ SysCommonMessage() [4/4]

Member Function Documentation

◆ getMessageType()

◆ getNumberOfDataBytes()

◆ MIDIMessage() [1/2]

◆ MIDIMessage() [2/2]

◆ operator==()

◆ operator!=()

◆ setMessageType()

◆ getData1()

◆ getData2()

◆ setData1()

◆ setData2()

◆ getCable()

◆ setCable()

◆ hasValidChannelMessageHeader()

◆ hasValidSystemCommonHeader()

◆ getData14bit()

◆ setData14bit()

◆ sanitize()

Member Data Documentation

◆ MTC_QUARTER_FRAME

◆ SONG_POSITION_POINTER

◆ SONG_SELECT

◆ UNDEFINED_SYSCOMMON_1

◆ UNDEFINED_SYSCOMMON_2

◆ TUNE_REQUEST

◆ header

◆ data1

◆ data2

◆ cable