/usr/share/qt5/doc/qtmultimedia/qsound.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 | <?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" />
<!-- qsound.cpp -->
<title>QSound 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>QSound</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="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#public-slots">Public Slots</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QSound Class</h1>
<!-- $$$QSound-brief -->
<p>The QSound class provides a method to play .wav sound files. <a href="#details">More...</a></p>
<!-- @@@QSound -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include <QSound></span>
</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> <tt>QT += multimedia</tt></td></tr></table><ul>
<li><a href="qsound-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="qsound.html#Loop-enum">Loop</a></b> { Infinite }</td></tr>
</table>
<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="qsound.html#QSound">QSound</a></b>(const QString &<i> filename</i>, QObject *<i> parent</i> = 0)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qsound.html#dtor.QSound">~QSound</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qsound.html#fileName">fileName</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qsound.html#isFinished">isFinished</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qsound.html#loops">loops</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qsound.html#loopsRemaining">loopsRemaining</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsound.html#setLoops">setLoops</a></b>(int<i> number</i>)</td></tr>
</table>
<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="qsound.html#play-2">play</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsound.html#stop">stop</a></b>()</td></tr>
</table>
<a name="static-public-members"></a>
<h2>Static Public Members</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsound.html#play">play</a></b>(const QString &<i> filename</i>)</td></tr>
</table>
<a name="details"></a>
<!-- $$$QSound-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QSound class provides a method to play .wav sound files.</p>
<p>Qt provides the most commonly required audio operation in GUI applications: asynchronously playing a sound file. This is most easily accomplished using the static <a href="qsound.html#play">play</a>() function:</p>
<pre class="cpp"><span class="type">QSound</span><span class="operator">::</span>play(<span class="string">"mysounds/bells.wav"</span>);</pre>
<p>Alternatively, create a QSound object from the sound file first and then call the <a href="qsound.html#play">play</a>() slot:</p>
<pre class="cpp"><span class="type">QSound</span> bells(<span class="string">"mysounds/bells.wav"</span>);
bells<span class="operator">.</span>play();</pre>
<p>Once created a QSound object can be queried for its <a href="qsound.html#fileName">fileName</a>() and total number of <a href="qsound.html#loops">loops</a>() (i.e. the number of times the sound will play). The number of repetitions can be altered using the <a href="qsound.html#setLoops">setLoops</a>() function. While playing the sound, the <a href="qsound.html#loopsRemaining">loopsRemaining</a>() function returns the remaining number of repetitions. Use the <a href="qsound.html#isFinished">isFinished</a>() function to determine whether the sound has finished playing.</p>
<p>Sounds played using a QSound object may use more memory than the static <a href="qsound.html#play">play</a>() function, but it may also play more immediately (depending on the underlying platform audio facilities).</p>
<p>If you require finer control over playing sounds, consider the <a href="qsoundeffect.html">QSoundEffect</a> or <a href="qaudiooutput.html">QAudioOutput</a> classes.</p>
</div>
<p><b>See also </b><a href="qsoundeffect.html">QSoundEffect</a>.</p>
<!-- @@@QSound -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$Loop$$$Infinite -->
<h3 class="fn"><a name="Loop-enum"></a>enum QSound::<span class="name">Loop</span></h3>
<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>QSound::Infinite</tt></td><td class="topAlign"><tt>-1</tt></td><td class="topAlign">Can be used as a parameter to <a href="qsound.html#setLoops">setLoops</a>() to loop infinitely.</td></tr>
</table>
<!-- @@@Loop -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QSound[overload1]$$$QSoundconstQString&QObject* -->
<h3 class="fn"><a name="QSound"></a>QSound::<span class="name">QSound</span>(const <span class="type">QString</span> &<i> filename</i>, <span class="type">QObject</span> *<i> parent</i> = 0)</h3>
<p>Constructs a <a href="qsound.html">QSound</a> object from the file specified by the given <i>filename</i> and with the given <i>parent</i>.</p>
<p><b>See also </b><a href="qsound.html#play">play</a>().</p>
<!-- @@@QSound -->
<!-- $$$~QSound[overload1]$$$~QSound -->
<h3 class="fn"><a name="dtor.QSound"></a>QSound::<span class="name">~QSound</span>()</h3>
<p>Destroys this sound object. If the sound is not finished playing, the <a href="qsound.html#stop">stop</a>() function is called before the sound object is destroyed.</p>
<p><b>See also </b><a href="qsound.html#stop">stop</a>() and <a href="qsound.html#isFinished">isFinished</a>().</p>
<!-- @@@~QSound -->
<!-- $$$fileName[overload1]$$$fileName -->
<h3 class="fn"><a name="fileName"></a><span class="type">QString</span> QSound::<span class="name">fileName</span>() const</h3>
<p>Returns the filename associated with this <a href="qsound.html">QSound</a> object.</p>
<p><b>See also </b><a href="qsound.html#QSound">QSound</a>().</p>
<!-- @@@fileName -->
<!-- $$$isFinished[overload1]$$$isFinished -->
<h3 class="fn"><a name="isFinished"></a><span class="type">bool</span> QSound::<span class="name">isFinished</span>() const</h3>
<p>Returns true if the sound has finished playing; otherwise returns false.</p>
<!-- @@@isFinished -->
<!-- $$$loops[overload1]$$$loops -->
<h3 class="fn"><a name="loops"></a><span class="type">int</span> QSound::<span class="name">loops</span>() const</h3>
<p>Returns the number of times the sound will play. Return value of <tt>QSound::Infinite</tt> indicates infinite number of loops</p>
<p><b>See also </b><a href="qsound.html#loopsRemaining">loopsRemaining</a>() and <a href="qsound.html#setLoops">setLoops</a>().</p>
<!-- @@@loops -->
<!-- $$$loopsRemaining[overload1]$$$loopsRemaining -->
<h3 class="fn"><a name="loopsRemaining"></a><span class="type">int</span> QSound::<span class="name">loopsRemaining</span>() const</h3>
<p>Returns the remaining number of times the sound will loop (for all positive values this value decreases each time the sound is played). Return value of <tt>QSound::Infinite</tt> indicates infinite number of loops</p>
<p><b>See also </b><a href="qsound.html#loops">loops</a>() and <a href="qsound.html#isFinished">isFinished</a>().</p>
<!-- @@@loopsRemaining -->
<!-- $$$play[overload1]$$$playconstQString& -->
<h3 class="fn"><a name="play"></a><span class="type">void</span> QSound::<span class="name">play</span>(const <span class="type">QString</span> &<i> filename</i>)<tt> [static]</tt></h3>
<p>Plays the sound stored in the file specified by the given <i>filename</i>.</p>
<p><b>See also </b><a href="qsound.html#stop">stop</a>(), <a href="qsound.html#loopsRemaining">loopsRemaining</a>(), and <a href="qsound.html#isFinished">isFinished</a>().</p>
<!-- @@@play -->
<!-- $$$play$$$play -->
<h3 class="fn"><a name="play-2"></a><span class="type">void</span> QSound::<span class="name">play</span>()<tt> [slot]</tt></h3>
<p>This is an overloaded function.</p>
<p>Starts playing the sound specified by this <a href="qsound.html">QSound</a> object.</p>
<p>The function returns immediately. Depending on the platform audio facilities, other sounds may stop or be mixed with the new sound. The sound can be played again at any time, possibly mixing or replacing previous plays of the sound.</p>
<p><b>See also </b><a href="qsound.html#fileName">fileName</a>().</p>
<!-- @@@play -->
<!-- $$$setLoops[overload1]$$$setLoopsint -->
<h3 class="fn"><a name="setLoops"></a><span class="type">void</span> QSound::<span class="name">setLoops</span>(<span class="type">int</span><i> number</i>)</h3>
<p>Sets the sound to repeat the given <i>number</i> of times when it is played.</p>
<p>Note that passing the value <tt>QSound::Infinite</tt> will cause the sound to loop indefinitely.</p>
<p><b>See also </b><a href="qsound.html#loops">loops</a>().</p>
<!-- @@@setLoops -->
<!-- $$$stop[overload1]$$$stop -->
<h3 class="fn"><a name="stop"></a><span class="type">void</span> QSound::<span class="name">stop</span>()<tt> [slot]</tt></h3>
<p>Stops the sound playing.</p>
<p><b>See also </b><a href="qsound.html#play">play</a>().</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>
|