Detailed Description

Functions
bool	MidiInterface< Transport, _Settings, _Platform >::read ()
	Read messages from the serial port using the main input channel.

bool	MidiInterface< Transport, _Settings, _Platform >::read (Channel inChannel)
	Read messages on a specified channel.

MidiType	MidiInterface< Transport, _Settings, _Platform >::getType () const
	Get the last received message's type.

Channel	MidiInterface< Transport, _Settings, _Platform >::getChannel () const
	Get the channel of the message stored in the structure.

DataByte	MidiInterface< Transport, _Settings, _Platform >::getData1 () const
	Get the first data byte of the last received message.

DataByte	MidiInterface< Transport, _Settings, _Platform >::getData2 () const
	Get the second data byte of the last received message.

const byte *	MidiInterface< Transport, _Settings, _Platform >::getSysExArray () const
	Get the System Exclusive byte array.

unsigned	MidiInterface< Transport, _Settings, _Platform >::getSysExArrayLength () const
	Get the length of the System Exclusive array.

bool	MidiInterface< Transport, _Settings, _Platform >::check () const
	Check if a valid message is stored in the structure.

Channel	MidiInterface< Transport, _Settings, _Platform >::getInputChannel () const

void	MidiInterface< Transport, _Settings, _Platform >::setInputChannel (Channel inChannel)
	Set the value for the input MIDI channel.

static MidiType	MidiInterface< Transport, _Settings, _Platform >::getTypeFromStatusByte (byte inStatus)
	Extract an enumerated MIDI type from a status byte.

static Channel	MidiInterface< Transport, _Settings, _Platform >::getChannelFromStatusByte (byte inStatus)
	Returns channel in the range 1-16.

static bool	MidiInterface< Transport, _Settings, _Platform >::isChannelMessage (MidiType inType)

void	MidiInterface< Transport, _Settings, _Platform >::disconnectCallbackFromType (MidiType inType)
	Detach an external function from the given type.

Function Documentation

◆ check()

template<class Transport , class Settings , class Platform >

bool MidiInterface< Transport, Settings, Platform >::check ( ) const

inline

Check if a valid message is stored in the structure.

Definition at line 1187 of file MIDI.hpp.

◆ disconnectCallbackFromType()

template<class Transport , class Settings , class Platform >

void MidiInterface< Transport, Settings, Platform >::disconnectCallbackFromType ( MidiType inType )

inline

Detach an external function from the given type.

Use this method to cancel the effects of setHandle********.

Parameters

inType The type of message to unbind. When a message of this type is received, no function will be called.

Definition at line 1262 of file MIDI.hpp.

◆ getChannel()

template<class Transport , class Settings , class Platform >

Channel MidiInterface< Transport, Settings, Platform >::getChannel ( ) const

inline

Get the channel of the message stored in the structure.

Returns: Channel range is 1 to 16. For non-channel messages, this will return 0.

Definition at line 1145 of file MIDI.hpp.

◆ getChannelFromStatusByte()

template<class Transport , class Settings , class Platform >

Channel MidiInterface< Transport, Settings, Platform >::getChannelFromStatusByte ( byte inStatus )

inlinestatic

Returns channel in the range 1-16.

Definition at line 1236 of file MIDI.hpp.

◆ getData1()

template<class Transport , class Settings , class Platform >

DataByte MidiInterface< Transport, Settings, Platform >::getData1 ( ) const

inline

Get the first data byte of the last received message.

Definition at line 1152 of file MIDI.hpp.

◆ getData2()

template<class Transport , class Settings , class Platform >

DataByte MidiInterface< Transport, Settings, Platform >::getData2 ( ) const

inline

Get the second data byte of the last received message.

Definition at line 1159 of file MIDI.hpp.

◆ getInputChannel()

template<class Transport , class Settings , class Platform >

Channel MidiInterface< Transport, Settings, Platform >::getInputChannel ( ) const

inline

Definition at line 1195 of file MIDI.hpp.

◆ getSysExArray()

template<class Transport , class Settings , class Platform >

const byte * MidiInterface< Transport, Settings, Platform >::getSysExArray ( ) const

inline

Get the System Exclusive byte array.

See also: getSysExArrayLength to get the array's length in bytes.

Definition at line 1169 of file MIDI.hpp.

◆ getSysExArrayLength()

template<class Transport , class Settings , class Platform >

unsigned MidiInterface< Transport, Settings, Platform >::getSysExArrayLength ( ) const

inline

Get the length of the System Exclusive array.

It is coded using data1 as LSB and data2 as MSB.

Returns: The array's length, in bytes.

Definition at line 1180 of file MIDI.hpp.

◆ getType()

template<class Transport , class Settings , class Platform >

MidiType MidiInterface< Transport, Settings, Platform >::getType ( ) const

inline

Get the last received message's type.

Returns an enumerated type.

See also: MidiType

Definition at line 1134 of file MIDI.hpp.

◆ getTypeFromStatusByte()

template<class Transport , class Settings , class Platform >

MidiType MidiInterface< Transport, Settings, Platform >::getTypeFromStatusByte ( byte inStatus )

inlinestatic

Extract an enumerated MIDI type from a status byte.

This is a utility static method, used internally, made public so you can handle MidiTypes more easily.

Definition at line 1218 of file MIDI.hpp.

◆ isChannelMessage()

template<class Transport , class Settings , class Platform >

bool MidiInterface< Transport, Settings, Platform >::isChannelMessage ( MidiType inType )

inlinestatic

Definition at line 1242 of file MIDI.hpp.

◆ read() [1/2]

template<class Transport , class Settings , class Platform >

bool MidiInterface< Transport, Settings, Platform >::read ( )

inline

Read messages from the serial port using the main input channel.

Returns: True if a valid message has been stored in the structure, false if not. A valid message is a message that matches the input channel.

If the Thru is enabled and the message matches the filter, it is sent back on the MIDI output.

See also: see setInputChannel()

Definition at line 704 of file MIDI.hpp.

◆ read() [2/2]

template<class Transport , class Settings , class Platform >

bool MidiInterface< Transport, Settings, Platform >::read ( Channel inChannel )

inline

Read messages on a specified channel.

Definition at line 712 of file MIDI.hpp.

◆ setInputChannel()

template<class Transport , class Settings , class Platform >

void MidiInterface< Transport, Settings, Platform >::setInputChannel ( Channel inChannel )

inline

Set the value for the input MIDI channel.

Parameters

inChannel the channel value. Valid values are 1 to 16, MIDI_CHANNEL_OMNI if you want to listen to all channels, and MIDI_CHANNEL_OFF to disable input.

Definition at line 1205 of file MIDI.hpp.

Detailed Description

Functions

Function Documentation

◆ check()

◆ disconnectCallbackFromType()

◆ getChannel()

◆ getChannelFromStatusByte()

◆ getData1()

◆ getData2()

◆ getInputChannel()

◆ getSysExArray()

◆ getSysExArrayLength()

◆ getType()

◆ getTypeFromStatusByte()

◆ isChannelMessage()

◆ read() [1/2]

◆ read() [2/2]

◆ setInputChannel()