annotate doc/html/functions_func.html @ 23:92ee4ace9d46 develop

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