diff options
| author | Stephen Sinclair <radarsat1@gmail.com> | 2017-10-18 10:15:54 -0300 |
|---|---|---|
| committer | Stephen Sinclair <radarsat1@gmail.com> | 2017-10-18 10:16:04 -0300 |
| commit | 853e5b7cde233394a80acbf5ae169a416c8ee105 (patch) | |
| tree | dda91a4638db6b31e50ff65b2d4e9062a2b104b3 /readme | |
| parent | 8b543a2850d9d24f85cca9229169fe5027ab863e (diff) | |
Reformat readme as markdown.
Diffstat (limited to 'readme')
| -rw-r--r-- | readme | 61 |
1 files changed, 0 insertions, 61 deletions
@@ -1,61 +0,0 @@ -RtAudio - a set of C++ classes that provide a common API for realtime audio input/output across Linux (native ALSA, JACK, PulseAudio and OSS), Macintosh OS X (CoreAudio and JACK), and Windows (DirectSound, ASIO and WASAPI) operating systems. - -By Gary P. Scavone, 2001-2017 (and many other developers!) - -This distribution of RtAudio contains the following: - -doc: RtAudio documentation (see doc/html/index.html) -tests: example RtAudio programs -include: header and source files necessary for ASIO, DS & OSS compilation -tests/Windows: Visual C++ .net test program workspace and projects - -OVERVIEW: - -RtAudio is a set of C++ classes that provides a common API (Application Programming Interface) for realtime audio input/output across Linux (native ALSA, JACK, PulseAudio and OSS), Macintosh OS X and Windows (DirectSound, ASIO and WASAPI) operating systems. RtAudio significantly simplifies the process of interacting with computer audio hardware. It was designed with the following objectives: - - - object-oriented C++ design - - simple, common API across all supported platforms - - only one source and one header file for easy inclusion in programming projects - - allow simultaneous multi-api support - - support dynamic connection of devices - - provide extensive audio device parameter control - - allow audio device capability probing - - automatic internal conversion for data format, channel number compensation, (de)interleaving, and byte-swapping - -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. - -FURTHER READING: - -For complete documentation on RtAudio, see the doc directory of the distribution or surf to http://www.music.mcgill.ca/~gary/rtaudio/. - - -LEGAL AND ETHICAL: - -The RtAudio license is similar to the MIT License. - - RtAudio: a set of realtime audio i/o C++ classes - Copyright (c) 2001-2017 Gary P. Scavone - - Permission is hereby granted, free of charge, to any person - obtaining a copy of this software and associated documentation files - (the "Software"), to deal in the Software without restriction, - including without limitation the rights to use, copy, modify, merge, - publish, distribute, sublicense, and/or sell copies of the Software, - and to permit persons to whom the Software is furnished to do so, - subject to the following conditions: - - The above copyright notice and this permission notice shall be - included in all copies or substantial portions of the Software. - - Any person wishing to distribute modifications to the Software is - asked to send the modifications to the original developer so that - they can be incorporated into the canonical version. This is, - however, not a binding provision of this license. - - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR - ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF - CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION - WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
