<!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: DynamicMusic 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="classDynamicMusic-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">DynamicMusic Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class allows to play music depending on a current "scene", scene changes are managed by the class.
<a href="classDynamicMusic.html#details">More...</a></p>
<p><code>#include <<a class="el" href="DynamicMusic_8h_source.html">DynamicMusic.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:a7c2a63fa2f7f76b40171ca15c1a13f5d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDynamicMusic.html#a7c2a63fa2f7f76b40171ca15c1a13f5d">DynamicMusic</a> (std::shared_ptr< <a class="el" href="classIDevice.html">IDevice</a> > device)</td></tr>
<tr class="memdesc:a7c2a63fa2f7f76b40171ca15c1a13f5d"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new dynamic music manager with the default silent scene (id: 0). <a href="#a7c2a63fa2f7f76b40171ca15c1a13f5d">More...</a><br /></td></tr>
<tr class="separator:a7c2a63fa2f7f76b40171ca15c1a13f5d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:add159532486693e366f165129b3fdd07"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classDynamicMusic.html#add159532486693e366f165129b3fdd07">addScene</a> (std::shared_ptr< <a class="el" href="classISound.html">ISound</a> > sound)</td></tr>
<tr class="memdesc:add159532486693e366f165129b3fdd07"><td class="mdescLeft"> </td><td class="mdescRight">Adds a new scene to the manager. <a href="#add159532486693e366f165129b3fdd07">More...</a><br /></td></tr>
<tr class="separator:add159532486693e366f165129b3fdd07"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa44294a4f7fcb73011bd3a75421068c7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDynamicMusic.html#aa44294a4f7fcb73011bd3a75421068c7">changeScene</a> (int id)</td></tr>
<tr class="memdesc:aa44294a4f7fcb73011bd3a75421068c7"><td class="mdescLeft"> </td><td class="mdescRight">Changes to another scene. <a href="#aa44294a4f7fcb73011bd3a75421068c7">More...</a><br /></td></tr>
<tr class="separator:aa44294a4f7fcb73011bd3a75421068c7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8a807eda92fec62f983eee17f2987a4a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classDynamicMusic.html#a8a807eda92fec62f983eee17f2987a4a">getScene</a> ()</td></tr>
<tr class="memdesc:a8a807eda92fec62f983eee17f2987a4a"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the scene currently selected. <a href="#a8a807eda92fec62f983eee17f2987a4a">More...</a><br /></td></tr>
<tr class="separator:a8a807eda92fec62f983eee17f2987a4a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a995ba3dc1328c77225aa8696a653f234"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDynamicMusic.html#a995ba3dc1328c77225aa8696a653f234">addTransition</a> (int init, int end, std::shared_ptr< <a class="el" href="classISound.html">ISound</a> > sound)</td></tr>
<tr class="memdesc:a995ba3dc1328c77225aa8696a653f234"><td class="mdescLeft"> </td><td class="mdescRight">Adds a new transition between scenes. <a href="#a995ba3dc1328c77225aa8696a653f234">More...</a><br /></td></tr>
<tr class="separator:a995ba3dc1328c77225aa8696a653f234"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abfe49fe303d9ba268cec7ed253639772"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDynamicMusic.html#abfe49fe303d9ba268cec7ed253639772">setFadeTime</a> (float seconds)</td></tr>
<tr class="memdesc:abfe49fe303d9ba268cec7ed253639772"><td class="mdescLeft"> </td><td class="mdescRight">Sets the length of the crossfade transition (default 1 second). <a href="#abfe49fe303d9ba268cec7ed253639772">More...</a><br /></td></tr>
<tr class="separator:abfe49fe303d9ba268cec7ed253639772"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5fb44ac725607bf04ec543cde2938aac"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classDynamicMusic.html#a5fb44ac725607bf04ec543cde2938aac">getFadeTime</a> ()</td></tr>
<tr class="memdesc:a5fb44ac725607bf04ec543cde2938aac"><td class="mdescLeft"> </td><td class="mdescRight">Gets the length of the crossfade transition (default 1 second). <a href="#a5fb44ac725607bf04ec543cde2938aac">More...</a><br /></td></tr>
<tr class="separator:a5fb44ac725607bf04ec543cde2938aac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae41ddb8bf32443b931e4c2175b5c2496"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDynamicMusic.html#ae41ddb8bf32443b931e4c2175b5c2496">resume</a> ()</td></tr>
<tr class="memdesc:ae41ddb8bf32443b931e4c2175b5c2496"><td class="mdescLeft"> </td><td class="mdescRight">Resumes a paused sound. <a href="#ae41ddb8bf32443b931e4c2175b5c2496">More...</a><br /></td></tr>
<tr class="separator:ae41ddb8bf32443b931e4c2175b5c2496"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a89d2486b9e773f49fab706a7f58f90b5"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDynamicMusic.html#a89d2486b9e773f49fab706a7f58f90b5">pause</a> ()</td></tr>
<tr class="memdesc:a89d2486b9e773f49fab706a7f58f90b5"><td class="mdescLeft"> </td><td class="mdescRight">Pauses the current played back sound. <a href="#a89d2486b9e773f49fab706a7f58f90b5">More...</a><br /></td></tr>
<tr class="separator:a89d2486b9e773f49fab706a7f58f90b5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0e50ddf165ed892ee23af811dcc728a3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDynamicMusic.html#a0e50ddf165ed892ee23af811dcc728a3">seek</a> (float position)</td></tr>
<tr class="memdesc:a0e50ddf165ed892ee23af811dcc728a3"><td class="mdescLeft"> </td><td class="mdescRight">Seeks in the current played back sound. <a href="#a0e50ddf165ed892ee23af811dcc728a3">More...</a><br /></td></tr>
<tr class="separator:a0e50ddf165ed892ee23af811dcc728a3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af91af95e7b0bac902a9c0c84bfa51672"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classDynamicMusic.html#af91af95e7b0bac902a9c0c84bfa51672">getPosition</a> ()</td></tr>
<tr class="memdesc:af91af95e7b0bac902a9c0c84bfa51672"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the current playback position of a sound. <a href="#af91af95e7b0bac902a9c0c84bfa51672">More...</a><br /></td></tr>
<tr class="separator:af91af95e7b0bac902a9c0c84bfa51672"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a614553a145ebb0cd8b5cc465b055deda"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classDynamicMusic.html#a614553a145ebb0cd8b5cc465b055deda">getVolume</a> ()</td></tr>
<tr class="memdesc:a614553a145ebb0cd8b5cc465b055deda"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the volume of the scenes. <a href="#a614553a145ebb0cd8b5cc465b055deda">More...</a><br /></td></tr>
<tr class="separator:a614553a145ebb0cd8b5cc465b055deda"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afd818b97412740350ac951cef05c1b60"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDynamicMusic.html#afd818b97412740350ac951cef05c1b60">setVolume</a> (float volume)</td></tr>
<tr class="memdesc:afd818b97412740350ac951cef05c1b60"><td class="mdescLeft"> </td><td class="mdescRight">Sets the volume for the scenes. <a href="#afd818b97412740350ac951cef05c1b60">More...</a><br /></td></tr>
<tr class="separator:afd818b97412740350ac951cef05c1b60"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5fc2fe953630276569ee5d97ab86cd93"><td class="memItemLeft" align="right" valign="top"><a class="el" href="IHandle_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDynamicMusic.html#a5fc2fe953630276569ee5d97ab86cd93">getStatus</a> ()</td></tr>
<tr class="memdesc:a5fc2fe953630276569ee5d97ab86cd93"><td class="mdescLeft"> </td><td class="mdescRight">Returns the status of the current played back sound. <a href="#a5fc2fe953630276569ee5d97ab86cd93">More...</a><br /></td></tr>
<tr class="separator:a5fc2fe953630276569ee5d97ab86cd93"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad4f5985a6c2a4df37ea67aabf19f7796"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDynamicMusic.html#ad4f5985a6c2a4df37ea67aabf19f7796">stop</a> ()</td></tr>
<tr class="memdesc:ad4f5985a6c2a4df37ea67aabf19f7796"><td class="mdescLeft"> </td><td class="mdescRight">Stops any played back or paused sound and sets the dynamic music player to default silent state (scene 0) <a href="#ad4f5985a6c2a4df37ea67aabf19f7796">More...</a><br /></td></tr>
<tr class="separator:ad4f5985a6c2a4df37ea67aabf19f7796"><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 play music depending on a current "scene", scene changes are managed by the class. </p>
<p>The default scene is silent and has id 0. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a7c2a63fa2f7f76b40171ca15c1a13f5d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c2a63fa2f7f76b40171ca15c1a13f5d">◆ </a></span>DynamicMusic()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DynamicMusic::DynamicMusic </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 dynamic music manager with the default silent scene (id: 0). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">device</td><td>The device that will be used to play sounds. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="add159532486693e366f165129b3fdd07"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add159532486693e366f165129b3fdd07">◆ </a></span>addScene()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int DynamicMusic::addScene </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>Adds a new scene to the manager. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sound</td><td>The sound that will play when the scene is selected with the <a class="el" href="classDynamicMusic.html#aa44294a4f7fcb73011bd3a75421068c7" title="Changes to another scene.">changeScene()</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The identifier of the new scene. </dd></dl>
</div>
</div>
<a id="a995ba3dc1328c77225aa8696a653f234"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a995ba3dc1328c77225aa8696a653f234">◆ </a></span>addTransition()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool DynamicMusic::addTransition </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>init</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>end</em>, </td>
</tr>
<tr>
<td class="paramkey"></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></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a new transition between scenes. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">init</td><td>The id of the initial scene that will allow the transition to play. </td></tr>
<tr><td class="paramname">end</td><td>The id if the target scene for the transition. </td></tr>
<tr><td class="paramname">sound</td><td>The sound that will play when the scene changes from init to end. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>false if the init or end scenes don't exist. </dd></dl>
</div>
</div>
<a id="aa44294a4f7fcb73011bd3a75421068c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa44294a4f7fcb73011bd3a75421068c7">◆ </a></span>changeScene()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool DynamicMusic::changeScene </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Changes to another scene. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>The id of the scene which should start playing the changeScene method. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>true if the change has been scheduled succesfully.</li>
<li>false if there already is a transition in course or the scene selected doesnt exist. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a5fb44ac725607bf04ec543cde2938aac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5fb44ac725607bf04ec543cde2938aac">◆ </a></span>getFadeTime()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float DynamicMusic::getFadeTime </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the length of the crossfade transition (default 1 second). </p>
<dl class="section return"><dt>Returns</dt><dd>The length of the cressfade transition in seconds. </dd></dl>
</div>
</div>
<a id="af91af95e7b0bac902a9c0c84bfa51672"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af91af95e7b0bac902a9c0c84bfa51672">◆ </a></span>getPosition()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float DynamicMusic::getPosition </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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>
</div>
</div>
<a id="a8a807eda92fec62f983eee17f2987a4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a807eda92fec62f983eee17f2987a4a">◆ </a></span>getScene()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int DynamicMusic::getScene </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the scene currently selected. </p>
<dl class="section return"><dt>Returns</dt><dd>The identifier of the current scene. </dd></dl>
</div>
</div>
<a id="a5fc2fe953630276569ee5d97ab86cd93"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5fc2fe953630276569ee5d97ab86cd93">◆ </a></span>getStatus()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="IHandle_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a> DynamicMusic::getStatus </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the status of the current 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>
</div>
</div>
<a id="a614553a145ebb0cd8b5cc465b055deda"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a614553a145ebb0cd8b5cc465b055deda">◆ </a></span>getVolume()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float DynamicMusic::getVolume </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the volume of the scenes. </p>
<dl class="section return"><dt>Returns</dt><dd>The volume. </dd></dl>
</div>
</div>
<a id="a89d2486b9e773f49fab706a7f58f90b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a89d2486b9e773f49fab706a7f58f90b5">◆ </a></span>pause()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool DynamicMusic::pause </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Pauses the current 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>
</div>
</div>
<a id="ae41ddb8bf32443b931e4c2175b5c2496"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae41ddb8bf32443b931e4c2175b5c2496">◆ </a></span>resume()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool DynamicMusic::resume </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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>
</div>
</div>
<a id="a0e50ddf165ed892ee23af811dcc728a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e50ddf165ed892ee23af811dcc728a3">◆ </a></span>seek()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool DynamicMusic::seek </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>position</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Seeks in the current 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>
</div>
</div>
<a id="abfe49fe303d9ba268cec7ed253639772"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abfe49fe303d9ba268cec7ed253639772">◆ </a></span>setFadeTime()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DynamicMusic::setFadeTime </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>seconds</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the length of the crossfade transition (default 1 second). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">seconds</td><td>The time in seconds. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="afd818b97412740350ac951cef05c1b60"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd818b97412740350ac951cef05c1b60">◆ </a></span>setVolume()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool DynamicMusic::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 scenes. </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>
</div>
</div>
<a id="ad4f5985a6c2a4df37ea67aabf19f7796"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad4f5985a6c2a4df37ea67aabf19f7796">◆ </a></span>stop()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool DynamicMusic::stop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Stops any played back or paused sound and sets the dynamic music player to default silent state (scene 0) </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>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>fx/<a class="el" href="DynamicMusic_8h_source.html">DynamicMusic.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
>
946
