/usr/share/doc/libjuce/apiref/classAudioPlayHead.html is in libjuce-doc 4.3.0~repack-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 | <!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: AudioPlayHead Class Reference</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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">JUCE
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="classAudioPlayHead-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">AudioPlayHead Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>A subclass of <a class="el" href="classAudioPlayHead.html" title="A subclass of AudioPlayHead can supply information about the position and status of a moving play hea...">AudioPlayHead</a> can supply information about the position and status of a moving play head during audio playback.
<a href="classAudioPlayHead.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structAudioPlayHead_1_1CurrentPositionInfo.html">CurrentPositionInfo</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This structure is filled-in by the <a class="el" href="classAudioPlayHead.html#ae8ff79b6ec79fbecb1e8276ad9867cd2" title="Fills-in the given structure with details about the transport's position at the start of the current ...">AudioPlayHead::getCurrentPosition()</a> method. <a href="structAudioPlayHead_1_1CurrentPositionInfo.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a9afad1749c8002945b2a6921eef92b25"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioPlayHead.html#a9afad1749c8002945b2a6921eef92b25">FrameRateType</a> { <br />
  <a class="el" href="classAudioPlayHead.html#a9afad1749c8002945b2a6921eef92b25a0a9a4305317d85cf1975f6be3569e9df">fps24</a> = 0,
<a class="el" href="classAudioPlayHead.html#a9afad1749c8002945b2a6921eef92b25a8deb0cfa8182f6be90cb4d91b4b68456">fps25</a> = 1,
<a class="el" href="classAudioPlayHead.html#a9afad1749c8002945b2a6921eef92b25a7c5eadafb62a8be03ab5690d34fb7460">fps2997</a> = 2,
<a class="el" href="classAudioPlayHead.html#a9afad1749c8002945b2a6921eef92b25a77c3bd70c42f416f663c83036bff401d">fps30</a> = 3,
<br />
  <a class="el" href="classAudioPlayHead.html#a9afad1749c8002945b2a6921eef92b25ac03944a2bba5e61cabcca112edfd1efd">fps2997drop</a> = 4,
<a class="el" href="classAudioPlayHead.html#a9afad1749c8002945b2a6921eef92b25a2263e006dec6f9cf53adbbcecdc9e287">fps30drop</a> = 5,
<a class="el" href="classAudioPlayHead.html#a9afad1749c8002945b2a6921eef92b25a7e58343767d199b598a16ea25c09b062">fpsUnknown</a> = 99
<br />
}<tr class="memdesc:a9afad1749c8002945b2a6921eef92b25"><td class="mdescLeft"> </td><td class="mdescRight">Frame rate types. <a href="classAudioPlayHead.html#a9afad1749c8002945b2a6921eef92b25">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a9afad1749c8002945b2a6921eef92b25"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a9c32cae9ee0bb7442a2c465a73aca6bd"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioPlayHead.html#a9c32cae9ee0bb7442a2c465a73aca6bd">~AudioPlayHead</a> ()</td></tr>
<tr class="separator:a9c32cae9ee0bb7442a2c465a73aca6bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae8ff79b6ec79fbecb1e8276ad9867cd2"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioPlayHead.html#ae8ff79b6ec79fbecb1e8276ad9867cd2">getCurrentPosition</a> (<a class="el" href="structAudioPlayHead_1_1CurrentPositionInfo.html">CurrentPositionInfo</a> &result)=0</td></tr>
<tr class="memdesc:ae8ff79b6ec79fbecb1e8276ad9867cd2"><td class="mdescLeft"> </td><td class="mdescRight">Fills-in the given structure with details about the transport's position at the start of the current processing block. <a href="#ae8ff79b6ec79fbecb1e8276ad9867cd2">More...</a><br /></td></tr>
<tr class="separator:ae8ff79b6ec79fbecb1e8276ad9867cd2"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a9e78c0595510555a3d816a54bffeb610"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioPlayHead.html#a9e78c0595510555a3d816a54bffeb610">AudioPlayHead</a> ()</td></tr>
<tr class="separator:a9e78c0595510555a3d816a54bffeb610"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A subclass of <a class="el" href="classAudioPlayHead.html" title="A subclass of AudioPlayHead can supply information about the position and status of a moving play hea...">AudioPlayHead</a> can supply information about the position and status of a moving play head during audio playback. </p>
<p>One of these can be supplied to an <a class="el" href="classAudioProcessor.html" title="Base class for audio processing filters or plugins. ">AudioProcessor</a> object so that it can find out about the position of the audio that it is rendering.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classAudioProcessor.html#a9015f8476c07b173e3c9919b3036339d" title="Tells the processor to use this playhead object. ">AudioProcessor::setPlayHead</a>, <a class="el" href="classAudioProcessor.html#a3000c867da8b04866a4f91c8103956ac" title="Returns the current AudioPlayHead object that should be used to find out the state and position of th...">AudioProcessor::getPlayHead</a> </dd></dl>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a9afad1749c8002945b2a6921eef92b25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9afad1749c8002945b2a6921eef92b25">§ </a></span>FrameRateType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classAudioPlayHead.html#a9afad1749c8002945b2a6921eef92b25">AudioPlayHead::FrameRateType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Frame rate types. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a9afad1749c8002945b2a6921eef92b25a0a9a4305317d85cf1975f6be3569e9df"></a>fps24 </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a9afad1749c8002945b2a6921eef92b25a8deb0cfa8182f6be90cb4d91b4b68456"></a>fps25 </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a9afad1749c8002945b2a6921eef92b25a7c5eadafb62a8be03ab5690d34fb7460"></a>fps2997 </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a9afad1749c8002945b2a6921eef92b25a77c3bd70c42f416f663c83036bff401d"></a>fps30 </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a9afad1749c8002945b2a6921eef92b25ac03944a2bba5e61cabcca112edfd1efd"></a>fps2997drop </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a9afad1749c8002945b2a6921eef92b25a2263e006dec6f9cf53adbbcecdc9e287"></a>fps30drop </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a9afad1749c8002945b2a6921eef92b25a7e58343767d199b598a16ea25c09b062"></a>fpsUnknown </td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a9e78c0595510555a3d816a54bffeb610"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e78c0595510555a3d816a54bffeb610">§ </a></span>AudioPlayHead()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">AudioPlayHead::AudioPlayHead </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a9c32cae9ee0bb7442a2c465a73aca6bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c32cae9ee0bb7442a2c465a73aca6bd">§ </a></span>~AudioPlayHead()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual AudioPlayHead::~AudioPlayHead </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ae8ff79b6ec79fbecb1e8276ad9867cd2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8ff79b6ec79fbecb1e8276ad9867cd2">§ </a></span>getCurrentPosition()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool AudioPlayHead::getCurrentPosition </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structAudioPlayHead_1_1CurrentPositionInfo.html">CurrentPositionInfo</a> & </td>
<td class="paramname"><em>result</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Fills-in the given structure with details about the transport's position at the start of the current processing block. </p>
<p>If this method returns false then the current play head position is not available and the given structure will be undefined.</p>
<p>You can ONLY call this from your processBlock() method! Calling it at other times will produce undefined behaviour, as the host may not have any context in which a time would make sense, and some hosts will almost certainly have multithreading issues if it's not called on the audio thread. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__AudioPlayHead_8h.html">juce_AudioPlayHead.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|