<!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: SoftwareDevice 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="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="classSoftwareDevice-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">SoftwareDevice Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>The software device is a generic device with software mixing.
<a href="classSoftwareDevice.html#details">More...</a></p>
<p><code>#include <<a class="el" href="SoftwareDevice_8h_source.html">SoftwareDevice.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for SoftwareDevice:</div>
<div class="dyncontent">
<div class="center"><img src="classSoftwareDevice__inherit__graph.png" border="0" usemap="#SoftwareDevice_inherit__map" alt="Inheritance graph"/></div>
<map name="SoftwareDevice_inherit__map" id="SoftwareDevice_inherit__map">
<area shape="rect" title="The software device is a generic device with software mixing." alt="" coords="104,155,220,181"/>
<area shape="rect" href="classJackDevice.html" title="This device plays back through JACK." alt="" coords="5,229,92,256"/>
<area shape="rect" href="classReadDevice.html" title="This device enables to let the user read raw data out of it." alt="" coords="116,229,208,256"/>
<area shape="rect" href="classSDLDevice.html" title="This device plays back through SDL, the simple direct media layer." alt="" coords="232,229,319,256"/>
<area shape="rect" href="classIDevice.html" title="The IDevice interface represents an output device for sound sources." alt="" coords="80,80,145,107"/>
<area shape="rect" href="classILockable.html" title="This class provides an interface for lockable objects." alt="" coords="73,5,153,32"/>
<area shape="rect" href="classI3DDevice.html" title="The I3DDevice interface represents an output device for 3D sound." alt="" coords="170,80,253,107"/>
</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="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html">SoftwareHandle</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Saves the data for playback. <a href="classSoftwareDevice_1_1SoftwareHandle.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:ac048e970d1c07fa225cb7640f2c1d2d9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoftwareDevice.html#ac048e970d1c07fa225cb7640f2c1d2d9">setQuality</a> (bool quality)</td></tr>
<tr class="memdesc:ac048e970d1c07fa225cb7640f2c1d2d9"><td class="mdescLeft"> </td><td class="mdescRight">Sets the resampling quality. <a href="#ac048e970d1c07fa225cb7640f2c1d2d9">More...</a><br /></td></tr>
<tr class="separator:ac048e970d1c07fa225cb7640f2c1d2d9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4a7fa29ce2ba60113923d4845a852dcf"><td class="memItemLeft" align="right" valign="top"><a id="a4a7fa29ce2ba60113923d4845a852dcf"></a>
virtual <a class="el" href="structDeviceSpecs.html">DeviceSpecs</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoftwareDevice.html#a4a7fa29ce2ba60113923d4845a852dcf">getSpecs</a> () const</td></tr>
<tr class="memdesc:a4a7fa29ce2ba60113923d4845a852dcf"><td class="mdescLeft"> </td><td class="mdescRight">Returns the specification of the device. <br /></td></tr>
<tr class="separator:a4a7fa29ce2ba60113923d4845a852dcf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad1fd5199e9f35ed45f4f64143ae57c67"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr< <a class="el" href="classIHandle.html">IHandle</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoftwareDevice.html#ad1fd5199e9f35ed45f4f64143ae57c67">play</a> (std::shared_ptr< <a class="el" href="classIReader.html">IReader</a> > reader, bool keep=false)</td></tr>
<tr class="memdesc:ad1fd5199e9f35ed45f4f64143ae57c67"><td class="mdescLeft"> </td><td class="mdescRight">Plays a sound source. <a href="#ad1fd5199e9f35ed45f4f64143ae57c67">More...</a><br /></td></tr>
<tr class="separator:ad1fd5199e9f35ed45f4f64143ae57c67"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a958e0174b3309056a8a081b7254c42a7"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr< <a class="el" href="classIHandle.html">IHandle</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoftwareDevice.html#a958e0174b3309056a8a081b7254c42a7">play</a> (std::shared_ptr< <a class="el" href="classISound.html">ISound</a> > sound, bool keep=false)</td></tr>
<tr class="memdesc:a958e0174b3309056a8a081b7254c42a7"><td class="mdescLeft"> </td><td class="mdescRight">Plays a sound source. <a href="#a958e0174b3309056a8a081b7254c42a7">More...</a><br /></td></tr>
<tr class="separator:a958e0174b3309056a8a081b7254c42a7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af38ef1dd52d08d4c2fd34dfaa458ffb7"><td class="memItemLeft" align="right" valign="top"><a id="af38ef1dd52d08d4c2fd34dfaa458ffb7"></a>
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoftwareDevice.html#af38ef1dd52d08d4c2fd34dfaa458ffb7">stopAll</a> ()</td></tr>
<tr class="memdesc:af38ef1dd52d08d4c2fd34dfaa458ffb7"><td class="mdescLeft"> </td><td class="mdescRight">Stops all playing sounds. <br /></td></tr>
<tr class="separator:af38ef1dd52d08d4c2fd34dfaa458ffb7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a899e79ea1a3db44d8f277bd4639318d1"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoftwareDevice.html#a899e79ea1a3db44d8f277bd4639318d1">lock</a> ()</td></tr>
<tr class="memdesc:a899e79ea1a3db44d8f277bd4639318d1"><td class="mdescLeft"> </td><td class="mdescRight">Locks the device. <a href="#a899e79ea1a3db44d8f277bd4639318d1">More...</a><br /></td></tr>
<tr class="separator:a899e79ea1a3db44d8f277bd4639318d1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8f2b413099cc5b4e7e515aad358a128d"><td class="memItemLeft" align="right" valign="top"><a id="a8f2b413099cc5b4e7e515aad358a128d"></a>
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoftwareDevice.html#a8f2b413099cc5b4e7e515aad358a128d">unlock</a> ()</td></tr>
<tr class="memdesc:a8f2b413099cc5b4e7e515aad358a128d"><td class="mdescLeft"> </td><td class="mdescRight">Unlocks the previously locked device. <br /></td></tr>
<tr class="separator:a8f2b413099cc5b4e7e515aad358a128d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3a6c07d74186b0b76052521e4c789f40"><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoftwareDevice.html#a3a6c07d74186b0b76052521e4c789f40">getVolume</a> () const</td></tr>
<tr class="memdesc:a3a6c07d74186b0b76052521e4c789f40"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the overall device volume. <a href="#a3a6c07d74186b0b76052521e4c789f40">More...</a><br /></td></tr>
<tr class="separator:a3a6c07d74186b0b76052521e4c789f40"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa530cbd59c872b042681480ba838b60f"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoftwareDevice.html#aa530cbd59c872b042681480ba838b60f">setVolume</a> (float volume)</td></tr>
<tr class="memdesc:aa530cbd59c872b042681480ba838b60f"><td class="mdescLeft"> </td><td class="mdescRight">Sets the overall device volume. <a href="#aa530cbd59c872b042681480ba838b60f">More...</a><br /></td></tr>
<tr class="separator:aa530cbd59c872b042681480ba838b60f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a494e54c82905f5f97f770a3a352bec88"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classISynchronizer.html">ISynchronizer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoftwareDevice.html#a494e54c82905f5f97f770a3a352bec88">getSynchronizer</a> ()</td></tr>
<tr class="memdesc:a494e54c82905f5f97f770a3a352bec88"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the synchronizer for this device, which enables accurate synchronization between audio playback and video playback for example. <a href="#a494e54c82905f5f97f770a3a352bec88">More...</a><br /></td></tr>
<tr class="separator:a494e54c82905f5f97f770a3a352bec88"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f16a87dc8b0ce6fba38c8f8f031d408"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVector3.html">Vector3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoftwareDevice.html#a4f16a87dc8b0ce6fba38c8f8f031d408">getListenerLocation</a> () const</td></tr>
<tr class="memdesc:a4f16a87dc8b0ce6fba38c8f8f031d408"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the listener location. <a href="#a4f16a87dc8b0ce6fba38c8f8f031d408">More...</a><br /></td></tr>
<tr class="separator:a4f16a87dc8b0ce6fba38c8f8f031d408"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3b2b2e6c2695f469e6b5421f5deace1e"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoftwareDevice.html#a3b2b2e6c2695f469e6b5421f5deace1e">setListenerLocation</a> (const <a class="el" href="classVector3.html">Vector3</a> &location)</td></tr>
<tr class="memdesc:a3b2b2e6c2695f469e6b5421f5deace1e"><td class="mdescLeft"> </td><td class="mdescRight">Sets the listener location. <a href="#a3b2b2e6c2695f469e6b5421f5deace1e">More...</a><br /></td></tr>
<tr class="separator:a3b2b2e6c2695f469e6b5421f5deace1e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9c4a01f3a95dde077b5dfcc08be2e303"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVector3.html">Vector3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoftwareDevice.html#a9c4a01f3a95dde077b5dfcc08be2e303">getListenerVelocity</a> () const</td></tr>
<tr class="memdesc:a9c4a01f3a95dde077b5dfcc08be2e303"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the listener velocity. <a href="#a9c4a01f3a95dde077b5dfcc08be2e303">More...</a><br /></td></tr>
<tr class="separator:a9c4a01f3a95dde077b5dfcc08be2e303"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8d26bd535b137034b00b864708c37da7"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoftwareDevice.html#a8d26bd535b137034b00b864708c37da7">setListenerVelocity</a> (const <a class="el" href="classVector3.html">Vector3</a> &velocity)</td></tr>
<tr class="memdesc:a8d26bd535b137034b00b864708c37da7"><td class="mdescLeft"> </td><td class="mdescRight">Sets the listener velocity. <a href="#a8d26bd535b137034b00b864708c37da7">More...</a><br /></td></tr>
<tr class="separator:a8d26bd535b137034b00b864708c37da7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a44b10b48cb983bba822e34dd61a6a78c"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classQuaternion.html">Quaternion</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoftwareDevice.html#a44b10b48cb983bba822e34dd61a6a78c">getListenerOrientation</a> () const</td></tr>
<tr class="memdesc:a44b10b48cb983bba822e34dd61a6a78c"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the listener orientation. <a href="#a44b10b48cb983bba822e34dd61a6a78c">More...</a><br /></td></tr>
<tr class="separator:a44b10b48cb983bba822e34dd61a6a78c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa3f30df95d150f6db738534b67a30718"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoftwareDevice.html#aa3f30df95d150f6db738534b67a30718">setListenerOrientation</a> (const <a class="el" href="classQuaternion.html">Quaternion</a> &orientation)</td></tr>
<tr class="memdesc:aa3f30df95d150f6db738534b67a30718"><td class="mdescLeft"> </td><td class="mdescRight">Sets the listener orientation. <a href="#aa3f30df95d150f6db738534b67a30718">More...</a><br /></td></tr>
<tr class="separator:aa3f30df95d150f6db738534b67a30718"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aff446f4637f2031bed9e127b08c1a7ec"><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoftwareDevice.html#aff446f4637f2031bed9e127b08c1a7ec">getSpeedOfSound</a> () const</td></tr>
<tr class="memdesc:aff446f4637f2031bed9e127b08c1a7ec"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the speed of sound. <a href="#aff446f4637f2031bed9e127b08c1a7ec">More...</a><br /></td></tr>
<tr class="separator:aff446f4637f2031bed9e127b08c1a7ec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae1b8546a90bdc0464847f01d72267902"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoftwareDevice.html#ae1b8546a90bdc0464847f01d72267902">setSpeedOfSound</a> (float speed)</td></tr>
<tr class="memdesc:ae1b8546a90bdc0464847f01d72267902"><td class="mdescLeft"> </td><td class="mdescRight">Sets the speed of sound. <a href="#ae1b8546a90bdc0464847f01d72267902">More...</a><br /></td></tr>
<tr class="separator:ae1b8546a90bdc0464847f01d72267902"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3845b5c658b03e80d672eaa37b013e52"><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoftwareDevice.html#a3845b5c658b03e80d672eaa37b013e52">getDopplerFactor</a> () const</td></tr>
<tr class="memdesc:a3845b5c658b03e80d672eaa37b013e52"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the doppler factor. <a href="#a3845b5c658b03e80d672eaa37b013e52">More...</a><br /></td></tr>
<tr class="separator:a3845b5c658b03e80d672eaa37b013e52"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a776dd94a29194352c12e5e5e24d642ca"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoftwareDevice.html#a776dd94a29194352c12e5e5e24d642ca">setDopplerFactor</a> (float factor)</td></tr>
<tr class="memdesc:a776dd94a29194352c12e5e5e24d642ca"><td class="mdescLeft"> </td><td class="mdescRight">Sets the doppler factor. <a href="#a776dd94a29194352c12e5e5e24d642ca">More...</a><br /></td></tr>
<tr class="separator:a776dd94a29194352c12e5e5e24d642ca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aee43e644eb6fa0069daed0c111091ef3"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="I3DDevice_8h.html#a5e42e9a2b2a31997de7556c983d15ffd">DistanceModel</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoftwareDevice.html#aee43e644eb6fa0069daed0c111091ef3">getDistanceModel</a> () const</td></tr>
<tr class="memdesc:aee43e644eb6fa0069daed0c111091ef3"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the distance model. <a href="#aee43e644eb6fa0069daed0c111091ef3">More...</a><br /></td></tr>
<tr class="separator:aee43e644eb6fa0069daed0c111091ef3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b7224a7da49b121587e23b2fa86ada1"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoftwareDevice.html#a7b7224a7da49b121587e23b2fa86ada1">setDistanceModel</a> (<a class="el" href="I3DDevice_8h.html#a5e42e9a2b2a31997de7556c983d15ffd">DistanceModel</a> model)</td></tr>
<tr class="memdesc:a7b7224a7da49b121587e23b2fa86ada1"><td class="mdescLeft"> </td><td class="mdescRight">Sets the distance model. <a href="#a7b7224a7da49b121587e23b2fa86ada1">More...</a><br /></td></tr>
<tr class="separator:a7b7224a7da49b121587e23b2fa86ada1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classIDevice"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classIDevice')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classIDevice.html">IDevice</a></td></tr>
<tr class="memitem:a172e12396100def6a01ec1c0b88ee645 inherit pub_methods_classIDevice"><td class="memItemLeft" align="right" valign="top"><a id="a172e12396100def6a01ec1c0b88ee645"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classIDevice.html#a172e12396100def6a01ec1c0b88ee645">~IDevice</a> ()</td></tr>
<tr class="memdesc:a172e12396100def6a01ec1c0b88ee645 inherit pub_methods_classIDevice"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the device. <br /></td></tr>
<tr class="separator:a172e12396100def6a01ec1c0b88ee645 inherit pub_methods_classIDevice"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a31326c9bb16985ab58303b59fba51c75"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoftwareDevice.html#a31326c9bb16985ab58303b59fba51c75">setPanning</a> (<a class="el" href="classIHandle.html">IHandle</a> *handle, float pan)</td></tr>
<tr class="memdesc:a31326c9bb16985ab58303b59fba51c75"><td class="mdescLeft"> </td><td class="mdescRight">Sets the panning of a specific handle. <a href="#a31326c9bb16985ab58303b59fba51c75">More...</a><br /></td></tr>
<tr class="separator:a31326c9bb16985ab58303b59fba51c75"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a9f03335e4b54c55cc373821363885dd3"><td class="memItemLeft" align="right" valign="top"><a id="a9f03335e4b54c55cc373821363885dd3"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoftwareDevice.html#a9f03335e4b54c55cc373821363885dd3">create</a> ()</td></tr>
<tr class="memdesc:a9f03335e4b54c55cc373821363885dd3"><td class="mdescLeft"> </td><td class="mdescRight">Initializes member variables. <br /></td></tr>
<tr class="separator:a9f03335e4b54c55cc373821363885dd3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abd6ce77b06624ab0e782ca98f44de5e6"><td class="memItemLeft" align="right" valign="top"><a id="abd6ce77b06624ab0e782ca98f44de5e6"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoftwareDevice.html#abd6ce77b06624ab0e782ca98f44de5e6">destroy</a> ()</td></tr>
<tr class="memdesc:abd6ce77b06624ab0e782ca98f44de5e6"><td class="mdescLeft"> </td><td class="mdescRight">Uninitializes member variables. <br /></td></tr>
<tr class="separator:abd6ce77b06624ab0e782ca98f44de5e6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abba2ac65c0d885417583a3936725cf5b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoftwareDevice.html#abba2ac65c0d885417583a3936725cf5b">mix</a> (<a class="el" href="Audaspace_8h.html#ae91c9d70e1e2c8b657e51de1fff60ada">data_t</a> *buffer, int length)</td></tr>
<tr class="memdesc:abba2ac65c0d885417583a3936725cf5b"><td class="mdescLeft"> </td><td class="mdescRight">Mixes the next samples into the buffer. <a href="#abba2ac65c0d885417583a3936725cf5b">More...</a><br /></td></tr>
<tr class="separator:abba2ac65c0d885417583a3936725cf5b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af536b44463d8d18d611d448e8b733173"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoftwareDevice.html#af536b44463d8d18d611d448e8b733173">playing</a> (bool playing)=0</td></tr>
<tr class="memdesc:af536b44463d8d18d611d448e8b733173"><td class="mdescLeft"> </td><td class="mdescRight">This function tells the device, to start or pause playback. <a href="#af536b44463d8d18d611d448e8b733173">More...</a><br /></td></tr>
<tr class="separator:af536b44463d8d18d611d448e8b733173"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad0c9ae8656ab6134e15571ea742edbb9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoftwareDevice.html#ad0c9ae8656ab6134e15571ea742edbb9">setSpecs</a> (<a class="el" href="structSpecs.html">Specs</a> specs)</td></tr>
<tr class="memdesc:ad0c9ae8656ab6134e15571ea742edbb9"><td class="mdescLeft"> </td><td class="mdescRight">Sets the audio output specification of the device. <a href="#ad0c9ae8656ab6134e15571ea742edbb9">More...</a><br /></td></tr>
<tr class="separator:ad0c9ae8656ab6134e15571ea742edbb9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af91c43d54286fad881e2e2a0a3b64e5d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoftwareDevice.html#af91c43d54286fad881e2e2a0a3b64e5d">SoftwareDevice</a> ()</td></tr>
<tr class="memdesc:af91c43d54286fad881e2e2a0a3b64e5d"><td class="mdescLeft"> </td><td class="mdescRight">Empty default constructor. <a href="#af91c43d54286fad881e2e2a0a3b64e5d">More...</a><br /></td></tr>
<tr class="separator:af91c43d54286fad881e2e2a0a3b64e5d"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a188ff7a41ee8c89f7e6ae15baf3b9744"><td class="memItemLeft" align="right" valign="top"><a id="a188ff7a41ee8c89f7e6ae15baf3b9744"></a>
<a class="el" href="structDeviceSpecs.html">DeviceSpecs</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoftwareDevice.html#a188ff7a41ee8c89f7e6ae15baf3b9744">m_specs</a></td></tr>
<tr class="memdesc:a188ff7a41ee8c89f7e6ae15baf3b9744"><td class="mdescLeft"> </td><td class="mdescRight">The specification of the device. <br /></td></tr>
<tr class="separator:a188ff7a41ee8c89f7e6ae15baf3b9744"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1a06ff591bd611073d0c826c1d0ab2ee"><td class="memItemLeft" align="right" valign="top"><a id="a1a06ff591bd611073d0c826c1d0ab2ee"></a>
std::shared_ptr< <a class="el" href="classMixer.html">Mixer</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoftwareDevice.html#a1a06ff591bd611073d0c826c1d0ab2ee">m_mixer</a></td></tr>
<tr class="memdesc:a1a06ff591bd611073d0c826c1d0ab2ee"><td class="mdescLeft"> </td><td class="mdescRight">The mixer. <br /></td></tr>
<tr class="separator:a1a06ff591bd611073d0c826c1d0ab2ee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6a7c5217dd4a4f5c3f7e26f798a5d3e5"><td class="memItemLeft" align="right" valign="top"><a id="a6a7c5217dd4a4f5c3f7e26f798a5d3e5"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoftwareDevice.html#a6a7c5217dd4a4f5c3f7e26f798a5d3e5">m_quality</a></td></tr>
<tr class="memdesc:a6a7c5217dd4a4f5c3f7e26f798a5d3e5"><td class="mdescLeft"> </td><td class="mdescRight">Whether to do high or low quality resampling. <br /></td></tr>
<tr class="separator:a6a7c5217dd4a4f5c3f7e26f798a5d3e5"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The software device is a generic device with software mixing. </p>
<p>It is a base class for all software mixing classes. Classes implementing this have to:</p><ul>
<li>Implement the playing function.</li>
<li>Prepare the m_specs, m_mixer variables.</li>
<li>Call the create and destroy functions.</li>
<li>Call the mix function to retrieve their audio data. </li>
</ul>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="af91c43d54286fad881e2e2a0a3b64e5d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af91c43d54286fad881e2e2a0a3b64e5d">◆ </a></span>SoftwareDevice()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">SoftwareDevice::SoftwareDevice </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Empty default constructor. </p>
<p>To setup the device call the function <a class="el" href="classSoftwareDevice.html#a9f03335e4b54c55cc373821363885dd3" title="Initializes member variables.">create()</a> and to uninitialize call <a class="el" href="classSoftwareDevice.html#abd6ce77b06624ab0e782ca98f44de5e6" title="Uninitializes member variables.">destroy()</a>. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aee43e644eb6fa0069daed0c111091ef3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee43e644eb6fa0069daed0c111091ef3">◆ </a></span>getDistanceModel()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="I3DDevice_8h.html#a5e42e9a2b2a31997de7556c983d15ffd">DistanceModel</a> SoftwareDevice::getDistanceModel </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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>Retrieves the distance model. </p>
<dl class="section return"><dt>Returns</dt><dd>The distance model. </dd></dl>
<p>Implements <a class="el" href="classI3DDevice.html#a73c3e56afc38b3b1d8429be833e80af0">I3DDevice</a>.</p>
</div>
</div>
<a id="a3845b5c658b03e80d672eaa37b013e52"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3845b5c658b03e80d672eaa37b013e52">◆ </a></span>getDopplerFactor()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual float SoftwareDevice::getDopplerFactor </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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>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>
<p>Implements <a class="el" href="classI3DDevice.html#afa4caabf857f5d466077d87713b7a281">I3DDevice</a>.</p>
</div>
</div>
<a id="a4f16a87dc8b0ce6fba38c8f8f031d408"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f16a87dc8b0ce6fba38c8f8f031d408">◆ </a></span>getListenerLocation()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classVector3.html">Vector3</a> SoftwareDevice::getListenerLocation </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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>Retrieves the listener location. </p>
<dl class="section return"><dt>Returns</dt><dd>The listener location. </dd></dl>
<p>Implements <a class="el" href="classI3DDevice.html#ade56d00824716bb6de59aa9d47786c76">I3DDevice</a>.</p>
</div>
</div>
<a id="a44b10b48cb983bba822e34dd61a6a78c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44b10b48cb983bba822e34dd61a6a78c">◆ </a></span>getListenerOrientation()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classQuaternion.html">Quaternion</a> SoftwareDevice::getListenerOrientation </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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>Retrieves the listener orientation. </p>
<dl class="section return"><dt>Returns</dt><dd>The listener orientation as quaternion. </dd></dl>
<p>Implements <a class="el" href="classI3DDevice.html#ad0a95508e725442752aeca4b411418e2">I3DDevice</a>.</p>
</div>
</div>
<a id="a9c4a01f3a95dde077b5dfcc08be2e303"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c4a01f3a95dde077b5dfcc08be2e303">◆ </a></span>getListenerVelocity()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classVector3.html">Vector3</a> SoftwareDevice::getListenerVelocity </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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>Retrieves the listener velocity. </p>
<dl class="section return"><dt>Returns</dt><dd>The listener velocity. </dd></dl>
<p>Implements <a class="el" href="classI3DDevice.html#a2817f8fedcc4f44d82f20296e9816552">I3DDevice</a>.</p>
</div>
</div>
<a id="aff446f4637f2031bed9e127b08c1a7ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff446f4637f2031bed9e127b08c1a7ec">◆ </a></span>getSpeedOfSound()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual float SoftwareDevice::getSpeedOfSound </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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>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>
<p>Implements <a class="el" href="classI3DDevice.html#a0371f744f9b4ba9eeb46c8cd7aa5ba70">I3DDevice</a>.</p>
</div>
</div>
<a id="a494e54c82905f5f97f770a3a352bec88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a494e54c82905f5f97f770a3a352bec88">◆ </a></span>getSynchronizer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classISynchronizer.html">ISynchronizer</a>* SoftwareDevice::getSynchronizer </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>Retrieves the synchronizer for this device, which enables accurate synchronization between audio playback and video playback for example. </p>
<dl class="section return"><dt>Returns</dt><dd>The synchronizer which will be the <a class="el" href="classDefaultSynchronizer.html" title="This class is a default ISynchronizer implementation that actually does no synchronization and is int...">DefaultSynchronizer</a> if synchonization is not supported. </dd></dl>
<p>Implements <a class="el" href="classIDevice.html#a4e26b0a194da731b86a5a55c649ce9f4">IDevice</a>.</p>
<p>Reimplemented in <a class="el" href="classJackDevice.html#ad89459887293f3b20766bd29f1931ffd">JackDevice</a>.</p>
</div>
</div>
<a id="a3a6c07d74186b0b76052521e4c789f40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a6c07d74186b0b76052521e4c789f40">◆ </a></span>getVolume()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual float SoftwareDevice::getVolume </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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>Retrieves the overall device volume. </p>
<dl class="section return"><dt>Returns</dt><dd>The overall device volume. </dd></dl>
<p>Implements <a class="el" href="classIDevice.html#a68e36c383e78317830aae0c66614ba06">IDevice</a>.</p>
</div>
</div>
<a id="a899e79ea1a3db44d8f277bd4639318d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a899e79ea1a3db44d8f277bd4639318d1">◆ </a></span>lock()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void SoftwareDevice::lock </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>Locks the device. </p>
<p>Used to make sure that between lock and unlock, no buffers are read, so that it is possible to start, resume, pause, stop or seek several playback handles simultaneously. </p><dl class="section warning"><dt>Warning</dt><dd>Make sure the locking time is as small as possible to avoid playback delays that result in unexpected noise and cracks. </dd></dl>
<p>Implements <a class="el" href="classIDevice.html#a90208831c6108e7f155244a59c3731d6">IDevice</a>.</p>
</div>
</div>
<a id="abba2ac65c0d885417583a3936725cf5b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abba2ac65c0d885417583a3936725cf5b">◆ </a></span>mix()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SoftwareDevice::mix </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Audaspace_8h.html#ae91c9d70e1e2c8b657e51de1fff60ada">data_t</a> * </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>length</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Mixes the next samples into the buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>The target buffer. </td></tr>
<tr><td class="paramname">length</td><td>The length in samples to be filled. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad1fd5199e9f35ed45f4f64143ae57c67"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad1fd5199e9f35ed45f4f64143ae57c67">◆ </a></span>play() <span class="overload">[1/2]</span></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="classIHandle.html">IHandle</a>> SoftwareDevice::play </td>
<td>(</td>
<td class="paramtype">std::shared_ptr< <a class="el" href="classIReader.html">IReader</a> > </td>
<td class="paramname"><em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>keep</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Plays a sound source. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reader</td><td>The reader to play. </td></tr>
<tr><td class="paramname">keep</td><td>When keep is true the sound source will not be deleted but set to paused when its end has been reached. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a handle with which the playback can be controlled. This is nullptr if the sound couldn't be played back. </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>Thrown if there's an unexpected (from the device side) error during creation of the reader. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classIDevice.html#a18360239667c2adbec6ca696f2f54379">IDevice</a>.</p>
</div>
</div>
<a id="a958e0174b3309056a8a081b7254c42a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a958e0174b3309056a8a081b7254c42a7">◆ </a></span>play() <span class="overload">[2/2]</span></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="classIHandle.html">IHandle</a>> SoftwareDevice::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">bool </td>
<td class="paramname"><em>keep</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Plays a sound source. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sound</td><td>The sound to create the reader for the sound source. </td></tr>
<tr><td class="paramname">keep</td><td>When keep is true the sound source will not be deleted but set to paused when its end has been reached. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a handle with which the playback can be controlled. This is nullptr if the sound couldn't be played back. </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>Thrown if there's an unexpected (from the device side) error during creation of the reader. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classIDevice.html#a7ceffd020c0592cc70201749a6af0f25">IDevice</a>.</p>
</div>
</div>
<a id="af536b44463d8d18d611d448e8b733173"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af536b44463d8d18d611d448e8b733173">◆ </a></span>playing()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void SoftwareDevice::playing </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>playing</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This function tells the device, to start or pause playback. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">playing</td><td>True if device should playback. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classJackDevice.html#adafefb4e310d31ccb5334282ecd9d4e3">JackDevice</a>, <a class="el" href="classSDLDevice.html#a4e5f9ce8666019497b7f2e1d92f97035">SDLDevice</a>, and <a class="el" href="classReadDevice.html#a098cd6d64ee8f4966cd9926dfde5b198">ReadDevice</a>.</p>
</div>
</div>
<a id="a7b7224a7da49b121587e23b2fa86ada1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b7224a7da49b121587e23b2fa86ada1">◆ </a></span>setDistanceModel()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void SoftwareDevice::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>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </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>
<p>Implements <a class="el" href="classI3DDevice.html#a5fe4f7f2da677e3a9dee4d752bbe2516">I3DDevice</a>.</p>
</div>
</div>
<a id="a776dd94a29194352c12e5e5e24d642ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a776dd94a29194352c12e5e5e24d642ca">◆ </a></span>setDopplerFactor()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void SoftwareDevice::setDopplerFactor </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>factor</em></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>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>
<p>Implements <a class="el" href="classI3DDevice.html#a4cb15288758bbecaf06317d6ce8d7c48">I3DDevice</a>.</p>
</div>
</div>
<a id="a3b2b2e6c2695f469e6b5421f5deace1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b2b2e6c2695f469e6b5421f5deace1e">◆ </a></span>setListenerLocation()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void SoftwareDevice::setListenerLocation </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classVector3.html">Vector3</a> & </td>
<td class="paramname"><em>location</em></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>Sets the listener location. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">location</td><td>The new location. </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>The location is not updated with the velocity and remains constant until the next call of this method. </dd></dl>
<p>Implements <a class="el" href="classI3DDevice.html#aac2d1ff8a182a15d4ef82776d85539e2">I3DDevice</a>.</p>
</div>
</div>
<a id="aa3f30df95d150f6db738534b67a30718"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3f30df95d150f6db738534b67a30718">◆ </a></span>setListenerOrientation()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void SoftwareDevice::setListenerOrientation </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classQuaternion.html">Quaternion</a> & </td>
<td class="paramname"><em>orientation</em></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>Sets the listener orientation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">orientation</td><td>The new orientation as quaternion. </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>The coordinate system used is right handed and the listener by default is oriented looking in the negative z direction with the positive y axis as up direction. </dd></dl>
<p>Implements <a class="el" href="classI3DDevice.html#aa34387e05742e190521194fb57958469">I3DDevice</a>.</p>
</div>
</div>
<a id="a8d26bd535b137034b00b864708c37da7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d26bd535b137034b00b864708c37da7">◆ </a></span>setListenerVelocity()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void SoftwareDevice::setListenerVelocity </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classVector3.html">Vector3</a> & </td>
<td class="paramname"><em>velocity</em></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>Sets the listener velocity. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">velocity</td><td>The new velocity. </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This velocity does not change the position of the listener over time, it is simply used for the calculation of the doppler effect. </dd></dl>
<p>Implements <a class="el" href="classI3DDevice.html#a9a599317eb378f12687120bcbf4a077b">I3DDevice</a>.</p>
</div>
</div>
<a id="a31326c9bb16985ab58303b59fba51c75"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31326c9bb16985ab58303b59fba51c75">◆ </a></span>setPanning()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void SoftwareDevice::setPanning </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classIHandle.html">IHandle</a> * </td>
<td class="paramname"><em>handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>pan</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the panning of a specific handle. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>The handle to set the panning from. </td></tr>
<tr><td class="paramname">pan</td><td>The new panning value, should be in the range [-2, 2]. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac048e970d1c07fa225cb7640f2c1d2d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac048e970d1c07fa225cb7640f2c1d2d9">◆ </a></span>setQuality()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SoftwareDevice::setQuality </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>quality</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the resampling quality. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">quality</td><td>Low (false) or high (true) quality. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad0c9ae8656ab6134e15571ea742edbb9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0c9ae8656ab6134e15571ea742edbb9">◆ </a></span>setSpecs()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SoftwareDevice::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>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the audio output specification of the device. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">specs</td><td>The output specification. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae1b8546a90bdc0464847f01d72267902"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae1b8546a90bdc0464847f01d72267902">◆ </a></span>setSpeedOfSound()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void SoftwareDevice::setSpeedOfSound </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>speed</em></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>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>
<p>Implements <a class="el" href="classI3DDevice.html#a3bbb657ead48b599035fd0147b35f645">I3DDevice</a>.</p>
</div>
</div>
<a id="aa530cbd59c872b042681480ba838b60f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa530cbd59c872b042681480ba838b60f">◆ </a></span>setVolume()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void SoftwareDevice::setVolume </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>volume</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the overall device volume. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">volume</td><td>The overall device volume. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classIDevice.html#a0a977bd1854c5579930fc4ead5c788ae">IDevice</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>devices/<a class="el" href="SoftwareDevice_8h_source.html">SoftwareDevice.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
>
1299
