<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qdeclarative_audiocategory_p.cpp --> <title>AudioCategory QML Type | Qt Multimedia 5.12.2</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.12</td><td ><a href="qtmultimedia-index.html">Qt Multimedia</a></td><td ><a href="qtmultimedia-qmlmodule.html">QML Types</a></td><td >AudioCategory QML Type</td></tr></table><table class="buildversion"><tr> <td id="buildversion" width="100%" align="right"><a href="qtmultimedia-index.html">Qt 5.12.2 Reference Documentation</a></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="#methods">Methods</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">AudioCategory QML Type</h1> <span class="subtitle"></span> <!-- $$$AudioCategory-brief --> <p>Control all active sound instances by group. <a href="#details">More...</a></p> <!-- @@@AudioCategory --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtAudioEngine 1.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.0</td></tr></table></div><ul> <li><a href="qml-qtaudioengine-audiocategory-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-qtaudioengine-audiocategory.html#name-prop">name</a></b></b> : string</li> <li class="fn"><b><b><a href="qml-qtaudioengine-audiocategory.html#volume-prop">volume</a></b></b> : real</li> </ul> <a name="methods"></a> <h2 id="methods">Methods</h2> <ul> <li class="fn"><b><b><a href="qml-qtaudioengine-audiocategory.html#pause-method">pause</a></b></b>()</li> <li class="fn"><b><b><a href="qml-qtaudioengine-audiocategory.html#pause-method-1">pause</a></b></b>()</li> <li class="fn"><b><b><a href="qml-qtaudioengine-audiocategory.html#stop-method">stop</a></b></b>()</li> </ul> <!-- $$$AudioCategory-description --> <a name="details"></a> <h2 id="details">Detailed Description</h2> <p>An instance of <a href="qml-qtaudioengine-audiocategory.html">AudioCategory</a> can be accessed through <a href="qml-qtaudioengine-audioengine.html#categories-prop">AudioEngine.categories</a> with its unique name and must be defined inside <a href="qml-qtaudioengine-audioengine.html">AudioEngine</a> or be added to it using <a href="qml-qtaudioengine-audioengine.html#addAudioCategory-method">AudioEngine.addAudioCategory()</a> if <a href="qml-qtaudioengine-audiocategory.html">AudioCategory</a> is created dynamically.</p> <pre class="qml"> </pre> <p><a href="qml-qtaudioengine-sound.html">Sound</a> instances can be grouped together by specifying the category property. When you change the volume of a category, all audio output from related instances will be affected as well.</p> <p>Note: there will always be an <a href="qml-qtaudioengine-audiocategory.html">AudioCategory</a> named <code>default</code> whether you explicitly define it or not. If you do not specify any category for a <a href="qml-qtaudioengine-sound.html">Sound</a>, it will be grouped into the <code>default</code> category.</p> <!-- @@@AudioCategory --> <h2>Property Documentation</h2> <!-- $$$name --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="name-prop"> <td class="tblQmlPropNode"><p> <a name="name-prop"></a><span class="name">name</span> : <span class="type">string</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the name of <a href="qml-qtaudioengine-audiocategory.html">AudioCategory</a>. The name must be unique among all categories and only defined once. The name cannot be changed after the instance has been initialized.</p> </div></div><!-- @@@name --> <br/> <!-- $$$volume --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="volume-prop"> <td class="tblQmlPropNode"><p> <a name="volume-prop"></a><span class="name">volume</span> : <span class="type">real</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the volume of the category and will modulate all audio output from the instances which belong to this category.</p> </div></div><!-- @@@volume --> <br/> <h2>Method Documentation</h2> <!-- $$$pause --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="pause-method"> <td class="tblQmlFuncNode"><p> <a name="pause-method"></a><span class="name">pause</span>()</p></td></tr> </table></div> </div><div class="qmldoc"><p>Pauses all active sound instances which belong to this category.</p> </div></div><!-- @@@pause --> <br/> <!-- $$$pause --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="pause-method-1"> <td class="tblQmlFuncNode"><p> <a name="pause-method-1"></a><span class="name">pause</span>()</p></td></tr> </table></div> </div><div class="qmldoc"><p>Resumes all active sound instances from paused state which belong to this category.</p> </div></div><!-- @@@pause --> <br/> <!-- $$$stop --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="stop-method"> <td class="tblQmlFuncNode"><p> <a name="stop-method"></a><span class="name">stop</span>()</p></td></tr> </table></div> </div><div class="qmldoc"><p>Stops all active sound instances which belong to this category.</p> </div></div><!-- @@@stop --> <br/> </div> </div> </div> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2019 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>