<!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: PlaybackManager Class 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="classPlaybackManager-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">PlaybackManager Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class allows to control groups of playing sounds easily.
<a href="classPlaybackManager.html#details">More...</a></p>
<p><code>#include <<a class="el" href="PlaybackManager_8h_source.html">PlaybackManager.h</a>></code></p>
<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:a37fcbe074e38d6dd68b6bb7c6fffb855"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlaybackManager.html#a37fcbe074e38d6dd68b6bb7c6fffb855">PlaybackManager</a> (std::shared_ptr< <a class="el" href="classIDevice.html">IDevice</a> > device)</td></tr>
<tr class="memdesc:a37fcbe074e38d6dd68b6bb7c6fffb855"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new <a class="el" href="classPlaybackManager.html" title="This class allows to control groups of playing sounds easily.">PlaybackManager</a>. <a href="#a37fcbe074e38d6dd68b6bb7c6fffb855">More...</a><br /></td></tr>
<tr class="separator:a37fcbe074e38d6dd68b6bb7c6fffb855"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afa0ccbefdefe2da95bd324f7015e8642"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlaybackManager.html#afa0ccbefdefe2da95bd324f7015e8642">addCategory</a> (std::shared_ptr< <a class="el" href="classPlaybackCategory.html">PlaybackCategory</a> > category)</td></tr>
<tr class="memdesc:afa0ccbefdefe2da95bd324f7015e8642"><td class="mdescLeft"> </td><td class="mdescRight">Adds an existent category to the manager and returns a key to access it. <a href="#afa0ccbefdefe2da95bd324f7015e8642">More...</a><br /></td></tr>
<tr class="separator:afa0ccbefdefe2da95bd324f7015e8642"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3aca5f80ec259a903dd804e42e51b271"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlaybackManager.html#a3aca5f80ec259a903dd804e42e51b271">addCategory</a> (float volume)</td></tr>
<tr class="memdesc:a3aca5f80ec259a903dd804e42e51b271"><td class="mdescLeft"> </td><td class="mdescRight">Adds an existent category to the manager and returns a key to access it. <a href="#a3aca5f80ec259a903dd804e42e51b271">More...</a><br /></td></tr>
<tr class="separator:a3aca5f80ec259a903dd804e42e51b271"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a31258ad0d8688ea4f5dd8841e0eac869"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classIHandle.html">IHandle</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlaybackManager.html#a31258ad0d8688ea4f5dd8841e0eac869">play</a> (std::shared_ptr< <a class="el" href="classISound.html">ISound</a> > sound, unsigned int catKey)</td></tr>
<tr class="memdesc:a31258ad0d8688ea4f5dd8841e0eac869"><td class="mdescLeft"> </td><td class="mdescRight">Plays a sound and adds it to a new or existent category. <a href="#a31258ad0d8688ea4f5dd8841e0eac869">More...</a><br /></td></tr>
<tr class="separator:a31258ad0d8688ea4f5dd8841e0eac869"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8bddc3777284390aa25037d64c60a5ca"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlaybackManager.html#a8bddc3777284390aa25037d64c60a5ca">resume</a> (unsigned int catKey)</td></tr>
<tr class="memdesc:a8bddc3777284390aa25037d64c60a5ca"><td class="mdescLeft"> </td><td class="mdescRight">Resumes all the paused sounds of a category. <a href="#a8bddc3777284390aa25037d64c60a5ca">More...</a><br /></td></tr>
<tr class="separator:a8bddc3777284390aa25037d64c60a5ca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0d4911ebee41dfb84a0c6fb6039b0dfd"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlaybackManager.html#a0d4911ebee41dfb84a0c6fb6039b0dfd">pause</a> (unsigned int catKey)</td></tr>
<tr class="memdesc:a0d4911ebee41dfb84a0c6fb6039b0dfd"><td class="mdescLeft"> </td><td class="mdescRight">Pauses all current playing sounds of a category. <a href="#a0d4911ebee41dfb84a0c6fb6039b0dfd">More...</a><br /></td></tr>
<tr class="separator:a0d4911ebee41dfb84a0c6fb6039b0dfd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7141c5bc7868465d4ec5e0b7db567dd3"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlaybackManager.html#a7141c5bc7868465d4ec5e0b7db567dd3">getVolume</a> (unsigned int catKey)</td></tr>
<tr class="memdesc:a7141c5bc7868465d4ec5e0b7db567dd3"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the volume of a category. <a href="#a7141c5bc7868465d4ec5e0b7db567dd3">More...</a><br /></td></tr>
<tr class="separator:a7141c5bc7868465d4ec5e0b7db567dd3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1c4a2fb57e1c036dcf933379d27d08ad"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlaybackManager.html#a1c4a2fb57e1c036dcf933379d27d08ad">setVolume</a> (float volume, unsigned int catKey)</td></tr>
<tr class="memdesc:a1c4a2fb57e1c036dcf933379d27d08ad"><td class="mdescLeft"> </td><td class="mdescRight">Sets the volume for a category. <a href="#a1c4a2fb57e1c036dcf933379d27d08ad">More...</a><br /></td></tr>
<tr class="separator:a1c4a2fb57e1c036dcf933379d27d08ad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a33ec1fab95b337152f40de46f8028031"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlaybackManager.html#a33ec1fab95b337152f40de46f8028031">stop</a> (unsigned int catKey)</td></tr>
<tr class="memdesc:a33ec1fab95b337152f40de46f8028031"><td class="mdescLeft"> </td><td class="mdescRight">Stops and erases a category of sounds. <a href="#a33ec1fab95b337152f40de46f8028031">More...</a><br /></td></tr>
<tr class="separator:a33ec1fab95b337152f40de46f8028031"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac86dae621dce7f28ccfa77ba8603f9bc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlaybackManager.html#ac86dae621dce7f28ccfa77ba8603f9bc">clean</a> ()</td></tr>
<tr class="memdesc:ac86dae621dce7f28ccfa77ba8603f9bc"><td class="mdescLeft"> </td><td class="mdescRight">Removes all the invalid handles of all the categories. <a href="#ac86dae621dce7f28ccfa77ba8603f9bc">More...</a><br /></td></tr>
<tr class="separator:ac86dae621dce7f28ccfa77ba8603f9bc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0f5472b039c712a4cf2c0597681c11d5"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlaybackManager.html#a0f5472b039c712a4cf2c0597681c11d5">clean</a> (unsigned int catKey)</td></tr>
<tr class="memdesc:a0f5472b039c712a4cf2c0597681c11d5"><td class="mdescLeft"> </td><td class="mdescRight">Removes all the invalid handles of a category. <a href="#a0f5472b039c712a4cf2c0597681c11d5">More...</a><br /></td></tr>
<tr class="separator:a0f5472b039c712a4cf2c0597681c11d5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1eb8dd1e442c6b53336e68d3a9f50523"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classIDevice.html">IDevice</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlaybackManager.html#a1eb8dd1e442c6b53336e68d3a9f50523">getDevice</a> ()</td></tr>
<tr class="memdesc:a1eb8dd1e442c6b53336e68d3a9f50523"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the device of the <a class="el" href="classPlaybackManager.html" title="This class allows to control groups of playing sounds easily.">PlaybackManager</a>. <a href="#a1eb8dd1e442c6b53336e68d3a9f50523">More...</a><br /></td></tr>
<tr class="separator:a1eb8dd1e442c6b53336e68d3a9f50523"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class allows to control groups of playing sounds easily. </p>
<p>The sounds are part of categories. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a37fcbe074e38d6dd68b6bb7c6fffb855"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a37fcbe074e38d6dd68b6bb7c6fffb855">◆ </a></span>PlaybackManager()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PlaybackManager::PlaybackManager </td>
<td>(</td>
<td class="paramtype">std::shared_ptr< <a class="el" href="classIDevice.html">IDevice</a> > </td>
<td class="paramname"><em>device</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new <a class="el" href="classPlaybackManager.html" title="This class allows to control groups of playing sounds easily.">PlaybackManager</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">device</td><td>A shared pointer to the device which will be used for playback. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="afa0ccbefdefe2da95bd324f7015e8642"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afa0ccbefdefe2da95bd324f7015e8642">◆ </a></span>addCategory() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int PlaybackManager::addCategory </td>
<td>(</td>
<td class="paramtype">std::shared_ptr< <a class="el" href="classPlaybackCategory.html">PlaybackCategory</a> > </td>
<td class="paramname"><em>category</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds an existent category to the manager and returns a key to access it. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">category</td><td>The category to be added. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The category key. </dd></dl>
</div>
</div>
<a id="a3aca5f80ec259a903dd804e42e51b271"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3aca5f80ec259a903dd804e42e51b271">◆ </a></span>addCategory() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int PlaybackManager::addCategory </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>volume</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds an existent category to the manager and returns a key to access it. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">volume</td><td>The volume of the new category. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The category key. </dd></dl>
</div>
</div>
<a id="ac86dae621dce7f28ccfa77ba8603f9bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac86dae621dce7f28ccfa77ba8603f9bc">◆ </a></span>clean() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PlaybackManager::clean </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes all the invalid handles of all the categories. </p>
<p>Only needed if individual sounds are stopped with their handles. </p>
</div>
</div>
<a id="a0f5472b039c712a4cf2c0597681c11d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0f5472b039c712a4cf2c0597681c11d5">◆ </a></span>clean() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool PlaybackManager::clean </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>catKey</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes all the invalid handles of a category. </p>
<p>Only needed if individual sounds are stopped with their handles. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">catKey</td><td>Key of the category. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>true if succesful.</li>
<li>false if the category doesn't exist. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a1eb8dd1e442c6b53336e68d3a9f50523"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1eb8dd1e442c6b53336e68d3a9f50523">◆ </a></span>getDevice()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr<<a class="el" href="classIDevice.html">IDevice</a>> PlaybackManager::getDevice </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the device of the <a class="el" href="classPlaybackManager.html" title="This class allows to control groups of playing sounds easily.">PlaybackManager</a>. </p>
<dl class="section return"><dt>Returns</dt><dd>A shared pointer to the device used by the playback manager. </dd></dl>
</div>
</div>
<a id="a7141c5bc7868465d4ec5e0b7db567dd3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7141c5bc7868465d4ec5e0b7db567dd3">◆ </a></span>getVolume()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float PlaybackManager::getVolume </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>catKey</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the volume of a category. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">catKey</td><td>Key of the category. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The volume value of the category. If the category doesn't exist it returns a negative number. </dd></dl>
</div>
</div>
<a id="a0d4911ebee41dfb84a0c6fb6039b0dfd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d4911ebee41dfb84a0c6fb6039b0dfd">◆ </a></span>pause()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool PlaybackManager::pause </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>catKey</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Pauses all current playing sounds of a category. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">catKey</td><td>Key of the category. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>true if succesful.</li>
<li>false if the category doesn't exist. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a31258ad0d8688ea4f5dd8841e0eac869"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31258ad0d8688ea4f5dd8841e0eac869">◆ </a></span>play()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr<<a class="el" href="classIHandle.html">IHandle</a>> PlaybackManager::play </td>
<td>(</td>
<td class="paramtype">std::shared_ptr< <a class="el" href="classISound.html">ISound</a> > </td>
<td class="paramname"><em>sound</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>catKey</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Plays a sound and adds it to a new or existent category. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sound</td><td>The sound to be played and added to a category. </td></tr>
<tr><td class="paramname">catKey</td><td>Key of the category. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The handle of the playback; nullptr if the sound couldn't be played. </dd></dl>
</div>
</div>
<a id="a8bddc3777284390aa25037d64c60a5ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8bddc3777284390aa25037d64c60a5ca">◆ </a></span>resume()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool PlaybackManager::resume </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>catKey</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Resumes all the paused sounds of a category. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">catKey</td><td>Key of the category. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>true if succesful.</li>
<li>false if the category doesn't exist. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a1c4a2fb57e1c036dcf933379d27d08ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c4a2fb57e1c036dcf933379d27d08ad">◆ </a></span>setVolume()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool PlaybackManager::setVolume </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>volume</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>catKey</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the volume for a category. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">volume</td><td>The volume. </td></tr>
<tr><td class="paramname">catKey</td><td>Key of the category. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>true if succesful.</li>
<li>false if the category doesn't exist. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a33ec1fab95b337152f40de46f8028031"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33ec1fab95b337152f40de46f8028031">◆ </a></span>stop()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool PlaybackManager::stop </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>catKey</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Stops and erases a category of sounds. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">catKey</td><td>Key of the category. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>true if succesful.</li>
<li>false if the category doesn't exist. </li>
</ul>
</dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>fx/<a class="el" href="PlaybackManager_8h_source.html">PlaybackManager.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
>
1203
