#include <MIDI_Parsers/MIDI_MessageTypes.hpp>

Detailed Description

Examples: MIDI-Input-Callback.ino, MIDI-Input.ino, MIDI-Monitor-OLED.ino, MIDI_Pipes-Filter.ino, and Mackie-Control-Universal-Reverse-Engineering.ino.

Definition at line 205 of file MIDI_MessageTypes.hpp.

Inheritance diagram for ChannelMessage:

Collaboration diagram for ChannelMessage:

Public Member Functions
	ChannelMessage (MIDIMessageType type, Channel channel, uint8_t data1, uint8_t data2=0x00, Cable cable=Cable_1)
	Constructor.

	ChannelMessage (const MIDIMessage &msg)

MIDIMessageType	getMessageType () const
	Get the MIDI message type.

void	setMessageType (MIDIMessageType type)
	Set the MIDI message type.

Channel	getChannel () const
	Get the MIDI channel of the message.

void	setChannel (Channel channel)
	Set the MIDI channel of the message.

MIDIChannelCable	getChannelCable () const
	Get the MIDI channel and cable number.

MIDIAddress	getAddress () const
	Get the MIDI address of this message, using `data1` as the address.

bool	hasTwoDataBytes () const
	Check whether this message has one or two data bytes.

	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.

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.

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
static constexpr auto	NoteOff = MIDIMessageType::NoteOff

static constexpr auto	NoteOn = MIDIMessageType::NoteOn

static constexpr auto	KeyPressure = MIDIMessageType::KeyPressure

static constexpr auto	ControlChange = MIDIMessageType::ControlChange

static constexpr auto	ProgramChange = MIDIMessageType::ProgramChange

static constexpr auto	ChannelPressure = MIDIMessageType::ChannelPressure

static constexpr auto	PitchBend = MIDIMessageType::PitchBend

Constructor & Destructor Documentation

◆ ChannelMessage() [1/2]

ChannelMessage	(	MIDIMessageType	type,
		Channel	channel,
		uint8_t	data1,
		uint8_t	data2 = 0x00,
		Cable	cable = Cable_1 )

inline

Constructor.

Definition at line 209 of file MIDI_MessageTypes.hpp.

◆ ChannelMessage() [2/2]

ChannelMessage ( const MIDIMessage & msg )

inlineexplicit

Definition at line 213 of file MIDI_MessageTypes.hpp.

Member Function Documentation

◆ getMessageType()

MIDIMessageType getMessageType ( ) const

inline

Get the MIDI message type.

Examples: MIDI-Monitor-OLED.ino, MIDI_Pipes-Filter.ino, and Mackie-Control-Universal-Reverse-Engineering.ino.

Definition at line 216 of file MIDI_MessageTypes.hpp.

◆ setMessageType()

void setMessageType ( MIDIMessageType type )

inline

Set the MIDI message type.

Definition at line 220 of file MIDI_MessageTypes.hpp.

◆ getChannel()

Channel getChannel ( ) const

inline

Get the MIDI channel of the message.

Examples: MIDI-Monitor-OLED.ino.

Definition at line 226 of file MIDI_MessageTypes.hpp.

◆ setChannel()

void setChannel ( Channel channel )

inline

Set the MIDI channel of the message.

Examples: MIDI_Pipes-Filter.ino.

Definition at line 228 of file MIDI_MessageTypes.hpp.

◆ getChannelCable()

MIDIChannelCable getChannelCable ( ) const

inline

Get the MIDI channel and cable number.

Note: Valid for all MIDI Channel messages, including Channel Pressure and Pitch Bend.

Definition at line 236 of file MIDI_MessageTypes.hpp.

◆ getAddress()

MIDIAddress getAddress ( ) const

inline

Get the MIDI address of this message, using data1 as the address.

Note: Don't use this for Channel Pressure or Pitch Bend messages, as data1 will have a different meaning in those cases.

Definition at line 240 of file MIDI_MessageTypes.hpp.

◆ hasTwoDataBytes()

bool hasTwoDataBytes ( ) const

inline

Check whether this message has one or two data bytes.

2 data bytes: Note On/Off, Aftertouch, Control Change or Pitch Bend
1 data byte: Program Change or Channel Pressure

Returns false if the header is a SysEx, Real-Time or System Common byte.

Examples: MIDI-Monitor-OLED.ino.

Definition at line 248 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 117 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 122 of file MIDI_MessageTypes.hpp.

