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.

51 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.1.0)
  13. Changes in this release include:
  14. - new C API wrapper
  15. - new static functions to get API names
  16. - many WASAPI updates (thanks to Marcus Tomlinson)
  17. - miscellaneous build system updates
  18. - bug fix for stream ticking in CoreAudio if using two devices for duplex
  19. - ALSA stream handle bug fixes
  20. - see git history for complete list of changes
  21. \section download Download
  22. Latest Release (17 April 2019): <A href="http://www.music.mcgill.ca/~gary/rtaudio/release/rtaudio-5.1.0.tar.gz">Version 5.1.0</A>
  23. \section documentation Documentation Links
  24. -# \ref errors
  25. -# \ref probe
  26. -# \ref settings
  27. -# \ref playback
  28. -# \ref recording
  29. -# \ref duplex
  30. -# \ref multi
  31. -# \ref compiling
  32. -# \ref apinotes
  33. -# \ref acknowledge
  34. -# \ref license
  35. -# <A href="http://github.com/thestk/rtaudio">RtAudio on GitHub</A>
  36. */
  37. -# <A href="bugs.html">Bug Tracker (out of date)</A>
  38. -# <A href="updates.html">Possible Updates (out of date)</A>