Mercurial > hg > btrack
diff doc/html/functions.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 diff
--- a/doc/html/functions.html Fri Aug 18 10:44:50 2023 +0200 +++ b/doc/html/functions.html Fri Aug 18 10:48:26 2023 +0200 @@ -1,17 +1,17 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml"> +<!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=9"/> +<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</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> -<script type="text/javascript"> - $(document).ready(function() { searchBox.OnSelectItem(0); }); -</script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> @@ -19,8 +19,8 @@ <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> - <tr style="height: 56px;"> - <td style="padding-left: 0.5em;"> + <tr id="projectrow"> + <td id="projectalign"> <div id="projectname">BTrack - A Real-Time Beat Tracker </div> </td> @@ -29,121 +29,75 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.8.2 --> +<!-- Generated by Doxygen 1.9.7 --> <script type="text/javascript"> -var searchBox = new SearchBox("searchBox", "search",false,'Search'); +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ +var searchBox = new SearchBox("searchBox", "search/",'.html'); +/* @license-end */ </script> - <div id="navrow1" class="tabs"> - <ul class="tablist"> - <li><a href="index.html"><span>Main Page</span></a></li> - <li class="current"><a href="annotated.html"><span>Classes</span></a></li> - <li><a href="files.html"><span>Files</span></a></li> - <li> - <div id="MSearchBox" class="MSearchBoxInactive"> - <span class="left"> - <img id="MSearchSelect" src="search/mag_sel.png" - onmouseover="return searchBox.OnSearchSelectShow()" - onmouseout="return searchBox.OnSearchSelectHide()" - alt=""/> - <input type="text" id="MSearchField" value="Search" accesskey="S" - onfocus="searchBox.OnSearchFieldFocus(true)" - onblur="searchBox.OnSearchFieldFocus(false)" - onkeyup="searchBox.OnSearchFieldChange(event)"/> - </span><span class="right"> - <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> - </span> - </div> - </li> - </ul> - </div> - <div id="navrow2" class="tabs2"> - <ul class="tablist"> - <li><a href="annotated.html"><span>Class List</span></a></li> - <li><a href="classes.html"><span>Class Index</span></a></li> - <li class="current"><a href="functions.html"><span>Class Members</span></a></li> - </ul> - </div> - <div id="navrow3" class="tabs2"> - <ul class="tablist"> - <li class="current"><a href="functions.html"><span>All</span></a></li> - <li><a href="functions_func.html"><span>Functions</span></a></li> - </ul> - </div> +<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&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)"> -<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><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Pages</a></div> +</div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> -<iframe src="javascript:void(0)" frameborder="0" - name="MSearchResults" id="MSearchResults"> -</iframe> +<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 class members with links to the class documentation for each member:</div><ul> -<li>beatDueInCurrentFrame() -: <a class="el" href="class_b_track.html#ac92eaea0e42dd18c79de10bf852d7f4a">BTrack</a> -</li> -<li>BTrack() -: <a class="el" href="class_b_track.html#afce9e207a2f6ff71d96125dee16797de">BTrack</a> -</li> -<li>calculateOnsetDetectionFunctionSample() -: <a class="el" href="class_onset_detection_function.html#a7b8fffe6221d3bd4f6cac82c17db0e92">OnsetDetectionFunction</a> -</li> -<li>doNotFixTempo() -: <a class="el" href="class_b_track.html#a22917ea231d2efd5670a764dd5a98983">BTrack</a> -</li> -<li>fixTempo() -: <a class="el" href="class_b_track.html#a550829be9b4c58cd53195ec4900c7c71">BTrack</a> -</li> -<li>getBeatTimeInSeconds() -: <a class="el" href="class_b_track.html#aa66d0b9dfb4408e8cf84398f03b60a56">BTrack</a> -</li> -<li>getCurrentTempoEstimate() -: <a class="el" href="class_b_track.html#a17cea0a4dff3908660e4117e9a6c42bb">BTrack</a> -</li> -<li>getHopSize() -: <a class="el" href="class_b_track.html#ac06aa079977062bfa2930cdca45e69fb">BTrack</a> -</li> -<li>getLatestCumulativeScoreValue() -: <a class="el" href="class_b_track.html#a7ccb5059d0f00e3217ea686e4c1e156d">BTrack</a> -</li> -<li>initialise() -: <a class="el" href="class_onset_detection_function.html#ab3379d150c375e4a7e525f326ce5a2e6">OnsetDetectionFunction</a> -</li> -<li>OnsetDetectionFunction() -: <a class="el" href="class_onset_detection_function.html#a1af5db39698d413cbb892b3a6de7aee5">OnsetDetectionFunction</a> -</li> -<li>processAudioFrame() -: <a class="el" href="class_b_track.html#abb7ce7253095e6f859ef7b30f06ce051">BTrack</a> -</li> -<li>processOnsetDetectionFunctionSample() -: <a class="el" href="class_b_track.html#a6fab18732bef8c87152e93dec9e4f854">BTrack</a> -</li> -<li>setOnsetDetectionFunctionType() -: <a class="el" href="class_onset_detection_function.html#a51fdab443155aaaa935956645e8f9131">OnsetDetectionFunction</a> -</li> -<li>setTempo() -: <a class="el" href="class_b_track.html#a96cf4088e40dff66ce15ada1f671a186">BTrack</a> -</li> -<li>updateHopAndFrameSize() -: <a class="el" href="class_b_track.html#a70244e9a5aa8f860533fa56f942b7ede">BTrack</a> -</li> -<li>~OnsetDetectionFunction() -: <a class="el" href="class_onset_detection_function.html#aa01f8125c950f3def45154878107e503">OnsetDetectionFunction</a> -</li> +<li>addSampleToEnd() : <a class="el" href="class_circular_buffer.html#a8e6fa8bf39215a466876a7a2daa1ce22">CircularBuffer</a></li> +<li>beatDueInCurrentFrame() : <a class="el" href="class_b_track.html#ac92eaea0e42dd18c79de10bf852d7f4a">BTrack</a></li> +<li>BTrack() : <a class="el" href="class_b_track.html#a243ac408666ce0301fecd9b0a2a6f307">BTrack</a></li> +<li>calculateOnsetDetectionFunctionSample() : <a class="el" href="class_onset_detection_function.html#a7b8fffe6221d3bd4f6cac82c17db0e92">OnsetDetectionFunction</a></li> +<li>CircularBuffer() : <a class="el" href="class_circular_buffer.html#a8c5de0e610bb50bac684f4707e23431c">CircularBuffer</a></li> +<li>doNotFixTempo() : <a class="el" href="class_b_track.html#a22917ea231d2efd5670a764dd5a98983">BTrack</a></li> +<li>fixTempo() : <a class="el" href="class_b_track.html#a550829be9b4c58cd53195ec4900c7c71">BTrack</a></li> +<li>getBeatTimeInSeconds() : <a class="el" href="class_b_track.html#aa66d0b9dfb4408e8cf84398f03b60a56">BTrack</a></li> +<li>getCurrentTempoEstimate() : <a class="el" href="class_b_track.html#a17cea0a4dff3908660e4117e9a6c42bb">BTrack</a></li> +<li>getHopSize() : <a class="el" href="class_b_track.html#ac06aa079977062bfa2930cdca45e69fb">BTrack</a></li> +<li>getLatestCumulativeScoreValue() : <a class="el" href="class_b_track.html#a7ccb5059d0f00e3217ea686e4c1e156d">BTrack</a></li> +<li>initialise() : <a class="el" href="class_onset_detection_function.html#a527d4f433d4f7bcd098b54190ee89297">OnsetDetectionFunction</a></li> +<li>OnsetDetectionFunction() : <a class="el" href="class_onset_detection_function.html#a507e6258c5e703c989a6a58d2d8f4dcb">OnsetDetectionFunction</a></li> +<li>operator[]() : <a class="el" href="class_circular_buffer.html#a5b0c486a7eb76bae0d1a0d6e459d0f5a">CircularBuffer</a></li> +<li>processAudioFrame() : <a class="el" href="class_b_track.html#abb7ce7253095e6f859ef7b30f06ce051">BTrack</a></li> +<li>processOnsetDetectionFunctionSample() : <a class="el" href="class_b_track.html#a6fab18732bef8c87152e93dec9e4f854">BTrack</a></li> +<li>resize() : <a class="el" href="class_circular_buffer.html#a09d74c64e5e9e0ee13c84663ba9523ea">CircularBuffer</a></li> +<li>setOnsetDetectionFunctionType() : <a class="el" href="class_onset_detection_function.html#ac607feee669f3d3f4015662eec717f6a">OnsetDetectionFunction</a></li> +<li>setTempo() : <a class="el" href="class_b_track.html#a96cf4088e40dff66ce15ada1f671a186">BTrack</a></li> +<li>size() : <a class="el" href="class_circular_buffer.html#ad452b3b0f7703927ce1f3befd8f7512f">CircularBuffer</a></li> +<li>updateHopAndFrameSize() : <a class="el" href="class_b_track.html#adda9c1b3a9e3fc02accfacc9d144e33d">BTrack</a></li> +<li>~BTrack() : <a class="el" href="class_b_track.html#a386413d90e57d0a2cf7f18413338bbaf">BTrack</a></li> +<li>~OnsetDetectionFunction() : <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 on Tue Jan 28 2014 01:06:53 for BTrack - A Real-Time Beat Tracker by  <a href="http://www.doxygen.org/index.html"> -<img class="footer" src="doxygen.png" alt="doxygen"/> -</a> 1.8.2 +Generated by <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>