<!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: NULLDevice 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="classNULLDevice-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">NULLDevice Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This device plays nothing.
<a href="classNULLDevice.html#details">More...</a></p>
<p><code>#include <<a class="el" href="NULLDevice_8h_source.html">NULLDevice.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for NULLDevice:</div>
<div class="dyncontent">
<div class="center"><img src="classNULLDevice__inherit__graph.png" border="0" usemap="#NULLDevice_inherit__map" alt="Inheritance graph"/></div>
<map name="NULLDevice_inherit__map" id="NULLDevice_inherit__map">
<area shape="rect" title="This device plays nothing." alt="" coords="5,155,100,181"/>
<area shape="rect" href="classIDevice.html" title="The IDevice interface represents an output device for sound sources." alt="" coords="20,80,85,107"/>
<area shape="rect" href="classILockable.html" title="This class provides an interface for lockable objects." alt="" coords="13,5,93,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:ad22ca334b5aff082174c68c866d6a970"><td class="memItemLeft" align="right" valign="top"><a id="ad22ca334b5aff082174c68c866d6a970"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classNULLDevice.html#ad22ca334b5aff082174c68c866d6a970">NULLDevice</a> ()</td></tr>
<tr class="memdesc:ad22ca334b5aff082174c68c866d6a970"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new <a class="el" href="classNULLDevice.html" title="This device plays nothing.">NULLDevice</a>. <br /></td></tr>
<tr class="separator:ad22ca334b5aff082174c68c866d6a970"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a09c5aceccc3282de2e4ec76518f4dee3"><td class="memItemLeft" align="right" valign="top"><a id="a09c5aceccc3282de2e4ec76518f4dee3"></a>
virtual <a class="el" href="structDeviceSpecs.html">DeviceSpecs</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classNULLDevice.html#a09c5aceccc3282de2e4ec76518f4dee3">getSpecs</a> () const</td></tr>
<tr class="memdesc:a09c5aceccc3282de2e4ec76518f4dee3"><td class="mdescLeft"> </td><td class="mdescRight">Returns the specification of the device. <br /></td></tr>
<tr class="separator:a09c5aceccc3282de2e4ec76518f4dee3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a97568fdd2ace575ccd2e8ecb7dac36b0"><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="classNULLDevice.html#a97568fdd2ace575ccd2e8ecb7dac36b0">play</a> (std::shared_ptr< <a class="el" href="classIReader.html">IReader</a> > reader, bool keep=false)</td></tr>
<tr class="memdesc:a97568fdd2ace575ccd2e8ecb7dac36b0"><td class="mdescLeft"> </td><td class="mdescRight">Plays a sound source. <a href="#a97568fdd2ace575ccd2e8ecb7dac36b0">More...</a><br /></td></tr>
<tr class="separator:a97568fdd2ace575ccd2e8ecb7dac36b0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1900d9d60b73e94211e5a412f5efcd69"><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="classNULLDevice.html#a1900d9d60b73e94211e5a412f5efcd69">play</a> (std::shared_ptr< <a class="el" href="classISound.html">ISound</a> > sound, bool keep=false)</td></tr>
<tr class="memdesc:a1900d9d60b73e94211e5a412f5efcd69"><td class="mdescLeft"> </td><td class="mdescRight">Plays a sound source. <a href="#a1900d9d60b73e94211e5a412f5efcd69">More...</a><br /></td></tr>
<tr class="separator:a1900d9d60b73e94211e5a412f5efcd69"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a812274ed0938ba2b3deba1be4eb8acc4"><td class="memItemLeft" align="right" valign="top"><a id="a812274ed0938ba2b3deba1be4eb8acc4"></a>
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classNULLDevice.html#a812274ed0938ba2b3deba1be4eb8acc4">stopAll</a> ()</td></tr>
<tr class="memdesc:a812274ed0938ba2b3deba1be4eb8acc4"><td class="mdescLeft"> </td><td class="mdescRight">Stops all playing sounds. <br /></td></tr>
<tr class="separator:a812274ed0938ba2b3deba1be4eb8acc4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad7c26a50fa9b29f8ac29c726f8dec9d9"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classNULLDevice.html#ad7c26a50fa9b29f8ac29c726f8dec9d9">lock</a> ()</td></tr>
<tr class="memdesc:ad7c26a50fa9b29f8ac29c726f8dec9d9"><td class="mdescLeft"> </td><td class="mdescRight">Locks the device. <a href="#ad7c26a50fa9b29f8ac29c726f8dec9d9">More...</a><br /></td></tr>
<tr class="separator:ad7c26a50fa9b29f8ac29c726f8dec9d9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a716d0365acb7c07cd2fa68bd24850e69"><td class="memItemLeft" align="right" valign="top"><a id="a716d0365acb7c07cd2fa68bd24850e69"></a>
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classNULLDevice.html#a716d0365acb7c07cd2fa68bd24850e69">unlock</a> ()</td></tr>
<tr class="memdesc:a716d0365acb7c07cd2fa68bd24850e69"><td class="mdescLeft"> </td><td class="mdescRight">Unlocks the previously locked device. <br /></td></tr>
<tr class="separator:a716d0365acb7c07cd2fa68bd24850e69"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af8b47165d168e2e7582caba6c16f8d1c"><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classNULLDevice.html#af8b47165d168e2e7582caba6c16f8d1c">getVolume</a> () const</td></tr>
<tr class="memdesc:af8b47165d168e2e7582caba6c16f8d1c"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the overall device volume. <a href="#af8b47165d168e2e7582caba6c16f8d1c">More...</a><br /></td></tr>
<tr class="separator:af8b47165d168e2e7582caba6c16f8d1c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a46dc2841806e748d8bacbcb5c8807fe6"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classNULLDevice.html#a46dc2841806e748d8bacbcb5c8807fe6">setVolume</a> (float volume)</td></tr>
<tr class="memdesc:a46dc2841806e748d8bacbcb5c8807fe6"><td class="mdescLeft"> </td><td class="mdescRight">Sets the overall device volume. <a href="#a46dc2841806e748d8bacbcb5c8807fe6">More...</a><br /></td></tr>
<tr class="separator:a46dc2841806e748d8bacbcb5c8807fe6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a14f0429593adfa56ac538ebcd68080c9"><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="classNULLDevice.html#a14f0429593adfa56ac538ebcd68080c9">getSynchronizer</a> ()</td></tr>
<tr class="memdesc:a14f0429593adfa56ac538ebcd68080c9"><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="#a14f0429593adfa56ac538ebcd68080c9">More...</a><br /></td></tr>
<tr class="separator:a14f0429593adfa56ac538ebcd68080c9"><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:a1d750b5f2a5e67d27cb744403e7b3c83"><td class="memItemLeft" align="right" valign="top"><a id="a1d750b5f2a5e67d27cb744403e7b3c83"></a>
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classNULLDevice.html#a1d750b5f2a5e67d27cb744403e7b3c83">registerPlugin</a> ()</td></tr>
<tr class="memdesc:a1d750b5f2a5e67d27cb744403e7b3c83"><td class="mdescLeft"> </td><td class="mdescRight">Registers this plugin. <br /></td></tr>
<tr class="separator:a1d750b5f2a5e67d27cb744403e7b3c83"><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 device plays nothing. </p>
<p>It is similar to the linux device /dev/null. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a14f0429593adfa56ac538ebcd68080c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a14f0429593adfa56ac538ebcd68080c9">◆ </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>* NULLDevice::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>
</div>
</div>
<a id="af8b47165d168e2e7582caba6c16f8d1c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af8b47165d168e2e7582caba6c16f8d1c">◆ </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 NULLDevice::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="ad7c26a50fa9b29f8ac29c726f8dec9d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7c26a50fa9b29f8ac29c726f8dec9d9">◆ </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 NULLDevice::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="a97568fdd2ace575ccd2e8ecb7dac36b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a97568fdd2ace575ccd2e8ecb7dac36b0">◆ </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>> NULLDevice::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="a1900d9d60b73e94211e5a412f5efcd69"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1900d9d60b73e94211e5a412f5efcd69">◆ </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>> NULLDevice::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="a46dc2841806e748d8bacbcb5c8807fe6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46dc2841806e748d8bacbcb5c8807fe6">◆ </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 NULLDevice::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="NULLDevice_8h_source.html">NULLDevice.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
>
1171
