<!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: JackSynchronizer Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">Audaspace  <span id="projectnumber">1.3.0</span> </div> <div id="projectbrief">A high level audio library.</div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.15 --> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ var searchBox = new SearchBox("searchBox", "search",false,'Search'); /* @license-end */ </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); /* @license-end */</script> <div id="main-nav"></div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> </div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="classJackSynchronizer-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">JackSynchronizer Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>This class is a Synchronizer implementation using JACK Transport. <a href="classJackSynchronizer.html#details">More...</a></p> <p><code>#include <<a class="el" href="JackSynchronizer_8h_source.html">JackSynchronizer.h</a>></code></p> <div class="dynheader"> Inheritance diagram for JackSynchronizer:</div> <div class="dyncontent"> <div class="center"><img src="classJackSynchronizer__inherit__graph.png" border="0" usemap="#JackSynchronizer_inherit__map" alt="Inheritance graph"/></div> <map name="JackSynchronizer_inherit__map" id="JackSynchronizer_inherit__map"> <area shape="rect" title="This class is a Synchronizer implementation using JACK Transport." alt="" coords="5,80,132,107"/> <area shape="rect" href="classISynchronizer.html" title="This class enables global synchronization of several audio applications if supported." alt="" coords="17,5,121,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:ab4a962c7be3fdba4f51dabf2e386297a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classJackSynchronizer.html#ab4a962c7be3fdba4f51dabf2e386297a">JackSynchronizer</a> (<a class="el" href="classJackDevice.html">JackDevice</a> *device)</td></tr> <tr class="memdesc:ab4a962c7be3fdba4f51dabf2e386297a"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new <a class="el" href="classJackSynchronizer.html" title="This class is a Synchronizer implementation using JACK Transport.">JackSynchronizer</a>. <a href="#ab4a962c7be3fdba4f51dabf2e386297a">More...</a><br /></td></tr> <tr class="separator:ab4a962c7be3fdba4f51dabf2e386297a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a22e5d44537b15f9c5173c2e88efe79d1"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classJackSynchronizer.html#a22e5d44537b15f9c5173c2e88efe79d1">seek</a> (std::shared_ptr< <a class="el" href="classIHandle.html">IHandle</a> > handle, float time)</td></tr> <tr class="memdesc:a22e5d44537b15f9c5173c2e88efe79d1"><td class="mdescLeft"> </td><td class="mdescRight">Sets the playback position of a handle and the synchronizer to a specific time. <a href="#a22e5d44537b15f9c5173c2e88efe79d1">More...</a><br /></td></tr> <tr class="separator:a22e5d44537b15f9c5173c2e88efe79d1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab132288771d36ba49d6f22a52d59970f"><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classJackSynchronizer.html#ab132288771d36ba49d6f22a52d59970f">getPosition</a> (std::shared_ptr< <a class="el" href="classIHandle.html">IHandle</a> > handle)</td></tr> <tr class="memdesc:ab132288771d36ba49d6f22a52d59970f"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the position of the synchronizer. <a href="#ab132288771d36ba49d6f22a52d59970f">More...</a><br /></td></tr> <tr class="separator:ab132288771d36ba49d6f22a52d59970f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a05875c77884b2c5d91086bee929619ce"><td class="memItemLeft" align="right" valign="top"><a id="a05875c77884b2c5d91086bee929619ce"></a> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classJackSynchronizer.html#a05875c77884b2c5d91086bee929619ce">play</a> ()</td></tr> <tr class="memdesc:a05875c77884b2c5d91086bee929619ce"><td class="mdescLeft"> </td><td class="mdescRight">Starts the synchronizer playback. <br /></td></tr> <tr class="separator:a05875c77884b2c5d91086bee929619ce"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9fa784ab6c54aa504b7ab0992020a59e"><td class="memItemLeft" align="right" valign="top"><a id="a9fa784ab6c54aa504b7ab0992020a59e"></a> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classJackSynchronizer.html#a9fa784ab6c54aa504b7ab0992020a59e">stop</a> ()</td></tr> <tr class="memdesc:a9fa784ab6c54aa504b7ab0992020a59e"><td class="mdescLeft"> </td><td class="mdescRight">Stops the synchronizer playback. <br /></td></tr> <tr class="separator:a9fa784ab6c54aa504b7ab0992020a59e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6823f0b92895049d20f97e369d2c9753"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classJackSynchronizer.html#a6823f0b92895049d20f97e369d2c9753">setSyncCallback</a> (<a class="el" href="classISynchronizer.html#a055d3b6aeda93fd20f87b2ff08c5fa04">syncFunction</a> function, void *data)</td></tr> <tr class="memdesc:a6823f0b92895049d20f97e369d2c9753"><td class="mdescLeft"> </td><td class="mdescRight">Sets the callback function that is called when a synchronization event happens. <a href="#a6823f0b92895049d20f97e369d2c9753">More...</a><br /></td></tr> <tr class="separator:a6823f0b92895049d20f97e369d2c9753"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6cdb4535ab6df7656f22443b0b90d24b"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classJackSynchronizer.html#a6cdb4535ab6df7656f22443b0b90d24b">isPlaying</a> ()</td></tr> <tr class="memdesc:a6cdb4535ab6df7656f22443b0b90d24b"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves whether the synchronizer is playing back. <a href="#a6cdb4535ab6df7656f22443b0b90d24b">More...</a><br /></td></tr> <tr class="separator:a6cdb4535ab6df7656f22443b0b90d24b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_methods_classISynchronizer"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classISynchronizer')"><img src="closed.png" alt="-"/> 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 </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"> </td><td class="mdescRight">Destroys the synchronizer. <br /></td></tr> <tr class="separator:afbdc324e89a52ca529f99d23e9dcdd18 inherit pub_methods_classISynchronizer"><td class="memSeparator" colspan="2"> </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="-"/> 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(* </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"> </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"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>This class is a Synchronizer implementation using JACK Transport. </p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a id="ab4a962c7be3fdba4f51dabf2e386297a"></a> <h2 class="memtitle"><span class="permalink"><a href="#ab4a962c7be3fdba4f51dabf2e386297a">◆ </a></span>JackSynchronizer()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">JackSynchronizer::JackSynchronizer </td> <td>(</td> <td class="paramtype"><a class="el" href="classJackDevice.html">JackDevice</a> * </td> <td class="paramname"><em>device</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Creates a new <a class="el" href="classJackSynchronizer.html" title="This class is a Synchronizer implementation using JACK Transport.">JackSynchronizer</a>. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">device</td><td>The device that should be synchronized. </td></tr> </table> </dd> </dl> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a id="ab132288771d36ba49d6f22a52d59970f"></a> <h2 class="memtitle"><span class="permalink"><a href="#ab132288771d36ba49d6f22a52d59970f">◆ </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 JackSynchronizer::getPosition </td> <td>(</td> <td class="paramtype">std::shared_ptr< <a class="el" href="classIHandle.html">IHandle</a> > </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="a6cdb4535ab6df7656f22443b0b90d24b"></a> <h2 class="memtitle"><span class="permalink"><a href="#a6cdb4535ab6df7656f22443b0b90d24b">◆ </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 JackSynchronizer::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="a22e5d44537b15f9c5173c2e88efe79d1"></a> <h2 class="memtitle"><span class="permalink"><a href="#a22e5d44537b15f9c5173c2e88efe79d1">◆ </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 JackSynchronizer::seek </td> <td>(</td> <td class="paramtype">std::shared_ptr< <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>time</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">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="a6823f0b92895049d20f97e369d2c9753"></a> <h2 class="memtitle"><span class="permalink"><a href="#a6823f0b92895049d20f97e369d2c9753">◆ </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 JackSynchronizer::setSyncCallback </td> <td>(</td> <td class="paramtype"><a class="el" href="classISynchronizer.html#a055d3b6aeda93fd20f87b2ff08c5fa04">syncFunction</a> </td> <td class="paramname"><em>function</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">void * </td> <td class="paramname"><em>data</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">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>jack/<a class="el" href="JackSynchronizer_8h_source.html">JackSynchronizer.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>