libraries/phonon/Mainpage.dox

0001 /** @mainpage The Phonon Library API Reference
0002
0003 <p><b>
0004 Overview |
0005 @ref development
0006 </b></p>
0007
0008 <a href="http://phonon.kde.org/">Phonon</a> provides a Qt-style interface for audio
0009 and video.  It is aimed at the average desktop application, whether that is a game
0010 that needs sound effects or a full-blown multimedia playback application like
0011 <a href="http://amarok.kde.org/">Amarok</a> or
0012 <a href="http://bangarangkde.wordpress.com/">Bangarang</a>.
0013
0014 If you writing a Qt program and want audio or video playback, then Phonon is
0015 almost certainly the right choice for you.  It provides an API that any Qt
0016 developer will be comfortable with, and uses the native multimedia frameworks
0017 on Windows and MacOS.  On UNIX systems, where there is no one standard
0018 multimedia system, it offers <a href="http://www.gstreamer.net/">GStreamer</a>
0019 and <a href="http://www.videolan.org/">VLC</a> backends.
0020
0021 However, Phonon is not aimed at professional audio applications (in the style of
0022 <a href="http://audacity.sourceforge.net/">Audacity</a>, say).  For these applications,
0023 you will probably want more control over the audio layer than Phonon will give you,
0024 and you should probably be using something like <a href="http://jackaudio.org/">JACK</a>.
0025
0026 @authors
0027 Matthias Kretz \<kretz@kde.org\><br/>
0028 Ricardo Villalba \<rvm@escomposlinux.org\><br/>
0029 Ian Monroe \<ian@monroe.nu\><br/>
0030 Colin Guthrie \<phonon@colin.guthr.ie\><br/>
0031 Martin Sandsmark \<martin.sandsmark@kde.org\><br/>
0032 Harald Sitter \<sitter@kde.org\><br/>
0033 Nokia Corporation and/or its subsidiary(-ies)
0034
0035 @maintainers
0036 Harald Sitter \<sitter@kde.org\>
0037
0038 @licenses
0039 Libraries: @lgpl<br>
0040 Examples: @mit<br>
0041 Backends: @lgpl or @gpl
0042
0043 */
0044
0045 /** @page development Development
0046
0047 <p><b>
0048 @ref index "Overview" |
0049 Development
0050 </b></p>
0051
0052 If you want to get involved with Phonon backend development please subscribe to
0053 <a href="https://mail.kde.org/mailman/listinfo/phonon-backends">phonon-backends@kde.org</a>.
0054
0055 If you want to contribute, make comments or useful suggestions you can also
0056 write to the
0057 <a href="mailto:kde-multimedia@kde.org">KDE Multimedia mailinglist</a>.
0058 You can join the mailinglist using the
0059 <a href="https://mail.kde.org/mailman/listinfo/kde-multimedia">webinterface</a>
0060 or take a look at the
0061 <a href="http://lists.kde.org/?l=kde-multimedia">archives</a>
0062
0063 If you want more immediate help, try the \#kde-devel IRC channel on irc.libera.chat.
0064
0065 */
0066
0067 // DOXYGEN_VERSION=4.7.0
0068 // DOXYGEN_NAME=Phonon
0069 // DOXYGEN_ENABLE=YES
0070 // DOXYGEN_SET_INPUT = @topdir@/phonon/
0071 // DOXYGEN_SET_EXCLUDE = @topdir@/phonon/backend/ @topdir@/phonon/experimental/
0072 // DOXYGEN_SET_FILE_PATTERNS = *.h *.dox
0073 // DOXYGEN_SET_EXCLUDE_PATTERNS = *interface.h *_p.h
0074
0075 // vim:ts=4:sw=4:expandtab:filetype=doxygen