Update to CMake file for WASAPI; documentation update for CMake; finalized date for...

[rtaudio-cdist.git] / doc / doxygen / tutorial.txt

diff --git a/doc/doxygen/tutorial.txt b/doc/doxygen/tutorial.txt
index 65817742e1f1159baa90670fb90fada4b751553c..fc1a226fdb74edf3559f3fa0467745b5dd5a32ac 100644 (file)
--- 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>
@@ -15,21 +15,23 @@ RtAudio is a set of C++ classes that provide a common API (Application Programmi
 
 RtAudio incorporates the concept of audio streams, which represent audio output (playback) and/or input (recording).  Available audio devices and their capabilities can be enumerated and then specified when opening a stream.  Where applicable, multiple API support can be compiled and a particular API specified when creating an RtAudio instance.  See the \ref apinotes section for information specific to each of the supported audio APIs.
 
-\section whatsnew Latest Updates (Version 4.0.12)
+\section whatsnew Latest Updates (Version 4.1.0)
 
-- new functionality to allow error reporting via a client-supplied function (thanks to Pavel Mogilevskiy)
-- new function to return the version number
-- updated RtAudio.cpp and ASIO files for UNICODE support (thanks to Renaud Schoonbroodt)
-- updates to PulseAudio API support (thanks to Peter Meerwald and Tristan Matthews)
-- updates for pkg-config support in configure script
-- 24-bit format changed to true 24-bit format, not sub-bytes of 32-bits (thanks to Marc Britton)
-- bug fixes to make sure stream status is closed if error during probeDeviceOpen
-- updates / fixes to SCHED_RR code in ALSA (thanks to Marc Lindahl)
-- various changes to avoid global variables (thanks to Martin Koegler)
+A minor API change was made. The RtError class was renamed RtAudioError and embedded directly in RtAudio.h.  Thus, all references to RtError should be renamed to RtAudioError and the RtError.h file should be deleted.
+
+Other changes in this release include:
+
+- new support for the Windows WASAPI API (thanks to Marcus Tomlinson)
+- CMake support (thanks to Berkus Decker)
+- pulse audio update to support bufferFrames argument with audio input (thanks to Jonatan Wallmander)
+- fixes for ALSA API to avoid high CPU usage during stops and to clear stale data before input (thanks to Pluto Hades)
+- miscellaneous efficiency updates suggested by Martin Koegler
+- bug fix for OS-X xrun reporting problem
+- bug fix if error when opening a stream after closing a previously open stream
 
 \section download Download
 
-Latest Release (16 April 2013): <A href="http://www.music.mcgill.ca/~gary/rtaudio/release/rtaudio-4.0.12.tar.gz">Version 4.0.12</A>
+Latest Release (10 April 2014): <A href="http://www.music.mcgill.ca/~gary/rtaudio/release/rtaudio-4.1.0.tar.gz">Version 4.1.0</A>
 
 \section documentation Documentation Links
 
@@ -44,8 +46,8 @@ Latest Release (16 April 2013): <A href="http://www.music.mcgill.ca/~gary/rtaudi
 -# \ref apinotes
 -# \ref acknowledge
 -# \ref license
--# <A href="bugs.html">Bug Tracker</A>
--# <A href="updates.html">Possible Updates</A>
--# <A href="http://sourceforge.net/projects/rtaudio">RtAudio at SourceForge</A>
+-# <A href="bugs.html">Bug Tracker (out of date)</A>
+-# <A href="updates.html">Possible Updates (out of date)</A>
+-# <A href="http://github.com/thestk/rtaudio">RtAudio on GitHub</A>
 
 */