diff options
Diffstat (limited to 'src/3rdparty/phonon/phonon/backendcapabilities.h')
| -rw-r--r-- | src/3rdparty/phonon/phonon/backendcapabilities.h | 213 |
1 files changed, 213 insertions, 0 deletions
diff --git a/src/3rdparty/phonon/phonon/backendcapabilities.h b/src/3rdparty/phonon/phonon/backendcapabilities.h new file mode 100644 index 0000000000..65b2830056 --- /dev/null +++ b/src/3rdparty/phonon/phonon/backendcapabilities.h @@ -0,0 +1,213 @@ +/* This file is part of the KDE project + Copyright (C) 2005-2006 Matthias Kretz <kretz@kde.org> + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) version 3, or any + later version accepted by the membership of KDE e.V. (or its + successor approved by the membership of KDE e.V.), Trolltech ASA + (or its successors, if any) and the KDE Free Qt Foundation, which shall + act as a proxy defined in Section 6 of version 3 of the license. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library. If not, see <http://www.gnu.org/licenses/>. + +*/ + +#ifndef Phonon_BACKENDCAPABILITIES_H +#define Phonon_BACKENDCAPABILITIES_H + +#include "phonon_export.h" +#include "objectdescription.h" + +#include <QtCore/QObject> + +QT_BEGIN_HEADER +QT_BEGIN_NAMESPACE + +#ifdef __QT_SYNCQT__ +// Tell syncqt that the BackendCapabilities namespace should be treated like a class +#pragma qt_class(Phonon::BackendCapabilities) +#pragma qt_sync_stop_processing +#endif + +template<class T> class QList; +class QStringList; + +namespace Phonon +{ + +/** + * Collection of functions describing the capabilities of the Backend. + * + * \ingroup BackendInformation + * \author Matthias Kretz <kretz@kde.org> + */ +namespace BackendCapabilities +{ + /** \class Notifier backendcapabilities.h Phonon/BackendCapabilities + * Notifications about backend capabilities. + * + * \ingroup BackendInformation + */ + class Notifier : public QObject + { + Q_OBJECT + Q_SIGNALS: + /** + * This signal is emitted if the capabilities have changed. This can + * happen if the user has requested a backend change. + */ + void capabilitiesChanged(); + + /** + * This signal is emitted when audio output devices were plugged or + * unplugged. + * + * Check BackendCapabilities::availableAudioOutputDevices to get the + * current list of available devices. + */ + void availableAudioOutputDevicesChanged(); + + /** + * This signal is emitted when audio capture devices were plugged or + * unplugged. + * + * Check BackendCapabilities::availableAudioCaptureDevices to get the + * current list of available devices. + */ +#ifndef QT_NO_PHONON_AUDIOCAPTURE + void availableAudioCaptureDevicesChanged(); +#endif //QT_NO_PHONON_AUDIOCAPTURE + }; + + /** + * Use this function to get a QObject pointer to connect to the capabilitiesChanged signal. + * + * \return a pointer to a QObject. + * + * The capabilitiesChanged signal is emitted if the capabilities have changed. This can + * happen if the user has requested a backend change. + * + * To connect to this signal do the following: + * \code + * QObject::connect(BackendCapabilities::notifier(), SIGNAL(capabilitiesChanged()), ... + * \endcode + * + * \see Notifier::capabilitiesChanged() + */ + PHONON_EXPORT Notifier *notifier(); + + /** + * Returns a list of mime types that the Backend can decode. + * + * \see isMimeTypeAvailable() + */ + PHONON_EXPORT QStringList availableMimeTypes(); + + /** + * Often all you want to know is whether one given MIME type can be + * decoded by the backend. Use this method in favor of availableMimeTypes() + * as it can give you a negative answer without having a backend loaded. + * + * \see availableMimeTypes(); + */ + PHONON_EXPORT bool isMimeTypeAvailable(const QString &mimeType); + + /** + * Returns the audio output devices the backend supports. + * + * \return A list of AudioOutputDevice objects that give a name and + * description for every supported audio output device. + */ + PHONON_EXPORT QList<AudioOutputDevice> availableAudioOutputDevices(); + + /** + * Returns the audio capture devices the backend supports. + * + * \return A list of AudioCaptureDevice objects that give a name and + * description for every supported audio capture device. + */ +#ifndef QT_NO_PHONON_AUDIOCAPTURE + PHONON_EXPORT QList<AudioCaptureDevice> availableAudioCaptureDevices(); +#endif //QT_NO_PHONON_AUDIOCAPTURE + + /** + * Returns the video output devices the backend supports. + * + * \return A list of VideoOutputDevice objects that give a name and + * description for every supported video output device. + */ +// PHONON_EXPORT QList<VideoOutputDevice> availableVideoOutputDevices(); + + /** + * Returns the video capture devices the backend supports. + * + * \return A list of VideoCaptureDevice objects that give a name and + * description for every supported video capture device. + */ +// PHONON_EXPORT QList<VideoCaptureDevice> availableVideoCaptureDevices(); + + /** + * Returns the visualization effects the backend supports. + * + * \return A list of VisualizationEffect objects that give a name and + * description for every supported visualization effect. + */ +// PHONON_EXPORT QList<VisualizationDescription> availableVisualizations(); + + /** + * Returns descriptions for the audio effects the backend supports. + * + * \return A list of AudioEffectDescription objects that give a name and + * description for every supported audio effect. + */ +#ifndef QT_NO_PHONON_EFFECT + PHONON_EXPORT QList<EffectDescription> availableAudioEffects(); +#endif //QT_NO_PHONON_EFFECT + +//X /** +//X * Returns descriptions for the video effects the backend supports. +//X * +//X * \return A list of VideoEffectDescription objects that give a name and +//X * description for every supported video effect. +//X */ +//X PHONON_EXPORT QList<EffectDescription> availableVideoEffects(); + + /** + * Returns descriptions for the audio codecs the backend supports. + * + * \return A list of AudioCodec objects that give a name and + * description for every supported audio codec. + */ +// PHONON_EXPORT QList<AudioCodecDescription> availableAudioCodecs(); + + /** + * Returns descriptions for the video codecs the backend supports. + * + * \return A list of VideoCodec objects that give a name and + * description for every supported video codec. + */ +// PHONON_EXPORT QList<VideoCodecDescription> availableVideoCodecs(); + + /** + * Returns descriptions for the container formats the backend supports. + * + * \return A list of ContainerFormat objects that give a name and + * description for every supported container format. + */ +// PHONON_EXPORT QList<ContainerFormatDescription> availableContainerFormats(); +} // namespace BackendCapabilities +} // namespace Phonon + +QT_END_NAMESPACE +QT_END_HEADER + +#endif // Phonon_BACKENDCAPABILITIES_H +// vim: sw=4 ts=4 tw=80 |