Sophie

Sophie

distrib > Mageia > 7 > i586 > media > core-release > by-pkgid > 4f48f620eaa1d8b8f904a92a0540d40f > files > 904

audaspace-doc-1.3.0-18.mga7.noarch.rpm

<!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: DefaultSynchronizer 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
   &#160;<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&amp;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&amp;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> &#124;
<a href="classDefaultSynchronizer-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">DefaultSynchronizer Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>This class is a default <a class="el" href="classISynchronizer.html" title="This class enables global synchronization of several audio applications if supported.">ISynchronizer</a> implementation that actually does no synchronization and is intended for devices that don't support it.  
 <a href="classDefaultSynchronizer.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="DefaultSynchronizer_8h_source.html">DefaultSynchronizer.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for DefaultSynchronizer:</div>
<div class="dyncontent">
<div class="center"><img src="classDefaultSynchronizer__inherit__graph.png" border="0" usemap="#DefaultSynchronizer_inherit__map" alt="Inheritance graph"/></div>
<map name="DefaultSynchronizer_inherit__map" id="DefaultSynchronizer_inherit__map">
<area shape="rect"  title="This class is a default ISynchronizer implementation that actually does no synchronization and is int..." alt="" coords="5,80,151,107"/>
<area shape="rect"  href="classISynchronizer.html" title="This class enables global synchronization of several audio applications if supported." alt="" coords="26,5,130,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:a619fb8a1a6e2cc4d573b89ae5b355528"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDefaultSynchronizer.html#a619fb8a1a6e2cc4d573b89ae5b355528">seek</a> (std::shared_ptr&lt; <a class="el" href="classIHandle.html">IHandle</a> &gt; handle, float time)</td></tr>
<tr class="memdesc:a619fb8a1a6e2cc4d573b89ae5b355528"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the playback position of a handle and the synchronizer to a specific time.  <a href="#a619fb8a1a6e2cc4d573b89ae5b355528">More...</a><br /></td></tr>
<tr class="separator:a619fb8a1a6e2cc4d573b89ae5b355528"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31644468fd4ba17d322371a5de0fb80e"><td class="memItemLeft" align="right" valign="top">virtual float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDefaultSynchronizer.html#a31644468fd4ba17d322371a5de0fb80e">getPosition</a> (std::shared_ptr&lt; <a class="el" href="classIHandle.html">IHandle</a> &gt; handle)</td></tr>
<tr class="memdesc:a31644468fd4ba17d322371a5de0fb80e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the position of the synchronizer.  <a href="#a31644468fd4ba17d322371a5de0fb80e">More...</a><br /></td></tr>
<tr class="separator:a31644468fd4ba17d322371a5de0fb80e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2547f1680779a2d54999a55e3875fb8e"><td class="memItemLeft" align="right" valign="top"><a id="a2547f1680779a2d54999a55e3875fb8e"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDefaultSynchronizer.html#a2547f1680779a2d54999a55e3875fb8e">play</a> ()</td></tr>
<tr class="memdesc:a2547f1680779a2d54999a55e3875fb8e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts the synchronizer playback. <br /></td></tr>
<tr class="separator:a2547f1680779a2d54999a55e3875fb8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35ab8080e5aaa145c274b12db6d0964d"><td class="memItemLeft" align="right" valign="top"><a id="a35ab8080e5aaa145c274b12db6d0964d"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDefaultSynchronizer.html#a35ab8080e5aaa145c274b12db6d0964d">stop</a> ()</td></tr>
<tr class="memdesc:a35ab8080e5aaa145c274b12db6d0964d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stops the synchronizer playback. <br /></td></tr>
<tr class="separator:a35ab8080e5aaa145c274b12db6d0964d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5954224202b4296f00c4c8c6e349a0c3"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDefaultSynchronizer.html#a5954224202b4296f00c4c8c6e349a0c3">setSyncCallback</a> (<a class="el" href="classISynchronizer.html#a055d3b6aeda93fd20f87b2ff08c5fa04">syncFunction</a> function, void *data)</td></tr>
<tr class="memdesc:a5954224202b4296f00c4c8c6e349a0c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the callback function that is called when a synchronization event happens.  <a href="#a5954224202b4296f00c4c8c6e349a0c3">More...</a><br /></td></tr>
<tr class="separator:a5954224202b4296f00c4c8c6e349a0c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2af44b9030eb5f12c6b487ba7c12018f"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDefaultSynchronizer.html#a2af44b9030eb5f12c6b487ba7c12018f">isPlaying</a> ()</td></tr>
<tr class="memdesc:a2af44b9030eb5f12c6b487ba7c12018f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves whether the synchronizer is playing back.  <a href="#a2af44b9030eb5f12c6b487ba7c12018f">More...</a><br /></td></tr>
<tr class="separator:a2af44b9030eb5f12c6b487ba7c12018f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classISynchronizer"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classISynchronizer')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classISynchronizer.html">ISynchronizer</a></td></tr>
<tr class="memitem:afbdc324e89a52ca529f99d23e9dcdd18 inherit pub_methods_classISynchronizer"><td class="memItemLeft" align="right" valign="top"><a id="afbdc324e89a52ca529f99d23e9dcdd18"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classISynchronizer.html#afbdc324e89a52ca529f99d23e9dcdd18">~ISynchronizer</a> ()</td></tr>
<tr class="memdesc:afbdc324e89a52ca529f99d23e9dcdd18 inherit pub_methods_classISynchronizer"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys the synchronizer. <br /></td></tr>
<tr class="separator:afbdc324e89a52ca529f99d23e9dcdd18 inherit pub_methods_classISynchronizer"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_classISynchronizer"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classISynchronizer')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classISynchronizer.html">ISynchronizer</a></td></tr>
<tr class="memitem:a055d3b6aeda93fd20f87b2ff08c5fa04 inherit pub_types_classISynchronizer"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classISynchronizer.html#a055d3b6aeda93fd20f87b2ff08c5fa04">syncFunction</a>) (void *, int, float)</td></tr>
<tr class="memdesc:a055d3b6aeda93fd20f87b2ff08c5fa04 inherit pub_types_classISynchronizer"><td class="mdescLeft">&#160;</td><td class="mdescRight">The syncFunction is called when a synchronization event happens.  <a href="classISynchronizer.html#a055d3b6aeda93fd20f87b2ff08c5fa04">More...</a><br /></td></tr>
<tr class="separator:a055d3b6aeda93fd20f87b2ff08c5fa04 inherit pub_types_classISynchronizer"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class is a default <a class="el" href="classISynchronizer.html" title="This class enables global synchronization of several audio applications if supported.">ISynchronizer</a> implementation that actually does no synchronization and is intended for devices that don't support it. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a31644468fd4ba17d322371a5de0fb80e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31644468fd4ba17d322371a5de0fb80e">&#9670;&nbsp;</a></span>getPosition()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual float DefaultSynchronizer::getPosition </td>
          <td>(</td>
          <td class="paramtype">std::shared_ptr&lt; <a class="el" href="classIHandle.html">IHandle</a> &gt;&#160;</td>
          <td class="paramname"><em>handle</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>Retrieves the position of the synchronizer. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">handle</td><td>The handle which is synchronized. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The position in seconds. </dd></dl>

<p>Implements <a class="el" href="classISynchronizer.html#ad2f2b8e6b67472e9ce94e660c0e5152d">ISynchronizer</a>.</p>

</div>
</div>
<a id="a2af44b9030eb5f12c6b487ba7c12018f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2af44b9030eb5f12c6b487ba7c12018f">&#9670;&nbsp;</a></span>isPlaying()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual int DefaultSynchronizer::isPlaying </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 whether the synchronizer is playing back. </p>
<dl class="section return"><dt>Returns</dt><dd>Whether the synchronizer plays back. </dd></dl>

<p>Implements <a class="el" href="classISynchronizer.html#aea7d44284749d6ddc78ed0350dd94afe">ISynchronizer</a>.</p>

</div>
</div>
<a id="a619fb8a1a6e2cc4d573b89ae5b355528"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a619fb8a1a6e2cc4d573b89ae5b355528">&#9670;&nbsp;</a></span>seek()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void DefaultSynchronizer::seek </td>
          <td>(</td>
          <td class="paramtype">std::shared_ptr&lt; <a class="el" href="classIHandle.html">IHandle</a> &gt;&#160;</td>
          <td class="paramname"><em>handle</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>time</em>&#160;</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>Sets the playback position of a handle and the synchronizer to a specific time. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">handle</td><td>The handle that should be synchronized/seeked. </td></tr>
    <tr><td class="paramname">time</td><td>The absolute time to synchronize to. </td></tr>
  </table>
  </dd>
</dl>

<p>Implements <a class="el" href="classISynchronizer.html#acd1ddd3c20cf14c931190a4d6a016f87">ISynchronizer</a>.</p>

</div>
</div>
<a id="a5954224202b4296f00c4c8c6e349a0c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5954224202b4296f00c4c8c6e349a0c3">&#9670;&nbsp;</a></span>setSyncCallback()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void DefaultSynchronizer::setSyncCallback </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classISynchronizer.html#a055d3b6aeda93fd20f87b2ff08c5fa04">syncFunction</a>&#160;</td>
          <td class="paramname"><em>function</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>data</em>&#160;</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>Sets the callback function that is called when a synchronization event happens. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">function</td><td>The function to be called. </td></tr>
    <tr><td class="paramname">data</td><td>User data to be passed to the callback. </td></tr>
  </table>
  </dd>
</dl>

<p>Implements <a class="el" href="classISynchronizer.html#ac06e9ea7feff80d58cffdaad40d85cb7">ISynchronizer</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>devices/<a class="el" href="DefaultSynchronizer_8h_source.html">DefaultSynchronizer.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>