DISTRHO
/
DISTRHO-Ports-Extra
mirror of https://github.com/DISTRHO/DISTRHO-Ports-Extra
1
0
Fork 0
Code Releases 0 Activity
Extra "ports" of juce-based plugins using the distrho build system
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
10 Commits
1 Branch
28MB
Tree: aed02c1b70
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'aed02c1b70'
${ noResults }
DISTRHO-Ports-Extra/ports/protoplug/ProtoplugFiles/doc/modules/plugin.html

793 lines
22KB
Raw Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"

  2.    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

  3. <html>

  4. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>

  5. <head>

  6.     <title>protoplug: Module plugin</title>

  7.     <link rel="stylesheet" href="../ldoc.css" type="text/css" />

  8. </head>

  9. <body>

  10. 

  11. <div id="container">

  12. 

  13. <div id="product">

  14. 	<div id="product_logo"></div>

  15. 	<div id="product_name"><big><b></b></big></div>

  16. 	<div id="product_description"></div>

  17. </div> <!-- id="product" -->

  18. 

  19. 

  20. <div id="main">

  21. 

  22. 

  23. <!-- Menu -->

  24. 

  25. <div id="navigation">

  26. <a href="http://osar.fr">

  27. <div class=osarlogo> </div>

  28. </a>

  29. <br/>

  30. <a href="http://osar.fr/protoplug">

  31. <h1>protoplug</h1>

  32. </a>

  33. 	<span class="proto_subtitle">Lua API reference</span>

  34. 

  35. <ul>

  36.   <li><a href="../index.html">Index</a></li>

  37. </ul>

  38. 

  39. <h2>Contents</h2>

  40. <ul>

  41. <li><a href="#Callback_functions">Callback functions </a></li>

  42. <li><a href="#Override_functions">Override functions </a></li>

  43. <li><a href="#Class_plugin_PositionInfo">Class plugin.PositionInfo </a></li>

  44. </ul>

  45. 

  46. 

  47. <h2>Modules</h2>

  48. <ul class="$(kind=='Topics' and '' or 'nowrap'">

  49.   <li><strong>plugin</strong></li>

  50.   <li><a href="../modules/script.html">script</a></li>

  51.   <li><a href="../modules/midi.html">midi</a></li>

  52.   <li><a href="../modules/gui.html">gui</a></li>

  53.   <li><a href="../modules/polyGen.html">polyGen</a></li>

  54.   <li><a href="../modules/stereoFx.html">stereoFx</a></li>

  55. </ul>

  56. <h2>Classes</h2>

  57. <ul class="$(kind=='Topics' and '' or 'nowrap'">

  58.   <li><a href="../classes/juce.AffineTransform.html">juce.AffineTransform</a></li>

  59.   <li><a href="../classes/juce.AudioFormatReader.html">juce.AudioFormatReader</a></li>

  60.   <li><a href="../classes/juce.Colour.html">juce.Colour</a></li>

  61.   <li><a href="../classes/juce.ColourGradient.html">juce.ColourGradient</a></li>

  62.   <li><a href="../classes/juce.Component.html">juce.Component</a></li>

  63.   <li><a href="../classes/juce.FillType.html">juce.FillType</a></li>

  64.   <li><a href="../classes/juce.Font.html">juce.Font</a></li>

  65.   <li><a href="../classes/juce.Graphics.html">juce.Graphics</a></li>

  66.   <li><a href="../classes/juce.Image.html">juce.Image</a></li>

  67.   <li><a href="../classes/juce.Justification.html">juce.Justification</a></li>

  68.   <li><a href="../classes/juce.LagrangeInterpolator.html">juce.LagrangeInterpolator</a></li>

  69.   <li><a href="../classes/juce.Line.html">juce.Line</a></li>

  70.   <li><a href="../classes/juce.Path.html">juce.Path</a></li>

  71.   <li><a href="../classes/juce.Point.html">juce.Point</a></li>

  72.   <li><a href="../classes/juce.RectanglePlacement.html">juce.RectanglePlacement</a></li>

  73.   <li><a href="../classes/juce.Rectangle_float.html">juce.Rectangle_float</a></li>

  74.   <li><a href="../classes/juce.Rectangle_int.html">juce.Rectangle_int</a></li>

  75. </ul>

  76. <h2>Examples</h2>

  77. <ul class="$(kind=='Topics' and '' or 'nowrap'">

  78.   <li><a href="../examples/classic-filter.lua.html">classic-filter.lua</a></li>

  79.   <li><a href="../examples/sine-organ.lua.html">sine-organ.lua</a></li>

  80.   <li><a href="../examples/midi-chordify.lua.html">midi-chordify.lua</a></li>

  81.   <li><a href="../examples/sinemouse-demo.lua.html">sinemouse-demo.lua</a></li>

  82.   <li><a href="../examples/soundfile-test.lua.html">soundfile-test.lua</a></li>

  83. </ul>

  84. 

  85. </div>

  86. 

  87. <div id="content">

  88. 

  89. <h1>Module <code>plugin</code></h1>

  90. <p>Use <a href="../modules/plugin.html#">plugin</a>  to define the AU/VST audio plugin's behaviour.</p>

  91. <p>

  92. 

  93. <p> The <a href="../modules/plugin.html#">plugin</a>  global is available to every protoplug script after including the

  94.  main protoplug header :</p>

  95. <pre><code>require "include/protoplug"

  96. </code></pre>

  97. </p>

  98. 

  99. 

  100. <h2><a href="#Callback_functions">Callback functions </a></h2>

  101. <table class="function_list">

  102. 	<tr>

  103. 	<td class="name" nowrap><a href="#manageParams"><span class="proto_prefix">plugin</span>.manageParams (paramList)</a></td>

  104. 	<td class="summary">Automatically set up a list of parameters.</td>

  105. 	</tr>

  106. 	<tr>

  107. 	<td class="name" nowrap><a href="#setParameter"><span class="proto_prefix">plugin</span>.setParameter (index, value)</a></td>

  108. 	<td class="summary">Set (automate) a parameter's value.</td>

  109. 	</tr>

  110. 	<tr>

  111. 	<td class="name" nowrap><a href="#getParameter"><span class="proto_prefix">plugin</span>.getParameter (index)</a></td>

  112. 	<td class="summary">Get a parameter's value.</td>

  113. 	</tr>

  114. 	<tr>

  115. 	<td class="name" nowrap><a href="#getCurrentPosition"><span class="proto_prefix">plugin</span>.getCurrentPosition ()</a></td>

  116. 	<td class="summary">Get host position info, if available.</td>

  117. 	</tr>

  118. 	<tr>

  119. 	<td class="name" nowrap><a href="#getSampleRate"><span class="proto_prefix">plugin</span>.getSampleRate ()</a></td>

  120. 	<td class="summary">Get host samplerate.</td>

  121. 	</tr>

  122. 	<tr>

  123. 	<td class="name" nowrap><a href="#isSampleRateKnown"><span class="proto_prefix">plugin</span>.isSampleRateKnown ()</a></td>

  124. 	<td class="summary">Check if the samplerate is known.</td>

  125. 	</tr>

  126. 	<tr>

  127. 	<td class="name" nowrap><a href="#addHandler"><span class="proto_prefix">plugin</span>.addHandler (event, handler)</a></td>

  128. 	<td class="summary">Add a handler for a VST/AU event.</td>

  129. 	</tr>

  130. </table>

  131. <h2><a href="#Override_functions">Override functions </a></h2>

  132. <table class="function_list">

  133. 	<tr>

  134. 	<td class="name" nowrap><a href="#processBlock"><span class="proto_prefix">plugin</span>.processBlock (samples, smax, midiBuf)</a></td>

  135. 	<td class="summary">Process Audio Block.</td>

  136. 	</tr>

  137. 	<tr>

  138. 	<td class="name" nowrap><a href="#getParameterName"><span class="proto_prefix">plugin</span>.getParameterName (index)</a></td>

  139. 	<td class="summary">Return the name of a parameter.</td>

  140. 	</tr>

  141. 	<tr>

  142. 	<td class="name" nowrap><a href="#getParameterText"><span class="proto_prefix">plugin</span>.getParameterText (index)</a></td>

  143. 	<td class="summary">Return the representation of a parameter's value.</td>

  144. 	</tr>

  145. 	<tr>

  146. 	<td class="name" nowrap><a href="#paramChanged"><span class="proto_prefix">plugin</span>.paramChanged (index)</a></td>

  147. 	<td class="summary">Handle parameter changes.</td>

  148. 	</tr>

  149. 	<tr>

  150. 	<td class="name" nowrap><a href="#getTailLengthSeconds"><span class="proto_prefix">plugin</span>.getTailLengthSeconds ()</a></td>

  151. 	<td class="summary">Return the tail length in seconds (effects only).</td>

  152. 	</tr>

  153. </table>

  154. <h2><a href="#Class_plugin_PositionInfo">Class plugin.PositionInfo </a></h2>

  155. <table class="function_list">

  156. 	<tr>

  157. 	<td class="name" nowrap><a href="#PositionInfo.bpm"><span class="proto_prefix">plugin.PositionInfo</span>.bpm</a></td>

  158. 	<td class="summary">Host tempo (beats per minute)</td>

  159. 	</tr>

  160. 	<tr>

  161. 	<td class="name" nowrap><a href="#PositionInfo.timeSigNumerator"><span class="proto_prefix">plugin.PositionInfo</span>.timeSigNumerator</a></td>

  162. 	<td class="summary">Time signature numerator ie.</td>

  163. 	</tr>

  164. 	<tr>

  165. 	<td class="name" nowrap><a href="#PositionInfo.timeSigDenominator"><span class="proto_prefix">plugin.PositionInfo</span>.timeSigDenominator</a></td>

  166. 	<td class="summary">Time signature denominator ie.</td>

  167. 	</tr>

  168. 	<tr>

  169. 	<td class="name" nowrap><a href="#PositionInfo.timeInSamples"><span class="proto_prefix">plugin.PositionInfo</span>.timeInSamples</a></td>

  170. 	<td class="summary">Current position on the host's timeline (samples)</td>

  171. 	</tr>

  172. 	<tr>

  173. 	<td class="name" nowrap><a href="#PositionInfo.timeInSeconds"><span class="proto_prefix">plugin.PositionInfo</span>.timeInSeconds</a></td>

  174. 	<td class="summary">Current position on the host's timeline (seconds)</td>

  175. 	</tr>

  176. 	<tr>

  177. 	<td class="name" nowrap><a href="#PositionInfo.editOriginTime"><span class="proto_prefix">plugin.PositionInfo</span>.editOriginTime</a></td>

  178. 	<td class="summary">Position of the start of the edit region on the host's timeline</td>

  179. 	</tr>

  180. 	<tr>

  181. 	<td class="name" nowrap><a href="#PositionInfo.ppqPosition"><span class="proto_prefix">plugin.PositionInfo</span>.ppqPosition</a></td>

  182. 	<td class="summary">Current position on the host's timeline (pulses-per-quarter-note)</td>

  183. 	</tr>

  184. 	<tr>

  185. 	<td class="name" nowrap><a href="#PositionInfo.ppqPositionOfLastBarStart"><span class="proto_prefix">plugin.PositionInfo</span>.ppqPositionOfLastBarStart</a></td>

  186. 	<td class="summary">Position of the last bar start (pulses-per-quarter-note).</td>

  187. 	</tr>

  188. 	<tr>

  189. 	<td class="name" nowrap><a href="#PositionInfo.frameRate"><span class="proto_prefix">plugin.PositionInfo</span>.frameRate</a></td>

  190. 	<td class="summary">Video frame rate</td>

  191. 	</tr>

  192. 	<tr>

  193. 	<td class="name" nowrap><a href="#PositionInfo.isPlaying"><span class="proto_prefix">plugin.PositionInfo</span>.isPlaying</a></td>

  194. 	<td class="summary">Is playing</td>

  195. 	</tr>

  196. 	<tr>

  197. 	<td class="name" nowrap><a href="#PositionInfo.isRecording"><span class="proto_prefix">plugin.PositionInfo</span>.isRecording</a></td>

  198. 	<td class="summary">Is recording</td>

  199. 	</tr>

  200. 	<tr>

  201. 	<td class="name" nowrap><a href="#PositionInfo.ppqLoopStart"><span class="proto_prefix">plugin.PositionInfo</span>.ppqLoopStart</a></td>

  202. 	<td class="summary">Position of the loop start (pulses-per-quarter-note).</td>

  203. 	</tr>

  204. 	<tr>

  205. 	<td class="name" nowrap><a href="#PositionInfo.ppqLoopEnd"><span class="proto_prefix">plugin.PositionInfo</span>.ppqLoopEnd</a></td>

  206. 	<td class="summary">Position of the loop end (pulses-per-quarter-note).</td>

  207. 	</tr>

  208. 	<tr>

  209. 	<td class="name" nowrap><a href="#PositionInfo.isLooping"><span class="proto_prefix">plugin.PositionInfo</span>.isLooping</a></td>

  210. 	<td class="summary">Is looping</td>

  211. 	</tr>

  212. </table>

  213. 

  214. <br/>

  215. <br/>

  216. 

  217. 

  218.     <h2><a name="Callback_functions"></a>Callback functions </h2>

  219. 

  220.  Functions that your script can call.

  221.  <br><br>

  222.     <dl class="function">

  223.     <dt>

  224.     <a name = "manageParams"></a>

  225.     <strong><span class="proto_prefix">plugin</span>.manageParams (paramList)</strong>

  226.     </dt>

  227.     <dd>

  228.     Automatically set up a list of parameters.

  229.  Call this function with a table containing parameter definitions as argument, and

  230.  it will perform the repetitive task of defining all the parameter-related overrides.</p>

  231. 

  232. <p> The format of the parameter list is demonstrated in <a href="../examples/classic-filter.lua.html#">classic-filter.lua</a>

  233. 

  234.     </ul>

  235. 

  236.     <h3>Parameters:</h3>

  237.     <ul>

  238.         <li><span class="parameter">paramList</span>

  239.          a table with parameter definitions (see example)

  240.         </li>

  241.     </ul>

  242. 

  243. 

  244. 

  245. 

  246. 

  247. </dd>

  248.     <dt>

  249.     <a name = "setParameter"></a>

  250.     <strong><span class="proto_prefix">plugin</span>.setParameter (index, value)</strong>

  251.     </dt>

  252.     <dd>

  253.     Set (automate) a parameter's value.

  254.  The value must be normalized to be between 0 and 1.

  255. 

  256.     </ul>

  257. 

  258.     <h3>Parameters:</h3>

  259.     <ul>

  260.         <li><span class="parameter">index</span>

  261.          parameter index (0-126)

  262.         </li>

  263.         <li><span class="parameter">value</span>

  264.          parameter value (0-1)

  265.         </li>

  266.     </ul>

  267. 

  268. 

  269. 

  270. 

  271. 

  272. </dd>

  273.     <dt>

  274.     <a name = "getParameter"></a>

  275.     <strong><span class="proto_prefix">plugin</span>.getParameter (index)</strong>

  276.     </dt>

  277.     <dd>

  278.     Get a parameter's value.

  279.  The values are between 0 and 1, but different minimums and maximums can

  280.  be easily simulated using <a href="../modules/plugin.html#manageParams">plugin.manageParams</a>.

  281. 

  282.     </ul>

  283. 

  284.     <h3>Parameters:</h3>

  285.     <ul>

  286.         <li><span class="parameter">index</span>

  287.          parameter index (0-126)

  288.         </li>

  289.     </ul>

  290. 

  291. 

  292. 

  293. 

  294. 

  295. </dd>

  296.     <dt>

  297.     <a name = "getCurrentPosition"></a>

  298.     <strong><span class="proto_prefix">plugin</span>.getCurrentPosition ()</strong>

  299.     </dt>

  300.     <dd>

  301.     Get host position info, if available.

  302.  Only call this from within <a href="../modules/plugin.html#processBlock">processBlock</a>.

  303. 

  304.     </ul>

  305. 

  306. 

  307.     <h3>Returns:</h3>

  308.     <ol>

  309. 

  310.            <span class="types"><a class="type" href="../modules/plugin.html#plugin.PositionInfo">plugin.PositionInfo</a></span>

  311.         current position info, or <code>nil</code> depending on the host.

  312.     </ol>

  313. 

  314. 

  315. 

  316. 

  317. </dd>

  318.     <dt>

  319.     <a name = "getSampleRate"></a>

  320.     <strong><span class="proto_prefix">plugin</span>.getSampleRate ()</strong>

  321.     </dt>

  322.     <dd>

  323.     Get host samplerate.

  324.  The value is unknown until the plugin <code>prepareToPlay</code> event has been emitted.

  325.  The value is always known in <a href="../modules/plugin.html#processBlock">processBlock</a>. An error is caused if an

  326.  attempt is made to access the sample rate prematurely.

  327. 

  328.     </ul>

  329. 

  330. 

  331.     <h3>Returns:</h3>

  332.     <ol>

  333. 

  334.         current samplerate.

  335.     </ol>

  336. 

  337. 

  338.     <h3>See also:</h3>

  339.     <ul>

  340.          <a href="../modules/plugin.html#addHandler">plugin.addHandler</a>

  341.     </ul>

  342. 

  343. 

  344. </dd>

  345.     <dt>

  346.     <a name = "isSampleRateKnown"></a>

  347.     <strong><span class="proto_prefix">plugin</span>.isSampleRateKnown ()</strong>

  348.     </dt>

  349.     <dd>

  350.     Check if the samplerate is known.

  351. 

  352.     </ul>

  353. 

  354. 

  355.     <h3>Returns:</h3>

  356.     <ol>

  357. 

  358.            <span class="types"><span class="type">boolean</span></span>

  359. 

  360. 

  361. 

  362.     </ol>

  363. 

  364. 

  365. 

  366. 

  367. </dd>

  368.     <dt>

  369.     <a name = "addHandler"></a>

  370.     <strong><span class="proto_prefix">plugin</span>.addHandler (event, handler)</strong>

  371.     </dt>

  372.     <dd>

  373. 

  374. <p>Add a handler for a VST/AU event.

  375.  The following events are available :</p>

  376. 

  377. <ul>

  378.     <li><code>"prepareToPlay"</code> - Emitted before the first call to <a href="../modules/plugin.html#processBlock">processBlock</a>, when the samplerate is known.</li>

  379. </ul>

  380. 

  381. 

  382.     </ul>

  383. 

  384.     <h3>Parameters:</h3>

  385.     <ul>

  386.         <li><span class="parameter">event</span>

  387.             <span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>

  388.          the event to handle

  389.         </li>

  390.         <li><span class="parameter">handler</span>

  391.             <span class="types"><span class="type">function</span></span>

  392.          a function to add the event's handlers

  393.         </li>

  394.     </ul>

  395. 

  396. 

  397. 

  398.     <h3>See also:</h3>

  399.     <ul>

  400.          <li><a href="../modules/script.html#addHandler">script.addHandler</a></li>

  401.          <li><a href="../modules/gui.html#addHandler">gui.addHandler</a></li>

  402.     </ul>

  403. 

  404. 

  405. </dd>

  406. </dl>

  407.     <h2><a name="Override_functions"></a>Override functions </h2>

  408. 

  409.  Define these functions and the host will call them.

  410.  <br><br>

  411.     <dl class="function">

  412.     <dt>

  413.     <a name = "processBlock"></a>

  414.     <strong><span class="proto_prefix">plugin</span>.processBlock (samples, smax, midiBuf)</strong>

  415.     </dt>

  416.     <dd>

  417.     Process Audio Block.

  418.  Override this function to input and output audio and MIDI data.</p>

  419. 

  420. <p> This override is handled automatically if <a href="../modules/stereoFx.html#">stereoFx</a> or <a href="../modules/polyGen.html#">polyGen</a> are used.

  421.  Use this function to handle the raw data instead.

  422. 

  423.     </ul>

  424. 

  425.     <h3>Parameters:</h3>

  426.     <ul>

  427.         <li><span class="parameter">samples</span>

  428.          a C float** pointing to two channels of samples, serving as input and output

  429.         </li>

  430.         <li><span class="parameter">smax</span>

  431.          the maximum sample index (nSamples - 1)

  432.         </li>

  433.         <li><span class="parameter">midiBuf</span>

  434.             <span class="types"><a class="type" href="../modules/midi.html#midi.Buffer">midi.Buffer</a></span>

  435.          the MIDI data for this block, serving as input and output

  436.         </li>

  437.     </ul>

  438. 

  439. 

  440. 

  441. 

  442.     <h3>Usage:</h3>

  443.     <ul>

  444.         <pre class="example"> <span class="keyword">function</span> plugin.processBlock (samples, smax) <span class="comment">-- let's ignore midi for this example

  445. </span>     <span class="keyword">for</span> i = <span class="number">0</span>, smax <span class="keyword">do</span>

  446.          samples[<span class="number">0</span>][i] = sin(myTime) <span class="comment">-- left channel

  447. </span>         samples[<span class="number">1</span>][i] = sin(myTime) <span class="comment">-- right channel

  448. </span>         myTime = myTime + myDelta

  449.      <span class="keyword">end</span>

  450.  <span class="keyword">end</span></pre>

  451.     </ul>

  452. 

  453. </dd>

  454.     <dt>

  455.     <a name = "getParameterName"></a>

  456.     <strong><span class="proto_prefix">plugin</span>.getParameterName (index)</strong>

  457.     </dt>

  458.     <dd>

  459.     Return the name of a parameter. </p>

  460. 

  461. <p> This override is handled automatically if <a href="../modules/plugin.html#manageParams">manageParams</a> is used.

  462. 

  463.     </ul>

  464. 

  465.     <h3>Parameters:</h3>

  466.     <ul>

  467.         <li><span class="parameter">index</span>

  468.          parameter index (0-126)

  469.         </li>

  470.     </ul>

  471. 

  472.     <h3>Returns:</h3>

  473.     <ol>

  474. 

  475.            <span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>

  476.         the parameter's name

  477.     </ol>

  478. 

  479. 

  480. 

  481. 

  482. </dd>

  483.     <dt>

  484.     <a name = "getParameterText"></a>

  485.     <strong><span class="proto_prefix">plugin</span>.getParameterText (index)</strong>

  486.     </dt>

  487.     <dd>

  488.     Return the representation of a parameter's value.

  489.  Override this function to choose how each parameter's value should

  490.  be displayed by the host. The parameter's current value can be obtained

  491.  using <a href="../modules/plugin.html#getParameter">plugin.getParameter</a></p>

  492. 

  493. <p> This override is handled automatically if <a href="../modules/plugin.html#manageParams">manageParams</a> is used.

  494. 

  495.     </ul>

  496. 

  497.     <h3>Parameters:</h3>

  498.     <ul>

  499.         <li><span class="parameter">index</span>

  500.          parameter index (0-126)

  501.         </li>

  502.     </ul>

  503. 

  504.     <h3>Returns:</h3>

  505.     <ol>

  506. 

  507.            <span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>

  508.         a string representation of the parameter's current value

  509.     </ol>

  510. 

  511. 

  512. 

  513. 

  514. </dd>

  515.     <dt>

  516.     <a name = "paramChanged"></a>

  517.     <strong><span class="proto_prefix">plugin</span>.paramChanged (index)</strong>

  518.     </dt>

  519.     <dd>

  520.     Handle parameter changes.

  521.  Override this function to do something when a parameter changes

  522.  The parameter's current value can be obtained using <a href="../modules/plugin.html#getParameter">plugin.getParameter</a></p>

  523. 

  524. <p> This override is handled automatically if <a href="../modules/plugin.html#manageParams">manageParams</a> is used.

  525. 

  526.     </ul>

  527. 

  528.     <h3>Parameters:</h3>

  529.     <ul>

  530.         <li><span class="parameter">index</span>

  531.          parameter index (0-126)

  532.         </li>

  533.     </ul>

  534. 

  535. 

  536. 

  537. 

  538. 

  539. </dd>

  540.     <dt>

  541.     <a name = "getTailLengthSeconds"></a>

  542.     <strong><span class="proto_prefix">plugin</span>.getTailLengthSeconds ()</strong>

  543.     </dt>

  544.     <dd>

  545.     Return the tail length in seconds (effects only).

  546.  Override this function to define the effect's audio tail length.

  547. 

  548.     </ul>

  549. 

  550. 

  551.     <h3>Returns:</h3>

  552.     <ol>

  553. 

  554.         the tail length in seconds

  555.     </ol>

  556. 

  557. 

  558. 

  559. 

  560. </dd>

  561. </dl>

  562.     <h2><a name="Class_plugin_PositionInfo"></a>Class plugin.PositionInfo </h2>

  563. 

  564.  A container type for host-related information as returned by <a href="../modules/plugin.html#getCurrentPosition">plugin.getCurrentPosition</a></p>

  565. 

  566. <p> Is a <a href="http://www.juce.com/api/structAudioPlayHead_1_1CurrentPositionInfo.html">JUCE AudioPlayHead::CurrentPositionInfo</a>

  567.  <br><br>

  568.     <dl class="function">

  569.     <dt>

  570.     <a name = "PositionInfo.bpm"></a>

  571.     <strong><span class="proto_prefix">plugin.PositionInfo</span>.bpm</strong>

  572.     </dt>

  573.     <dd>

  574.     Host tempo (beats per minute)

  575. 

  576.     </ul>

  577. 

  578. 

  579. 

  580. 

  581. 

  582. 

  583. </dd>

  584.     <dt>

  585.     <a name = "PositionInfo.timeSigNumerator"></a>

  586.     <strong><span class="proto_prefix">plugin.PositionInfo</span>.timeSigNumerator</strong>

  587.     </dt>

  588.     <dd>

  589.     Time signature numerator ie.  <em>3</em>/4

  590. 

  591.     </ul>

  592. 

  593. 

  594. 

  595. 

  596. 

  597. 

  598. </dd>

  599.     <dt>

  600.     <a name = "PositionInfo.timeSigDenominator"></a>

  601.     <strong><span class="proto_prefix">plugin.PositionInfo</span>.timeSigDenominator</strong>

  602.     </dt>

  603.     <dd>

  604.     Time signature denominator ie.  3/<em>4</em>

  605. 

  606.     </ul>

  607. 

  608. 

  609. 

  610. 

  611. 

  612. 

  613. </dd>

  614.     <dt>

  615.     <a name = "PositionInfo.timeInSamples"></a>

  616.     <strong><span class="proto_prefix">plugin.PositionInfo</span>.timeInSamples</strong>

  617.     </dt>

  618.     <dd>

  619.     Current position on the host's timeline (samples)

  620. 

  621.     </ul>

  622. 

  623. 

  624. 

  625. 

  626. 

  627. 

  628. </dd>

  629.     <dt>

  630.     <a name = "PositionInfo.timeInSeconds"></a>

  631.     <strong><span class="proto_prefix">plugin.PositionInfo</span>.timeInSeconds</strong>

  632.     </dt>

  633.     <dd>

  634.     Current position on the host's timeline (seconds)

  635. 

  636.     </ul>

  637. 

  638. 

  639. 

  640. 

  641. 

  642. 

  643. </dd>

  644.     <dt>

  645.     <a name = "PositionInfo.editOriginTime"></a>

  646.     <strong><span class="proto_prefix">plugin.PositionInfo</span>.editOriginTime</strong>

  647.     </dt>

  648.     <dd>

  649.     Position of the start of the edit region on the host's timeline

  650. 

  651.     </ul>

  652. 

  653. 

  654. 

  655. 

  656. 

  657. 

  658. </dd>

  659.     <dt>

  660.     <a name = "PositionInfo.ppqPosition"></a>

  661.     <strong><span class="proto_prefix">plugin.PositionInfo</span>.ppqPosition</strong>

  662.     </dt>

  663.     <dd>

  664.     Current position on the host's timeline (pulses-per-quarter-note)

  665. 

  666.     </ul>

  667. 

  668. 

  669. 

  670. 

  671. 

  672. 

  673. </dd>

  674.     <dt>

  675.     <a name = "PositionInfo.ppqPositionOfLastBarStart"></a>

  676.     <strong><span class="proto_prefix">plugin.PositionInfo</span>.ppqPositionOfLastBarStart</strong>

  677.     </dt>

  678.     <dd>

  679.     Position of the last bar start (pulses-per-quarter-note).

  680.  (or zero if unavailable.)

  681. 

  682.     </ul>

  683. 

  684. 

  685. 

  686. 

  687. 

  688. 

  689. </dd>

  690.     <dt>

  691.     <a name = "PositionInfo.frameRate"></a>

  692.     <strong><span class="proto_prefix">plugin.PositionInfo</span>.frameRate</strong>

  693.     </dt>

  694.     <dd>

  695.     Video frame rate

  696. 

  697.     </ul>

  698. 

  699. 

  700. 

  701. 

  702. 

  703. 

  704. </dd>

  705.     <dt>

  706.     <a name = "PositionInfo.isPlaying"></a>

  707.     <strong><span class="proto_prefix">plugin.PositionInfo</span>.isPlaying</strong>

  708.     </dt>

  709.     <dd>

  710.     Is playing

  711. 

  712.     </ul>

  713. 

  714. 

  715. 

  716. 

  717. 

  718. 

  719. </dd>

  720.     <dt>

  721.     <a name = "PositionInfo.isRecording"></a>

  722.     <strong><span class="proto_prefix">plugin.PositionInfo</span>.isRecording</strong>

  723.     </dt>

  724.     <dd>

  725.     Is recording

  726. 

  727.     </ul>

  728. 

  729. 

  730. 

  731. 

  732. 

  733. 

  734. </dd>

  735.     <dt>

  736.     <a name = "PositionInfo.ppqLoopStart"></a>

  737.     <strong><span class="proto_prefix">plugin.PositionInfo</span>.ppqLoopStart</strong>

  738.     </dt>

  739.     <dd>

  740.     Position of the loop start (pulses-per-quarter-note).

  741.  (or zero if unavailable.)

  742. 

  743.     </ul>

  744. 

  745. 

  746. 

  747. 

  748. 

  749. 

  750. </dd>

  751.     <dt>

  752.     <a name = "PositionInfo.ppqLoopEnd"></a>

  753.     <strong><span class="proto_prefix">plugin.PositionInfo</span>.ppqLoopEnd</strong>

  754.     </dt>

  755.     <dd>

  756.     Position of the loop end (pulses-per-quarter-note).

  757.  (or zero if unavailable.)

  758. 

  759.     </ul>

  760. 

  761. 

  762. 

  763. 

  764. 

  765. 

  766. </dd>

  767.     <dt>

  768.     <a name = "PositionInfo.isLooping"></a>

  769.     <strong><span class="proto_prefix">plugin.PositionInfo</span>.isLooping</strong>

  770.     </dt>

  771.     <dd>

  772.     Is looping

  773. 

  774.     </ul>

  775. 

  776. 

  777. 

  778. 

  779. 

  780. 

  781. </dd>

  782. </dl>

  783. 

  784. 

  785. </div> <!-- id="content" -->

  786. </div> <!-- id="main" -->

  787. <div id="about">

  788. <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.2</a></i>

  789. </div> <!-- id="about" -->

  790. </div> <!-- id="container" -->

  791. </body>

  792. </html>