summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGary Scavone <gary@music.mcgill.ca>2013-12-27 11:30:37 -0800
committerGary Scavone <gary@music.mcgill.ca>2013-12-27 11:30:37 -0800
commit07c639e41165da70aab5016adf1bf7133a418b31 (patch)
tree23134f770f593643c52f9ca458f06c23fc3d0873 /doc
parenta16508efc3f1ce9dee8f8d760ed68626b34881df (diff)
Renamed RtError class to RtAudioError and embedded it in RtAudio.h.
Deleted RtError.h from distribution and renamed all references to RtError in the documentation, test files, and Windows .dsp files. The version number was incremented to 4.1.0 in anticipation of the next release, as this change affects the API.
Diffstat (limited to 'doc')
-rw-r--r--doc/doxygen/compiling.txt2
-rw-r--r--doc/doxygen/duplex.txt4
-rw-r--r--doc/doxygen/playback.txt4
-rw-r--r--doc/doxygen/recording.txt4
-rw-r--r--doc/doxygen/settings.txt4
-rw-r--r--doc/doxygen/tutorial.txt2
-rw-r--r--doc/release.txt5
7 files changed, 14 insertions, 11 deletions
diff --git a/doc/doxygen/compiling.txt b/doc/doxygen/compiling.txt
index c1f83e4..9e9cab2 100644
--- a/doc/doxygen/compiling.txt
+++ b/doc/doxygen/compiling.txt
@@ -78,7 +78,7 @@ In order to compile RtAudio for a specific OS and audio API, it is necessary to
</TABLE>
<P>
-The example compiler statements above could be used to compile the <TT>audioprobe.cpp</TT> example file, assuming that <TT>audioprobe.cpp</TT>, <TT>RtAudio.h</TT>, <tt>RtError.h</tt>, and <TT>RtAudio.cpp</TT> all exist in the same directory.
+The example compiler statements above could be used to compile the <TT>audioprobe.cpp</TT> example file, assuming that <TT>audioprobe.cpp</TT>, <TT>RtAudio.h</TT> and <TT>RtAudio.cpp</TT> all exist in the same directory.
*/
diff --git a/doc/doxygen/duplex.txt b/doc/doxygen/duplex.txt
index c76ae73..2777fdc 100644
--- a/doc/doxygen/duplex.txt
+++ b/doc/doxygen/duplex.txt
@@ -40,7 +40,7 @@ int main()
try {
adac.openStream( &oParams, &iParams, RTAUDIO_SINT32, 44100, &bufferFrames, &inout, (void *)&bufferBytes );
}
- catch ( RtError& e ) {
+ catch ( RtAudioError& e ) {
e.printMessage();
exit( 0 );
}
@@ -57,7 +57,7 @@ int main()
// Stop the stream.
adac.stopStream();
}
- catch ( RtError& e ) {
+ catch ( RtAudioError& e ) {
e.printMessage();
goto cleanup;
}
diff --git a/doc/doxygen/playback.txt b/doc/doxygen/playback.txt
index c291f5a..cf182a6 100644
--- a/doc/doxygen/playback.txt
+++ b/doc/doxygen/playback.txt
@@ -52,7 +52,7 @@ int main()
sampleRate, &bufferFrames, &saw, (void *)&data );
dac.startStream();
}
- catch ( RtError& e ) {
+ catch ( RtAudioError& e ) {
e.printMessage();
exit( 0 );
}
@@ -65,7 +65,7 @@ int main()
// Stop the stream
dac.stopStream();
}
- catch (RtError& e) {
+ catch (RtAudioError& e) {
e.printMessage();
}
diff --git a/doc/doxygen/recording.txt b/doc/doxygen/recording.txt
index 9b62438..69b4e3e 100644
--- a/doc/doxygen/recording.txt
+++ b/doc/doxygen/recording.txt
@@ -40,7 +40,7 @@ int main()
sampleRate, &bufferFrames, &record );
adc.startStream();
}
- catch ( RtError& e ) {
+ catch ( RtAudioError& e ) {
e.printMessage();
exit( 0 );
}
@@ -53,7 +53,7 @@ int main()
// Stop the stream
adc.stopStream();
}
- catch (RtError& e) {
+ catch (RtAudioError& e) {
e.printMessage();
}
diff --git a/doc/doxygen/settings.txt b/doc/doxygen/settings.txt
index d7cc1d2..54cb38b 100644
--- a/doc/doxygen/settings.txt
+++ b/doc/doxygen/settings.txt
@@ -24,7 +24,7 @@ int main()
dac.openStream( &parameters, NULL, RTAUDIO_FLOAT32,
sampleRate, &bufferFrames, &myCallback, NULL, &options );
}
- catch ( RtError& e ) {
+ catch ( RtAudioError& e ) {
std::cout << '\n' << e.getMessage() << '\n' << std::endl;
exit( 0 );
}
@@ -33,7 +33,7 @@ int main()
}
\endcode
-The RtAudio::openStream() function attempts to open a stream with a specified set of parameter values. In the above example, we attempt to open a two channel playback stream using the default output device, 32-bit floating point data, a sample rate of 44100 Hz, and a frame rate of 256 sample frames per output buffer. If the user specifies an invalid parameter value (such as a device id greater than or equal to the number of enumerated devices), an RtError is thrown of type = INVALID_USE. If a system error occurs or the device does not support the specified parameter values, an RtError of type = SYSTEM_ERROR is thrown. In either case, a descriptive error message is bundled with the exception and can be queried with the RtError::getMessage() or RtError::what() functions.
+The RtAudio::openStream() function attempts to open a stream with a specified set of parameter values. In the above example, we attempt to open a two channel playback stream using the default output device, 32-bit floating point data, a sample rate of 44100 Hz, and a frame rate of 256 sample frames per output buffer. If the user specifies an invalid parameter value (such as a device id greater than or equal to the number of enumerated devices), an RtAudioError is thrown of type = INVALID_USE. If a system error occurs or the device does not support the specified parameter values, an RtAudioError of type = SYSTEM_ERROR is thrown. In either case, a descriptive error message is bundled with the exception and can be queried with the RtAudioError::getMessage() or RtAudioError::what() functions.
RtAudio provides four signed integer and two floating point data formats which can be specified using the RtAudioFormat parameter values mentioned earlier. If the opened device does not natively support the given format, RtAudio will automatically perform the necessary data format conversion.
diff --git a/doc/doxygen/tutorial.txt b/doc/doxygen/tutorial.txt
index 6581774..be72425 100644
--- a/doc/doxygen/tutorial.txt
+++ b/doc/doxygen/tutorial.txt
@@ -5,7 +5,7 @@ RtAudio is a set of C++ classes that provide a common API (Application Programmi
<UL>
<LI>object-oriented C++ design</LI>
<LI>simple, common API across all supported platforms</LI>
- <LI>only one source and two header files for easy inclusion in programming projects</LI>
+ <LI>only one source and one header file for easy inclusion in programming projects</LI>
<LI>allow simultaneous multi-api support</LI>
<LI>support dynamic connection of devices</LI>
<LI>provide extensive audio device parameter control</LI>
diff --git a/doc/release.txt b/doc/release.txt
index b9ba915..7cbd9df 100644
--- a/doc/release.txt
+++ b/doc/release.txt
@@ -1,6 +1,9 @@
RtAudio - a set of C++ classes that provide a common API for realtime audio input/output across Linux (native ALSA, JACK, PulseAudio, and OSS), Macintosh OS X (CoreAudio and JACK), and Windows (DirectSound and ASIO) operating systems.
-By Gary P. Scavone, 2001-2013.
+By Gary P. Scavone, 2001-2014.
+
+v4.1.0: (?? 2014)
+- RtError class renamed RtAudioError and embedded in RtAudio.h (RtError.h deleted)
v4.0.12: (16 April 2013)
- new functionality to allow error reporting via a client-supplied function (thanks to Pavel Mogilevskiy)