view doc/html/functions_func.html @ 114:d6d9df2db3e1

Update documentation
author Adam Stark <adamstark.uk@gmail.com>
date Fri, 18 Aug 2023 10:48:26 +0200
parents ae3ec9b14092
children
line wrap: on
line source
<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.7"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>BTrack - A Real-Time Beat Tracker: Class Members - Functions</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 id="projectrow">
  <td id="projectalign">
   <div id="projectname">BTrack - A Real-Time Beat Tracker
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="contents">
<div class="textblock">Here is a list of all documented functions with links to the class documentation for each member:</div><ul>
<li>addSampleToEnd()&#160;:&#160;<a class="el" href="class_circular_buffer.html#a8e6fa8bf39215a466876a7a2daa1ce22">CircularBuffer</a></li>
<li>beatDueInCurrentFrame()&#160;:&#160;<a class="el" href="class_b_track.html#ac92eaea0e42dd18c79de10bf852d7f4a">BTrack</a></li>
<li>BTrack()&#160;:&#160;<a class="el" href="class_b_track.html#a243ac408666ce0301fecd9b0a2a6f307">BTrack</a></li>
<li>calculateOnsetDetectionFunctionSample()&#160;:&#160;<a class="el" href="class_onset_detection_function.html#a7b8fffe6221d3bd4f6cac82c17db0e92">OnsetDetectionFunction</a></li>
<li>CircularBuffer()&#160;:&#160;<a class="el" href="class_circular_buffer.html#a8c5de0e610bb50bac684f4707e23431c">CircularBuffer</a></li>
<li>doNotFixTempo()&#160;:&#160;<a class="el" href="class_b_track.html#a22917ea231d2efd5670a764dd5a98983">BTrack</a></li>
<li>fixTempo()&#160;:&#160;<a class="el" href="class_b_track.html#a550829be9b4c58cd53195ec4900c7c71">BTrack</a></li>
<li>getBeatTimeInSeconds()&#160;:&#160;<a class="el" href="class_b_track.html#aa66d0b9dfb4408e8cf84398f03b60a56">BTrack</a></li>
<li>getCurrentTempoEstimate()&#160;:&#160;<a class="el" href="class_b_track.html#a17cea0a4dff3908660e4117e9a6c42bb">BTrack</a></li>
<li>getHopSize()&#160;:&#160;<a class="el" href="class_b_track.html#ac06aa079977062bfa2930cdca45e69fb">BTrack</a></li>
<li>getLatestCumulativeScoreValue()&#160;:&#160;<a class="el" href="class_b_track.html#a7ccb5059d0f00e3217ea686e4c1e156d">BTrack</a></li>
<li>initialise()&#160;:&#160;<a class="el" href="class_onset_detection_function.html#a527d4f433d4f7bcd098b54190ee89297">OnsetDetectionFunction</a></li>
<li>OnsetDetectionFunction()&#160;:&#160;<a class="el" href="class_onset_detection_function.html#a507e6258c5e703c989a6a58d2d8f4dcb">OnsetDetectionFunction</a></li>
<li>operator[]()&#160;:&#160;<a class="el" href="class_circular_buffer.html#a5b0c486a7eb76bae0d1a0d6e459d0f5a">CircularBuffer</a></li>
<li>processAudioFrame()&#160;:&#160;<a class="el" href="class_b_track.html#abb7ce7253095e6f859ef7b30f06ce051">BTrack</a></li>
<li>processOnsetDetectionFunctionSample()&#160;:&#160;<a class="el" href="class_b_track.html#a6fab18732bef8c87152e93dec9e4f854">BTrack</a></li>
<li>resize()&#160;:&#160;<a class="el" href="class_circular_buffer.html#a09d74c64e5e9e0ee13c84663ba9523ea">CircularBuffer</a></li>
<li>setOnsetDetectionFunctionType()&#160;:&#160;<a class="el" href="class_onset_detection_function.html#ac607feee669f3d3f4015662eec717f6a">OnsetDetectionFunction</a></li>
<li>setTempo()&#160;:&#160;<a class="el" href="class_b_track.html#a96cf4088e40dff66ce15ada1f671a186">BTrack</a></li>
<li>size()&#160;:&#160;<a class="el" href="class_circular_buffer.html#ad452b3b0f7703927ce1f3befd8f7512f">CircularBuffer</a></li>
<li>updateHopAndFrameSize()&#160;:&#160;<a class="el" href="class_b_track.html#adda9c1b3a9e3fc02accfacc9d144e33d">BTrack</a></li>
<li>~BTrack()&#160;:&#160;<a class="el" href="class_b_track.html#a386413d90e57d0a2cf7f18413338bbaf">BTrack</a></li>
<li>~OnsetDetectionFunction()&#160;:&#160;<a class="el" href="class_onset_detection_function.html#aa01f8125c950f3def45154878107e503">OnsetDetectionFunction</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
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
</small></address>
</body>
</html>