/usr/share/qt5/doc/qtmultimedia/qradiotuner.html is in qtmultimedia5-doc-html 5.2.1-0ubuntu5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qradiotuner.cpp -->
<title>QRadioTuner Class | QtMultimedia 5.2</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<ul>
<li>Qt 5.2</li>
<li><a href="qtmultimedia-index.html">Qt Multimedia</a></li>
<li><a href="qtmultimedia-module.html">C++ Classes</a></li>
<li>QRadioTuner</li>
<li id="buildversion">
Qt 5.2.1 Reference Documentation</li>
</ul>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#public-slots">Public Slots</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QRadioTuner Class</h1>
<!-- $$$QRadioTuner-brief -->
<p>The QRadioTuner class provides an interface to the systems analog radio device. <a href="#details">More...</a></p>
<!-- @@@QRadioTuner -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include <QRadioTuner></span>
</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> <tt>QT += multimedia</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qmediaobject.html">QMediaObject</a>.</td></tr></table><ul>
<li><a href="qradiotuner-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#Band-enum">Band</a></b> { AM, FM, SW, LW, FM2 }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#Error-enum">Error</a></b> { NoError, ResourceError, OpenError, OutOfRangeError }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#SearchMode-enum">SearchMode</a></b> { SearchFast, SearchGetStationId }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#State-enum">State</a></b> { ActiveState, StoppedState }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#StereoMode-enum">StereoMode</a></b> { ForceStereo, ForceMono, Auto }</td></tr>
</table>
<a name="properties"></a>
<h2>Properties</h2>
<table class="propsummary">
<tr><td class="topAlign"><ul>
<li class="fn"><b><a href="qradiotuner.html#antennaConnected-prop">antennaConnected</a></b> : const bool</li>
<li class="fn"><b><a href="qradiotuner.html#band-prop">band</a></b> : Band</li>
<li class="fn"><b><a href="qradiotuner.html#frequency-prop">frequency</a></b> : int</li>
<li class="fn"><b><a href="qradiotuner.html#muted-prop">muted</a></b> : bool</li>
<li class="fn"><b><a href="qradiotuner.html#radioData-prop">radioData</a></b> : QRadioData * const</li>
<li class="fn"><b><a href="qradiotuner.html#searching-prop">searching</a></b> : const bool</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><b><a href="qradiotuner.html#signalStrength-prop">signalStrength</a></b> : const int</li>
<li class="fn"><b><a href="qradiotuner.html#state-prop">state</a></b> : const State</li>
<li class="fn"><b><a href="qradiotuner.html#stereo-prop">stereo</a></b> : const bool</li>
<li class="fn"><b><a href="qradiotuner.html#stereoMode-prop">stereoMode</a></b> : StereoMode</li>
<li class="fn"><b><a href="qradiotuner.html#volume-prop">volume</a></b> : int</li>
</ul>
</td></tr>
</table>
<ul>
<li class="fn">1 property inherited from <a href="qmediaobject.html#properties">QMediaObject</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#QRadioTuner">QRadioTuner</a></b>(QObject *<i> parent</i> = 0)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#dtor.QRadioTuner">~QRadioTuner</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Band </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#band-prop">band</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Error </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#error">error</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#errorString">errorString</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#frequency-prop">frequency</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPair<int, int> </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#frequencyRange">frequencyRange</a></b>(Band<i> band</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#frequencyStep">frequencyStep</a></b>(Band<i> band</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#antennaConnected-prop">isAntennaConnected</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#isBandSupported">isBandSupported</a></b>(Band<i> band</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#muted-prop">isMuted</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#searching-prop">isSearching</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#stereo-prop">isStereo</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QRadioData * </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#radioData-prop">radioData</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#stereoMode-prop">setStereoMode</a></b>(QRadioTuner::StereoMode<i> mode</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#signalStrength-prop">signalStrength</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> State </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#state-prop">state</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> StereoMode </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#stereoMode-prop">stereoMode</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#volume-prop">volume</a></b>() const</td></tr>
</table>
<a name="reimplemented-public-functions"></a>
<h2>Reimplemented Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual QMultimedia::AvailabilityStatus </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#availability">availability</a></b>() const</td></tr>
</table>
<ul>
<li class="fn">10 public functions inherited from <a href="qmediaobject.html#public-functions">QMediaObject</a></li>
</ul>
<a name="public-slots"></a>
<h2>Public Slots</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#cancelSearch">cancelSearch</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#searchAllStations">searchAllStations</a></b>(QRadioTuner::SearchMode<i> searchMode</i> = QRadioTuner::SearchFast)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#searchBackward">searchBackward</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#searchForward">searchForward</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#band-prop">setBand</a></b>(Band<i> band</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#frequency-prop">setFrequency</a></b>(int<i> frequency</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#muted-prop">setMuted</a></b>(bool<i> muted</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#volume-prop">setVolume</a></b>(int<i> volume</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#start">start</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#stop">stop</a></b>()</td></tr>
</table>
<a name="signals"></a>
<h2>Signals</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#antennaConnected-prop">antennaConnectedChanged</a></b>(bool<i> connectionStatus</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#band-prop">bandChanged</a></b>(QRadioTuner::Band<i> band</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#error-2">error</a></b>(QRadioTuner::Error<i> error</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#frequency-prop">frequencyChanged</a></b>(int<i> frequency</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#muted-prop">mutedChanged</a></b>(bool<i> muted</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#searching-prop">searchingChanged</a></b>(bool<i> searching</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#signalStrength-prop">signalStrengthChanged</a></b>(int<i> strength</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#state-prop">stateChanged</a></b>(QRadioTuner::State<i> state</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#stationFound">stationFound</a></b>(int<i> frequency</i>, QString<i> stationId</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#stereo-prop">stereoStatusChanged</a></b>(bool<i> stereo</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qradiotuner.html#volume-prop">volumeChanged</a></b>(int<i> volume</i>)</td></tr>
</table>
<ul>
<li class="fn">6 signals inherited from <a href="qmediaobject.html#signals">QMediaObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">2 protected functions inherited from <a href="qmediaobject.html#protected-functions">QMediaObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QRadioTuner-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QRadioTuner class provides an interface to the systems analog radio device.</p>
<p>You can control the systems analog radio device using this interface, for example:</p>
<pre class="cpp">radio <span class="operator">=</span> <span class="keyword">new</span> <span class="type">QRadioTuner</span>;
connect(radio<span class="operator">,</span> SIGNAL(frequencyChanged(<span class="type">int</span>))<span class="operator">,</span> <span class="keyword">this</span><span class="operator">,</span> SLOT(freqChanged(<span class="type">int</span>)));
<span class="keyword">if</span> (radio<span class="operator">-</span><span class="operator">></span>isBandSupported(<span class="type">QRadioTuner</span><span class="operator">::</span>FM)) {
radio<span class="operator">-</span><span class="operator">></span>setBand(<span class="type">QRadioTuner</span><span class="operator">::</span>FM);
radio<span class="operator">-</span><span class="operator">></span>setFrequency(yourRadioStationFrequency);
radio<span class="operator">-</span><span class="operator">></span>setVolume(<span class="number">100</span>);
radio<span class="operator">-</span><span class="operator">></span>start();
}</pre>
<p>The radio object will emit signals for any changes in state such as: <a href="qradiotuner.html#band-prop">bandChanged</a>(), <a href="qradiotuner.html#frequency-prop">frequencyChanged</a>(), <a href="qradiotuner.html#stereo-prop">stereoStatusChanged</a>(), <a href="qradiotuner.html#searching-prop">searchingChanged</a>(), <a href="qradiotuner.html#signalStrength-prop">signalStrengthChanged</a>(), <a href="qradiotuner.html#volume-prop">volumeChanged</a>(), <a href="qradiotuner.html#muted-prop">mutedChanged</a>().</p>
<p>You can change between the frequency bands using <a href="qradiotuner.html#band-prop">setBand</a>() however it is recommended that you check to make sure the band is available first using <a href="qradiotuner.html#isBandSupported">isBandSupported</a>().</p>
</div>
<p><b>See also </b><a href="qradiodata.html">QRadioData</a> and <a href="radiooverview.html">Radio Overview</a>.</p>
<!-- @@@QRadioTuner -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$Band$$$AM$$$FM$$$SW$$$LW$$$FM2 -->
<h3 class="fn"><a name="Band-enum"></a>enum QRadioTuner::<span class="name">Band</span></h3>
<p>Enumerates radio frequency bands.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QRadioTuner::AM</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">520 to 1610 kHz, 9 or 10kHz channel spacing, extended 1610 to 1710 kHz</td></tr>
<tr><td class="topAlign"><tt>QRadioTuner::FM</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">87.5 to 108.0 MHz, except Japan 76-90 MHz</td></tr>
<tr><td class="topAlign"><tt>QRadioTuner::SW</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">1.711 to 30.0 MHz, divided into 15 bands. 5kHz channel spacing</td></tr>
<tr><td class="topAlign"><tt>QRadioTuner::LW</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">148.5 to 283.5 kHz, 9kHz channel spacing (Europe, Africa, Asia)</td></tr>
<tr><td class="topAlign"><tt>QRadioTuner::FM2</tt></td><td class="topAlign"><tt>4</tt></td><td class="topAlign">range not defined, used when area supports more than one FM range.</td></tr>
</table>
<!-- @@@Band -->
<!-- $$$Error$$$NoError$$$ResourceError$$$OpenError$$$OutOfRangeError -->
<h3 class="fn"><a name="Error-enum"></a>enum QRadioTuner::<span class="name">Error</span></h3>
<p>Enumerates radio tuner error conditions.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QRadioTuner::NoError</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">No errors have occurred.</td></tr>
<tr><td class="topAlign"><tt>QRadioTuner::ResourceError</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">There is no radio service available.</td></tr>
<tr><td class="topAlign"><tt>QRadioTuner::OpenError</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">Unable to open radio device.</td></tr>
<tr><td class="topAlign"><tt>QRadioTuner::OutOfRangeError</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">An attempt to set a frequency or band that is not supported by radio device.</td></tr>
</table>
<!-- @@@Error -->
<!-- $$$SearchMode$$$SearchFast$$$SearchGetStationId -->
<h3 class="fn"><a name="SearchMode-enum"></a>enum QRadioTuner::<span class="name">SearchMode</span></h3>
<p>Enumerates how the radio tuner should search for stations.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QRadioTuner::SearchFast</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">Use only signal strength when searching.</td></tr>
<tr><td class="topAlign"><tt>QRadioTuner::SearchGetStationId</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">After finding a strong signal, wait for the RDS station id (PI) before continuing.</td></tr>
</table>
<!-- @@@SearchMode -->
<!-- $$$State$$$ActiveState$$$StoppedState -->
<h3 class="fn"><a name="State-enum"></a>enum QRadioTuner::<span class="name">State</span></h3>
<p>Enumerates radio tuner states.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QRadioTuner::ActiveState</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">The tuner is started and active.</td></tr>
<tr><td class="topAlign"><tt>QRadioTuner::StoppedState</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">The tuner device is stopped.</td></tr>
</table>
<!-- @@@State -->
<!-- $$$StereoMode$$$ForceStereo$$$ForceMono$$$Auto -->
<h3 class="fn"><a name="StereoMode-enum"></a>enum QRadioTuner::<span class="name">StereoMode</span></h3>
<p>Enumerates radio tuner policy for receiving stereo signals.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QRadioTuner::ForceStereo</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">Provide stereo mode, converting if required.</td></tr>
<tr><td class="topAlign"><tt>QRadioTuner::ForceMono</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">Provide mono mode, converting if required.</td></tr>
<tr><td class="topAlign"><tt>QRadioTuner::Auto</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">Uses the stereo mode matching the station.</td></tr>
</table>
<!-- @@@StereoMode -->
</div>
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$antennaConnected-prop$$$isAntennaConnected$$$antennaConnectedChangedbool -->
<h3 class="fn"><a name="antennaConnected-prop"></a><span class="name">antennaConnected</span> : const <span class="type">bool</span></h3>
<p>This property holds whether there is an antenna connected.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>isAntennaConnected</b></span>() const</td></tr>
</table>
<p><b>Notifier signal:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>antennaConnectedChanged</b></span>(bool<i> connectionStatus</i>)</td></tr>
</table>
<!-- @@@antennaConnected -->
<!-- $$$band-prop$$$band$$$setBandBand$$$bandChangedQRadioTuner::Band -->
<h3 class="fn"><a name="band-prop"></a><span class="name">band</span> : <span class="type"><a href="qradiotuner.html#Band-enum">Band</a></span></h3>
<p>This property holds the frequency band a radio tuner is tuned to.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> Band </td><td class="memItemRight bottomAlign"><span class="name"><b>band</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setBand</b></span>(Band<i> band</i>)</td></tr>
</table>
<p><b>Notifier signal:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>bandChanged</b></span>(QRadioTuner::Band<i> band</i>)</td></tr>
</table>
<p><b>See also </b><a href="qradiotuner.html#Band-enum">QRadioTuner::Band</a>.</p>
<!-- @@@band -->
<!-- $$$frequency-prop$$$frequency$$$setFrequencyint$$$frequencyChangedint -->
<h3 class="fn"><a name="frequency-prop"></a><span class="name">frequency</span> : <span class="type">int</span></h3>
<p>This property holds the frequency in Hertz a radio tuner is tuned to.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>frequency</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setFrequency</b></span>(int<i> frequency</i>)</td></tr>
</table>
<p><b>Notifier signal:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>frequencyChanged</b></span>(int<i> frequency</i>)</td></tr>
</table>
<!-- @@@frequency -->
<!-- $$$muted-prop$$$isMuted$$$setMutedbool$$$mutedChangedbool -->
<h3 class="fn"><a name="muted-prop"></a><span class="name">muted</span> : <span class="type">bool</span></h3>
<p>This property holds whether a radio tuner's audio output is muted.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>isMuted</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setMuted</b></span>(bool<i> muted</i>)</td></tr>
</table>
<p><b>Notifier signal:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>mutedChanged</b></span>(bool<i> muted</i>)</td></tr>
</table>
<!-- @@@muted -->
<!-- $$$radioData-prop$$$radioData -->
<h3 class="fn"><a name="radioData-prop"></a><span class="name">radioData</span> : <span class="type"><a href="qradiodata.html">QRadioData</a></span> * const</h3>
<p>This property holds an instance of QRadioData.</p>
<p>The instance of <a href="qradiodata.html">QRadioData</a> is already bound to this instance of <a href="qradiotuner.html">QRadioTuner</a>.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QRadioData * </td><td class="memItemRight bottomAlign"><span class="name"><b>radioData</b></span>() const</td></tr>
</table>
<!-- @@@radioData -->
<!-- $$$searching-prop$$$isSearching$$$searchingChangedbool -->
<h3 class="fn"><a name="searching-prop"></a><span class="name">searching</span> : const <span class="type">bool</span></h3>
<p>This property holds whether a radio tuner is currently scanning for a signal.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>isSearching</b></span>() const</td></tr>
</table>
<p><b>Notifier signal:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>searchingChanged</b></span>(bool<i> searching</i>)</td></tr>
</table>
<p><b>See also </b><a href="qradiotuner.html#searchForward">searchForward</a>(), <a href="qradiotuner.html#searchBackward">searchBackward</a>(), and <a href="qradiotuner.html#cancelSearch">cancelSearch</a>().</p>
<!-- @@@searching -->
<!-- $$$signalStrength-prop$$$signalStrength$$$signalStrengthChangedint -->
<h3 class="fn"><a name="signalStrength-prop"></a><span class="name">signalStrength</span> : const <span class="type">int</span></h3>
<p>This property holds the strength of the current radio signal as a percentage.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>signalStrength</b></span>() const</td></tr>
</table>
<p><b>Notifier signal:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>signalStrengthChanged</b></span>(int<i> strength</i>)</td></tr>
</table>
<!-- @@@signalStrength -->
<!-- $$$state-prop$$$state$$$stateChangedQRadioTuner::State -->
<h3 class="fn"><a name="state-prop"></a><span class="name">state</span> : const <span class="type"><a href="qradiotuner.html#State-enum">State</a></span></h3>
<p>Return the current radio tuner state.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> State </td><td class="memItemRight bottomAlign"><span class="name"><b>state</b></span>() const</td></tr>
</table>
<p><b>Notifier signal:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>stateChanged</b></span>(QRadioTuner::State<i> state</i>)</td></tr>
</table>
<p><b>See also </b><a href="qradiotuner.html#State-enum">QRadioTuner::State</a>.</p>
<!-- @@@state -->
<!-- $$$stereo-prop$$$isStereo$$$stereoStatusChangedbool -->
<h3 class="fn"><a name="stereo-prop"></a><span class="name">stereo</span> : const <span class="type">bool</span></h3>
<p>This property holds whether a radio tuner is receiving a stereo signal.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>isStereo</b></span>() const</td></tr>
</table>
<p><b>Notifier signal:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>stereoStatusChanged</b></span>(bool<i> stereo</i>)</td></tr>
</table>
<!-- @@@stereo -->
<!-- $$$stereoMode-prop$$$stereoMode$$$setStereoModeQRadioTuner::StereoMode -->
<h3 class="fn"><a name="stereoMode-prop"></a><span class="name">stereoMode</span> : <span class="type"><a href="qradiotuner.html#StereoMode-enum">StereoMode</a></span></h3>
<p>This property holds the stereo mode of a radio tuner.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> StereoMode </td><td class="memItemRight bottomAlign"><span class="name"><b>stereoMode</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setStereoMode</b></span>(QRadioTuner::StereoMode<i> mode</i>)</td></tr>
</table>
<!-- @@@stereoMode -->
<!-- $$$volume-prop$$$volume$$$setVolumeint$$$volumeChangedint -->
<h3 class="fn"><a name="volume-prop"></a><span class="name">volume</span> : <span class="type">int</span></h3>
<p>This property holds the volume of a radio tuner's audio output as a percentage.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> int </td><td class="memItemRight bottomAlign"><span class="name"><b>volume</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setVolume</b></span>(int<i> volume</i>)</td></tr>
</table>
<p><b>Notifier signal:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>volumeChanged</b></span>(int<i> volume</i>)</td></tr>
</table>
<!-- @@@volume -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QRadioTuner[overload1]$$$QRadioTunerQObject* -->
<h3 class="fn"><a name="QRadioTuner"></a>QRadioTuner::<span class="name">QRadioTuner</span>(<span class="type">QObject</span> *<i> parent</i> = 0)</h3>
<p>Constructs a radio tuner based on a media service allocated by the default media service provider.</p>
<p>The <i>parent</i> is passed to <a href="qmediaobject.html">QMediaObject</a>.</p>
<!-- @@@QRadioTuner -->
<!-- $$$~QRadioTuner[overload1]$$$~QRadioTuner -->
<h3 class="fn"><a name="dtor.QRadioTuner"></a>QRadioTuner::<span class="name">~QRadioTuner</span>()</h3>
<p>Destroys a radio tuner.</p>
<!-- @@@~QRadioTuner -->
<!-- $$$availability[overload1]$$$availability -->
<h3 class="fn"><a name="availability"></a><span class="type"><a href="qmultimedia.html#AvailabilityStatus-enum">QMultimedia::AvailabilityStatus</a></span> QRadioTuner::<span class="name">availability</span>() const<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qmediaobject.html#availability">QMediaObject::availability</a>().</p>
<p>Returns the availability of the radio tuner.</p>
<!-- @@@availability -->
<!-- $$$cancelSearch[overload1]$$$cancelSearch -->
<h3 class="fn"><a name="cancelSearch"></a><span class="type">void</span> QRadioTuner::<span class="name">cancelSearch</span>()<tt> [slot]</tt></h3>
<p>Stops scanning for a signal.</p>
<p><b>See also </b><a href="qradiotuner.html#searchForward">searchForward</a>(), <a href="qradiotuner.html#searchBackward">searchBackward</a>(), and <a href="qradiotuner.html#searching-prop">searching</a>.</p>
<!-- @@@cancelSearch -->
<!-- $$$error[overload1]$$$error -->
<h3 class="fn"><a name="error"></a><span class="type"><a href="qradiotuner.html#Error-enum">Error</a></span> QRadioTuner::<span class="name">error</span>() const</h3>
<p>Returns the error state of a radio tuner.</p>
<p><b>See also </b><a href="qradiotuner.html#errorString">errorString</a>().</p>
<!-- @@@error -->
<!-- $$$error$$$errorQRadioTuner::Error -->
<h3 class="fn"><a name="error-2"></a><span class="type">void</span> QRadioTuner::<span class="name">error</span>(<span class="type"><a href="qradiotuner.html#Error-enum">QRadioTuner::Error</a></span><i> error</i>)<tt> [signal]</tt></h3>
<p>Signals that an <i>error</i> occurred.</p>
<!-- @@@error -->
<!-- $$$errorString[overload1]$$$errorString -->
<h3 class="fn"><a name="errorString"></a><span class="type">QString</span> QRadioTuner::<span class="name">errorString</span>() const</h3>
<p>Returns a description of a radio tuner's error state.</p>
<p><b>See also </b><a href="qradiotuner.html#error">error</a>().</p>
<!-- @@@errorString -->
<!-- $$$frequencyRange[overload1]$$$frequencyRangeBand -->
<h3 class="fn"><a name="frequencyRange"></a><span class="type">QPair</span><<span class="type">int</span>, <span class="type">int</span>> QRadioTuner::<span class="name">frequencyRange</span>(<span class="type"><a href="qradiotuner.html#Band-enum">Band</a></span><i> band</i>) const</h3>
<p>Returns a frequency <i>band</i>'s minimum and maximum frequency.</p>
<!-- @@@frequencyRange -->
<!-- $$$frequencyStep[overload1]$$$frequencyStepBand -->
<h3 class="fn"><a name="frequencyStep"></a><span class="type">int</span> QRadioTuner::<span class="name">frequencyStep</span>(<span class="type"><a href="qradiotuner.html#Band-enum">Band</a></span><i> band</i>) const</h3>
<p>Returns the number of Hertz to increment the frequency by when stepping through frequencies within a given <i>band</i>.</p>
<!-- @@@frequencyStep -->
<!-- $$$isBandSupported[overload1]$$$isBandSupportedBand -->
<h3 class="fn"><a name="isBandSupported"></a><span class="type">bool</span> QRadioTuner::<span class="name">isBandSupported</span>(<span class="type"><a href="qradiotuner.html#Band-enum">Band</a></span><i> band</i>) const</h3>
<p>Identifies if a frequency <i>band</i> is supported by a radio tuner.</p>
<p>Returns true if the band is supported, and false if it is not.</p>
<!-- @@@isBandSupported -->
<!-- $$$searchAllStations[overload1]$$$searchAllStationsQRadioTuner::SearchMode -->
<h3 class="fn"><a name="searchAllStations"></a><span class="type">void</span> QRadioTuner::<span class="name">searchAllStations</span>(<span class="type"><a href="qradiotuner.html#SearchMode-enum">QRadioTuner::SearchMode</a></span><i> searchMode</i> = QRadioTuner::SearchFast)<tt> [slot]</tt></h3>
<p>Search all stations in current band</p>
<p>Emits QRadioTuner::stationFound(int, QString) for every found station. After searching is completed, QRadioTuner::searchingChanged(bool) is emitted (false). If <i>searchMode</i> is set to <a href="qradiotuner.html#SearchMode-enum">SearchGetStationId</a>, searching waits for station id (PI) on each frequency.</p>
<p><b>See also </b><a href="qradiotuner.html#searchForward">searchForward</a>(), <a href="qradiotuner.html#searchBackward">searchBackward</a>(), and <a href="qradiotuner.html#searching-prop">searching</a>.</p>
<!-- @@@searchAllStations -->
<!-- $$$searchBackward[overload1]$$$searchBackward -->
<h3 class="fn"><a name="searchBackward"></a><span class="type">void</span> QRadioTuner::<span class="name">searchBackward</span>()<tt> [slot]</tt></h3>
<p>Starts a backwards scan for a signal, starting from the current <a href="qradiotuner.html#frequency-prop">frequency</a>.</p>
<p><b>See also </b><a href="qradiotuner.html#searchForward">searchForward</a>(), <a href="qradiotuner.html#cancelSearch">cancelSearch</a>(), and <a href="qradiotuner.html#searching-prop">searching</a>.</p>
<!-- @@@searchBackward -->
<!-- $$$searchForward[overload1]$$$searchForward -->
<h3 class="fn"><a name="searchForward"></a><span class="type">void</span> QRadioTuner::<span class="name">searchForward</span>()<tt> [slot]</tt></h3>
<p>Starts a forward scan for a signal, starting from the current <a href="qradiotuner.html#frequency-prop">frequency</a>.</p>
<p><b>See also </b><a href="qradiotuner.html#searchBackward">searchBackward</a>(), <a href="qradiotuner.html#cancelSearch">cancelSearch</a>(), and <a href="qradiotuner.html#searching-prop">searching</a>.</p>
<!-- @@@searchForward -->
<!-- $$$start[overload1]$$$start -->
<h3 class="fn"><a name="start"></a><span class="type">void</span> QRadioTuner::<span class="name">start</span>()<tt> [slot]</tt></h3>
<p>Activate the radio device.</p>
<!-- @@@start -->
<!-- $$$stationFound[overload1]$$$stationFoundintQString -->
<h3 class="fn"><a name="stationFound"></a><span class="type">void</span> QRadioTuner::<span class="name">stationFound</span>(<span class="type">int</span><i> frequency</i>, <span class="type">QString</span><i> stationId</i>)<tt> [signal]</tt></h3>
<p>Signals that a station was found in <i>frequency</i> with <i>stationId</i> Program Identification code.</p>
<!-- @@@stationFound -->
<!-- $$$stop[overload1]$$$stop -->
<h3 class="fn"><a name="stop"></a><span class="type">void</span> QRadioTuner::<span class="name">stop</span>()<tt> [slot]</tt></h3>
<p>Deactivate the radio device.</p>
<!-- @@@stop -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2013 Digia Plc and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.<br> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br> Digia, Qt and their respective logos are trademarks of Digia Plc in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
|