summaryrefslogtreecommitdiffstats
path: root/doc/html/ntqsound.html
diff options
context:
space:
mode:
authorTimothy Pearson <kb9vqf@pearsoncomputing.net>2012-01-26 23:32:43 -0600
committerTimothy Pearson <kb9vqf@pearsoncomputing.net>2012-01-26 23:32:43 -0600
commitea318d1431c89e647598c510c4245c6571aa5f46 (patch)
tree996d29b80c30d453dda86d1a23162d441628f169 /doc/html/ntqsound.html
parentaaf89d4b48f69c9293feb187db26362e550b5561 (diff)
downloadtqt3-ea318d1431c89e647598c510c4245c6571aa5f46.tar.gz
tqt3-ea318d1431c89e647598c510c4245c6571aa5f46.zip
Update to latest tqt3 automated conversion
Diffstat (limited to 'doc/html/ntqsound.html')
-rw-r--r--doc/html/ntqsound.html180
1 files changed, 180 insertions, 0 deletions
diff --git a/doc/html/ntqsound.html b/doc/html/ntqsound.html
new file mode 100644
index 000000000..2e052157f
--- /dev/null
+++ b/doc/html/ntqsound.html
@@ -0,0 +1,180 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/kernel/qsound.cpp:97 -->
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>TQSound Class</title>
+<style type="text/css"><!--
+fn { margin-left: 1cm; text-indent: -1cm; }
+a:link { color: #004faf; text-decoration: none }
+a:visited { color: #672967; text-decoration: none }
+body { background: #ffffff; color: black; }
+--></style>
+</head>
+<body>
+
+<table border="0" cellpadding="0" cellspacing="0" width="100%">
+<tr bgcolor="#E5E5E5">
+<td valign=center>
+ <a href="index.html">
+<font color="#004faf">Home</font></a>
+ | <a href="classes.html">
+<font color="#004faf">All&nbsp;Classes</font></a>
+ | <a href="mainclasses.html">
+<font color="#004faf">Main&nbsp;Classes</font></a>
+ | <a href="annotated.html">
+<font color="#004faf">Annotated</font></a>
+ | <a href="groups.html">
+<font color="#004faf">Grouped&nbsp;Classes</font></a>
+ | <a href="functions.html">
+<font color="#004faf">Functions</font></a>
+</td>
+<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>TQSound Class Reference</h1>
+
+<p>The TQSound class provides access to the platform audio facilities.
+<a href="#details">More...</a>
+<p><tt>#include &lt;<a href="qsound-h.html">ntqsound.h</a>&gt;</tt>
+<p>Inherits <a href="ntqobject.html">TQObject</a>.
+<p><a href="qsound-members.html">List of all member functions.</a>
+<h2>Public Members</h2>
+<ul>
+<li class=fn><a href="#TQSound"><b>TQSound</b></a> ( const&nbsp;TQString&nbsp;&amp;&nbsp;filename, TQObject&nbsp;*&nbsp;parent = 0, const&nbsp;char&nbsp;*&nbsp;name = 0 )</li>
+<li class=fn><a href="#~TQSound"><b>~TQSound</b></a> ()</li>
+<li class=fn>int <a href="#loops"><b>loops</b></a> () const</li>
+<li class=fn>int <a href="#loopsRemaining"><b>loopsRemaining</b></a> () const</li>
+<li class=fn>void <a href="#setLoops"><b>setLoops</b></a> ( int&nbsp;l )</li>
+<li class=fn>TQString <a href="#fileName"><b>fileName</b></a> () const</li>
+<li class=fn>bool <a href="#isFinished"><b>isFinished</b></a> () const</li>
+</ul>
+<h2>Public Slots</h2>
+<ul>
+<li class=fn>void <a href="#play-2"><b>play</b></a> ()</li>
+<li class=fn>void <a href="#stop"><b>stop</b></a> ()</li>
+</ul>
+<h2>Static Public Members</h2>
+<ul>
+<li class=fn>bool <a href="#isAvailable"><b>isAvailable</b></a> ()</li>
+<li class=fn>void <a href="#play"><b>play</b></a> ( const&nbsp;TQString&nbsp;&amp;&nbsp;filename )</li>
+<li class=fn>bool <a href="#available"><b>available</b></a> ()</li>
+</ul>
+<hr><a name="details"></a><h2>Detailed Description</h2>
+
+
+The TQSound class provides access to the platform audio facilities.
+<p>
+
+<p> TQt provides the most commonly required audio operation in GUI
+applications: asynchronously playing a sound file. This is most
+easily accomplished with a single call:
+<pre>
+ TQSound::<a href="#play">play</a>("mysounds/bells.wav");
+ </pre>
+
+<p> A second API is provided in which a TQSound object is created from
+a sound file and is played later:
+<pre>
+ TQSound bells("mysounds/bells.wav");
+
+ bells.<a href="#play">play</a>();
+ </pre>
+
+<p> Sounds played using the second model may use more memory but play
+more immediately than sounds played using the first model,
+depending on the underlying platform audio facilities.
+<p> On Microsoft Windows the underlying multimedia system is used;
+only WAVE format sound files are supported.
+<p> On X11 the <a href="ftp://ftp.x.org/contrib/audio/nas/">Network Audio
+ System</a> is used if available, otherwise all operations work
+silently. NAS supports WAVE and AU files.
+<p> On Macintosh, ironically, we use QT (<a href="http://tquicktime.apple.com">QuickTime</a>) for sound, this
+means all QuickTime formats are supported by TQt/Mac.
+<p> On TQt/Embedded, a built-in mixing sound server is used, which
+accesses <tt>/dev/dsp</tt> directly. Only the WAVE format is supported.
+<p> The availability of sound can be tested with
+<a href="#isAvailable">TQSound::isAvailable</a>().
+<p>See also <a href="multimedia.html">Multimedia Classes</a>.
+
+<hr><h2>Member Function Documentation</h2>
+<h3 class=fn><a name="TQSound"></a>TQSound::TQSound ( const&nbsp;<a href="ntqstring.html">TQString</a>&nbsp;&amp;&nbsp;filename, <a href="ntqobject.html">TQObject</a>&nbsp;*&nbsp;parent = 0, const&nbsp;char&nbsp;*&nbsp;name = 0 )
+</h3>
+Constructs a TQSound that can tquickly play the sound in a file
+named <em>filename</em>.
+<p> This may use more memory than the static <tt>play</tt> function.
+<p> The <em>parent</em> and <em>name</em> arguments (default 0) are passed on to
+the <a href="ntqobject.html">TQObject</a> constructor.
+
+<h3 class=fn><a name="~TQSound"></a>TQSound::~TQSound ()
+</h3>
+Destroys the sound object. If the sound is not finished playing <a href="#stop">stop</a>() is called on it.
+<p> <p>See also <a href="#stop">stop</a>() and <a href="#isFinished">isFinished</a>().
+
+<h3 class=fn>bool <a name="available"></a>TQSound::available ()<tt> [static]</tt>
+</h3>
+
+<p> Returns TRUE if sound support is available; otherwise returns FALSE.
+
+<h3 class=fn><a href="ntqstring.html">TQString</a> <a name="fileName"></a>TQSound::fileName () const
+</h3>
+Returns the filename associated with the sound.
+
+<h3 class=fn>bool <a name="isAvailable"></a>TQSound::isAvailable ()<tt> [static]</tt>
+</h3>
+Returns TRUE if sound facilities exist on the platform; otherwise
+returns FALSE. An application may choose either to notify the user
+if sound is crucial to the application or to operate silently
+without bothering the user.
+<p> If no sound is available, all TQSound operations work silently and
+tquickly.
+
+<h3 class=fn>bool <a name="isFinished"></a>TQSound::isFinished () const
+</h3>
+Returns TRUE if the sound has finished playing; otherwise returns FALSE.
+<p> <b>Warning:</b> On Windows this function always returns TRUE for unlooped sounds.
+
+<h3 class=fn>int <a name="loops"></a>TQSound::loops () const
+</h3>
+Returns the number of times the sound will play.
+
+<h3 class=fn>int <a name="loopsRemaining"></a>TQSound::loopsRemaining () const
+</h3>
+Returns the number of times the sound will loop. This value
+decreases each time the sound loops.
+
+<h3 class=fn>void <a name="play"></a>TQSound::play ( const&nbsp;<a href="ntqstring.html">TQString</a>&nbsp;&amp;&nbsp;filename )<tt> [static]</tt>
+</h3>
+Plays the sound in a file called <em>filename</em>.
+
+<p>Example: <a href="sound-example.html#x2813">sound/sound.cpp</a>.
+<h3 class=fn>void <a name="play-2"></a>TQSound::play ()<tt> [slot]</tt>
+</h3>
+This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
+<p> Starts the sound playing. The function returns immediately.
+Depending on the platform audio facilities, other sounds may stop
+or may be mixed with the new sound.
+<p> The sound can be played again at any time, possibly mixing or
+replacing previous plays of the sound.
+
+<h3 class=fn>void <a name="setLoops"></a>TQSound::setLoops ( int&nbsp;l )
+</h3>
+Sets the sound to repeat <em>l</em> times when it is played. Passing the
+value -1 will cause the sound to loop indefinitely.
+<p> <p>See also <a href="#loops">loops</a>().
+
+<h3 class=fn>void <a name="stop"></a>TQSound::stop ()<tt> [slot]</tt>
+</h3>
+Stops the sound playing.
+<p> On Windows the current loop will finish if a sound is played
+in a loop.
+<p> <p>See also <a href="#play">play</a>().
+
+<!-- eof -->
+<hr><p>
+This file is part of the <a href="index.html">TQt toolkit</a>.
+Copyright &copy; 1995-2007
+<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
+<table width=100% cellspacing=0 border=0><tr>
+<td>Copyright &copy; 2007
+<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
+<td align=right><div align=right>TQt 3.3.8</div>
+</table></div></address></body>
+</html>