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 - object-oriented C++ design
   6 - simple, common API across all supported platforms
   7 - only one source and one header file for easy inclusion in programming projects
   8 - allow simultaneous multi-api support
   9 - support dynamic connection of devices
  10 - provide extensive audio device parameter control
  11 - allow audio device capability probing
  12 - automatic internal conversion for data format, channel number compensation, (de)interleaving, and byte-swapping
  13
  14 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.
  15
  16 \section whatsnew Latest Updates (Version 5.0.0)
  17
  18 The version number has been bumped to 5.0.0 because of the past API change concerning the renaming of the RtError class to RtAudioError.  Changes in this release include:
  19
  20 - WASAPI updates (thanks to Marcus Tomlinson)
  21 - minor exception semantic changes
  22 - miscellaneous build system updates
  23 - see git history for complete list of changes
  24
  25 \section download Download
  26
  27 Latest Release (30 August 2017): <A href="http://www.music.mcgill.ca/~gary/rtaudio/release/rtaudio-5.0.0.tar.gz">Version 5.0.0</A>
  28
  29 \section documentation Documentation Links
  30
  31 -# \ref errors
  32 -# \ref probe
  33 -# \ref settings
  34 -# \ref playback
  35 -# \ref recording
  36 -# \ref duplex
  37 -# \ref multi
  38 -# \ref compiling
  39 -# \ref apinotes
  40 -# \ref acknowledge
  41 -# \ref license
  42 -# <A href="http://github.com/thestk/rtaudio">RtAudio on GitHub</A>
  43
  44 */
  45
  46 -# <A href="bugs.html">Bug Tracker (out of date)</A>
  47 -# <A href="updates.html">Possible Updates (out of date)</A>