RtMidi Class Reference

An abstract base class for realtime MIDI input/output. More...

#include <RtMidi.h>

Inheritance diagram for RtMidi:

Public Types
enum	Api {   UNSPECIFIED , MACOSX_CORE , LINUX_ALSA , UNIX_JACK ,   WINDOWS_MM , RTMIDI_DUMMY , WEB_MIDI_API , WINDOWS_UWP ,   ANDROID_AMIDI , NUM_APIS }
	MIDI API specifier arguments. More...

Public Member Functions
virtual void	openPort (unsigned int portNumber=0, const std::string &portName=std::string("RtMidi"))=0
	Pure virtual openPort() function.
virtual void	openVirtualPort (const std::string &portName=std::string("RtMidi"))=0
	Pure virtual openVirtualPort() function.
virtual unsigned int	getPortCount ()=0
	Pure virtual getPortCount() function.
virtual std::string	getPortName (unsigned int portNumber=0)=0
	Pure virtual getPortName() function.
virtual void	closePort (void)=0
	Pure virtual closePort() function.
virtual bool	isPortOpen (void) const =0
	Returns true if a port is open and false if not.
virtual void	setErrorCallback (RtMidiErrorCallback errorCallback=NULL, void *userData=0)=0
	Set an error callback function to be invoked when an error has occurred.

Static Public Member Functions
static std::string	getVersion (void) throw ()
	A static function to determine the current RtMidi version.
static void	getCompiledApi (std::vector< RtMidi::Api > &apis) throw ()
	A static function to determine the available compiled MIDI APIs.
static std::string	getApiName (RtMidi::Api api)
	Return the name of a specified compiled MIDI API.
static std::string	getApiDisplayName (RtMidi::Api api)
	Return the display name of a specified compiled MIDI API.
static RtMidi::Api	getCompiledApiByName (const std::string &name)
	Return the compiled MIDI API having the given name.

Detailed Description

An abstract base class for realtime MIDI input/output.

This class implements some common functionality for the realtime MIDI input/output subclasses RtMidiIn and RtMidiOut.

RtMidi GitHub site: https://github.com/thestk/rtmidi RtMidi WWW site: http://www.music.mcgill.ca/~gary/rtmidi/

RtMidi: realtime MIDI i/o C++ classes Copyright (c) 2003-2023 Gary P. Scavone

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

Any person wishing to distribute modifications to the Software is asked to send the modifications to the original developer so that they can be incorporated into the canonical version. This is, however, not a binding provision of this license.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Member Enumeration Documentation

Api

enum RtMidi::Api

MIDI API specifier arguments.

Enumerator
UNSPECIFIED	Search for a working compiled API.
MACOSX_CORE	Macintosh OS-X CoreMIDI API.
LINUX_ALSA	The Advanced Linux Sound Architecture API.
UNIX_JACK	The JACK Low-Latency MIDI Server API.
WINDOWS_MM	The Microsoft Multimedia MIDI API.
RTMIDI_DUMMY	A compilable but non-functional API.
WEB_MIDI_API	W3C Web MIDI API.
WINDOWS_UWP	The Microsoft Universal Windows Platform MIDI API.
ANDROID_AMIDI	Native Android MIDI API.
NUM_APIS	Number of values in this enum.

Member Function Documentation

getCompiledApi()

static void RtMidi::getCompiledApi ( std::vector< RtMidi::Api > & apis ) throw (  )

static

A static function to determine the available compiled MIDI APIs.

The values returned in the std::vector can be compared against the enumerated list values. Note that there can be more than one API compiled for certain operating systems.

getApiName()

static std::string RtMidi::getApiName ( RtMidi::Api api )

static

Return the name of a specified compiled MIDI API.

This obtains a short lower-case name used for identification purposes. This value is guaranteed to remain identical across library versions. If the API is unknown, this function will return the empty string.

getApiDisplayName()

static std::string RtMidi::getApiDisplayName ( RtMidi::Api api )

static

Return the display name of a specified compiled MIDI API.

This obtains a long name used for display purposes. If the API is unknown, this function will return the empty string.

getCompiledApiByName()

static RtMidi::Api RtMidi::getCompiledApiByName ( const std::string & name )

static

Return the compiled MIDI API having the given name.

A case insensitive comparison will check the specified name against the list of compiled APIs, and return the one which matches. On failure, the function returns UNSPECIFIED.

isPortOpen()

virtual bool RtMidi::isPortOpen ( void ) const

pure virtual

Returns true if a port is open and false if not.

Note that this only applies to connections made with the openPort() function, not to virtual ports.

Implemented in RtMidiIn, and RtMidiOut.

setErrorCallback()

virtual void RtMidi::setErrorCallback ( RtMidiErrorCallback errorCallback = NULL, void * userData = 0 )

pure virtual

Set an error callback function to be invoked when an error has occurred.

The callback function will be called whenever an error has occurred. It is best to set the error callback function before opening a port.

Implemented in RtMidiIn, and RtMidiOut.

---

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

• RtMidi.h