Mercurial > hg > btrack

annotate doc/html/functions.html @ 114:d6d9df2db3e1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update documentation
author Adam Stark <adamstark.uk@gmail.com>
date Fri, 18 Aug 2023 10:48:26 +0200
parents ae3ec9b14092
children
rev   line source
adamstark@114 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
adamstark@114 2 <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
adamstark@60 3 <head>
adamstark@60 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
adamstark@114 5 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
adamstark@114 6 <meta name="generator" content="Doxygen 1.9.7"/>
adamstark@114 7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
adamstark@60 8 <title>BTrack - A Real-Time Beat Tracker: Class Members</title>
adamstark@60 9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
adamstark@60 10 <script type="text/javascript" src="jquery.js"></script>
adamstark@60 11 <script type="text/javascript" src="dynsections.js"></script>
adamstark@60 12 <link href="search/search.css" rel="stylesheet" type="text/css"/>
adamstark@114 13 <script type="text/javascript" src="search/searchdata.js"></script>
adamstark@60 14 <script type="text/javascript" src="search/search.js"></script>
adamstark@60 15 <link href="doxygen.css" rel="stylesheet" type="text/css" />
adamstark@60 16 </head>
adamstark@60 17 <body>
adamstark@60 18 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
adamstark@60 19 <div id="titlearea">
adamstark@60 20 <table cellspacing="0" cellpadding="0">
adamstark@60 21 <tbody>
adamstark@114 22 <tr id="projectrow">
adamstark@114 23 <td id="projectalign">
adamstark@60 24 <div id="projectname">BTrack - A Real-Time Beat Tracker
adamstark@60 25 </div>
adamstark@60 26 </td>
adamstark@60 27 </tr>
adamstark@60 28 </tbody>
adamstark@60 29 </table>
adamstark@60 30 </div>
adamstark@60 31 <!-- end header part -->
adamstark@114 32 <!-- Generated by Doxygen 1.9.7 -->
adamstark@60 33 <script type="text/javascript">
adamstark@114 34 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
adamstark@114 35 var searchBox = new SearchBox("searchBox", "search/",'.html');
adamstark@114 36 /* @license-end */
adamstark@60 37 </script>
adamstark@114 38 <script type="text/javascript" src="menudata.js"></script>
adamstark@114 39 <script type="text/javascript" src="menu.js"></script>
adamstark@114 40 <script type="text/javascript">
adamstark@114 41 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
adamstark@114 42 $(function() {
adamstark@114 43 initMenu('',true,false,'search.php','Search');
adamstark@114 44 $(document).ready(function() { init_search(); });
adamstark@114 45 });
adamstark@114 46 /* @license-end */
adamstark@114 47 </script>
adamstark@114 48 <div id="main-nav"></div>
adamstark@60 49 </div><!-- top -->
adamstark@60 50 <!-- window showing the filter options -->
adamstark@60 51 <div id="MSearchSelectWindow"
adamstark@60 52 onmouseover="return searchBox.OnSearchSelectShow()"
adamstark@60 53 onmouseout="return searchBox.OnSearchSelectHide()"
adamstark@60 54 onkeydown="return searchBox.OnSearchSelectKey(event)">
adamstark@114 55 </div>
adamstark@60 56
adamstark@60 57 <!-- iframe showing the search results (closed by default) -->
adamstark@60 58 <div id="MSearchResultsWindow">
adamstark@114 59 <div id="MSearchResults">
adamstark@114 60 <div class="SRPage">
adamstark@114 61 <div id="SRIndex">
adamstark@114 62 <div id="SRResults"></div>
adamstark@114 63 <div class="SRStatus" id="Loading">Loading...</div>
adamstark@114 64 <div class="SRStatus" id="Searching">Searching...</div>
adamstark@114 65 <div class="SRStatus" id="NoMatches">No Matches</div>
adamstark@114 66 </div>
adamstark@114 67 </div>
adamstark@114 68 </div>
adamstark@60 69 </div>
adamstark@60 70
adamstark@60 71 <div class="contents">
adamstark@60 72 <div class="textblock">Here is a list of all documented class members with links to the class documentation for each member:</div><ul>
adamstark@114 73 <li>addSampleToEnd()&#160;:&#160;<a class="el" href="class_circular_buffer.html#a8e6fa8bf39215a466876a7a2daa1ce22">CircularBuffer</a></li>
adamstark@114 74 <li>beatDueInCurrentFrame()&#160;:&#160;<a class="el" href="class_b_track.html#ac92eaea0e42dd18c79de10bf852d7f4a">BTrack</a></li>
adamstark@114 75 <li>BTrack()&#160;:&#160;<a class="el" href="class_b_track.html#a243ac408666ce0301fecd9b0a2a6f307">BTrack</a></li>
adamstark@114 76 <li>calculateOnsetDetectionFunctionSample()&#160;:&#160;<a class="el" href="class_onset_detection_function.html#a7b8fffe6221d3bd4f6cac82c17db0e92">OnsetDetectionFunction</a></li>
adamstark@114 77 <li>CircularBuffer()&#160;:&#160;<a class="el" href="class_circular_buffer.html#a8c5de0e610bb50bac684f4707e23431c">CircularBuffer</a></li>
adamstark@114 78 <li>doNotFixTempo()&#160;:&#160;<a class="el" href="class_b_track.html#a22917ea231d2efd5670a764dd5a98983">BTrack</a></li>
adamstark@114 79 <li>fixTempo()&#160;:&#160;<a class="el" href="class_b_track.html#a550829be9b4c58cd53195ec4900c7c71">BTrack</a></li>
adamstark@114 80 <li>getBeatTimeInSeconds()&#160;:&#160;<a class="el" href="class_b_track.html#aa66d0b9dfb4408e8cf84398f03b60a56">BTrack</a></li>
adamstark@114 81 <li>getCurrentTempoEstimate()&#160;:&#160;<a class="el" href="class_b_track.html#a17cea0a4dff3908660e4117e9a6c42bb">BTrack</a></li>
adamstark@114 82 <li>getHopSize()&#160;:&#160;<a class="el" href="class_b_track.html#ac06aa079977062bfa2930cdca45e69fb">BTrack</a></li>
adamstark@114 83 <li>getLatestCumulativeScoreValue()&#160;:&#160;<a class="el" href="class_b_track.html#a7ccb5059d0f00e3217ea686e4c1e156d">BTrack</a></li>
adamstark@114 84 <li>initialise()&#160;:&#160;<a class="el" href="class_onset_detection_function.html#a527d4f433d4f7bcd098b54190ee89297">OnsetDetectionFunction</a></li>
adamstark@114 85 <li>OnsetDetectionFunction()&#160;:&#160;<a class="el" href="class_onset_detection_function.html#a507e6258c5e703c989a6a58d2d8f4dcb">OnsetDetectionFunction</a></li>
adamstark@114 86 <li>operator[]()&#160;:&#160;<a class="el" href="class_circular_buffer.html#a5b0c486a7eb76bae0d1a0d6e459d0f5a">CircularBuffer</a></li>
adamstark@114 87 <li>processAudioFrame()&#160;:&#160;<a class="el" href="class_b_track.html#abb7ce7253095e6f859ef7b30f06ce051">BTrack</a></li>
adamstark@114 88 <li>processOnsetDetectionFunctionSample()&#160;:&#160;<a class="el" href="class_b_track.html#a6fab18732bef8c87152e93dec9e4f854">BTrack</a></li>
adamstark@114 89 <li>resize()&#160;:&#160;<a class="el" href="class_circular_buffer.html#a09d74c64e5e9e0ee13c84663ba9523ea">CircularBuffer</a></li>
adamstark@114 90 <li>setOnsetDetectionFunctionType()&#160;:&#160;<a class="el" href="class_onset_detection_function.html#ac607feee669f3d3f4015662eec717f6a">OnsetDetectionFunction</a></li>
adamstark@114 91 <li>setTempo()&#160;:&#160;<a class="el" href="class_b_track.html#a96cf4088e40dff66ce15ada1f671a186">BTrack</a></li>
adamstark@114 92 <li>size()&#160;:&#160;<a class="el" href="class_circular_buffer.html#ad452b3b0f7703927ce1f3befd8f7512f">CircularBuffer</a></li>
adamstark@114 93 <li>updateHopAndFrameSize()&#160;:&#160;<a class="el" href="class_b_track.html#adda9c1b3a9e3fc02accfacc9d144e33d">BTrack</a></li>
adamstark@114 94 <li>~BTrack()&#160;:&#160;<a class="el" href="class_b_track.html#a386413d90e57d0a2cf7f18413338bbaf">BTrack</a></li>
adamstark@114 95 <li>~OnsetDetectionFunction()&#160;:&#160;<a class="el" href="class_onset_detection_function.html#aa01f8125c950f3def45154878107e503">OnsetDetectionFunction</a></li>
adamstark@60 96 </ul>
adamstark@60 97 </div><!-- contents -->
adamstark@60 98 <!-- start footer part -->
adamstark@60 99 <hr class="footer"/><address class="footer"><small>
adamstark@114 100 Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7
adamstark@60 101 </small></address>
adamstark@60 102 </body>
adamstark@60 103 </html>