diff options
Diffstat (limited to 'portaudio/doc/src/mainpage.dox')
| -rw-r--r-- | portaudio/doc/src/mainpage.dox | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/portaudio/doc/src/mainpage.dox b/portaudio/doc/src/mainpage.dox new file mode 100644 index 0000000..53e0060 --- /dev/null +++ b/portaudio/doc/src/mainpage.dox @@ -0,0 +1,63 @@ +/* doxygen index page */ +/** @mainpage + +@section overview Overview + +PortAudio is a cross-platform, open-source C language library for real-time audio input and output. +The library provides functions that allow your software to acquire and output real-time audio streams from your computer's hardware audio interfaces. It is designed to simplify writing cross-platform audio applications, and also to simplify the development of audio software in general by hiding the complexities of dealing directly with each native audio API. PortAudio is used to implement sound recording, editing and mixing applications, software synthesizers, effects processors, music players, internet telephony applications, software defined radios and more. Supported platforms include MS Windows, Mac OS X and Linux. Third-party language bindings make it possible to call PortAudio from other programming languages including @ref java_binding "Java", C++, C#, Python, PureBasic, FreePascal and Lazarus. + +@section start_here Start here + +- @ref api_overview <br> +A top-down view of the PortAudio API, its capabilities, functions and data structures + +- @ref tutorial_start <br> +Get started writing code with PortAudio tutorials + +- @ref examples_src "Examples"<br> +Simple example programs demonstrating PortAudio usage + +- @ref License <br> +PortAudio is licenced under the MIT Expat open source licence. We make a non-binding request for you to contribute your changes back to the project. + + +@section reference API Reference + +- portaudio.h Portable API<br> +Detailed documentation for each portable API function and data type + +- @ref public_header "Host API Specific Extensions"<br> +Documentation for non-portable platform-specific host API extensions + + +@section resources Resources + +- <a href="http://www.portaudio.com">The PortAudio website</a> + +- <a href="http://www.portaudio.com/contacts.html">Our mailing list for users and developers</a><br> + +- <a href="https://github.com/PortAudio/portaudio/wiki">The PortAudio wiki</a> + +@section developer_resources Developer Resources + +@if INTERNAL +- @ref srcguide +@endif + +- <a href="https://github.com/PortAudio/portaudio/">Our repository on GitHub</a> + +- <a href="https://github.com/PortAudio/portaudio/wiki/DeveloperGuidelines">Developer guidelines</a> + +- <a href="https://github.com/PortAudio/portaudio/wiki/ImplementationStyleGuidelines">Implementation style guidelines</a> + +If you're interested in helping out with PortAudio development we're more than happy for you to be involved. +Just drop by the PortAudio mailing list and ask how you can help. +Or check out these <a href="https://github.com/PortAudio/portaudio/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22"> +recommended starter issues</a>. + +@section older_api_versions Older API Versions + +This documentation covers the current API version: PortAudio V19, API version 2.0. API 2.0 differs in a number of ways from previous versions (most often encountered in PortAudio V18), please consult the enhancement proposals for details of what was added/changed for V19: +http://www.portaudio.com/docs/proposals/index.html + +*/ |