Skip to content

Commit

Permalink
Deploying to doxygen from @ e38edd7 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
pschatzmann committed Oct 21, 2023
1 parent 365fbc7 commit d771655
Show file tree
Hide file tree
Showing 15 changed files with 189 additions and 154 deletions.
261 changes: 140 additions & 121 deletions _audio_s_t_k_8h_source.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -494,7 +494,7 @@
<tr id="row_0_408_" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classaudio__tools_1_1_s_t_k_lent_pit_shift.html" target="_self">STKLentPitShift</a></td><td class="desc">Pitch shifter effect class based on the Lent algorithm </td></tr>
<tr id="row_0_409_" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classaudio__tools_1_1_s_t_k_n_reverb.html" target="_self">STKNReverb</a></td><td class="desc">CCRMA's NRev reverberator class </td></tr>
<tr id="row_0_410_" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classaudio__tools_1_1_s_t_k_perry_reverb.html" target="_self">STKPerryReverb</a></td><td class="desc">Perry's simple reverberator class </td></tr>
<tr id="row_0_411_" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classaudio__tools_1_1_s_t_k_pit_shift.html" target="_self">STKPitShift</a></td><td class="desc">Pitch shifter effect class based on the Lent algorithm </td></tr>
<tr id="row_0_411_" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classaudio__tools_1_1_s_t_k_pit_shift.html" target="_self">STKPitShift</a></td><td class="desc">Simple Pitch shifter effect class: This class implements a simple pitch shifter using a delay line </td></tr>
<tr id="row_0_412_" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classaudio__tools_1_1_s_t_k_stream.html" target="_self">STKStream</a></td><td class="desc">STK <a class="el" href="classaudio__tools_1_1_stream.html">Stream</a> for Instrument or Voicer </td></tr>
<tr id="row_0_413_" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classaudio__tools_1_1_str.html" target="_self">Str</a></td><td class="desc">A simple wrapper to provide string functions on char*. If the underlying char* is a const we do not allow any updates; The ownership of the chr* must be managed externally! </td></tr>
<tr id="row_0_414_" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classaudio__tools_1_1_stream.html" target="_self">Stream</a></td><td class="desc"></td></tr>
Expand Down
2 changes: 1 addition & 1 deletion classaudio__tools_1_1_audio_effect.html
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
<area href="classaudio__tools_1_1_s_t_k_lent_pit_shift.html" title="Pitch shifter effect class based on the Lent algorithm." alt="STKLentPitShift" shape="rect" coords="142,728,274,752"/>
<area href="classaudio__tools_1_1_s_t_k_n_reverb.html" title="CCRMA&#39;s NRev reverberator class." alt="STKNReverb" shape="rect" coords="142,784,274,808"/>
<area href="classaudio__tools_1_1_s_t_k_perry_reverb.html" title="Perry&#39;s simple reverberator class." alt="STKPerryReverb" shape="rect" coords="142,840,274,864"/>
<area href="classaudio__tools_1_1_s_t_k_pit_shift.html" title="Pitch shifter effect class based on the Lent algorithm." alt="STKPitShift" shape="rect" coords="142,896,274,920"/>
<area href="classaudio__tools_1_1_s_t_k_pit_shift.html" title="Simple Pitch shifter effect class: This class implements a simple pitch shifter using a delay line." alt="STKPitShift" shape="rect" coords="142,896,274,920"/>
<area href="classaudio__tools_1_1_tremolo.html" title="Tremolo AudioEffect." alt="Tremolo" shape="rect" coords="142,952,274,976"/>
</map>
</div></div>
Expand Down
5 changes: 3 additions & 2 deletions classaudio__tools_1_1_s_t_k_chorus-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -76,15 +76,16 @@
<tr bgcolor="#f0f0f0"><td class="entry"><b>active_flag</b> (defined in <a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>AudioEffect</b>()=default (defined in <a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_effect.html#af52bdd0b692ecf558d8bd97fac35bf6b">clip</a>(int32_t in, int16_t clipLimit=32767, int16_t resultLimit=32767)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>clone</b>()=0 (defined in <a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>clone</b>() override (defined in <a class="el" href="classaudio__tools_1_1_s_t_k_chorus.html">STKChorus</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_s_t_k_chorus.html">STKChorus</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>copyParent</b>(AudioEffect *copy) (defined in <a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_effect.html#a4a716406d3d9d4fdbbe46f100e648f3b">id</a>()</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>id_value</b> (defined in <a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classaudio__tools_1_1_s_t_k_chorus.html#ae60a58177e645e1f35bb5ffe394427a2">process</a>(effect_t in)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_s_t_k_chorus.html">STKChorus</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_effect.html#a392adf5d7d03b5339b77ec58bca5f9a9">setActive</a>(bool value)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_effect.html#a3d929477fef71d52c9c6df2ba2d50841">setId</a>(int id)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>STKChorus</b>(float baseDelay=6000) (defined in <a class="el" href="classaudio__tools_1_1_s_t_k_chorus.html">STKChorus</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_s_t_k_chorus.html">STKChorus</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>~AudioEffect</b>()=default (defined in <a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>STKChorus</b>(const STKChorus &amp;copy)=default (defined in <a class="el" href="classaudio__tools_1_1_s_t_k_chorus.html">STKChorus</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_s_t_k_chorus.html">STKChorus</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>~AudioEffect</b>()=default (defined in <a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Expand Down
11 changes: 7 additions & 4 deletions classaudio__tools_1_1_s_t_k_chorus.html
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classaudio__tools_1_1_s_t_k_chorus-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">STKChorus Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__main.html">Arduino Audio Tools</a> &raquo; <a class="el" href="group__dsp.html">DSP</a> &raquo; <a class="el" href="group__effects.html">Effects</a></div></div> </div>
<div class="title">STKChorus Class Reference<div class="ingroups"><a class="el" href="group__main.html">Arduino Audio Tools</a> &raquo; <a class="el" href="group__dsp.html">DSP</a> &raquo; <a class="el" href="group__effects.html">Effects</a></div></div> </div>
</div><!--header-->
<div class="contents">

Expand All @@ -91,16 +91,19 @@
<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:a6dc435de20cb5a36faec824e67dea749"><td class="memItemLeft" align="right" valign="top"><a id="a6dc435de20cb5a36faec824e67dea749"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>STKChorus</b> (const <a class="el" href="classaudio__tools_1_1_s_t_k_chorus.html">STKChorus</a> &amp;copy)=default</td></tr>
<tr class="separator:a6dc435de20cb5a36faec824e67dea749"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acbfbd8db884a69545e0be41b93337431"><td class="memItemLeft" align="right" valign="top"><a id="acbfbd8db884a69545e0be41b93337431"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>STKChorus</b> (float baseDelay=6000)</td></tr>
<tr class="separator:acbfbd8db884a69545e0be41b93337431"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3708b79a6e03c964327c2988b2a70668"><td class="memItemLeft" align="right" valign="top"><a id="a3708b79a6e03c964327c2988b2a70668"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_effect.html#a3708b79a6e03c964327c2988b2a70668">active</a> ()</td></tr>
<tr class="memdesc:a3708b79a6e03c964327c2988b2a70668"><td class="mdescLeft">&#160;</td><td class="mdescRight">determines if the effect is active <br /></td></tr>
<tr class="separator:a3708b79a6e03c964327c2988b2a70668"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa80f6251a20600cf6da083a627c401df"><td class="memItemLeft" align="right" valign="top"><a id="aa80f6251a20600cf6da083a627c401df"></a>
virtual <a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>clone</b> ()=0</td></tr>
<tr class="separator:aa80f6251a20600cf6da083a627c401df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7dd900474cc05774cfa222eebb66a899"><td class="memItemLeft" align="right" valign="top"><a id="a7dd900474cc05774cfa222eebb66a899"></a>
<a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>clone</b> () override</td></tr>
<tr class="separator:a7dd900474cc05774cfa222eebb66a899"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a716406d3d9d4fdbbe46f100e648f3b"><td class="memItemLeft" align="right" valign="top"><a id="a4a716406d3d9d4fdbbe46f100e648f3b"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_effect.html#a4a716406d3d9d4fdbbe46f100e648f3b">id</a> ()</td></tr>
<tr class="memdesc:a4a716406d3d9d4fdbbe46f100e648f3b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allows to identify an effect. <br /></td></tr>
Expand Down
5 changes: 3 additions & 2 deletions classaudio__tools_1_1_s_t_k_echo-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -76,15 +76,16 @@
<tr bgcolor="#f0f0f0"><td class="entry"><b>active_flag</b> (defined in <a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>AudioEffect</b>()=default (defined in <a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_effect.html#af52bdd0b692ecf558d8bd97fac35bf6b">clip</a>(int32_t in, int16_t clipLimit=32767, int16_t resultLimit=32767)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>clone</b>()=0 (defined in <a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>clone</b>() override (defined in <a class="el" href="classaudio__tools_1_1_s_t_k_echo.html">STKEcho</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_s_t_k_echo.html">STKEcho</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>copyParent</b>(AudioEffect *copy) (defined in <a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_effect.html#a4a716406d3d9d4fdbbe46f100e648f3b">id</a>()</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>id_value</b> (defined in <a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classaudio__tools_1_1_s_t_k_echo.html#ae60a58177e645e1f35bb5ffe394427a2">process</a>(effect_t in)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_s_t_k_echo.html">STKEcho</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_effect.html#a392adf5d7d03b5339b77ec58bca5f9a9">setActive</a>(bool value)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_effect.html#a3d929477fef71d52c9c6df2ba2d50841">setId</a>(int id)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>STKEcho</b>(unsigned long maximumDelay=(unsigned long) Stk::sampleRate()) (defined in <a class="el" href="classaudio__tools_1_1_s_t_k_echo.html">STKEcho</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_s_t_k_echo.html">STKEcho</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>~AudioEffect</b>()=default (defined in <a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>STKEcho</b>(const STKEcho &amp;copy)=default (defined in <a class="el" href="classaudio__tools_1_1_s_t_k_echo.html">STKEcho</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_s_t_k_echo.html">STKEcho</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>~AudioEffect</b>()=default (defined in <a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a>)</td><td class="entry"><a class="el" href="classaudio__tools_1_1_audio_effect.html">AudioEffect</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Expand Down
Loading

0 comments on commit d771655

Please sign in to comment.