RtMidi Class Reference

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

#include <RtMidi.h>

Inheritance diagram for RtMidi:

Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual void openPort (unsigned int portNumber=0)=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.

Protected Member Functions

 RtMidi ()
virtual ~RtMidi ()
void error (RtError::Type type)

Protected Attributes

void * apiData_
bool connected_
std::string errorString_


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-2007 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 requested to send the modifications to the original developer so that they can be incorporated into the canonical version.

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.

Definition at line 46 of file RtMidi.h.


Constructor & Destructor Documentation

RtMidi::RtMidi (  )  [protected]

Definition at line 47 of file RtMidi.cpp.

virtual RtMidi::~RtMidi (  )  [inline, protected, virtual]

Definition at line 68 of file RtMidi.h.


Member Function Documentation

virtual void RtMidi::openPort ( unsigned int  portNumber = 0  )  [pure virtual]

Pure virtual openPort() function.

Implemented in RtMidiIn, and RtMidiOut.

virtual void RtMidi::openVirtualPort ( const std::string  portName = std::string("RtMidi")  )  [pure virtual]

Pure virtual openVirtualPort() function.

Implemented in RtMidiIn, and RtMidiOut.

virtual unsigned int RtMidi::getPortCount (  )  [pure virtual]

Pure virtual getPortCount() function.

Implemented in RtMidiIn, and RtMidiOut.

virtual std::string RtMidi::getPortName ( unsigned int  portNumber = 0  )  [pure virtual]

Pure virtual getPortName() function.

Implemented in RtMidiIn, and RtMidiOut.

virtual void RtMidi::closePort ( void   )  [pure virtual]

Pure virtual closePort() function.

Implemented in RtMidiIn, and RtMidiOut.

void RtMidi::error ( RtError::Type  type  )  [protected]

Definition at line 52 of file RtMidi.cpp.

References RtError::DEBUG_WARNING, errorString_, and RtError::WARNING.

Referenced by RtMidiIn::cancelCallback(), RtMidiIn::getMessage(), and RtMidiIn::setCallback().

Here is the caller graph for this function:


Member Data Documentation

void* RtMidi::apiData_ [protected]

Definition at line 75 of file RtMidi.h.

bool RtMidi::connected_ [protected]

Definition at line 76 of file RtMidi.h.

std::string RtMidi::errorString_ [protected]

Definition at line 77 of file RtMidi.h.

Referenced by RtMidiIn::cancelCallback(), error(), RtMidiIn::getMessage(), and RtMidiIn::setCallback().


The documentation for this class was generated from the following files:
Generated on Sat Feb 9 13:24:47 2008 for Canorus by  doxygen 1.5.3