Collection of tools useful for audio production
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

55 lines
2.8KB

  1. /*! \mainpage The RtAudio Home Page
  2. 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:
  3. <UL>
  4. <LI>object-oriented C++ design</LI>
  5. <LI>simple, common API across all supported platforms</LI>
  6. <LI>only one source and two header files for easy inclusion in programming projects</LI>
  7. <LI>allow simultaneous multi-api support</LI>
  8. <LI>support dynamic connection of devices</LI>
  9. <LI>provide extensive audio device parameter control</LI>
  10. <LI>allow audio device capability probing</LI>
  11. <LI>automatic internal conversion for data format, channel number compensation, (de)interleaving, and byte-swapping</LI>
  12. </UL>
  13. 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.
  14. \section whatsnew What's New (Version 4.0)
  15. RtAudio V4 represents a significant rewrite of the code and includes a number of API and functionality changes from previous versions. A partial list of the changes includes:
  16. - new support for non-interleaved user data
  17. - additional input/output parameter specifications, including channel offset
  18. - new support for dynamic connection of devices
  19. - new support for stream time
  20. - revised callback arguments, including separate input and output buffer arguments
  21. - revised C++ exception handling
  22. - updated support for OSS version 4.0
  23. - discontinued support of blocking functionality
  24. - discontinued support of SGI
  25. Devices are now re-enumerated every time the RtAudio::getDeviceCount(), RtAudio::getDeviceInfo(), and RtAudio::openStream() functions are called. This allows for the proper identification of hot-pluggable (USB, Firewire, ...) devices that are connected after an RtAudio instance is created.
  26. \section download Download
  27. Latest Release (14 June 2012): <A href="http://www.music.mcgill.ca/~gary/rtaudio/release/rtaudio-4.0.11.tar.gz">Version 4.0.11</A>
  28. \section documentation Documentation Links
  29. -# \ref errors
  30. -# \ref probe
  31. -# \ref settings
  32. -# \ref playback
  33. -# \ref recording
  34. -# \ref duplex
  35. -# \ref multi
  36. -# \ref compiling
  37. -# \ref apinotes
  38. -# \ref acknowledge
  39. -# \ref license
  40. -# <A href="bugs.html">Bug Tracker</A>
  41. -# <A href="updates.html">Possible Updates</A>
  42. -# <A href="http://sourceforge.net/projects/rtaudio">RtAudio at SourceForge</A>
  43. */