Home   Information   Classes   Download   Usage   Mail List   Requirements   Links   FAQ   Tutorial


RtMidi Class Reference

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

#include <RtMidi.h>

Inheritance diagram for RtMidi:
RtMidiIn RtMidiOut

List of all members.

Public Types

enum  Api {
  UNSPECIFIED, MACOSX_CORE, LINUX_ALSA, UNIX_JACK,
  WINDOWS_MM, WINDOWS_KS, RTMIDI_DUMMY
}
 

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.

Static Public Member Functions

static void getCompiledApi (std::vector< RtMidi::Api > &apis) throw ()
 A static function to determine the available compiled MIDI APIs.
static void error (RtError::Type type, std::string errorString)
 A basic error reporting function for RtMidi classes.

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 WWW site: http://music.mcgill.ca/~gary/rtmidi/

RtMidi: realtime MIDI i/o C++ classes Copyright (c) 2003-2012 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

MIDI API specifier arguments.

Enumerator:
UNSPECIFIED 

Search for a working compiled API.

MACOSX_CORE 

Macintosh OS-X Core Midi 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.

WINDOWS_KS 

The Microsoft Kernel Streaming MIDI API.

RTMIDI_DUMMY 

A compilable but non-functional API.

00057            {
00058     UNSPECIFIED,    
00059     MACOSX_CORE,    
00060     LINUX_ALSA,     
00061     UNIX_JACK,      
00062     WINDOWS_MM,     
00063     WINDOWS_KS,     
00064     RTMIDI_DUMMY    
00065   };


Member Function Documentation

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.


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

The Synthesis ToolKit in C++ (STK)
©1995-2012 Perry R. Cook and Gary P. Scavone. All Rights Reserved.