<!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: Sequence 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="#friends">Friends</a> |
<a href="classSequence-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Sequence Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This sound represents sequenced entries to play a sound scene.
<a href="classSequence.html#details">More...</a></p>
<p><code>#include <<a class="el" href="Sequence_8h_source.html">Sequence.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Sequence:</div>
<div class="dyncontent">
<div class="center"><img src="classSequence__inherit__graph.png" border="0" usemap="#Sequence_inherit__map" alt="Inheritance graph"/></div>
<map name="Sequence_inherit__map" id="Sequence_inherit__map">
<area shape="rect" title="This sound represents sequenced entries to play a sound scene." alt="" coords="5,80,85,107"/>
<area shape="rect" href="classISound.html" title="This class represents a type of sound source and saves the necessary values for it." alt="" coords="13,5,78,32"/>
</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:ac74ff818dc3535abfc97a9379b2eb941"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequence.html#ac74ff818dc3535abfc97a9379b2eb941">Sequence</a> (<a class="el" href="structSpecs.html">Specs</a> specs, float fps, bool muted)</td></tr>
<tr class="memdesc:ac74ff818dc3535abfc97a9379b2eb941"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new sound scene. <a href="#ac74ff818dc3535abfc97a9379b2eb941">More...</a><br /></td></tr>
<tr class="separator:ac74ff818dc3535abfc97a9379b2eb941"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aae94df1f1b17d1faa18785d6a95c0079"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structSpecs.html">Specs</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequence.html#aae94df1f1b17d1faa18785d6a95c0079">getSpecs</a> ()</td></tr>
<tr class="memdesc:aae94df1f1b17d1faa18785d6a95c0079"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the audio output specification. <a href="#aae94df1f1b17d1faa18785d6a95c0079">More...</a><br /></td></tr>
<tr class="separator:aae94df1f1b17d1faa18785d6a95c0079"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4bedf508223aa68f1509ddbe7d213b10"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequence.html#a4bedf508223aa68f1509ddbe7d213b10">setSpecs</a> (<a class="el" href="structSpecs.html">Specs</a> specs)</td></tr>
<tr class="memdesc:a4bedf508223aa68f1509ddbe7d213b10"><td class="mdescLeft"> </td><td class="mdescRight">Sets the audio output specification. <a href="#a4bedf508223aa68f1509ddbe7d213b10">More...</a><br /></td></tr>
<tr class="separator:a4bedf508223aa68f1509ddbe7d213b10"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4109693f4fa26a6bb7be9d4615c14542"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequence.html#a4109693f4fa26a6bb7be9d4615c14542">getFPS</a> () const</td></tr>
<tr class="memdesc:a4109693f4fa26a6bb7be9d4615c14542"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the scene's FPS. <a href="#a4109693f4fa26a6bb7be9d4615c14542">More...</a><br /></td></tr>
<tr class="separator:a4109693f4fa26a6bb7be9d4615c14542"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aafb888e386080d2dbf14ac22e16562f1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequence.html#aafb888e386080d2dbf14ac22e16562f1">setFPS</a> (float fps)</td></tr>
<tr class="memdesc:aafb888e386080d2dbf14ac22e16562f1"><td class="mdescLeft"> </td><td class="mdescRight">Sets the scene's FPS. <a href="#aafb888e386080d2dbf14ac22e16562f1">More...</a><br /></td></tr>
<tr class="separator:aafb888e386080d2dbf14ac22e16562f1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a13c8dfdcac1eee57cc2d016a6e6ab7a9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequence.html#a13c8dfdcac1eee57cc2d016a6e6ab7a9">mute</a> (bool muted)</td></tr>
<tr class="memdesc:a13c8dfdcac1eee57cc2d016a6e6ab7a9"><td class="mdescLeft"> </td><td class="mdescRight">Sets the muting state of the scene. <a href="#a13c8dfdcac1eee57cc2d016a6e6ab7a9">More...</a><br /></td></tr>
<tr class="separator:a13c8dfdcac1eee57cc2d016a6e6ab7a9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a917f70b212f21bdc06eb711caed6ff70"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequence.html#a917f70b212f21bdc06eb711caed6ff70">isMuted</a> () const</td></tr>
<tr class="memdesc:a917f70b212f21bdc06eb711caed6ff70"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the muting state of the scene. <a href="#a917f70b212f21bdc06eb711caed6ff70">More...</a><br /></td></tr>
<tr class="separator:a917f70b212f21bdc06eb711caed6ff70"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8c4a07a456057479a73a29a9eb8b849d"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequence.html#a8c4a07a456057479a73a29a9eb8b849d">getSpeedOfSound</a> () const</td></tr>
<tr class="memdesc:a8c4a07a456057479a73a29a9eb8b849d"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the speed of sound. <a href="#a8c4a07a456057479a73a29a9eb8b849d">More...</a><br /></td></tr>
<tr class="separator:a8c4a07a456057479a73a29a9eb8b849d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a529abdba57b3aea0a6ceffd094562095"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequence.html#a529abdba57b3aea0a6ceffd094562095">setSpeedOfSound</a> (float speed)</td></tr>
<tr class="memdesc:a529abdba57b3aea0a6ceffd094562095"><td class="mdescLeft"> </td><td class="mdescRight">Sets the speed of sound. <a href="#a529abdba57b3aea0a6ceffd094562095">More...</a><br /></td></tr>
<tr class="separator:a529abdba57b3aea0a6ceffd094562095"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5c8202bdee82c081a81db036ebbda48b"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequence.html#a5c8202bdee82c081a81db036ebbda48b">getDopplerFactor</a> () const</td></tr>
<tr class="memdesc:a5c8202bdee82c081a81db036ebbda48b"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the doppler factor. <a href="#a5c8202bdee82c081a81db036ebbda48b">More...</a><br /></td></tr>
<tr class="separator:a5c8202bdee82c081a81db036ebbda48b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a49f088cc789d99f5b56f1a9a35b49b28"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequence.html#a49f088cc789d99f5b56f1a9a35b49b28">setDopplerFactor</a> (float factor)</td></tr>
<tr class="memdesc:a49f088cc789d99f5b56f1a9a35b49b28"><td class="mdescLeft"> </td><td class="mdescRight">Sets the doppler factor. <a href="#a49f088cc789d99f5b56f1a9a35b49b28">More...</a><br /></td></tr>
<tr class="separator:a49f088cc789d99f5b56f1a9a35b49b28"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac1c6b6966c1531be56cc3ddf814e3029"><td class="memItemLeft" align="right" valign="top"><a class="el" href="I3DDevice_8h.html#a5e42e9a2b2a31997de7556c983d15ffd">DistanceModel</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequence.html#ac1c6b6966c1531be56cc3ddf814e3029">getDistanceModel</a> () const</td></tr>
<tr class="memdesc:ac1c6b6966c1531be56cc3ddf814e3029"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the distance model. <a href="#ac1c6b6966c1531be56cc3ddf814e3029">More...</a><br /></td></tr>
<tr class="separator:ac1c6b6966c1531be56cc3ddf814e3029"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad2fcc0348136c9596d8c578937d0fd5d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequence.html#ad2fcc0348136c9596d8c578937d0fd5d">setDistanceModel</a> (<a class="el" href="I3DDevice_8h.html#a5e42e9a2b2a31997de7556c983d15ffd">DistanceModel</a> model)</td></tr>
<tr class="memdesc:ad2fcc0348136c9596d8c578937d0fd5d"><td class="mdescLeft"> </td><td class="mdescRight">Sets the distance model. <a href="#ad2fcc0348136c9596d8c578937d0fd5d">More...</a><br /></td></tr>
<tr class="separator:ad2fcc0348136c9596d8c578937d0fd5d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5157db9393d81788e345be56818a1b87"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classAnimateableProperty.html">AnimateableProperty</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequence.html#a5157db9393d81788e345be56818a1b87">getAnimProperty</a> (<a class="el" href="AnimateableProperty_8h.html#a88fcbc9d6d48a9832cc327f0b39cbec9">AnimateablePropertyType</a> type)</td></tr>
<tr class="memdesc:a5157db9393d81788e345be56818a1b87"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves one of the animated properties of the sound. <a href="#a5157db9393d81788e345be56818a1b87">More...</a><br /></td></tr>
<tr class="separator:a5157db9393d81788e345be56818a1b87"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a71aafe7bb658ebc9eb3eeb512879fd7e"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classSequenceEntry.html">SequenceEntry</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequence.html#a71aafe7bb658ebc9eb3eeb512879fd7e">add</a> (std::shared_ptr< <a class="el" href="classISound.html">ISound</a> > sound, float begin, float end, float skip)</td></tr>
<tr class="memdesc:a71aafe7bb658ebc9eb3eeb512879fd7e"><td class="mdescLeft"> </td><td class="mdescRight">Adds a new entry to the scene. <a href="#a71aafe7bb658ebc9eb3eeb512879fd7e">More...</a><br /></td></tr>
<tr class="separator:a71aafe7bb658ebc9eb3eeb512879fd7e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2f04716ff3b0c73c45e8ed94c834bc34"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequence.html#a2f04716ff3b0c73c45e8ed94c834bc34">remove</a> (std::shared_ptr< <a class="el" href="classSequenceEntry.html">SequenceEntry</a> > entry)</td></tr>
<tr class="memdesc:a2f04716ff3b0c73c45e8ed94c834bc34"><td class="mdescLeft"> </td><td class="mdescRight">Removes an entry from the scene. <a href="#a2f04716ff3b0c73c45e8ed94c834bc34">More...</a><br /></td></tr>
<tr class="separator:a2f04716ff3b0c73c45e8ed94c834bc34"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8de0cfb0e9650b0e25eb1486b16a935e"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classIReader.html">IReader</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequence.html#a8de0cfb0e9650b0e25eb1486b16a935e">createQualityReader</a> ()</td></tr>
<tr class="memdesc:a8de0cfb0e9650b0e25eb1486b16a935e"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new reader with high quality resampling. <a href="#a8de0cfb0e9650b0e25eb1486b16a935e">More...</a><br /></td></tr>
<tr class="separator:a8de0cfb0e9650b0e25eb1486b16a935e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a327436847ac782f467f333182ad65175"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr< <a class="el" href="classIReader.html">IReader</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequence.html#a327436847ac782f467f333182ad65175">createReader</a> ()</td></tr>
<tr class="memdesc:a327436847ac782f467f333182ad65175"><td class="mdescLeft"> </td><td class="mdescRight">Creates a reader for playback of the sound source. <a href="#a327436847ac782f467f333182ad65175">More...</a><br /></td></tr>
<tr class="separator:a327436847ac782f467f333182ad65175"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classISound"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classISound')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classISound.html">ISound</a></td></tr>
<tr class="memitem:ad968d59f5fdb16f050b3c74108c693b5 inherit pub_methods_classISound"><td class="memItemLeft" align="right" valign="top"><a id="ad968d59f5fdb16f050b3c74108c693b5"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classISound.html#ad968d59f5fdb16f050b3c74108c693b5">~ISound</a> ()</td></tr>
<tr class="memdesc:ad968d59f5fdb16f050b3c74108c693b5 inherit pub_methods_classISound"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the sound. <br /></td></tr>
<tr class="separator:ad968d59f5fdb16f050b3c74108c693b5 inherit pub_methods_classISound"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a9ba250b007d621254938add642d8d790"><td class="memItemLeft" align="right" valign="top"><a id="a9ba250b007d621254938add642d8d790"></a>
class </td><td class="memItemRight" valign="bottom"><b>SequenceReader</b></td></tr>
<tr class="separator:a9ba250b007d621254938add642d8d790"><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 sound represents sequenced entries to play a sound scene. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ac74ff818dc3535abfc97a9379b2eb941"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac74ff818dc3535abfc97a9379b2eb941">◆ </a></span>Sequence()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Sequence::Sequence </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structSpecs.html">Specs</a> </td>
<td class="paramname"><em>specs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>fps</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>muted</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new sound scene. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">specs</td><td>The output audio data specification. </td></tr>
<tr><td class="paramname">fps</td><td>The FPS of the scene. </td></tr>
<tr><td class="paramname">muted</td><td>Whether the whole scene is muted. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a71aafe7bb658ebc9eb3eeb512879fd7e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71aafe7bb658ebc9eb3eeb512879fd7e">◆ </a></span>add()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr<<a class="el" href="classSequenceEntry.html">SequenceEntry</a>> Sequence::add </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">float </td>
<td class="paramname"><em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>skip</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a new entry to the scene. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sound</td><td>The sound this entry should play. </td></tr>
<tr><td class="paramname">begin</td><td>The start time. </td></tr>
<tr><td class="paramname">end</td><td>The end time or a negative value if determined by the sound. </td></tr>
<tr><td class="paramname">skip</td><td>How much seconds should be skipped at the beginning. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The entry added. </dd></dl>
</div>
</div>
<a id="a8de0cfb0e9650b0e25eb1486b16a935e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8de0cfb0e9650b0e25eb1486b16a935e">◆ </a></span>createQualityReader()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr<<a class="el" href="classIReader.html">IReader</a>> Sequence::createQualityReader </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new reader with high quality resampling. </p>
<dl class="section return"><dt>Returns</dt><dd>The new reader. </dd></dl>
</div>
</div>
<a id="a327436847ac782f467f333182ad65175"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a327436847ac782f467f333182ad65175">◆ </a></span>createReader()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::shared_ptr<<a class="el" href="classIReader.html">IReader</a>> Sequence::createReader </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a reader for playback of the sound source. </p>
<dl class="section return"><dt>Returns</dt><dd>A pointer to an <a class="el" href="classIReader.html" title="This class represents a sound source as stream or as buffer which can be read for example by another ...">IReader</a> object or nullptr if there has been an error. </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classException.html" title="The Exception class is the general exception base class.">Exception</a></td><td>An exception may be thrown if there has been a more unexpected error during reader creation. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classISound.html#a194d09ea3b22f1cb0a49b89cfcf02d63">ISound</a>.</p>
</div>
</div>
<a id="a5157db9393d81788e345be56818a1b87"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5157db9393d81788e345be56818a1b87">◆ </a></span>getAnimProperty()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classAnimateableProperty.html">AnimateableProperty</a>* Sequence::getAnimProperty </td>
<td>(</td>
<td class="paramtype"><a class="el" href="AnimateableProperty_8h.html#a88fcbc9d6d48a9832cc327f0b39cbec9">AnimateablePropertyType</a> </td>
<td class="paramname"><em>type</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves one of the animated properties of the sound. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">type</td><td>Which animated property to retrieve. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the animated property, valid as long as the sound is. </dd></dl>
</div>
</div>
<a id="ac1c6b6966c1531be56cc3ddf814e3029"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1c6b6966c1531be56cc3ddf814e3029">◆ </a></span>getDistanceModel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="I3DDevice_8h.html#a5e42e9a2b2a31997de7556c983d15ffd">DistanceModel</a> Sequence::getDistanceModel </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the distance model. </p>
<dl class="section return"><dt>Returns</dt><dd>The distance model. </dd></dl>
</div>
</div>
<a id="a5c8202bdee82c081a81db036ebbda48b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c8202bdee82c081a81db036ebbda48b">◆ </a></span>getDopplerFactor()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float Sequence::getDopplerFactor </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the doppler factor. </p>
<p>This value is a scaling factor for the velocity vectors of sources and listener which is used while calculating the doppler effect. </p><dl class="section return"><dt>Returns</dt><dd>The doppler factor. </dd></dl>
</div>
</div>
<a id="a4109693f4fa26a6bb7be9d4615c14542"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4109693f4fa26a6bb7be9d4615c14542">◆ </a></span>getFPS()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float Sequence::getFPS </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the scene's FPS. </p>
<dl class="section return"><dt>Returns</dt><dd>The scene's FPS. </dd></dl>
</div>
</div>
<a id="aae94df1f1b17d1faa18785d6a95c0079"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae94df1f1b17d1faa18785d6a95c0079">◆ </a></span>getSpecs()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structSpecs.html">Specs</a> Sequence::getSpecs </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the audio output specification. </p>
<dl class="section return"><dt>Returns</dt><dd>The specification. </dd></dl>
</div>
</div>
<a id="a8c4a07a456057479a73a29a9eb8b849d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c4a07a456057479a73a29a9eb8b849d">◆ </a></span>getSpeedOfSound()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float Sequence::getSpeedOfSound </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the speed of sound. </p>
<p>This value is needed for doppler effect calculation. </p><dl class="section return"><dt>Returns</dt><dd>The speed of sound. </dd></dl>
</div>
</div>
<a id="a917f70b212f21bdc06eb711caed6ff70"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a917f70b212f21bdc06eb711caed6ff70">◆ </a></span>isMuted()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Sequence::isMuted </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the muting state of the scene. </p>
<dl class="section return"><dt>Returns</dt><dd>Whether the scene is muted. </dd></dl>
</div>
</div>
<a id="a13c8dfdcac1eee57cc2d016a6e6ab7a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a13c8dfdcac1eee57cc2d016a6e6ab7a9">◆ </a></span>mute()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Sequence::mute </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>muted</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the muting state of the scene. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">muted</td><td>Whether the scene is muted. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a2f04716ff3b0c73c45e8ed94c834bc34"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f04716ff3b0c73c45e8ed94c834bc34">◆ </a></span>remove()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Sequence::remove </td>
<td>(</td>
<td class="paramtype">std::shared_ptr< <a class="el" href="classSequenceEntry.html">SequenceEntry</a> > </td>
<td class="paramname"><em>entry</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes an entry from the scene. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">entry</td><td>The entry to remove. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad2fcc0348136c9596d8c578937d0fd5d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2fcc0348136c9596d8c578937d0fd5d">◆ </a></span>setDistanceModel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Sequence::setDistanceModel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="I3DDevice_8h.html#a5e42e9a2b2a31997de7556c983d15ffd">DistanceModel</a> </td>
<td class="paramname"><em>model</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the distance model. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">model</td><td>distance model. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a49f088cc789d99f5b56f1a9a35b49b28"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a49f088cc789d99f5b56f1a9a35b49b28">◆ </a></span>setDopplerFactor()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Sequence::setDopplerFactor </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>factor</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the doppler factor. </p>
<p>This value is a scaling factor for the velocity vectors of sources and listener which is used while calculating the doppler effect. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">factor</td><td>The new doppler factor. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aafb888e386080d2dbf14ac22e16562f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aafb888e386080d2dbf14ac22e16562f1">◆ </a></span>setFPS()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Sequence::setFPS </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>fps</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the scene's FPS. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fps</td><td>The new FPS. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4bedf508223aa68f1509ddbe7d213b10"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4bedf508223aa68f1509ddbe7d213b10">◆ </a></span>setSpecs()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Sequence::setSpecs </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structSpecs.html">Specs</a> </td>
<td class="paramname"><em>specs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the audio output specification. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">specs</td><td>The new specification. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a529abdba57b3aea0a6ceffd094562095"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a529abdba57b3aea0a6ceffd094562095">◆ </a></span>setSpeedOfSound()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Sequence::setSpeedOfSound </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>speed</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the speed of sound. </p>
<p>This value is needed for doppler effect calculation. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">speed</td><td>The new speed of sound. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>sequence/<a class="el" href="Sequence_8h_source.html">Sequence.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
>
1244