◆ operator==()

bool operator== ( MIDIMessage other ) const

inlineinherited

Check for equality.

Definition at line 133 of file MIDI_MessageTypes.hpp.

◆ operator!=()

bool operator!= ( MIDIMessage other ) const

inlineinherited

Check for inequality.

Definition at line 138 of file MIDI_MessageTypes.hpp.

◆ getData1()

uint8_t getData1 ( ) const

inlineinherited

Get the first data byte.

Examples: MIDI-Monitor-OLED.ino, and Mackie-Control-Universal-Reverse-Engineering.ino.

Definition at line 156 of file MIDI_MessageTypes.hpp.

◆ getData2()

uint8_t getData2 ( ) const

inlineinherited

Get the second data byte.

Examples: MIDI-Monitor-OLED.ino, and Mackie-Control-Universal-Reverse-Engineering.ino.

Definition at line 158 of file MIDI_MessageTypes.hpp.

◆ setData1()

void setData1 ( uint8_t data )

inlineinherited

Set the first data byte.

Definition at line 160 of file MIDI_MessageTypes.hpp.

◆ setData2()

void setData2 ( uint8_t data )

inlineinherited

Set the second data byte.

Definition at line 162 of file MIDI_MessageTypes.hpp.

◆ getCable()

Cable getCable ( ) const

inlineinherited

Get the MIDI USB cable number of the message.

Examples: MIDI-Monitor-OLED.ino.

Definition at line 165 of file MIDI_MessageTypes.hpp.

◆ setCable()

void setCable ( Cable cable )

inlineinherited

Set the MIDI USB cable number of the message.

Definition at line 167 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 170 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 180 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.

Examples: MIDI-Monitor-OLED.ino.

Definition at line 186 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 191 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 198 of file MIDI_MessageTypes.hpp.

Member Data Documentation

◆ NoteOff

constexpr auto NoteOff = MIDIMessageType::NoteOff

staticconstexpr

Definition at line 254 of file MIDI_MessageTypes.hpp.

◆ NoteOn

constexpr auto NoteOn = MIDIMessageType::NoteOn

staticconstexpr

Definition at line 255 of file MIDI_MessageTypes.hpp.

◆ KeyPressure

constexpr auto KeyPressure = MIDIMessageType::KeyPressure

staticconstexpr

Definition at line 256 of file MIDI_MessageTypes.hpp.

◆ ControlChange

constexpr auto ControlChange = MIDIMessageType::ControlChange

staticconstexpr

Definition at line 257 of file MIDI_MessageTypes.hpp.

◆ ProgramChange

constexpr auto ProgramChange = MIDIMessageType::ProgramChange

staticconstexpr

Definition at line 258 of file MIDI_MessageTypes.hpp.

◆ ChannelPressure

constexpr auto ChannelPressure = MIDIMessageType::ChannelPressure

staticconstexpr

Definition at line 259 of file MIDI_MessageTypes.hpp.

◆ PitchBend

constexpr auto PitchBend = MIDIMessageType::PitchBend

staticconstexpr

Examples: MIDI-Monitor-OLED.ino.

Definition at line 260 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, MIDI-Monitor-OLED.ino, and Mackie-Control-Universal-Reverse-Engineering.ino.

Definition at line 126 of file MIDI_MessageTypes.hpp.

◆ data1

uint8_t data1

inherited

First MIDI data byte.

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

Definition at line 127 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 128 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 130 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

◆ ChannelMessage() [1/2]

◆ ChannelMessage() [2/2]

Member Function Documentation

◆ getMessageType()

◆ setMessageType()

◆ getChannel()

◆ setChannel()

◆ getChannelCable()

◆ getAddress()

◆ hasTwoDataBytes()

◆ MIDIMessage() [1/2]

◆ MIDIMessage() [2/2]

◆ operator==()

◆ operator!=()

◆ getData1()

◆ getData2()

◆ setData1()

◆ setData2()

◆ getCable()

◆ setCable()

◆ hasValidChannelMessageHeader()

◆ hasValidSystemCommonHeader()

◆ getData14bit()

◆ setData14bit()

◆ sanitize()

Member Data Documentation

◆ NoteOff

◆ NoteOn

◆ KeyPressure

◆ ControlChange

◆ ProgramChange

◆ ChannelPressure

◆ PitchBend

◆ header

◆ data1

◆ data2

◆ cable