diff options
| author | Gary Scavone <gary@music.mcgill.ca> | 2013-10-11 14:49:10 +0200 |
|---|---|---|
| committer | Stephen Sinclair <sinclair@music.mcgill.ca> | 2013-10-11 14:49:10 +0200 |
| commit | 71b723e4cb7a1b641b5214306e56a1bca5b1b98c (patch) | |
| tree | 98830b2353d96dd99d449c0f34afa961c643a63d /doc | |
| parent | ca0e6a91d0c68ad51c8945f7b1c3a06274e90339 (diff) | |
Version 1.0.3
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/doxygen/tutorial.txt | 6 | ||||
| -rw-r--r-- | doc/release.txt | 3 |
2 files changed, 6 insertions, 3 deletions
diff --git a/doc/doxygen/tutorial.txt b/doc/doxygen/tutorial.txt index ca88fa7..326f641 100644 --- a/doc/doxygen/tutorial.txt +++ b/doc/doxygen/tutorial.txt @@ -19,11 +19,11 @@ MIDI input and output functionality are separated into two classes, RtMidiIn and \section download Download
-Latest Release (21 September 2004): <A href="http://music.mcgill.ca/~gary/rtmidi/release/rtmidi-1.0.2.tar.gz">Version 1.0.2 (111 kB tar/gzipped)</A>
+Latest Release (22 November 2004): <A href="http://music.mcgill.ca/~gary/rtmidi/release/rtmidi-1.0.3.tar.gz">Version 1.0.3</A>
\section start Getting Started
-The first thing that must be done when using RtMidi is to create an instance of the RtMidiIn or RtMidiOut subclasses. RtMidi is an abstract base class, which itself cannot be instantiated. Each default constructor attempts to establish any necessary "connections" with the underlying MIDI system. RtMidi uses C++ exceptions to report errors, necessitating try/catch blocks around many member functions. An RtError can be thrown during instantiation in some circumstances. A warning message may also be reported if no MIDI devices are found during instantiation. The RtMidi classes have been designed to work with "hot pluggable" or virtual (software) MIDI devices, making it is possible to connect or start MIDI devices after the classes have been instantiated. The following code example demonstrates default object construction and destruction:
+The first thing that must be done when using RtMidi is to create an instance of the RtMidiIn or RtMidiOut subclasses. RtMidi is an abstract base class, which itself cannot be instantiated. Each default constructor attempts to establish any necessary "connections" with the underlying MIDI system. RtMidi uses C++ exceptions to report errors, necessitating try/catch blocks around many member functions. An RtError can be thrown during instantiation in some circumstances. A warning message may also be reported if no MIDI devices are found during instantiation. The RtMidi classes have been designed to work with "hot pluggable" or virtual (software) MIDI devices, making it possible to connect to MIDI devices that may not have been present when the classes were instantiated. The following code example demonstrates default object construction and destruction:
\code
@@ -198,7 +198,7 @@ The RtMidiIn class provides the RtMidiIn::ignoreTypes() function to specify that \subsection qmidiin Queued MIDI Input
-The RtMidiIn::getMessage() function does not block. If a MIDI message is available in the queue, it is copied to the user-provided \c std::vector<unsigned char> container. When no MIDI message is available, the function returns an empty container. The default maximum MIDI queue size is 1024 messages. This value may be modified with the RtMidiIn::setQueueSizeLimit() function. If the maximum queue size limit is reached, subsequent MIDI messages are discarded until the queue size is reduced.
+The RtMidiIn::getMessage() function does not block. If a MIDI message is available in the queue, it is copied to the user-provided \c std::vector<unsigned char> container. When no MIDI message is available, the function returns an empty container. The default maximum MIDI queue size is 1024 messages. This value may be modified with the RtMidiIn::setQueueSizeLimit() function. If the maximum queue size limit is reached, subsequent incoming MIDI messages are discarded until the queue size is reduced.
In the following example, we omit some necessary error checking and details regarding OS-dependent sleep functions. For a more complete example, see the \c qmidiin.cpp program in the \c tests directory.
diff --git a/doc/release.txt b/doc/release.txt index 028a2bd..d6e7211 100644 --- a/doc/release.txt +++ b/doc/release.txt @@ -2,6 +2,9 @@ RtMidi - a set of C++ classes which provide a common API for realtime MIDI input By Gary P. Scavone, 2003-2004.
+v1.0.3: (22 November 2004)
+- added common pure virtual functions to RtMidi abstract base class
+
v1.0.2: (21 September 2004)
- added warning messages to openVirtualPort() functions in Windows and Irix (where it can't be implemented)
|
