Files
qtmultimedia/src/multimedia/controls/qmetadatareadercontrol.cpp
Michael Goddard e975897ad7 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>
2012-06-15 08:49:26 +02:00

151 lines
4.5 KiB
C++

/****************************************************************************
**
** 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 "qmediacontrol_p.h"
#include <qmetadatareadercontrol.h>
QT_BEGIN_NAMESPACE
/*!
\class QMetaDataReaderControl
\inmodule QtMultimedia
\ingroup multimedia_control
\brief The QMetaDataReaderControl class provides read access to the
meta-data of a QMediaService's media.
If a QMediaService can provide read or write access to the meta-data of
its current media it will implement QMetaDataReaderControl. This control
provides functions for both retrieving and setting meta-data values.
Meta-data may be addressed by the keys defined in the
QtMultimedia::MetaData namespace.
The functionality provided by this control is exposed to application
code by the meta-data members of QMediaObject, and so meta-data access
is potentially available in any of the media object classes. Any media
service may implement QMetaDataReaderControl.
The interface name of QMetaDataReaderControl is
\c org.qt-project.qt.metadatareadercontrol/5.0 as defined in
QMetaDataReaderControl_iid.
\sa QMediaService::requestControl(), QMediaObject
*/
/*!
\macro QMetaDataReaderControl_iid
\c org.qt-project.qt.metadatareadercontrol/5.0
Defines the interface name of the QMetaDataReaderControl class.
\relates QMetaDataReaderControl
*/
/*!
Construct a QMetaDataReaderControl with \a parent. This class is meant as a base class
for service specific meta data providers so this constructor is protected.
*/
QMetaDataReaderControl::QMetaDataReaderControl(QObject *parent):
QMediaControl(*new QMediaControlPrivate, parent)
{
}
/*!
Destroy the meta-data object.
*/
QMetaDataReaderControl::~QMetaDataReaderControl()
{
}
/*!
\fn bool QMetaDataReaderControl::isMetaDataAvailable() const
Identifies if meta-data is available from a media service.
Returns true if the meta-data is available and false otherwise.
*/
/*!
\fn QVariant QMetaDataReaderControl::metaData(const QString &key) const
Returns the meta-data for the given \a key.
*/
/*!
\fn QMetaDataReaderControl::availableMetaData() const
Returns a list of keys there is meta-data available for.
*/
/*!
\fn void QMetaDataReaderControl::metaDataChanged()
Signal the changes of meta-data.
If multiple meta-data elements are changed,
metaDataChanged(const QString &key, const QVariant &value) signal is emitted
for each of them with metaDataChanged() changed emitted once.
*/
/*!
\fn void QMetaDataReaderControl::metaDataChanged(const QString &key, const QVariant &value)
Signal the changes of one meta-data element \a value with the given \a key.
*/
/*!
\fn void QMetaDataReaderControl::metaDataAvailableChanged(bool available)
Signal the availability of meta-data has changed, \a available will
be true if the multimedia object has meta-data.
*/
#include "moc_qmetadatareadercontrol.cpp"
QT_END_NAMESPACE