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.

48 lines
2.2KB

  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. - object-oriented C++ design
  4. - simple, common API across all supported platforms
  5. - only one source and one header file for easy inclusion in programming projects
  6. - allow simultaneous multi-api support
  7. - support dynamic connection of devices
  8. - provide extensive audio device parameter control
  9. - allow audio device capability probing
  10. - automatic internal conversion for data format, channel number compensation, (de)interleaving, and byte-swapping
  11. 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.
  12. \section whatsnew Latest Updates (Version 5.0.0)
  13. 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:
  14. - WASAPI updates (thanks to Marcus Tomlinson)
  15. - minor exception semantic changes
  16. - miscellaneous build system updates
  17. - see git history for complete list of changes
  18. \section download Download
  19. 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>
  20. \section documentation Documentation Links
  21. -# \ref errors
  22. -# \ref probe
  23. -# \ref settings
  24. -# \ref playback
  25. -# \ref recording
  26. -# \ref duplex
  27. -# \ref multi
  28. -# \ref compiling
  29. -# \ref apinotes
  30. -# \ref acknowledge
  31. -# \ref license
  32. -# <A href="http://github.com/thestk/rtaudio">RtAudio on GitHub</A>
  33. */
  34. -# <A href="bugs.html">Bug Tracker (out of date)</A>
  35. -# <A href="updates.html">Possible Updates (out of date)</A>