DISTRHO Plugin Framework
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

187 lines
8.5KB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.11"/>
  7. <title>DISTRHO Plugin Framework: TimePosition Struct Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td id="projectalign" style="padding-left: 0.5em;">
  26. <div id="projectname">DISTRHO Plugin Framework
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.11 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="modules.html"><span>Modules</span></a></li>
  42. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  43. <li><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  51. <input type="text" id="MSearchField" value="Search" accesskey="S"
  52. onfocus="searchBox.OnSearchFieldFocus(true)"
  53. onblur="searchBox.OnSearchFieldFocus(false)"
  54. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  55. </span><span class="right">
  56. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. <div id="navrow2" class="tabs2">
  63. <ul class="tablist">
  64. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  65. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  66. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  67. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  68. </ul>
  69. </div>
  70. <!-- window showing the filter options -->
  71. <div id="MSearchSelectWindow"
  72. onmouseover="return searchBox.OnSearchSelectShow()"
  73. onmouseout="return searchBox.OnSearchSelectHide()"
  74. onkeydown="return searchBox.OnSearchSelectKey(event)">
  75. </div>
  76. <!-- iframe showing the search results (closed by default) -->
  77. <div id="MSearchResultsWindow">
  78. <iframe src="javascript:void(0)" frameborder="0"
  79. name="MSearchResults" id="MSearchResults">
  80. </iframe>
  81. </div>
  82. </div><!-- top -->
  83. <div class="header">
  84. <div class="summary">
  85. <a href="#nested-classes">Classes</a> &#124;
  86. <a href="#pub-methods">Public Member Functions</a> &#124;
  87. <a href="#pub-attribs">Public Attributes</a> &#124;
  88. <a href="structTimePosition-members.html">List of all members</a> </div>
  89. <div class="headertitle">
  90. <div class="title">TimePosition Struct Reference<div class="ingroups"><a class="el" href="group__BasePluginStructs.html">Base Plugin Structs</a></div></div> </div>
  91. </div><!--header-->
  92. <div class="contents">
  93. <p><code>#include &lt;<a class="el" href="DistrhoPlugin_8hpp_source.html">DistrhoPlugin.hpp</a>&gt;</code></p>
  94. <table class="memberdecls">
  95. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  96. Classes</h2></td></tr>
  97. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTimePosition_1_1BarBeatTick.html">BarBeatTick</a></td></tr>
  98. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. </table><table class="memberdecls">
  100. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  101. Public Member Functions</h2></td></tr>
  102. <tr class="memitem:aee816daeed95cf309ded1087a0c800ae"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTimePosition.html#aee816daeed95cf309ded1087a0c800ae">TimePosition</a> () noexcept</td></tr>
  103. <tr class="separator:aee816daeed95cf309ded1087a0c800ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. </table><table class="memberdecls">
  105. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  106. Public Attributes</h2></td></tr>
  107. <tr class="memitem:a35db424bdf8ec01102a4fa6346c45574"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTimePosition.html#a35db424bdf8ec01102a4fa6346c45574">playing</a></td></tr>
  108. <tr class="separator:a35db424bdf8ec01102a4fa6346c45574"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:aa3606d1c518c7ebe6335bc19f72b015b"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTimePosition.html#aa3606d1c518c7ebe6335bc19f72b015b">frame</a></td></tr>
  110. <tr class="separator:aa3606d1c518c7ebe6335bc19f72b015b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a358c61d7316c6a97e6cd083328e646bd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a358c61d7316c6a97e6cd083328e646bd"></a>
  112. struct <a class="el" href="structTimePosition_1_1BarBeatTick.html">TimePosition::BarBeatTick</a>&#160;</td><td class="memItemRight" valign="bottom"><b>bbt</b></td></tr>
  113. <tr class="separator:a358c61d7316c6a97e6cd083328e646bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. </table>
  115. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  116. <div class="textblock"><p>Time position.<br />
  117. The <em>playing</em> and <em>frame</em> values are always valid.<br />
  118. BBT values are only valid when <em>bbt.valid</em> is true.</p>
  119. <p>This struct is inspired by the JACK Transport API. </p>
  120. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  121. <a class="anchor" id="aee816daeed95cf309ded1087a0c800ae"></a>
  122. <div class="memitem">
  123. <div class="memproto">
  124. <table class="mlabels">
  125. <tr>
  126. <td class="mlabels-left">
  127. <table class="memname">
  128. <tr>
  129. <td class="memname">TimePosition::TimePosition </td>
  130. <td>(</td>
  131. <td class="paramname"></td><td>)</td>
  132. <td></td>
  133. </tr>
  134. </table>
  135. </td>
  136. <td class="mlabels-right">
  137. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
  138. </tr>
  139. </table>
  140. </div><div class="memdoc">
  141. <p>Default constructor for a time position. </p>
  142. </div>
  143. </div>
  144. <h2 class="groupheader">Member Data Documentation</h2>
  145. <a class="anchor" id="a35db424bdf8ec01102a4fa6346c45574"></a>
  146. <div class="memitem">
  147. <div class="memproto">
  148. <table class="memname">
  149. <tr>
  150. <td class="memname">bool TimePosition::playing</td>
  151. </tr>
  152. </table>
  153. </div><div class="memdoc">
  154. <p>Wherever the host transport is playing/rolling. </p>
  155. </div>
  156. </div>
  157. <a class="anchor" id="aa3606d1c518c7ebe6335bc19f72b015b"></a>
  158. <div class="memitem">
  159. <div class="memproto">
  160. <table class="memname">
  161. <tr>
  162. <td class="memname">uint64_t TimePosition::frame</td>
  163. </tr>
  164. </table>
  165. </div><div class="memdoc">
  166. <p>Current host transport position in frames. </p>
  167. </div>
  168. </div>
  169. <hr/>The documentation for this struct was generated from the following file:<ul>
  170. <li>distrho/<a class="el" href="DistrhoPlugin_8hpp_source.html">DistrhoPlugin.hpp</a></li>
  171. </ul>
  172. </div><!-- contents -->
  173. <!-- start footer part -->
  174. <hr class="footer"/><address class="footer"><small>
  175. Generated on Tue Jun 7 2016 14:04:30 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">
  176. <img class="footer" src="doxygen.png" alt="doxygen"/>
  177. </a> 1.8.11
  178. </small></address>
  179. </body>
  180. </html>