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 - new functionality to allow error reporting via a client-supplied function (thanks to Pavel Mogilevskiy)
  21 - new function to return the version number
  22 - updated RtAudio.cpp and ASIO files for UNICODE support (thanks to Renaud Schoonbroodt)
  23 - updates to PulseAudio API support (thanks to Peter Meerwald and Tristan Matthews)
  24 - updates for pkg-config support in configure script
  25 - 24-bit format changed to true 24-bit format, not sub-bytes of 32-bits (thanks to Marc Britton)
  26 - bug fixes to make sure stream status is closed if error during probeDeviceOpen
  27 - updates / fixes to SCHED_RR code in ALSA (thanks to Marc Lindahl)
  28 - various changes to avoid global variables (thanks to Martin Koegler)
  29
  30 \section download Download
  31
  32 Latest Release (?? 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</A>
  48 -# <A href="updates.html">Possible Updates</A>
  49 -# <A href="http://sourceforge.net/projects/rtaudio">RtAudio at SourceForge</A>
  50
  51 */