From f930e088fca4150ed61b1bfca0ec2ad139743a67 Mon Sep 17 00:00:00 2001 From: Venugopal Shivashankar Date: Thu, 19 Jul 2012 15:44:36 +0200 Subject: Moved doc under src to fall in-line with the new modular structure Change-Id: Ia2933baa1f0eaf82b5c2a626cb3661ee087049e3 Reviewed-by: Jerome Pasion --- src/multimedia/doc/src/radiooverview.qdoc | 89 +++++++++++++++++++++++++++++++ 1 file changed, 89 insertions(+) create mode 100644 src/multimedia/doc/src/radiooverview.qdoc (limited to 'src/multimedia/doc/src/radiooverview.qdoc') diff --git a/src/multimedia/doc/src/radiooverview.qdoc b/src/multimedia/doc/src/radiooverview.qdoc new file mode 100644 index 000000000..4697aa053 --- /dev/null +++ b/src/multimedia/doc/src/radiooverview.qdoc @@ -0,0 +1,89 @@ +/**************************************************************************** +** +** 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 + +*/ -- cgit v1.2.3