Mercurial > hg > btrack
comparison doc/html/functions.html @ 60:bf256abf1dd4
Did more commenting. Added documentation.
| author | Adam Stark <adamstark@users.noreply.github.com> |
|---|---|
| date | Sat, 25 Jan 2014 18:17:51 +0000 |
| parents | |
| children | deb49a2590f3 |
comparison
equal
deleted
inserted
replaced
| 59:ba3fc238ccad | 60:bf256abf1dd4 |
|---|---|
| 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 <title>BTrack - A Real-Time Beat Tracker: Class Members</title> | |
| 7 <link href="tabs.css" rel="stylesheet" type="text/css"/> | |
| 8 <script type="text/javascript" src="jquery.js"></script> | |
| 9 <script type="text/javascript" src="dynsections.js"></script> | |
| 10 <link href="search/search.css" rel="stylesheet" type="text/css"/> | |
| 11 <script type="text/javascript" src="search/search.js"></script> | |
| 12 <script type="text/javascript"> | |
| 13 $(document).ready(function() { searchBox.OnSelectItem(0); }); | |
| 14 </script> | |
| 15 <link href="doxygen.css" rel="stylesheet" type="text/css" /> | |
| 16 </head> | |
| 17 <body> | |
| 18 <div id="top"><!-- do not remove this div, it is closed by doxygen! --> | |
| 19 <div id="titlearea"> | |
| 20 <table cellspacing="0" cellpadding="0"> | |
| 21 <tbody> | |
| 22 <tr style="height: 56px;"> | |
| 23 <td style="padding-left: 0.5em;"> | |
| 24 <div id="projectname">BTrack - A Real-Time Beat Tracker | |
| 25 </div> | |
| 26 </td> | |
| 27 </tr> | |
| 28 </tbody> | |
| 29 </table> | |
| 30 </div> | |
| 31 <!-- end header part --> | |
| 32 <!-- Generated by Doxygen 1.8.2 --> | |
| 33 <script type="text/javascript"> | |
| 34 var searchBox = new SearchBox("searchBox", "search",false,'Search'); | |
| 35 </script> | |
| 36 <div id="navrow1" class="tabs"> | |
| 37 <ul class="tablist"> | |
| 38 <li><a href="index.html"><span>Main Page</span></a></li> | |
| 39 <li class="current"><a href="annotated.html"><span>Classes</span></a></li> | |
| 40 <li><a href="files.html"><span>Files</span></a></li> | |
| 41 <li> | |
| 42 <div id="MSearchBox" class="MSearchBoxInactive"> | |
| 43 <span class="left"> | |
| 44 <img id="MSearchSelect" src="search/mag_sel.png" | |
| 45 onmouseover="return searchBox.OnSearchSelectShow()" | |
| 46 onmouseout="return searchBox.OnSearchSelectHide()" | |
| 47 alt=""/> | |
| 48 <input type="text" id="MSearchField" value="Search" accesskey="S" | |
| 49 onfocus="searchBox.OnSearchFieldFocus(true)" | |
| 50 onblur="searchBox.OnSearchFieldFocus(false)" | |
| 51 onkeyup="searchBox.OnSearchFieldChange(event)"/> | |
| 52 </span><span class="right"> | |
| 53 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> | |
| 54 </span> | |
| 55 </div> | |
| 56 </li> | |
| 57 </ul> | |
| 58 </div> | |
| 59 <div id="navrow2" class="tabs2"> | |
| 60 <ul class="tablist"> | |
| 61 <li><a href="annotated.html"><span>Class List</span></a></li> | |
| 62 <li><a href="classes.html"><span>Class Index</span></a></li> | |
| 63 <li class="current"><a href="functions.html"><span>Class Members</span></a></li> | |
| 64 </ul> | |
| 65 </div> | |
| 66 <div id="navrow3" class="tabs2"> | |
| 67 <ul class="tablist"> | |
| 68 <li class="current"><a href="functions.html"><span>All</span></a></li> | |
| 69 <li><a href="functions_func.html"><span>Functions</span></a></li> | |
| 70 </ul> | |
| 71 </div> | |
| 72 </div><!-- top --> | |
| 73 <!-- window showing the filter options --> | |
| 74 <div id="MSearchSelectWindow" | |
| 75 onmouseover="return searchBox.OnSearchSelectShow()" | |
| 76 onmouseout="return searchBox.OnSearchSelectHide()" | |
| 77 onkeydown="return searchBox.OnSearchSelectKey(event)"> | |
| 78 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Enumerations</a></div> | |
| 79 | |
| 80 <!-- iframe showing the search results (closed by default) --> | |
| 81 <div id="MSearchResultsWindow"> | |
| 82 <iframe src="javascript:void(0)" frameborder="0" | |
| 83 name="MSearchResults" id="MSearchResults"> | |
| 84 </iframe> | |
| 85 </div> | |
| 86 | |
| 87 <div class="contents"> | |
| 88 <div class="textblock">Here is a list of all documented class members with links to the class documentation for each member:</div><ul> | |
| 89 <li>beatDueInCurrentFrame() | |
| 90 : <a class="el" href="class_b_track.html#ac92eaea0e42dd18c79de10bf852d7f4a">BTrack</a> | |
| 91 </li> | |
| 92 <li>BTrack() | |
| 93 : <a class="el" href="class_b_track.html#afce9e207a2f6ff71d96125dee16797de">BTrack</a> | |
| 94 </li> | |
| 95 <li>calculateOnsetDetectionFunctionSample() | |
| 96 : <a class="el" href="class_onset_detection_function.html#a7b8fffe6221d3bd4f6cac82c17db0e92">OnsetDetectionFunction</a> | |
| 97 </li> | |
| 98 <li>doNotFixTempo() | |
| 99 : <a class="el" href="class_b_track.html#a22917ea231d2efd5670a764dd5a98983">BTrack</a> | |
| 100 </li> | |
| 101 <li>fixTempo() | |
| 102 : <a class="el" href="class_b_track.html#a550829be9b4c58cd53195ec4900c7c71">BTrack</a> | |
| 103 </li> | |
| 104 <li>getBeatTimeInSeconds() | |
| 105 : <a class="el" href="class_b_track.html#aa66d0b9dfb4408e8cf84398f03b60a56">BTrack</a> | |
| 106 </li> | |
| 107 <li>getCurrentTempoEstimate() | |
| 108 : <a class="el" href="class_b_track.html#a17cea0a4dff3908660e4117e9a6c42bb">BTrack</a> | |
| 109 </li> | |
| 110 <li>getHopSize() | |
| 111 : <a class="el" href="class_b_track.html#ac06aa079977062bfa2930cdca45e69fb">BTrack</a> | |
| 112 </li> | |
| 113 <li>getLatestCumulativeScoreValue() | |
| 114 : <a class="el" href="class_b_track.html#a7ccb5059d0f00e3217ea686e4c1e156d">BTrack</a> | |
| 115 </li> | |
| 116 <li>initialise() | |
| 117 : <a class="el" href="class_onset_detection_function.html#a654ed22782f6dc62e8347df44c90fbeb">OnsetDetectionFunction</a> | |
| 118 </li> | |
| 119 <li>OnsetDetectionFunction() | |
| 120 : <a class="el" href="class_onset_detection_function.html#a7b4e4ab1b0be5f57682c52141eb959d6">OnsetDetectionFunction</a> | |
| 121 </li> | |
| 122 <li>processAudioFrame() | |
| 123 : <a class="el" href="class_b_track.html#abb7ce7253095e6f859ef7b30f06ce051">BTrack</a> | |
| 124 </li> | |
| 125 <li>processOnsetDetectionFunctionSample() | |
| 126 : <a class="el" href="class_b_track.html#a6fab18732bef8c87152e93dec9e4f854">BTrack</a> | |
| 127 </li> | |
| 128 <li>setOnsetDetectionFunctionType() | |
| 129 : <a class="el" href="class_onset_detection_function.html#a51fdab443155aaaa935956645e8f9131">OnsetDetectionFunction</a> | |
| 130 </li> | |
| 131 <li>setTempo() | |
| 132 : <a class="el" href="class_b_track.html#a96cf4088e40dff66ce15ada1f671a186">BTrack</a> | |
| 133 </li> | |
| 134 <li>~OnsetDetectionFunction() | |
| 135 : <a class="el" href="class_onset_detection_function.html#aa01f8125c950f3def45154878107e503">OnsetDetectionFunction</a> | |
| 136 </li> | |
| 137 </ul> | |
| 138 </div><!-- contents --> | |
| 139 <!-- start footer part --> | |
| 140 <hr class="footer"/><address class="footer"><small> | |
| 141 Generated on Sat Jan 25 2014 18:11:17 for BTrack - A Real-Time Beat Tracker by  <a href="http://www.doxygen.org/index.html"> | |
| 142 <img class="footer" src="doxygen.png" alt="doxygen"/> | |
| 143 </a> 1.8.2 | |
| 144 </small></address> | |
| 145 </body> | |
| 146 </html> |
