blob: 643c8ef7cf445db99a5b407ca2d43fcc0c40fad4 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
/* 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.), Nokia Corporation
(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 one of the Notifier signals.
*
* \return a pointer to a QObject.
*
* To connect to the signal do the following:
* \code
* QObject::connect(BackendCapabilities::notifier(), SIGNAL(capabilitiesChanged()), ...
* \endcode
*
* \see Notifier::capabilitiesChanged()
* \see Notifier::availableAudioOutputDevicesChanged()
* \see Notifier::availableAudioCaptureDevicesChanged()
*/
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
|
