RtMidi.h File Reference

#include <atomic>
#include <exception>
#include <iostream>
#include <string>
#include <vector>

Go to the source code of this file.

Classes
class	rt::midi::RtMidiError
	Exception handling class for RtMidi. More...
class	rt::midi::RtMidi
	An abstract base class for realtime MIDI input/output. More...
struct	rt::midi::RtMidi::RtMidiApiAvailability
	Result returned by checkApiAvailability(). More...
class	rt::midi::RtMidiIn
	A realtime MIDI input class. More...
class	rt::midi::RtMidiOut
	A realtime MIDI output class. More...
class	rt::midi::MidiApi
class	rt::midi::MidiInApi
struct	rt::midi::MidiInApi::MidiMessage
struct	rt::midi::MidiInApi::MidiQueue
struct	rt::midi::MidiInApi::RtMidiInData
class	rt::midi::MidiOutApi

Typedefs
typedef void(*	rt::midi::RtMidiErrorCallback) (RtMidiError::Type type, const std::string &errorText, void *userData)
	RtMidi error callback function prototype.

---

Class Documentation

rt::midi::RtMidi::RtMidiApiAvailability

struct rt::midi::RtMidi::RtMidiApiAvailability

Result returned by checkApiAvailability().

Class Members
bool	available = true	True when the API runtime is ready to use.
string	message	Human-readable reason if not available.
string	installUrl	Installer download URL when a runtime is missing.

Typedef Documentation

RtMidiErrorCallback

typedef void(* rt::midi::RtMidiErrorCallback) (RtMidiError::Type type, const std::string &errorText, void *userData)

RtMidi error callback function prototype.

Parameters

type	Type of error.
errorText	Error description.

Note that class behaviour is undefined after a critical error (not a warning) is reported.