ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

MidiDriver_BASE Class Reference

TODO: Document this, give it a better name. More...

#include <mididrv.h>

Inheritance diagram for MidiDriver_BASE:

List of all members.

Public Member Functions

virtual ~MidiDriver_BASE ()
virtual void send (uint32 b)=0
 Output a packed midi command to the midi stream.
void send (byte status, byte firstOp, byte secondOp)
 Output a midi command to the midi stream.
virtual void sysEx (const byte *msg, uint16 length)
 Transmit a sysEx to the midi device.
virtual void metaEvent (byte type, byte *data, uint16 length)

Detailed Description

TODO: Document this, give it a better name.

Definition at line 87 of file mididrv.h.

Constructor & Destructor Documentation

virtual MidiDriver_BASE::~MidiDriver_BASE (  )  [inline, virtual]

Definition at line 89 of file mididrv.h.

Member Function Documentation

virtual void MidiDriver_BASE::metaEvent ( byte  type,
byte data,
uint16  length 
) [inline, virtual]

Definition at line 123 of file mididrv.h.

void MidiDriver_BASE::send ( byte  status,
byte  firstOp,
byte  secondOp 
) [inline]

Output a midi command to the midi stream.

Convenience wrapper around the usual 'packed' send method.

Do NOT use this for sysEx transmission; instead, use the sysEx() method below.

Definition at line 106 of file mididrv.h.

virtual void MidiDriver_BASE::send ( uint32  b  )  [pure virtual]

Output a packed midi command to the midi stream.

The 'lowest' byte (i.e. b & 0xFF) is the status code, then come (if used) the first and second opcode.

Implemented in MidiDriver_ALSA, MidiDriver_ADLIB, and MidiDriver_NULL.

virtual void MidiDriver_BASE::sysEx ( const byte msg,
uint16  length 
) [inline, virtual]

Transmit a sysEx to the midi device.

The given msg MUST NOT contain the usual SysEx frame, i.e. do NOT include the leading 0xF0 and the trailing 0xF7.

Furthermore, the maximal supported length of a SysEx is 264 bytes. Passing longer buffers can lead to undefined behavior (most likely, a crash).

Reimplemented in MidiDriver_ALSA.

Definition at line 120 of file mididrv.h.

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

Generated on Sat May 18 2019 05:04:55 for ResidualVM by doxygen 1.7.1
curved edge   curved edge