doc/doxygen/tutorial.txt

   1 /*! \mainpage The RtAudio Home Page
   2
   3 RtAudio is a set of C++ classes that provide a common API (Application Programming Interface) for realtime audio input/output across Linux, Macintosh OS-X and Windows operating systems.  RtAudio significantly simplifies the process of interacting with computer audio hardware.  It was designed with the following objectives:
   4
   5 <UL>
   6   <LI>object-oriented C++ design</LI>
   7   <LI>simple, common API across all supported platforms</LI>
   8   <LI>only one source and one header file for easy inclusion in programming projects</LI>
   9   <LI>allow simultaneous multi-api support</LI>
  10   <LI>support dynamic connection of devices</LI>
  11   <LI>provide extensive audio device parameter control</LI>
  12   <LI>allow audio device capability probing</LI>
  13   <LI>automatic internal conversion for data format, channel number compensation, (de)interleaving, and byte-swapping</LI>
  14 </UL>
  15
  16 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.
  17
  18 \section whatsnew Latest Updates (Version 4.1.0)
  19
  20 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.
  21
  22 Other changes in this release include:
  23
  24 - new support for the Windows WASAPI API (thanks to Marcus Tomlinson)
  25 - pulse audio update to support bufferFrames argument with audio input (thanks to Jonatan Wallmander)
  26 - fixes for ALSA API to avoid high CPU usage during stops and to clear stale data before input (thanks to Pluto Hades)
  27 - miscellaneous efficiency updates suggested by Martin Koegler
  28 - bug fix for OS-X xrun reporting problem
  29
  30 \section download Download
  31
  32 Latest Release (?? April 2014): <A href="http://www.music.mcgill.ca/~gary/rtaudio/release/rtaudio-4.1.0.tar.gz">Version 4.1.0</A>
  33
  34 \section documentation Documentation Links
  35
  36 -# \ref errors
  37 -# \ref probe
  38 -# \ref settings
  39 -# \ref playback
  40 -# \ref recording
  41 -# \ref duplex
  42 -# \ref multi
  43 -# \ref compiling
  44 -# \ref apinotes
  45 -# \ref acknowledge
  46 -# \ref license
  47 -# <A href="bugs.html">Bug Tracker (out of date)</A>
  48 -# <A href="updates.html">Possible Updates (out of date)</A>
  49 -# <A href="http://github.com/thestk/rtaudio">RtAudio on GitHub</A>
  50
  51 */