<!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: IDevice Interface 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="classIDevice-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">IDevice Interface Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="classIDevice.html" title="The IDevice interface represents an output device for sound sources.">IDevice</a> interface represents an output device for sound sources.
<a href="classIDevice.html#details">More...</a></p>
<p><code>#include <<a class="el" href="IDevice_8h_source.html">IDevice.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for IDevice:</div>
<div class="dyncontent">
<div class="center"><img src="classIDevice__inherit__graph.png" border="0" usemap="#IDevice_inherit__map" alt="Inheritance graph"/></div>
<map name="IDevice_inherit__map" id="IDevice_inherit__map">
<area shape="rect" title="The IDevice interface represents an output device for sound sources." alt="" coords="147,80,212,107"/>
<area shape="rect" href="classNULLDevice.html" title="This device plays nothing." alt="" coords="5,155,100,181"/>
<area shape="rect" href="classOpenALDevice.html" title="This device plays through OpenAL." alt="" coords="124,155,235,181"/>
<area shape="rect" href="classSoftwareDevice.html" title="The software device is a generic device with software mixing." alt="" coords="259,155,375,181"/>
<area shape="rect" href="classILockable.html" title="This class provides an interface for lockable objects." alt="" coords="139,5,219,32"/>
<area shape="rect" href="classJackDevice.html" title="This device plays back through JACK." alt="" coords="160,229,247,256"/>
<area shape="rect" href="classReadDevice.html" title="This device enables to let the user read raw data out of it." alt="" coords="271,229,363,256"/>
<area shape="rect" href="classSDLDevice.html" title="This device plays back through SDL, the simple direct media layer." alt="" coords="387,229,473,256"/>
</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:a172e12396100def6a01ec1c0b88ee645"><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"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the device. <br /></td></tr>
<tr class="separator:a172e12396100def6a01ec1c0b88ee645"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2db317f6c4c6267f6627570ce3c5d8a1"><td class="memItemLeft" align="right" valign="top"><a id="a2db317f6c4c6267f6627570ce3c5d8a1"></a>
virtual <a class="el" href="structDeviceSpecs.html">DeviceSpecs</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIDevice.html#a2db317f6c4c6267f6627570ce3c5d8a1">getSpecs</a> () const =0</td></tr>
<tr class="memdesc:a2db317f6c4c6267f6627570ce3c5d8a1"><td class="mdescLeft"> </td><td class="mdescRight">Returns the specification of the device. <br /></td></tr>
<tr class="separator:a2db317f6c4c6267f6627570ce3c5d8a1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a18360239667c2adbec6ca696f2f54379"><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="classIDevice.html#a18360239667c2adbec6ca696f2f54379">play</a> (std::shared_ptr< <a class="el" href="classIReader.html">IReader</a> > reader, bool keep=false)=0</td></tr>
<tr class="memdesc:a18360239667c2adbec6ca696f2f54379"><td class="mdescLeft"> </td><td class="mdescRight">Plays a sound source. <a href="#a18360239667c2adbec6ca696f2f54379">More...</a><br /></td></tr>
<tr class="separator:a18360239667c2adbec6ca696f2f54379"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7ceffd020c0592cc70201749a6af0f25"><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="classIDevice.html#a7ceffd020c0592cc70201749a6af0f25">play</a> (std::shared_ptr< <a class="el" href="classISound.html">ISound</a> > sound, bool keep=false)=0</td></tr>
<tr class="memdesc:a7ceffd020c0592cc70201749a6af0f25"><td class="mdescLeft"> </td><td class="mdescRight">Plays a sound source. <a href="#a7ceffd020c0592cc70201749a6af0f25">More...</a><br /></td></tr>
<tr class="separator:a7ceffd020c0592cc70201749a6af0f25"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9b6e5f0f1dc269117d1b27230b927b8a"><td class="memItemLeft" align="right" valign="top"><a id="a9b6e5f0f1dc269117d1b27230b927b8a"></a>
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIDevice.html#a9b6e5f0f1dc269117d1b27230b927b8a">stopAll</a> ()=0</td></tr>
<tr class="memdesc:a9b6e5f0f1dc269117d1b27230b927b8a"><td class="mdescLeft"> </td><td class="mdescRight">Stops all playing sounds. <br /></td></tr>
<tr class="separator:a9b6e5f0f1dc269117d1b27230b927b8a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a90208831c6108e7f155244a59c3731d6"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIDevice.html#a90208831c6108e7f155244a59c3731d6">lock</a> ()=0</td></tr>
<tr class="memdesc:a90208831c6108e7f155244a59c3731d6"><td class="mdescLeft"> </td><td class="mdescRight">Locks the device. <a href="#a90208831c6108e7f155244a59c3731d6">More...</a><br /></td></tr>
<tr class="separator:a90208831c6108e7f155244a59c3731d6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa8aa549ef4733674338c711081e16e1d"><td class="memItemLeft" align="right" valign="top"><a id="aa8aa549ef4733674338c711081e16e1d"></a>
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIDevice.html#aa8aa549ef4733674338c711081e16e1d">unlock</a> ()=0</td></tr>
<tr class="memdesc:aa8aa549ef4733674338c711081e16e1d"><td class="mdescLeft"> </td><td class="mdescRight">Unlocks the previously locked device. <br /></td></tr>
<tr class="separator:aa8aa549ef4733674338c711081e16e1d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a68e36c383e78317830aae0c66614ba06"><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classIDevice.html#a68e36c383e78317830aae0c66614ba06">getVolume</a> () const =0</td></tr>
<tr class="memdesc:a68e36c383e78317830aae0c66614ba06"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the overall device volume. <a href="#a68e36c383e78317830aae0c66614ba06">More...</a><br /></td></tr>
<tr class="separator:a68e36c383e78317830aae0c66614ba06"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0a977bd1854c5579930fc4ead5c788ae"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIDevice.html#a0a977bd1854c5579930fc4ead5c788ae">setVolume</a> (float volume)=0</td></tr>
<tr class="memdesc:a0a977bd1854c5579930fc4ead5c788ae"><td class="mdescLeft"> </td><td class="mdescRight">Sets the overall device volume. <a href="#a0a977bd1854c5579930fc4ead5c788ae">More...</a><br /></td></tr>
<tr class="separator:a0a977bd1854c5579930fc4ead5c788ae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4e26b0a194da731b86a5a55c649ce9f4"><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="classIDevice.html#a4e26b0a194da731b86a5a55c649ce9f4">getSynchronizer</a> ()=0</td></tr>
<tr class="memdesc:a4e26b0a194da731b86a5a55c649ce9f4"><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="#a4e26b0a194da731b86a5a55c649ce9f4">More...</a><br /></td></tr>
<tr class="separator:a4e26b0a194da731b86a5a55c649ce9f4"><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 <a class="el" href="classIDevice.html" title="The IDevice interface represents an output device for sound sources.">IDevice</a> interface represents an output device for sound sources. </p>
<p>Output devices may be several backends such as plattform independand like SDL or OpenAL or plattform specific like ALSA, but they may also be files, RAM buffers or other types of streams. </p><dl class="section warning"><dt>Warning</dt><dd>Thread safety must be insured so that no reader is beeing called twice at the same time. </dd></dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a4e26b0a194da731b86a5a55c649ce9f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e26b0a194da731b86a5a55c649ce9f4">◆ </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>* IDevice::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">pure 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>Implemented in <a class="el" href="classSoftwareDevice.html#a494e54c82905f5f97f770a3a352bec88">SoftwareDevice</a>, <a class="el" href="classOpenALDevice.html#a8e4c67c103c7c7223711e3814d60ca52">OpenALDevice</a>, <a class="el" href="classJackDevice.html#ad89459887293f3b20766bd29f1931ffd">JackDevice</a>, and <a class="el" href="classNULLDevice.html#a14f0429593adfa56ac538ebcd68080c9">NULLDevice</a>.</p>
</div>
</div>
<a id="a68e36c383e78317830aae0c66614ba06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68e36c383e78317830aae0c66614ba06">◆ </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 IDevice::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">pure 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>Implemented in <a class="el" href="classSoftwareDevice.html#a3a6c07d74186b0b76052521e4c789f40">SoftwareDevice</a>, <a class="el" href="classOpenALDevice.html#ad907ef7541cf8bd759a8a089cacee212">OpenALDevice</a>, and <a class="el" href="classNULLDevice.html#af8b47165d168e2e7582caba6c16f8d1c">NULLDevice</a>.</p>
</div>
</div>
<a id="a90208831c6108e7f155244a59c3731d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a90208831c6108e7f155244a59c3731d6">◆ </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 IDevice::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">pure 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="classILockable.html#abeb599754f0ca2fbbf5d6e944e2be0c9">ILockable</a>.</p>
<p>Implemented in <a class="el" href="classSoftwareDevice.html#a899e79ea1a3db44d8f277bd4639318d1">SoftwareDevice</a>, <a class="el" href="classOpenALDevice.html#a654026d5cc5b7f9b5859512322a58646">OpenALDevice</a>, and <a class="el" href="classNULLDevice.html#ad7c26a50fa9b29f8ac29c726f8dec9d9">NULLDevice</a>.</p>
</div>
</div>
<a id="a18360239667c2adbec6ca696f2f54379"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18360239667c2adbec6ca696f2f54379">◆ </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>> IDevice::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">pure 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>Implemented in <a class="el" href="classSoftwareDevice.html#ad1fd5199e9f35ed45f4f64143ae57c67">SoftwareDevice</a>, <a class="el" href="classOpenALDevice.html#ae31631669359e4e477131bceefaf9c4c">OpenALDevice</a>, and <a class="el" href="classNULLDevice.html#a97568fdd2ace575ccd2e8ecb7dac36b0">NULLDevice</a>.</p>
</div>
</div>
<a id="a7ceffd020c0592cc70201749a6af0f25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ceffd020c0592cc70201749a6af0f25">◆ </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>> IDevice::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">pure 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>Implemented in <a class="el" href="classSoftwareDevice.html#a958e0174b3309056a8a081b7254c42a7">SoftwareDevice</a>, <a class="el" href="classOpenALDevice.html#aca26e2e286366c5497c106f0a1f79c0a">OpenALDevice</a>, and <a class="el" href="classNULLDevice.html#a1900d9d60b73e94211e5a412f5efcd69">NULLDevice</a>.</p>
</div>
</div>
<a id="a0a977bd1854c5579930fc4ead5c788ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0a977bd1854c5579930fc4ead5c788ae">◆ </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 IDevice::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">pure 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>Implemented in <a class="el" href="classSoftwareDevice.html#aa530cbd59c872b042681480ba838b60f">SoftwareDevice</a>, <a class="el" href="classOpenALDevice.html#ad399141744c5a97f2b5caf6a40955a44">OpenALDevice</a>, and <a class="el" href="classNULLDevice.html#a46dc2841806e748d8bacbcb5c8807fe6">NULLDevice</a>.</p>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>devices/<a class="el" href="IDevice_8h_source.html">IDevice.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
>
1035
