diff options
author | Jonas Rabbe <jonas.rabbe@nokia.com> | 2012-01-12 13:23:08 +1000 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-01-12 07:40:49 +0100 |
commit | 96eceb5f0aaa000677688ec48885e922c449d3e9 (patch) | |
tree | d0896979ca03bf6c15c9d6a5424c07dd08672067 /doc/src/radiooverview.qdoc | |
parent | 0dca769d5a805a682fcfa8534dc1f3c9589422e6 (diff) |
Added overview documentation for the radio
Change-Id: I71b072512db51f23b0aed82545b504f9efc824d0
Reviewed-by: Dmytro Poplavskiy <dmytro.poplavskiy@nokia.com>
Diffstat (limited to 'doc/src/radiooverview.qdoc')
-rw-r--r-- | doc/src/radiooverview.qdoc | 95 |
1 files changed, 95 insertions, 0 deletions
diff --git a/doc/src/radiooverview.qdoc b/doc/src/radiooverview.qdoc new file mode 100644 index 000000000..b49281b7b --- /dev/null +++ b/doc/src/radiooverview.qdoc @@ -0,0 +1,95 @@ +/**************************************************************************** +** +** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** 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 Radio API provides 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 element, 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 element, 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 the Radio element. + +\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 Radio Classes + +\list + \o \l QRadioTuner + \o \l QRadioData +\endlist + +\section2 QML Elements + +\list + \o \l Radio + \o \l RadioData +\endlist + +*/ |