<!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: PlaybackCategory 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="classPlaybackCategory-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">PlaybackCategory Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class represents a category of related sounds which are currently playing and allows to control them easily.
<a href="classPlaybackCategory.html#details">More...</a></p>
<p><code>#include <<a class="el" href="PlaybackCategory_8h_source.html">PlaybackCategory.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:a7c134e9182cfc1525a200c912af4823f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlaybackCategory.html#a7c134e9182cfc1525a200c912af4823f">PlaybackCategory</a> (std::shared_ptr< <a class="el" href="classIDevice.html">IDevice</a> > device)</td></tr>
<tr class="memdesc:a7c134e9182cfc1525a200c912af4823f"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new <a class="el" href="classPlaybackCategory.html" title="This class represents a category of related sounds which are currently playing and allows to control ...">PlaybackCategory</a>. <a href="#a7c134e9182cfc1525a200c912af4823f">More...</a><br /></td></tr>
<tr class="separator:a7c134e9182cfc1525a200c912af4823f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae9f0b3cb862e06cb6fd7049ce547f7b3"><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="classPlaybackCategory.html#ae9f0b3cb862e06cb6fd7049ce547f7b3">play</a> (std::shared_ptr< <a class="el" href="classISound.html">ISound</a> > sound)</td></tr>
<tr class="memdesc:ae9f0b3cb862e06cb6fd7049ce547f7b3"><td class="mdescLeft"> </td><td class="mdescRight">Plays a new sound in the category. <a href="#ae9f0b3cb862e06cb6fd7049ce547f7b3">More...</a><br /></td></tr>
<tr class="separator:ae9f0b3cb862e06cb6fd7049ce547f7b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a67c638c0b0cc2657f694f0b8a1df0da4"><td class="memItemLeft" align="right" valign="top"><a id="a67c638c0b0cc2657f694f0b8a1df0da4"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlaybackCategory.html#a67c638c0b0cc2657f694f0b8a1df0da4">resume</a> ()</td></tr>
<tr class="memdesc:a67c638c0b0cc2657f694f0b8a1df0da4"><td class="mdescLeft"> </td><td class="mdescRight">Resumes all the paused sounds of the category. <br /></td></tr>
<tr class="separator:a67c638c0b0cc2657f694f0b8a1df0da4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aac96132c98e944e88459bafc50ca5e90"><td class="memItemLeft" align="right" valign="top"><a id="aac96132c98e944e88459bafc50ca5e90"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlaybackCategory.html#aac96132c98e944e88459bafc50ca5e90">pause</a> ()</td></tr>
<tr class="memdesc:aac96132c98e944e88459bafc50ca5e90"><td class="mdescLeft"> </td><td class="mdescRight">Pauses all current played back sounds of the category. <br /></td></tr>
<tr class="separator:aac96132c98e944e88459bafc50ca5e90"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3bbee0c3bb24332fa652136c761643eb"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlaybackCategory.html#a3bbee0c3bb24332fa652136c761643eb">getVolume</a> ()</td></tr>
<tr class="memdesc:a3bbee0c3bb24332fa652136c761643eb"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the volume of the category. <a href="#a3bbee0c3bb24332fa652136c761643eb">More...</a><br /></td></tr>
<tr class="separator:a3bbee0c3bb24332fa652136c761643eb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a881ac4c6b79c6cc7185bba370347be4a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlaybackCategory.html#a881ac4c6b79c6cc7185bba370347be4a">setVolume</a> (float volume)</td></tr>
<tr class="memdesc:a881ac4c6b79c6cc7185bba370347be4a"><td class="mdescLeft"> </td><td class="mdescRight">Sets the volume for the category. <a href="#a881ac4c6b79c6cc7185bba370347be4a">More...</a><br /></td></tr>
<tr class="separator:a881ac4c6b79c6cc7185bba370347be4a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a912a587676c583cc1d3da39689321abf"><td class="memItemLeft" align="right" valign="top"><a id="a912a587676c583cc1d3da39689321abf"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlaybackCategory.html#a912a587676c583cc1d3da39689321abf">stop</a> ()</td></tr>
<tr class="memdesc:a912a587676c583cc1d3da39689321abf"><td class="mdescLeft"> </td><td class="mdescRight">Stops all the playing back or paused sounds. <br /></td></tr>
<tr class="separator:a912a587676c583cc1d3da39689321abf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6ddb23405a3271dca089250669170ec3"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classVolumeStorage.html">VolumeStorage</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlaybackCategory.html#a6ddb23405a3271dca089250669170ec3">getSharedVolume</a> ()</td></tr>
<tr class="memdesc:a6ddb23405a3271dca089250669170ec3"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the shared volume of the category. <a href="#a6ddb23405a3271dca089250669170ec3">More...</a><br /></td></tr>
<tr class="separator:a6ddb23405a3271dca089250669170ec3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a566db84ee34bfc4e5d29b24aebdf741e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlaybackCategory.html#a566db84ee34bfc4e5d29b24aebdf741e">cleanHandles</a> ()</td></tr>
<tr class="memdesc:a566db84ee34bfc4e5d29b24aebdf741e"><td class="mdescLeft"> </td><td class="mdescRight">Cleans the category erasing all the invalid handles. <a href="#a566db84ee34bfc4e5d29b24aebdf741e">More...</a><br /></td></tr>
<tr class="separator:a566db84ee34bfc4e5d29b24aebdf741e"><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 represents a category of related sounds which are currently playing and allows to control them easily. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a7c134e9182cfc1525a200c912af4823f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c134e9182cfc1525a200c912af4823f">◆ </a></span>PlaybackCategory()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PlaybackCategory::PlaybackCategory </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="classPlaybackCategory.html" title="This class represents a category of related sounds which are currently playing and allows to control ...">PlaybackCategory</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="a566db84ee34bfc4e5d29b24aebdf741e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a566db84ee34bfc4e5d29b24aebdf741e">◆ </a></span>cleanHandles()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PlaybackCategory::cleanHandles </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Cleans the category erasing all the invalid handles. </p>
<p>Only needed if individual sounds are stopped with their handles. </p>
</div>
</div>
<a id="a6ddb23405a3271dca089250669170ec3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ddb23405a3271dca089250669170ec3">◆ </a></span>getSharedVolume()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr<<a class="el" href="classVolumeStorage.html">VolumeStorage</a>> PlaybackCategory::getSharedVolume </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the shared volume of the category. </p>
<dl class="section return"><dt>Returns</dt><dd>A shared pointer to the <a class="el" href="classVolumeStorage.html" title="This class stores a volume value and allows to change if for a number of sounds in one go.">VolumeStorage</a> object that represents the shared volume of the category. </dd></dl>
</div>
</div>
<a id="a3bbee0c3bb24332fa652136c761643eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3bbee0c3bb24332fa652136c761643eb">◆ </a></span>getVolume()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float PlaybackCategory::getVolume </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the volume of the category. </p>
<dl class="section return"><dt>Returns</dt><dd>The volume. </dd></dl>
</div>
</div>
<a id="ae9f0b3cb862e06cb6fd7049ce547f7b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae9f0b3cb862e06cb6fd7049ce547f7b3">◆ </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>> PlaybackCategory::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><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Plays a new sound in the category. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sound</td><td>The sound to be played. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A handle for the playback. If the playback failed, nullptr will be returned. </dd></dl>
</div>
</div>
<a id="a881ac4c6b79c6cc7185bba370347be4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a881ac4c6b79c6cc7185bba370347be4a">◆ </a></span>setVolume()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PlaybackCategory::setVolume </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>Sets the volume for the category. </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>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>fx/<a class="el" href="PlaybackCategory_8h_source.html">PlaybackCategory.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
>
1201
