<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qradiodatacontrol.cpp -->
<title>QRadioDataControl Class | Qt Multimedia 5.9</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.9</td><td ><a href="qtmultimedia-index.html">Qt Multimedia</a></td><td ><a href="qtmultimedia-modules.html">C++ Classes</a></td><td >QRadioDataControl</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#macros">Macros</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QRadioDataControl Class</h1>
<!-- $$$QRadioDataControl-brief -->
<p>The <a href="qradiodatacontrol.html">QRadioDataControl</a> class provides access to the RDS functionality of the radio in the <a href="qmediaservice.html">QMediaService</a>. <a href="#details">More...</a></p>
<!-- @@@QRadioDataControl -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QRadioDataControl></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += multimedia</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qmediacontrol.html">QMediaControl</a></td></tr></table></div><ul>
<li><a href="qradiodatacontrol-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qradiodatacontrol.html#dtor.QRadioDataControl">~QRadioDataControl</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QRadioData::Error </td><td class="memItemRight bottomAlign"><b><a href="qradiodatacontrol.html#error">error</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qradiodatacontrol.html#errorString">errorString</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qradiodatacontrol.html#isAlternativeFrequenciesEnabled">isAlternativeFrequenciesEnabled</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QRadioData::ProgramType </td><td class="memItemRight bottomAlign"><b><a href="qradiodatacontrol.html#programType">programType</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qradiodatacontrol.html#programTypeName">programTypeName</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qradiodatacontrol.html#radioText">radioText</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qradiodatacontrol.html#setAlternativeFrequenciesEnabled">setAlternativeFrequenciesEnabled</a></b>(bool <i>enabled</i>) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qradiodatacontrol.html#stationId">stationId</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qradiodatacontrol.html#stationName">stationName</a></b>() const = 0</td></tr>
</table></div>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qradiodatacontrol.html#alternativeFrequenciesEnabledChanged">alternativeFrequenciesEnabledChanged</a></b>(bool <i>enabled</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qradiodatacontrol.html#error-1">error</a></b>(QRadioData::Error <i>error</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qradiodatacontrol.html#programTypeChanged">programTypeChanged</a></b>(QRadioData::ProgramType <i>programType</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qradiodatacontrol.html#programTypeNameChanged">programTypeNameChanged</a></b>(QString <i>programTypeName</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qradiodatacontrol.html#radioTextChanged">radioTextChanged</a></b>(QString <i>radioText</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qradiodatacontrol.html#stationIdChanged">stationIdChanged</a></b>(QString <i>stationId</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qradiodatacontrol.html#stationNameChanged">stationNameChanged</a></b>(QString <i>stationName</i>)</td></tr>
</table></div>
<a name="protected-functions"></a>
<h2 id="protected-functions">Protected Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qradiodatacontrol.html#QRadioDataControl">QRadioDataControl</a></b>(QObject *<i>parent</i> = Q_NULLPTR)</td></tr>
</table></div>
<a name="macros"></a>
<h2 id="macros">Macros</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qradiodatacontrol.html#QRadioDataControl_iid">QRadioDataControl_iid</a></b></td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QRadioDataControl-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qradiodatacontrol.html">QRadioDataControl</a> class provides access to the RDS functionality of the radio in the <a href="qmediaservice.html">QMediaService</a>.</p>
<p>The functionality provided by this control is exposed to application code through the <a href="qradiodata.html">QRadioData</a> class.</p>
<p>The interface name of <a href="qradiodatacontrol.html">QRadioDataControl</a> is <code>org.qt-project.qt.radiodatacontrol/5.0</code> as defined in <a href="qradiodatacontrol.html#QRadioDataControl_iid">QRadioDataControl_iid</a>.</p>
</div>
<p><b>See also </b><a href="qmediaservice.html#requestControl-1">QMediaService::requestControl</a>() and <a href="qradiodata.html">QRadioData</a>.</p>
<!-- @@@QRadioDataControl -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QRadioDataControl[overload1]$$$QRadioDataControlQObject* -->
<h3 class="fn" id="QRadioDataControl"><a name="QRadioDataControl"></a><code>[protected] </code>QRadioDataControl::<span class="name">QRadioDataControl</span>(<span class="type">QObject</span> *<i>parent</i> = Q_NULLPTR)</h3>
<p>Constructs a radio data control with the given <i>parent</i>.</p>
<!-- @@@QRadioDataControl -->
<!-- $$$~QRadioDataControl[overload1]$$$~QRadioDataControl -->
<h3 class="fn" id="dtor.QRadioDataControl"><a name="dtor.QRadioDataControl"></a>QRadioDataControl::<span class="name">~QRadioDataControl</span>()</h3>
<p>Destroys a radio data control.</p>
<!-- @@@~QRadioDataControl -->
<!-- $$$alternativeFrequenciesEnabledChanged[overload1]$$$alternativeFrequenciesEnabledChangedbool -->
<h3 class="fn" id="alternativeFrequenciesEnabledChanged"><a name="alternativeFrequenciesEnabledChanged"></a><code>[signal] </code><span class="type">void</span> QRadioDataControl::<span class="name">alternativeFrequenciesEnabledChanged</span>(<span class="type">bool</span> <i>enabled</i>)</h3>
<p>Signals that the alternative frequencies setting has changed to the value of <i>enabled</i>.</p>
<!-- @@@alternativeFrequenciesEnabledChanged -->
<!-- $$$error[overload1]$$$error -->
<h3 class="fn" id="error"><a name="error"></a><code>[pure virtual] </code><span class="type"><a href="qradiodata.html#Error-enum">QRadioData::Error</a></span> QRadioDataControl::<span class="name">error</span>() const</h3>
<p>Returns the error state of a radio data.</p>
<!-- @@@error -->
<!-- $$$error$$$errorQRadioData::Error -->
<h3 class="fn" id="error-1"><a name="error-1"></a><code>[signal] </code><span class="type">void</span> QRadioDataControl::<span class="name">error</span>(<span class="type"><a href="qradiodata.html#Error-enum">QRadioData::Error</a></span> <i>error</i>)</h3>
<p>Signals that an <i>error</i> has occurred.</p>
<p><b>Note:</b> Signal <i>error</i> is overloaded in this class. To connect to this one using the function pointer syntax, you must specify the signal type in a static cast, as shown in this example:<pre class="cpp">
connect(radioDataControl<span class="operator">,</span> <span class="keyword">static_cast</span><span class="operator"><</span><span class="type">void</span>(<span class="type"><a href="qradiodatacontrol.html#QRadioDataControl">QRadioDataControl</a></span><span class="operator">::</span><span class="operator">*</span>)(<span class="type"><a href="qradiodata.html">QRadioData</a></span><span class="operator">::</span>Error)<span class="operator">></span>(<span class="operator">&</span><span class="type"><a href="qradiodatacontrol.html#QRadioDataControl">QRadioDataControl</a></span><span class="operator">::</span>error)<span class="operator">,</span>
<span class="operator">[</span><span class="operator">=</span><span class="operator">]</span>(<span class="type"><a href="qradiodata.html">QRadioData</a></span><span class="operator">::</span>Error error){ <span class="comment">/* ... */</span> });
</pre>
<!-- @@@error -->
<!-- $$$errorString[overload1]$$$errorString -->
<h3 class="fn" id="errorString"><a name="errorString"></a><code>[pure virtual] </code><span class="type">QString</span> QRadioDataControl::<span class="name">errorString</span>() const</h3>
<p>Returns a string describing a radio data's error state.</p>
<!-- @@@errorString -->
<!-- $$$isAlternativeFrequenciesEnabled[overload1]$$$isAlternativeFrequenciesEnabled -->
<h3 class="fn" id="isAlternativeFrequenciesEnabled"><a name="isAlternativeFrequenciesEnabled"></a><code>[pure virtual] </code><span class="type">bool</span> QRadioDataControl::<span class="name">isAlternativeFrequenciesEnabled</span>() const</h3>
<p>Returns true if Alternative Frequency is currently enabled</p>
<!-- @@@isAlternativeFrequenciesEnabled -->
<!-- $$$programType[overload1]$$$programType -->
<h3 class="fn" id="programType"><a name="programType"></a><code>[pure virtual] </code><span class="type"><a href="qradiodata.html#ProgramType-enum">QRadioData::ProgramType</a></span> QRadioDataControl::<span class="name">programType</span>() const</h3>
<p>Returns the current Program Type</p>
<!-- @@@programType -->
<!-- $$$programTypeChanged[overload1]$$$programTypeChangedQRadioData::ProgramType -->
<h3 class="fn" id="programTypeChanged"><a name="programTypeChanged"></a><code>[signal] </code><span class="type">void</span> QRadioDataControl::<span class="name">programTypeChanged</span>(<span class="type"><a href="qradiodata.html#ProgramType-enum">QRadioData::ProgramType</a></span> <i>programType</i>)</h3>
<p>Signals that the Program Type <i>programType</i> has changed</p>
<!-- @@@programTypeChanged -->
<!-- $$$programTypeName[overload1]$$$programTypeName -->
<h3 class="fn" id="programTypeName"><a name="programTypeName"></a><code>[pure virtual] </code><span class="type">QString</span> QRadioDataControl::<span class="name">programTypeName</span>() const</h3>
<p>Returns the current Program Type Name</p>
<!-- @@@programTypeName -->
<!-- $$$programTypeNameChanged[overload1]$$$programTypeNameChangedQString -->
<h3 class="fn" id="programTypeNameChanged"><a name="programTypeNameChanged"></a><code>[signal] </code><span class="type">void</span> QRadioDataControl::<span class="name">programTypeNameChanged</span>(<span class="type">QString</span> <i>programTypeName</i>)</h3>
<p>Signals that the Program Type Name <i>programTypeName</i> has changed</p>
<!-- @@@programTypeNameChanged -->
<!-- $$$radioText[overload1]$$$radioText -->
<h3 class="fn" id="radioText"><a name="radioText"></a><code>[pure virtual] </code><span class="type">QString</span> QRadioDataControl::<span class="name">radioText</span>() const</h3>
<p>Returns the current Radio Text</p>
<!-- @@@radioText -->
<!-- $$$radioTextChanged[overload1]$$$radioTextChangedQString -->
<h3 class="fn" id="radioTextChanged"><a name="radioTextChanged"></a><code>[signal] </code><span class="type">void</span> QRadioDataControl::<span class="name">radioTextChanged</span>(<span class="type">QString</span> <i>radioText</i>)</h3>
<p>Signals that the Radio Text <i>radioText</i> has changed</p>
<!-- @@@radioTextChanged -->
<!-- $$$setAlternativeFrequenciesEnabled[overload1]$$$setAlternativeFrequenciesEnabledbool -->
<h3 class="fn" id="setAlternativeFrequenciesEnabled"><a name="setAlternativeFrequenciesEnabled"></a><code>[pure virtual] </code><span class="type">void</span> QRadioDataControl::<span class="name">setAlternativeFrequenciesEnabled</span>(<span class="type">bool</span> <i>enabled</i>)</h3>
<p>Sets the Alternative Frequency to <i>enabled</i></p>
<p><b>See also </b><a href="qradiodatacontrol.html#isAlternativeFrequenciesEnabled">isAlternativeFrequenciesEnabled</a>().</p>
<!-- @@@setAlternativeFrequenciesEnabled -->
<!-- $$$stationId[overload1]$$$stationId -->
<h3 class="fn" id="stationId"><a name="stationId"></a><code>[pure virtual] </code><span class="type">QString</span> QRadioDataControl::<span class="name">stationId</span>() const</h3>
<p>Returns the current Program Identification</p>
<!-- @@@stationId -->
<!-- $$$stationIdChanged[overload1]$$$stationIdChangedQString -->
<h3 class="fn" id="stationIdChanged"><a name="stationIdChanged"></a><code>[signal] </code><span class="type">void</span> QRadioDataControl::<span class="name">stationIdChanged</span>(<span class="type">QString</span> <i>stationId</i>)</h3>
<p>Signals that the Program Identification <i>stationId</i> has changed</p>
<!-- @@@stationIdChanged -->
<!-- $$$stationName[overload1]$$$stationName -->
<h3 class="fn" id="stationName"><a name="stationName"></a><code>[pure virtual] </code><span class="type">QString</span> QRadioDataControl::<span class="name">stationName</span>() const</h3>
<p>Returns the current Program Service</p>
<!-- @@@stationName -->
<!-- $$$stationNameChanged[overload1]$$$stationNameChangedQString -->
<h3 class="fn" id="stationNameChanged"><a name="stationNameChanged"></a><code>[signal] </code><span class="type">void</span> QRadioDataControl::<span class="name">stationNameChanged</span>(<span class="type">QString</span> <i>stationName</i>)</h3>
<p>Signals that the Program Service <i>stationName</i> has changed</p>
<!-- @@@stationNameChanged -->
</div>
<div class="macros">
<h2>Macro Documentation</h2>
<!-- $$$QRadioDataControl_iid[overload1]$$$QRadioDataControl_iid -->
<h3 class="fn" id="QRadioDataControl_iid"><a name="QRadioDataControl_iid"></a><span class="name">QRadioDataControl_iid</span></h3>
<p><code>org.qt-project.qt.radiodatacontrol/5.0</code></p>
<p>Defines the interface name of the <a href="qradiodatacontrol.html">QRadioDataControl</a> class.</p>
<!-- @@@QRadioDataControl_iid -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2017 The Qt Company Ltd.
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> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
