summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGary Scavone <gary@music.mcgill.ca>2009-01-29 19:00:08 +0000
committerStephen Sinclair <sinclair@music.mcgill.ca>2013-10-11 01:38:24 +0200
commitad768de27c78093a6000a4f00d1baeca8ca5ce37 (patch)
treeebddb56a9c682726a8bc2219f498ad8ca54926fb /doc
parentd80e83b7145a6c2ecaa6d7fc6ade83ef124515a1 (diff)
Various updates and fixes before 4.0.5 release (GS).
Diffstat (limited to 'doc')
-rw-r--r--doc/doxygen/compiling.txt2
-rw-r--r--doc/doxygen/duplex.txt2
-rw-r--r--doc/doxygen/playback.txt1
-rw-r--r--doc/doxygen/recording.txt2
-rw-r--r--doc/doxygen/tutorial.txt2
-rw-r--r--doc/release.txt3
6 files changed, 9 insertions, 3 deletions
diff --git a/doc/doxygen/compiling.txt b/doc/doxygen/compiling.txt
index d7b9a29..79cb314 100644
--- a/doc/doxygen/compiling.txt
+++ b/doc/doxygen/compiling.txt
@@ -2,7 +2,7 @@
\section debug Debugging
-If you are having problems getting RtAudio to run on your system, make sure to pass a value of \e true to the RtAudio::showWarnings() function (this is the default setting). A variety of warning messages will be displayed which may help in determining the problem. Also, try using the programs included in the <tt>tests</tt> directory. The program <tt>audioprobe</tt> displays the queried capabilities of all hardware devices found for all APIs compiled. When using the ALSA API, further information can be displayed by defining the preprocessor definition __RTAUDIO_DEBUG__.
+If you are having problems getting RtAudio to run on your system, make sure to pass a value of \e true to the RtAudio::showWarnings() function (this is the default setting). A variety of warning messages will be displayed which may help in determining the problem. Also, try using the programs included in the <tt>tests</tt> directory. The program <tt>audioprobe</tt> displays the queried capabilities of all hardware devices found for all APIs compiled. When using the ALSA and JACK APIs, further information can be displayed by defining the preprocessor definition __RTAUDIO_DEBUG__.
\section compile Compiling
diff --git a/doc/doxygen/duplex.txt b/doc/doxygen/duplex.txt
index f060602..c76ae73 100644
--- a/doc/doxygen/duplex.txt
+++ b/doc/doxygen/duplex.txt
@@ -5,6 +5,8 @@ Finally, it is easy to use RtAudio for simultaneous audio input/output, or duple
\code
#include "RtAudio.h"
#include <iostream>
+#include <cstdlib>
+#include <cstring>
// Pass-through function.
int inout( void *outputBuffer, void *inputBuffer, unsigned int nBufferFrames,
diff --git a/doc/doxygen/playback.txt b/doc/doxygen/playback.txt
index 4d5a793..c291f5a 100644
--- a/doc/doxygen/playback.txt
+++ b/doc/doxygen/playback.txt
@@ -5,6 +5,7 @@ In this example, we provide a complete program that demonstrates the use of RtAu
\code
#include "RtAudio.h"
#include <iostream>
+#include <cstdlib>
// Two-channel sawtooth wave generator.
int saw( void *outputBuffer, void *inputBuffer, unsigned int nBufferFrames,
diff --git a/doc/doxygen/recording.txt b/doc/doxygen/recording.txt
index 6316a5c..9b62438 100644
--- a/doc/doxygen/recording.txt
+++ b/doc/doxygen/recording.txt
@@ -6,6 +6,8 @@ Using RtAudio for audio input is almost identical to the way it is used for play
\code
#include "RtAudio.h"
#include <iostream>
+#include <cstdlib>
+#include <cstring>
int record( void *outputBuffer, void *inputBuffer, unsigned int nBufferFrames,
double streamTime, RtAudioStreamStatus status, void *userData )
diff --git a/doc/doxygen/tutorial.txt b/doc/doxygen/tutorial.txt
index b42a945..02e3bcb 100644
--- a/doc/doxygen/tutorial.txt
+++ b/doc/doxygen/tutorial.txt
@@ -32,7 +32,7 @@ Devices are now re-enumerated every time the RtAudio::getDeviceCount(), RtAudio:
\section download Download
-Latest Release (?? January 2009): <A href="http://www.music.mcgill.ca/~gary/rtaudio/release/rtaudio-4.0.5.tar.gz">Version 4.0.5</A>
+Latest Release (29 January 2009): <A href="http://www.music.mcgill.ca/~gary/rtaudio/release/rtaudio-4.0.5.tar.gz">Version 4.0.5</A>
\section documentation Documentation Links
diff --git a/doc/release.txt b/doc/release.txt
index 70f82c7..42a3fa9 100644
--- a/doc/release.txt
+++ b/doc/release.txt
@@ -2,11 +2,12 @@ RtAudio - a set of C++ classes that provide a common API for realtime audio inpu
By Gary P. Scavone, 2001-2009.
-v4.0.5: (?? January 2009)
+v4.0.5: (29 January 2009)
- added support in CoreAudio for arbitrary stream channel configurations
- added getStreamSampleRate() function because the actual sample rate can sometimes vary slightly from the specified one (thanks to Theo Veenker)
- added new StreamOptions flag "RTAUDIO_SCHEDULE_REALTIME" and attribute "priority" to StreamOptions (thanks to Theo Veenker)
- replaced usleep(50000) in callbackEvent() by a wait on condition variable which gets signaled in startStream() (thanks to Theo Veenker)
+- fix for Jack API when user callback function signals stop or abort calls
- fix to way stream state is changed to avoid infinite loop problem
- fix to int<->float conversion in convertBuffer() (thanks to Theo Veenker)
- bug fix in byteSwapBuffer() (thanks to Stefan Muller Arisona and Theo Veenker)