<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qdeclarativeradiodata.cpp -->
<title>RadioData QML Type | 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-qmlmodule.html">QML Types</a></td><td >RadioData QML Type</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="#properties">Properties</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">RadioData QML Type</h1>
<span class="subtitle"></span>
<!-- $$$RadioData-brief -->
<p>Access RDS data from a QML application. <a href="#details">More...</a></p>
<!-- @@@RadioData -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtMultimedia 5.8</td></tr></table></div><ul>
<li><a href="qml-qtmultimedia-radiodata-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtmultimedia-radiodata.html#alternativeFrequenciesEnabled-prop">alternativeFrequenciesEnabled</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtmultimedia-radiodata.html#availability-prop">availability</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-qtmultimedia-radiodata.html#programType-prop">programType</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-qtmultimedia-radiodata.html#programTypeName-prop">programTypeName</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtmultimedia-radiodata.html#radioText-prop">radioText</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtmultimedia-radiodata.html#stationId-prop">stationId</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtmultimedia-radiodata.html#stationName-prop">stationName</a></b></b> : string</li>
</ul>
<!-- $$$RadioData-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p><code>RadioData</code> is your gateway to all the data available through RDS. RDS is the Radio Data System which allows radio stations to broadcast information like the <a href="qml-qtmultimedia-radiodata.html#stationId-prop">stationId</a>, <a href="qml-qtmultimedia-radiodata.html#programType-prop">programType</a>, <a href="qml-qtmultimedia-radiodata.html#programTypeName-prop">programTypeName</a>, <a href="qml-qtmultimedia-radiodata.html#stationName-prop">stationName</a>, and <a href="qml-qtmultimedia-radiodata.html#radioText-prop">radioText</a>. This information can be read from the <code>RadioData</code>. It also allows you to set whether the radio should tune to alternative frequencies if the current signal strength falls too much.</p>
<pre class="qml">
<span class="type">Rectangle</span> {
<span class="name">width</span>: <span class="number">480</span>
<span class="name">height</span>: <span class="number">320</span>
<span class="type"><a href="qml-qtmultimedia-radio.html">Radio</a></span> {
<span class="name">id</span>: <span class="name">radio</span>
<span class="name">band</span>: <span class="name">Radio</span>.<span class="name">FM</span>
}
<span class="type">Column</span> {
<span class="type">Text</span> {
<span class="name">text</span>: <span class="name">radio</span>.<span class="name">radioData</span>.<span class="name">stationName</span>
}
<span class="type">Text</span> {
<span class="name">text</span>: <span class="name">radio</span>.<span class="name">radioData</span>.<span class="name">programTypeName</span>
}
<span class="type">Text</span> {
<span class="name">text</span>: <span class="name">radio</span>.<span class="name">radioData</span>.<span class="name">radioText</span>
}
}
}
</pre>
<p>You use <code>RadioData</code> together with a <a href="qml-qtmultimedia-radio.html">Radio</a>, either by accessing the <code>radioData</code> property of the Radio, or creating a separate <a href="qml-qtmultimedia-radiodata.html">RadioData</a>. The properties of the <a href="qml-qtmultimedia-radiodata.html">RadioData</a> type will reflect the information broadcast by the radio station the Radio is currently tuned to.</p>
<p><b>See also </b><a href="radiooverview.html">Radio Overview</a>.</p>
<!-- @@@RadioData -->
<h2>Property Documentation</h2>
<!-- $$$alternativeFrequenciesEnabled -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="alternativeFrequenciesEnabled-prop">
<td class="tblQmlPropNode"><p>
<a name="alternativeFrequenciesEnabled-prop"></a><span class="name">alternativeFrequenciesEnabled</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property allows you to specify whether the radio should try and tune to alternative frequencies if the signal strength of the current station becomes too weak. The alternative frequencies are emitted over RDS by the radio station, and the tuning happens automatically.</p>
</div></div><!-- @@@alternativeFrequenciesEnabled -->
<br/>
<!-- $$$availability -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="availability-prop">
<td class="tblQmlPropNode"><p>
<a name="availability-prop"></a><span class="name">availability</span> : <span class="type">enumeration</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Returns the availability state of the radio data interface.</p>
<p>This is one of:</p>
<div class="table"><table class="generic">
<thead><tr class="qt-style"><th >Value</th><th >Description</th></tr></thead>
<tr valign="top" class="odd"><td >Available</td><td >The radio data interface is available to use</td></tr>
<tr valign="top" class="even"><td >Busy</td><td >The radio data interface is usually available to use, but is currently busy.</td></tr>
<tr valign="top" class="odd"><td >Unavailable</td><td >The radio data interface is not available to use (there may be no radio hardware)</td></tr>
<tr valign="top" class="even"><td >ResourceMissing</td><td >There is one or more resources missing, so the radio cannot be used. It may be possible to try again at a later time.</td></tr>
</table></div>
</div></div><!-- @@@availability -->
<br/>
<!-- $$$programType -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="programType-prop">
<td class="tblQmlPropNode"><p>
<a name="programType-prop"></a><span class="name">programType</span> : <span class="type">enumeration</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the type of the currently playing program as transmitted by the radio station. The value can be any one of the values defined in the table below.</p>
<div class="table"><table class="generic">
<thead><tr class="qt-style"><th >Value</th></tr></thead>
<tr valign="top" class="odd"><td >Undefined</td></tr>
<tr valign="top" class="even"><td >News</td></tr>
<tr valign="top" class="odd"><td >CurrentAffairs</td></tr>
<tr valign="top" class="even"><td >Information</td></tr>
<tr valign="top" class="odd"><td >Sport</td></tr>
<tr valign="top" class="even"><td >Education</td></tr>
<tr valign="top" class="odd"><td >Drama</td></tr>
<tr valign="top" class="even"><td >Culture</td></tr>
<tr valign="top" class="odd"><td >Science</td></tr>
<tr valign="top" class="even"><td >Varied</td></tr>
<tr valign="top" class="odd"><td >PopMusic</td></tr>
<tr valign="top" class="even"><td >RockMusic</td></tr>
<tr valign="top" class="odd"><td >EasyListening</td></tr>
<tr valign="top" class="even"><td >LightClassical</td></tr>
<tr valign="top" class="odd"><td >SeriousClassical</td></tr>
<tr valign="top" class="even"><td >OtherMusic</td></tr>
<tr valign="top" class="odd"><td >Weather</td></tr>
<tr valign="top" class="even"><td >Finance</td></tr>
<tr valign="top" class="odd"><td >ChildrensProgrammes</td></tr>
<tr valign="top" class="even"><td >SocialAffairs</td></tr>
<tr valign="top" class="odd"><td >Religion</td></tr>
<tr valign="top" class="even"><td >PhoneIn</td></tr>
<tr valign="top" class="odd"><td >Travel</td></tr>
<tr valign="top" class="even"><td >Leisure</td></tr>
<tr valign="top" class="odd"><td >JazzMusic</td></tr>
<tr valign="top" class="even"><td >CountryMusic</td></tr>
<tr valign="top" class="odd"><td >NationalMusic</td></tr>
<tr valign="top" class="even"><td >OldiesMusic</td></tr>
<tr valign="top" class="odd"><td >FolkMusic</td></tr>
<tr valign="top" class="even"><td >Documentary</td></tr>
<tr valign="top" class="odd"><td >AlarmTest</td></tr>
<tr valign="top" class="even"><td >Alarm</td></tr>
<tr valign="top" class="odd"><td >Talk</td></tr>
<tr valign="top" class="even"><td >ClassicRock</td></tr>
<tr valign="top" class="odd"><td >AdultHits</td></tr>
<tr valign="top" class="even"><td >SoftRock</td></tr>
<tr valign="top" class="odd"><td >Top40</td></tr>
<tr valign="top" class="even"><td >Soft</td></tr>
<tr valign="top" class="odd"><td >Nostalgia</td></tr>
<tr valign="top" class="even"><td >Classical</td></tr>
<tr valign="top" class="odd"><td >RhythmAndBlues</td></tr>
<tr valign="top" class="even"><td >SoftRhythmAndBlues</td></tr>
<tr valign="top" class="odd"><td >Language</td></tr>
<tr valign="top" class="even"><td >ReligiousMusic</td></tr>
<tr valign="top" class="odd"><td >ReligiousTalk</td></tr>
<tr valign="top" class="even"><td >Personality</td></tr>
<tr valign="top" class="odd"><td >Public</td></tr>
<tr valign="top" class="even"><td >College</td></tr>
</table></div>
</div></div><!-- @@@programType -->
<br/>
<!-- $$$programTypeName -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="programTypeName-prop">
<td class="tblQmlPropNode"><p>
<a name="programTypeName-prop"></a><span class="name">programTypeName</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds a string representation of the <a href="qml-qtmultimedia-radiodata.html#programType-prop">programType</a>.</p>
</div></div><!-- @@@programTypeName -->
<br/>
<!-- $$$radioText -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="radioText-prop">
<td class="tblQmlPropNode"><p>
<a name="radioText-prop"></a><span class="name">radioText</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds free-text transmitted by the radio station. This is typically used to show supporting information for the currently playing content, for instance song title or artist name.</p>
</div></div><!-- @@@radioText -->
<br/>
<!-- $$$stationId -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="stationId-prop">
<td class="tblQmlPropNode"><p>
<a name="stationId-prop"></a><span class="name">stationId</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property allows you to read the station Id of the currently tuned radio station.</p>
</div></div><!-- @@@stationId -->
<br/>
<!-- $$$stationName -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="stationName-prop">
<td class="tblQmlPropNode"><p>
<a name="stationName-prop"></a><span class="name">stationName</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property has the name of the currently tuned radio station.</p>
</div></div><!-- @@@stationName -->
<br/>
</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>
