RtMidi Klassenreferenz

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

#include <RtMidi.h>

Klassendiagramm für RtMidi:

Zusammengehörigkeiten von RtMidi:

Aufstellung aller Elemente

Öffentliche Methoden
virtual void	openPort (unsigned int portNumber=0)=0
	Pure virtual openPort() function.
virtual void	openVirtualPort ()=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.
Geschützte Methoden
	RtMidi ()
virtual	~RtMidi ()
void	error (RtError::Type type)
Geschützte Attribute
void *	apiData_
bool	connected_
std::string	errorString_

---

Ausführliche Beschreibung

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-2004 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.

Definiert in Zeile 51 der Datei RtMidi.h.

---

Beschreibung der Konstruktoren und Destruktoren

RtMidi::RtMidi

(

)

[protected]

Definiert in Zeile 49 der Datei RtMidi.cpp.

                : apiData_( 0 ), connected_( false )
{}

virtual RtMidi::~RtMidi

(

)

[inline, protected, virtual]

Definiert in Zeile 78 der Datei RtMidi.h.

        {};

---

Dokumentation der Elementfunktionen

virtual void RtMidi::closePort

(

void

)

[pure virtual]

Pure virtual closePort() function.

Implementiert in RtMidiIn und RtMidiOut.

void RtMidi::error

(

RtError::Type

type

)

[protected]

Definiert in Zeile 53 der Datei RtMidi.cpp.

Benutzt RtError::DEBUG_WARNING, errorString_ und RtError::WARNING.

Wird benutzt von RtMidiIn::cancelCallback(), RtMidiIn::getMessage() und RtMidiIn::setCallback().

{
        if (type == RtError::WARNING) {
                STD_PRE::cerr << '\n' << errorString_.c_str() << "\n\n";
        } else if (type == RtError::DEBUG_WARNING) {
#if defined(__RTMIDI_DEBUG__)
                STD_PRE::cerr << '\n' << errorString_.c_str() << "\n\n";
#endif
        } else {
                STD_PRE::cerr << '\n' << errorString_.c_str() << "\n\n";
                throw RtError( errorString_, type );
        }
}

virtual unsigned int RtMidi::getPortCount

(

)

[pure virtual]

Pure virtual getPortCount() function.

Implementiert in RtMidiIn und RtMidiOut.

virtual std::string RtMidi::getPortName

(

unsigned int

portNumber = 0

)

[pure virtual]

Pure virtual getPortName() function.

Implementiert in RtMidiIn und RtMidiOut.

virtual void RtMidi::openPort

(

unsigned int

portNumber = 0

)

[pure virtual]

Pure virtual openPort() function.

Implementiert in RtMidiIn und RtMidiOut.

virtual void RtMidi::openVirtualPort

(

)

[pure virtual]

Pure virtual openVirtualPort() function.

Implementiert in RtMidiIn und RtMidiOut.

---

Dokumentation der Datenelemente

void* RtMidi::apiData_ [protected]

Definiert in Zeile 86 der Datei RtMidi.h.

bool RtMidi::connected_ [protected]

Definiert in Zeile 87 der Datei RtMidi.h.

std::string RtMidi::errorString_ [protected]

Definiert in Zeile 88 der Datei RtMidi.h.

Wird benutzt von RtMidiIn::cancelCallback(), error(), RtMidiIn::getMessage() und RtMidiIn::setCallback().

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Dateien:

• rtmidi/RtMidi.h
• rtmidi/RtMidi.cpp