<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Audaspace: IHandle Interface Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Audaspace
 <span id="projectnumber">1.3.0</span>
</div>
<div id="projectbrief">A high level audio library.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classIHandle-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">IHandle Interface Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="classIHandle.html" title="The IHandle interface represents a playback handles of a specific device.">IHandle</a> interface represents a playback handles of a specific device.
<a href="classIHandle.html#details">More...</a></p>
<p><code>#include <<a class="el" href="IHandle_8h_source.html">IHandle.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for IHandle:</div>
<div class="dyncontent">
<div class="center"><img src="classIHandle__inherit__graph.png" border="0" usemap="#IHandle_inherit__map" alt="Inheritance graph"/></div>
<map name="IHandle_inherit__map" id="IHandle_inherit__map">
<area shape="rect" title="The IHandle interface represents a playback handles of a specific device." alt="" coords="59,5,130,32"/>
<area shape="rect" href="classSoftwareDevice_1_1SoftwareHandle.html" title="Saves the data for playback." alt="" coords="5,80,184,121"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a89bef702f304fc1e567e73096851ae7f"><td class="memItemLeft" align="right" valign="top"><a id="a89bef702f304fc1e567e73096851ae7f"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classIHandle.html#a89bef702f304fc1e567e73096851ae7f">~IHandle</a> ()</td></tr>
<tr class="memdesc:a89bef702f304fc1e567e73096851ae7f"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the handle. <br /></td></tr>
<tr class="separator:a89bef702f304fc1e567e73096851ae7f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0fc16e686a1877ba08e251ba61b58aa0"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIHandle.html#a0fc16e686a1877ba08e251ba61b58aa0">pause</a> ()=0</td></tr>
<tr class="memdesc:a0fc16e686a1877ba08e251ba61b58aa0"><td class="mdescLeft"> </td><td class="mdescRight">Pauses a played back sound. <a href="#a0fc16e686a1877ba08e251ba61b58aa0">More...</a><br /></td></tr>
<tr class="separator:a0fc16e686a1877ba08e251ba61b58aa0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abfb96fe7ece8de8336a2cceeb1d7f5a3"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIHandle.html#abfb96fe7ece8de8336a2cceeb1d7f5a3">resume</a> ()=0</td></tr>
<tr class="memdesc:abfb96fe7ece8de8336a2cceeb1d7f5a3"><td class="mdescLeft"> </td><td class="mdescRight">Resumes a paused sound. <a href="#abfb96fe7ece8de8336a2cceeb1d7f5a3">More...</a><br /></td></tr>
<tr class="separator:abfb96fe7ece8de8336a2cceeb1d7f5a3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6baaee5885c8aa04e56172f3bb43728b"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIHandle.html#a6baaee5885c8aa04e56172f3bb43728b">stop</a> ()=0</td></tr>
<tr class="memdesc:a6baaee5885c8aa04e56172f3bb43728b"><td class="mdescLeft"> </td><td class="mdescRight">Stops a played back or paused sound. <a href="#a6baaee5885c8aa04e56172f3bb43728b">More...</a><br /></td></tr>
<tr class="separator:a6baaee5885c8aa04e56172f3bb43728b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a02006cf45d391395441bad4395ae24a8"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIHandle.html#a02006cf45d391395441bad4395ae24a8">getKeep</a> ()=0</td></tr>
<tr class="memdesc:a02006cf45d391395441bad4395ae24a8"><td class="mdescLeft"> </td><td class="mdescRight">Gets the behaviour of the device for a played back sound when the sound doesn't return any more samples. <a href="#a02006cf45d391395441bad4395ae24a8">More...</a><br /></td></tr>
<tr class="separator:a02006cf45d391395441bad4395ae24a8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a73929d9cc4b8e360341f813182d53517"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIHandle.html#a73929d9cc4b8e360341f813182d53517">setKeep</a> (bool keep)=0</td></tr>
<tr class="memdesc:a73929d9cc4b8e360341f813182d53517"><td class="mdescLeft"> </td><td class="mdescRight">Sets the behaviour of the device for a played back sound when the sound doesn't return any more samples. <a href="#a73929d9cc4b8e360341f813182d53517">More...</a><br /></td></tr>
<tr class="separator:a73929d9cc4b8e360341f813182d53517"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9c88264d4a2fae2e7eedb6b219d2c2d5"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIHandle.html#a9c88264d4a2fae2e7eedb6b219d2c2d5">seek</a> (float position)=0</td></tr>
<tr class="memdesc:a9c88264d4a2fae2e7eedb6b219d2c2d5"><td class="mdescLeft"> </td><td class="mdescRight">Seeks in a played back sound. <a href="#a9c88264d4a2fae2e7eedb6b219d2c2d5">More...</a><br /></td></tr>
<tr class="separator:a9c88264d4a2fae2e7eedb6b219d2c2d5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a820f82815f4fbe912c904fd1545505ac"><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classIHandle.html#a820f82815f4fbe912c904fd1545505ac">getPosition</a> ()=0</td></tr>
<tr class="memdesc:a820f82815f4fbe912c904fd1545505ac"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the current playback position of a sound. <a href="#a820f82815f4fbe912c904fd1545505ac">More...</a><br /></td></tr>
<tr class="separator:a820f82815f4fbe912c904fd1545505ac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a37f66a258a3f296b72bf22b472203244"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="IHandle_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIHandle.html#a37f66a258a3f296b72bf22b472203244">getStatus</a> ()=0</td></tr>
<tr class="memdesc:a37f66a258a3f296b72bf22b472203244"><td class="mdescLeft"> </td><td class="mdescRight">Returns the status of a played back sound. <a href="#a37f66a258a3f296b72bf22b472203244">More...</a><br /></td></tr>
<tr class="separator:a37f66a258a3f296b72bf22b472203244"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aea0709d0f78e9293abc68dc38ad8eade"><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classIHandle.html#aea0709d0f78e9293abc68dc38ad8eade">getVolume</a> ()=0</td></tr>
<tr class="memdesc:aea0709d0f78e9293abc68dc38ad8eade"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the volume of a playing sound. <a href="#aea0709d0f78e9293abc68dc38ad8eade">More...</a><br /></td></tr>
<tr class="separator:aea0709d0f78e9293abc68dc38ad8eade"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab67d0b33d9c3c8ea4cc3765c3dcd27c9"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIHandle.html#ab67d0b33d9c3c8ea4cc3765c3dcd27c9">setVolume</a> (float volume)=0</td></tr>
<tr class="memdesc:ab67d0b33d9c3c8ea4cc3765c3dcd27c9"><td class="mdescLeft"> </td><td class="mdescRight">Sets the volume of a playing sound. <a href="#ab67d0b33d9c3c8ea4cc3765c3dcd27c9">More...</a><br /></td></tr>
<tr class="separator:ab67d0b33d9c3c8ea4cc3765c3dcd27c9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a25dd1e605398070f8c3dfee577c4ce90"><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classIHandle.html#a25dd1e605398070f8c3dfee577c4ce90">getPitch</a> ()=0</td></tr>
<tr class="memdesc:a25dd1e605398070f8c3dfee577c4ce90"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the pitch of a playing sound. <a href="#a25dd1e605398070f8c3dfee577c4ce90">More...</a><br /></td></tr>
<tr class="separator:a25dd1e605398070f8c3dfee577c4ce90"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af7af272f12401f9613b46a3fd0569a91"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIHandle.html#af7af272f12401f9613b46a3fd0569a91">setPitch</a> (float pitch)=0</td></tr>
<tr class="memdesc:af7af272f12401f9613b46a3fd0569a91"><td class="mdescLeft"> </td><td class="mdescRight">Sets the pitch of a playing sound. <a href="#af7af272f12401f9613b46a3fd0569a91">More...</a><br /></td></tr>
<tr class="separator:af7af272f12401f9613b46a3fd0569a91"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa5e9c70dc7ac6189aba0d37ebaab2afe"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classIHandle.html#aa5e9c70dc7ac6189aba0d37ebaab2afe">getLoopCount</a> ()=0</td></tr>
<tr class="memdesc:aa5e9c70dc7ac6189aba0d37ebaab2afe"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the loop count of a playing sound. <a href="#aa5e9c70dc7ac6189aba0d37ebaab2afe">More...</a><br /></td></tr>
<tr class="separator:aa5e9c70dc7ac6189aba0d37ebaab2afe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a193603d25c7c64f8e8df2c34293533e0"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIHandle.html#a193603d25c7c64f8e8df2c34293533e0">setLoopCount</a> (int count)=0</td></tr>
<tr class="memdesc:a193603d25c7c64f8e8df2c34293533e0"><td class="mdescLeft"> </td><td class="mdescRight">Sets the loop count of a playing sound. <a href="#a193603d25c7c64f8e8df2c34293533e0">More...</a><br /></td></tr>
<tr class="separator:a193603d25c7c64f8e8df2c34293533e0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af9e65dd5913ce74b8429e0f1f75564a0"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIHandle.html#af9e65dd5913ce74b8429e0f1f75564a0">setStopCallback</a> (<a class="el" href="IHandle_8h.html#ad7147ffa399f8915e95b9e2eb94ca6e5">stopCallback</a> callback=0, void *data=0)=0</td></tr>
<tr class="memdesc:af9e65dd5913ce74b8429e0f1f75564a0"><td class="mdescLeft"> </td><td class="mdescRight">Sets the callback function that's called when the end of a playing sound is reached. <a href="#af9e65dd5913ce74b8429e0f1f75564a0">More...</a><br /></td></tr>
<tr class="separator:af9e65dd5913ce74b8429e0f1f75564a0"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="classIHandle.html" title="The IHandle interface represents a playback handles of a specific device.">IHandle</a> interface represents a playback handles of a specific device. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a02006cf45d391395441bad4395ae24a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02006cf45d391395441bad4395ae24a8">◆ </a></span>getKeep()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool IHandle::getKeep </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the behaviour of the device for a played back sound when the sound doesn't return any more samples. </p>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>true if the source will be paused when it's end is reached</li>
<li>false if the handle won't kept or is invalid. </li>
</ul>
</dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#a4d425171e9687101f406681cce536f68">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="aa5e9c70dc7ac6189aba0d37ebaab2afe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5e9c70dc7ac6189aba0d37ebaab2afe">◆ </a></span>getLoopCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int IHandle::getLoopCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the loop count of a playing sound. </p>
<p>A negative value indicates infinity. </p><dl class="section return"><dt>Returns</dt><dd>The remaining loop count. </dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#af046364c899fff5fdaa21fb8542cc136">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="a25dd1e605398070f8c3dfee577c4ce90"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25dd1e605398070f8c3dfee577c4ce90">◆ </a></span>getPitch()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual float IHandle::getPitch </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the pitch of a playing sound. </p>
<dl class="section return"><dt>Returns</dt><dd>The pitch. </dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#a8430ff9e83b7a7ebb3c6d45912377c44">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="a820f82815f4fbe912c904fd1545505ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a820f82815f4fbe912c904fd1545505ac">◆ </a></span>getPosition()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual float IHandle::getPosition </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the current playback position of a sound. </p>
<dl class="section return"><dt>Returns</dt><dd>The playback position in seconds, or 0.0 if the handle is invalid. </dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#ae35ffa19962da2d3f9e96ca22f8d2973">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="a37f66a258a3f296b72bf22b472203244"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a37f66a258a3f296b72bf22b472203244">◆ </a></span>getStatus()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="IHandle_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a> IHandle::getStatus </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the status of a played back sound. </p>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>STATUS_INVALID if the sound has stopped or the handle is . invalid</li>
<li>STATUS_PLAYING if the sound is currently played back.</li>
<li>STATUS_PAUSED if the sound is currently paused.</li>
<li>STATUS_STOPPED if the sound finished playing and is still kept in the device. </li>
</ul>
</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="IHandle_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70b" title="Status of a playback handle.">Status</a> </dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#a41d47b239bc758a7ede8d5d77ecf786f">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="aea0709d0f78e9293abc68dc38ad8eade"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea0709d0f78e9293abc68dc38ad8eade">◆ </a></span>getVolume()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual float IHandle::getVolume </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the volume of a playing sound. </p>
<dl class="section return"><dt>Returns</dt><dd>The volume. </dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#afcbacd038e3e6995573d3beeecdda351">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="a0fc16e686a1877ba08e251ba61b58aa0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0fc16e686a1877ba08e251ba61b58aa0">◆ </a></span>pause()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool IHandle::pause </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Pauses a played back sound. </p>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>true if the sound has been paused.</li>
<li>false if the sound isn't playing back or the handle is invalid. </li>
</ul>
</dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#a64037e65c58df942ae007b6f05de43dd">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="abfb96fe7ece8de8336a2cceeb1d7f5a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abfb96fe7ece8de8336a2cceeb1d7f5a3">◆ </a></span>resume()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool IHandle::resume </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Resumes a paused sound. </p>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>true if the sound has been resumed.</li>
<li>false if the sound isn't paused or the handle is invalid. </li>
</ul>
</dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#afbe995eb1060c902363220624c623077">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="a9c88264d4a2fae2e7eedb6b219d2c2d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c88264d4a2fae2e7eedb6b219d2c2d5">◆ </a></span>seek()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool IHandle::seek </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>position</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Seeks in a played back sound. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">position</td><td>The new position from where to play back, in seconds. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>true if the handle is valid.</li>
<li>false if the handle is invalid. </li>
</ul>
</dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>Whether the seek works or not depends on the sound source. </dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#a4a1da333f06eda0d06bce55b5c2bd05c">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="a73929d9cc4b8e360341f813182d53517"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73929d9cc4b8e360341f813182d53517">◆ </a></span>setKeep()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool IHandle::setKeep </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>keep</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the behaviour of the device for a played back sound when the sound doesn't return any more samples. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">keep</td><td>True when the source should be paused and not deleted. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>true if the behaviour has been changed.</li>
<li>false if the handle is invalid. </li>
</ul>
</dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#af095e10132803b6f4e091db286495a67">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="a193603d25c7c64f8e8df2c34293533e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a193603d25c7c64f8e8df2c34293533e0">◆ </a></span>setLoopCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool IHandle::setLoopCount </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>count</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the loop count of a playing sound. </p>
<p>A negative value indicates infinity. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">count</td><td>The new loop count. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>true if the handle is valid.</li>
<li>false if the handle is invalid. </li>
</ul>
</dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#a2585dfc2eef13fdd60ba08a6b7df4d87">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="af7af272f12401f9613b46a3fd0569a91"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af7af272f12401f9613b46a3fd0569a91">◆ </a></span>setPitch()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool IHandle::setPitch </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>pitch</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the pitch of a playing sound. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pitch</td><td>The pitch. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>true if the handle is valid.</li>
<li>false if the handle is invalid. </li>
</ul>
</dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#a0f346edef33226643620762b4bb98050">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="af9e65dd5913ce74b8429e0f1f75564a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af9e65dd5913ce74b8429e0f1f75564a0">◆ </a></span>setStopCallback()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool IHandle::setStopCallback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="IHandle_8h.html#ad7147ffa399f8915e95b9e2eb94ca6e5">stopCallback</a> </td>
<td class="paramname"><em>callback</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the callback function that's called when the end of a playing sound is reached. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">callback</td><td>The callback function. </td></tr>
<tr><td class="paramname">data</td><td>The data that should be passed to the callback function. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>true if the handle is valid.</li>
<li>false if the handle is invalid. </li>
</ul>
</dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#a166bfdf8089677eb339346d453d73fbc">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="ab67d0b33d9c3c8ea4cc3765c3dcd27c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab67d0b33d9c3c8ea4cc3765c3dcd27c9">◆ </a></span>setVolume()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool IHandle::setVolume </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>volume</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the volume of a playing sound. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">volume</td><td>The volume. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>true if the handle is valid.</li>
<li>false if the handle is invalid. </li>
</ul>
</dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#a18223bae7084fd1f9fcc42b696e8fa54">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="a6baaee5885c8aa04e56172f3bb43728b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6baaee5885c8aa04e56172f3bb43728b">◆ </a></span>stop()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool IHandle::stop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Stops a played back or paused sound. </p>
<p>The handle is definitely invalid afterwards. </p><dl class="section return"><dt>Returns</dt><dd><ul>
<li>true if the sound has been stopped.</li>
<li>false if the handle is invalid. </li>
</ul>
</dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#a4e36609e5e56bf4922a8fe2aff306f95">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>devices/<a class="el" href="IHandle_8h_source.html">IHandle.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
i586
>
media
>
core-release
>
by-pkgid
>
4f48f620eaa1d8b8f904a92a0540d40f
>
files
>
1057
