Mbed OS Reference
Loading...
Searching...
No Matches
MIDIMessage Class Reference

A MIDI message container. More...

#include <MIDIMessage.h>

Public Types

enum  MIDIMessageType
 MIDI Message Types. More...
 

Public Member Functions

 MIDIMessage (const MIDIMessage &other)
 Copy constructor. More...
 
MIDIMessageoperator= (const MIDIMessage &other)
 Assignment operator. More...
 
void from_raw (uint8_t *buf, int buf_len)
 Set this MIDIMessage to a raw MIDI message. More...
 
MIDIMessageType type ()
 Read the message type. More...
 
int channel ()
 Read the channel number. More...
 
int key ()
 Read the key ID. More...
 
int velocity ()
 Read the velocity. More...
 
int value ()
 Read the controller value. More...
 
int pressure ()
 Read the aftertouch pressure. More...
 
int controller ()
 Read the controller number. More...
 
int program ()
 Read the program number. More...
 
int pitch ()
 Read the pitch value. More...
 

Static Public Member Functions

static MIDIMessage NoteOff (int key, int velocity=127, int channel=0)
 Create a NoteOff message. More...
 
static MIDIMessage NoteOn (int key, int velocity=127, int channel=0)
 Create a NoteOn message. More...
 
static MIDIMessage PolyphonicAftertouch (int key, int pressure, int channel=0)
 Create a PolyPhonic Aftertouch message. More...
 
static MIDIMessage ControlChange (int control, int value, int channel=0)
 Create a Control Change message. More...
 
static MIDIMessage ProgramChange (int program, int channel=0)
 Create a Program Change message. More...
 
static MIDIMessage ChannelAftertouch (int pressure, int channel=0)
 Create a Channel Aftertouch message. More...
 
static MIDIMessage PitchWheel (int pitch=0, int channel=0)
 Create a Pitch Wheel message. More...
 
static MIDIMessage AllNotesOff (int channel=0)
 Create an All Notes Off message. More...
 
static MIDIMessage SysEx (uint8_t *data, int len)
 Create a SysEx message. More...
 

Detailed Description

A MIDI message container.

Definition at line 51 of file MIDIMessage.h.

Member Enumeration Documentation

◆ MIDIMessageType

MIDI Message Types.

Definition at line 255 of file MIDIMessage.h.

Constructor & Destructor Documentation

◆ MIDIMessage()

MIDIMessage ( const MIDIMessage other)

Copy constructor.

Definition at line 66 of file MIDIMessage.h.

Member Function Documentation

◆ operator=()

MIDIMessage & operator= ( const MIDIMessage other)

Assignment operator.

Definition at line 74 of file MIDIMessage.h.

◆ from_raw()

void from_raw ( uint8_t *  buf,
int  buf_len 
)

Set this MIDIMessage to a raw MIDI message.

Parameters
bufis a true MIDI message (not USBMidi message)
buf_lensize of message

Definition at line 95 of file MIDIMessage.h.

◆ NoteOff()

static MIDIMessage NoteOff ( int  key,
int  velocity = 127,
int  channel = 0 
)
static

Create a NoteOff message.

Parameters
keyKey ID
velocityKey velocity (0-127, default = 127)
channelKey channel (0-15, default 0)
Returns
A MIDIMessage

Definition at line 120 of file MIDIMessage.h.

◆ NoteOn()

static MIDIMessage NoteOn ( int  key,
int  velocity = 127,
int  channel = 0 
)
static

Create a NoteOn message.

Parameters
keyKey ID
velocityKey velocity (0-127, default = 127)
channelKey channel (0-15, default 0)
Returns
A MIDIMessage

Definition at line 137 of file MIDIMessage.h.

◆ PolyphonicAftertouch()

static MIDIMessage PolyphonicAftertouch ( int  key,
int  pressure,
int  channel = 0 
)
static

Create a PolyPhonic Aftertouch message.

Parameters
keyKey ID
pressureAftertouch pressure (0-127)
channelKey channel (0-15, default 0)
Returns
A MIDIMessage

Definition at line 154 of file MIDIMessage.h.

◆ ControlChange()

static MIDIMessage ControlChange ( int  control,
int  value,
int  channel = 0 
)
static

Create a Control Change message.

Parameters
controlController ID
valueController value (0-127)
channelController channel (0-15, default 0)
Returns
A MIDIMessage

Definition at line 171 of file MIDIMessage.h.

◆ ProgramChange()

static MIDIMessage ProgramChange ( int  program,
int  channel = 0 
)
static

Create a Program Change message.

Parameters
programProgram ID
channelChannel (0-15, default 0)
Returns
A MIDIMessage

Definition at line 187 of file MIDIMessage.h.

◆ ChannelAftertouch()

static MIDIMessage ChannelAftertouch ( int  pressure,
int  channel = 0 
)
static

Create a Channel Aftertouch message.

Parameters
pressurePressure
channelKey channel (0-15, default 0)
Returns
A MIDIMessage

Definition at line 203 of file MIDIMessage.h.

◆ PitchWheel()

static MIDIMessage PitchWheel ( int  pitch = 0,
int  channel = 0 
)
static

Create a Pitch Wheel message.

Parameters
pitchPitch (-8192 - 8191, default = 0)
channelChannel (0-15, default 0)
Returns
A MIDIMessage

Definition at line 219 of file MIDIMessage.h.

◆ AllNotesOff()

static MIDIMessage AllNotesOff ( int  channel = 0)
static

Create an All Notes Off message.

Parameters
channelChannel (0-15, default 0)
Returns
A MIDIMessage

Definition at line 235 of file MIDIMessage.h.

◆ SysEx()

static MIDIMessage SysEx ( uint8_t *  data,
int  len 
)
static

Create a SysEx message.

Parameters
dataSysEx data (including 0xF0 .. 0xF7)
lenSysEx data length
Returns
A MIDIMessage

Definition at line 245 of file MIDIMessage.h.

◆ type()

MIDIMessageType type ( )

Read the message type.

Returns
MIDIMessageType

Definition at line 273 of file MIDIMessage.h.

◆ channel()

int channel ( )

Read the channel number.

Returns
channel number or -1 on error

Definition at line 355 of file MIDIMessage.h.

◆ key()

int key ( )

Read the key ID.

Returns
key ID or -1 on error

Definition at line 365 of file MIDIMessage.h.

◆ velocity()

int velocity ( )

Read the velocity.

Returns
velocity or -1 on error

Definition at line 382 of file MIDIMessage.h.

◆ value()

int value ( )

Read the controller value.

Returns
controller value or -1 on error

Definition at line 398 of file MIDIMessage.h.

◆ pressure()

int pressure ( )

Read the aftertouch pressure.

Returns
aftertouch pressure or -1 on error

Definition at line 415 of file MIDIMessage.h.

◆ controller()

int controller ( )

Read the controller number.

Returns
controller number or -1 on error

Definition at line 435 of file MIDIMessage.h.

◆ program()

int program ( )

Read the program number.

Returns
program number or -1 on error

Definition at line 452 of file MIDIMessage.h.

◆ pitch()

int pitch ( )

Read the pitch value.

Returns
pitch value or -1 on error

Definition at line 467 of file MIDIMessage.h.