Tweak the controls documentation.

Also move the qaudioendpointselector control into controls.

Change-Id: Ia21f98a683eb38a9c11c42f6e7901d7d841aae90
Reviewed-by: Peter Yard <peter.yard@nokia.com>
Reviewed-by: Jonas Rabbe <jonas.rabbe@gmail.com>
This commit is contained in:
Michael Goddard
2012-06-14 15:03:30 +10:00
committed by Qt by Nokia
parent c88abd0177
commit e975897ad7
38 changed files with 37 additions and 37 deletions

View File

@@ -1,7 +1,6 @@
INCLUDEPATH += playback
PUBLIC_HEADERS += \
playback/qaudioendpointselector.h \
playback/qmediacontent.h \
playback/qmediaplayer.h \
playback/qmediaplaylist.h \
@@ -16,7 +15,6 @@ PRIVATE_HEADERS += \
playback/playlistfileparser_p.h
SOURCES += \
playback/qaudioendpointselector.cpp \
playback/qmedianetworkplaylistprovider.cpp \
playback/qmediacontent.cpp \
playback/qmediaplayer.cpp \

View File

@@ -1,133 +0,0 @@
/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/
**
** This file is part of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qaudioendpointselector.h"
QT_BEGIN_NAMESPACE
/*!
\class QAudioEndpointSelector
\brief The QAudioEndpointSelector class provides an audio endpoint selector media control.
\inmodule QtMultimedia
\ingroup multimedia
\ingroup multimedia_control
The QAudioEndpointSelector class provides descriptions of the audio
endpoints available on a system and allows one to be selected as the audio
of a media service.
The interface name of QAudioEndpointSelector is \c org.qt-project.qt.audioendpointselector/5.0 as
defined in QAudioEndpointSelector_iid.
\sa QMediaService::requestControl()
*/
/*!
\macro QAudioEndpointSelector_iid
\c org.qt-project.qt.audioendpointselector/5.0
Defines the interface name of the QAudioEndpointSelector class.
\relates QAudioEndpointSelector
*/
/*!
Constructs a new audio endpoint selector with the given \a parent.
*/
QAudioEndpointSelector::QAudioEndpointSelector(QObject *parent)
:QMediaControl(parent)
{
}
/*!
Destroys an audio endpoint selector.
*/
QAudioEndpointSelector::~QAudioEndpointSelector()
{
}
/*!
\fn QList<QString> QAudioEndpointSelector::availableEndpoints() const
Returns a list of the names of the available audio endpoints.
*/
/*!
\fn QString QAudioEndpointSelector::endpointDescription(const QString& name) const
Returns the description of the endpoint \a name.
*/
/*!
\fn QString QAudioEndpointSelector::defaultEndpoint() const
Returns the name of the default audio endpoint.
*/
/*!
\fn QString QAudioEndpointSelector::activeEndpoint() const
Returns the name of the currently selected audio endpoint.
*/
/*!
\fn QAudioEndpointSelector::setActiveEndpoint(const QString& name)
Set the active audio endpoint to \a name.
*/
/*!
\fn QAudioEndpointSelector::activeEndpointChanged(const QString& name)
Signals that the audio endpoint has changed to \a name.
*/
/*!
\fn QAudioEndpointSelector::availableEndpointsChanged()
Signals that list of available endpoints has changed.
*/
#include "moc_qaudioendpointselector.cpp"
QT_END_NAMESPACE

View File

@@ -1,88 +0,0 @@
/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/
**
** This file is part of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QAUDIOENDPOINTSELECTOR_H
#define QAUDIOENDPOINTSELECTOR_H
#include <qaudio.h>
#include <qmediacontrol.h>
QT_BEGIN_HEADER
QT_BEGIN_NAMESPACE
QT_MODULE(Multimedia)
// Class forward declaration required for QDoc bug
class QString;
class Q_MULTIMEDIA_EXPORT QAudioEndpointSelector : public QMediaControl
{
Q_OBJECT
public:
virtual ~QAudioEndpointSelector();
virtual QList<QString> availableEndpoints() const = 0;
virtual QString endpointDescription(const QString& name) const = 0;
virtual QString defaultEndpoint() const = 0;
virtual QString activeEndpoint() const = 0;
public Q_SLOTS:
virtual void setActiveEndpoint(const QString& name) = 0;
Q_SIGNALS:
void activeEndpointChanged(const QString& name);
void availableEndpointsChanged();
protected:
QAudioEndpointSelector(QObject *parent = 0);
};
#define QAudioEndpointSelector_iid "org.qt-project.qt.audioendpointselector/5.0"
Q_MEDIA_DECLARE_CONTROL(QAudioEndpointSelector, QAudioEndpointSelector_iid)
QT_END_NAMESPACE
QT_END_HEADER
#endif // QAUDIOENDPOINTSELECTOR_H