9e6d03584a
renaming QML element to QML type removing some \fn tags that were making the docs not build some rewording some new signal docs Change-Id: I9b350dad1780276959aef4105e53b91082a6083e Reviewed-by: Dmytro Poplavskiy <dmytro.poplavskiy@nokia.com>
90 lines
2.7 KiB
Plaintext
90 lines
2.7 KiB
Plaintext
/****************************************************************************
|
|
**
|
|
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
|
|
** Contact: http://www.qt-project.org/
|
|
**
|
|
** This file is part of the documentation of the Qt Toolkit.
|
|
**
|
|
** $QT_BEGIN_LICENSE:FDL$
|
|
** GNU Free Documentation License
|
|
** Alternatively, this file may be used under the terms of the GNU Free
|
|
** Documentation License version 1.3 as published by the Free Software
|
|
** Foundation and appearing in the file included in the packaging of
|
|
** this file.
|
|
**
|
|
** 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$
|
|
**
|
|
****************************************************************************/
|
|
|
|
/*!
|
|
|
|
\page radiooverview.html
|
|
\title Radio Overview
|
|
\brief An API to control system radio tuner
|
|
|
|
The Qt Multimedia API provides a number of radio related classes for control
|
|
over the radio tuner of the system, and gives access to Radio Data System
|
|
(RDS) information for radio stations that broadcasts it.
|
|
|
|
\section1 Radio Features
|
|
|
|
The Radio API consists of two separate components. The radio tuner,
|
|
\l QRadioTuner or the \l Radio QML type, which handles control of
|
|
the radio hardware as well as tuning. The other is the radio data
|
|
component, either \l QRadioData or the \l RadioData QML type, which
|
|
gives access to RDS information.
|
|
|
|
\section1 Radio Implementation Details
|
|
|
|
The actual level of support depends on the underlying system support. It should
|
|
be noted that only analog radio is supported, and the properties of the radio
|
|
data component will only be populated if the system radio tuner supports RDS.
|
|
|
|
\section1 Examples
|
|
|
|
There are two examples showing the usage of the Radio API. One shows how to use
|
|
the QRadioTuner class from C++. The other shows how to implement a similar
|
|
application using QML and \l Radio.
|
|
|
|
\section2 Radio Example
|
|
|
|
This image shows the example using the QRadioTuner API.
|
|
|
|
\image radio-example.png
|
|
|
|
The example reads the frequency from the radio tuner, and sets the "Got Signal"
|
|
text based on the signal strength. The buttons allow the user to tune and scan
|
|
up and down the frequency band, while the slider to the side allows volume
|
|
adjustments.
|
|
|
|
Only the FM frequency band is used in this example.
|
|
|
|
\section2 Declarative Radio Example
|
|
|
|
\image declarative-radio-example.png
|
|
|
|
This example has the same functionality of the regular radio example mentioned
|
|
above, but it includes a nice horizontal dial showing the position of the
|
|
current frequency inside the band.
|
|
|
|
\section1 Reference documentation
|
|
|
|
\section2 C++ Classes
|
|
|
|
\annotatedlist multimedia_radio
|
|
|
|
\section2 QML Types
|
|
|
|
\annotatedlist multimedia_radio_qml
|
|
|
|
*/
|