Skip to content

Commit 3d4283b

Browse files
kevinstadlerkevinstadler
committed
Update javadoc
1 parent c7c7bf9 commit 3d4283b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+43245
-8045
lines changed

‎docs/allclasses-index.html

Lines changed: 292 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,292 @@
1+
<!DOCTYPE HTML>
2+
<!-- NewPage -->
3+
<html lang="en">
4+
<head>
5+
<!-- Generated by javadoc -->
6+
<title>All Classes (Javadocs: Processing Sound)</title>
7+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
8+
<meta name="description" content="class index">
9+
<meta name="generator" content="javadoc/AllClassesIndexWriter">
10+
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
11+
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.css" title="Style">
12+
<script type="text/javascript" src="script.js"></script>
13+
<script type="text/javascript" src="script-dir/jszip/dist/jszip.min.js"></script>
14+
<script type="text/javascript" src="script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
15+
<!--[if IE]>
16+
<script type="text/javascript" src="script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
17+
<![endif]-->
18+
<script type="text/javascript" src="script-dir/jquery-3.4.1.js"></script>
19+
<script type="text/javascript" src="script-dir/jquery-ui.js"></script>
20+
</head>
21+
<body class="all-classes-index">
22+
<script type="text/javascript">var data = {"i0":2,"i1":8,"i2":2,"i3":2,"i4":2,"i5":2,"i6":2,"i7":2,"i8":2,"i9":2,"i10":2,"i11":2,"i12":2,"i13":2,"i14":2,"i15":2,"i16":2,"i17":2,"i18":2,"i19":2,"i20":2,"i21":2,"i22":2,"i23":2,"i24":2,"i25":2,"i26":2,"i27":2};
23+
var tabs = {65535:["t0","All Classes"],2:["t2","Class Summary"],8:["t4","Exception Summary"]};
24+
var altColor = "altColor";
25+
var rowColor = "rowColor";
26+
var tableTab = "tableTab";
27+
var activeTableTab = "activeTableTab";
28+
var pathtoroot = "./";
29+
loadScripts(document, 'script');</script>
30+
<noscript>
31+
<div>JavaScript is disabled on your browser.</div>
32+
</noscript>
33+
<header role="banner">
34+
<nav role="navigation">
35+
<div class="fixedNav">
36+
<!-- ========= START OF TOP NAVBAR ======= -->
37+
<div class="topNav"><a id="navbar.top">
38+
<!-- -->
39+
</a>
40+
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
41+
<a id="navbar.top.firstrow">
42+
<!-- -->
43+
</a>
44+
<ul class="navList" title="Navigation">
45+
<li><a href="processing/sound/package-summary.html">Package</a></li>
46+
<li>Class</li>
47+
<li><a href="overview-tree.html">Tree</a></li>
48+
<li><a href="deprecated-list.html">Deprecated</a></li>
49+
<li><a href="index-all.html">Index</a></li>
50+
<li><a href="help-doc.html">Help</a></li>
51+
</ul>
52+
</div>
53+
<div class="subNav">
54+
<div class="navListSearch"><label for="search">SEARCH:</label>
55+
<input type="text" id="search" value="search" disabled="disabled">
56+
<input type="reset" id="reset" value="reset" disabled="disabled">
57+
</div>
58+
</div>
59+
<a id="skip.navbar.top">
60+
<!-- -->
61+
</a>
62+
<!-- ========= END OF TOP NAVBAR ========= -->
63+
</div>
64+
<div class="navPadding">&nbsp;</div>
65+
<script type="text/javascript"><!--
66+
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
67+
//-->
68+
</script>
69+
</nav>
70+
</header>
71+
<main role="main">
72+
<div class="header">
73+
<h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
74+
</div>
75+
<div class="allClassesContainer">
76+
<div class="typeSummary">
77+
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="typeSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Classes</button><button role="tab" aria-selected="false" aria-controls="typeSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Class Summary</button><button role="tab" aria-selected="false" aria-controls="typeSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Exception Summary</button></div>
78+
<div id="typeSummary_tabpanel" role="tabpanel">
79+
<table aria-labelledby="t0">
80+
<thead>
81+
<tr>
82+
<th class="colFirst" scope="col">Class</th>
83+
<th class="colLast" scope="col">Description</th>
84+
</tr>
85+
</thead>
86+
<tbody>
87+
<tr class="altColor" id="i0">
88+
<td class="colFirst"><a href="processing/sound/Amplitude.html" title="class in processing.sound">Amplitude</a></td>
89+
<th class="colLast" scope="row">
90+
<div class="block">This is a volume analyzer.</div>
91+
</th>
92+
</tr>
93+
<tr class="rowColor" id="i1">
94+
<td class="colFirst"><a href="processing/sound/AndroidPermissionException.html" title="class in processing.sound">AndroidPermissionException</a></td>
95+
<th class="colLast" scope="row">
96+
<div class="block">AndroidPermissionException is thrown when trying to create an AudioIn on
97+
Android when you have not granted the required RECORD_AUDIO permission.</div>
98+
</th>
99+
</tr>
100+
<tr class="altColor" id="i2">
101+
<td class="colFirst"><a href="processing/sound/AudioDevice.html" title="class in processing.sound">AudioDevice</a></td>
102+
<th class="colLast" scope="row">Deprecated.&nbsp;</th>
103+
</tr>
104+
<tr class="rowColor" id="i3">
105+
<td class="colFirst"><a href="processing/sound/AudioIn.html" title="class in processing.sound">AudioIn</a></td>
106+
<th class="colLast" scope="row">
107+
<div class="block">AudioIn lets you grab the audio input from your sound card.</div>
108+
</th>
109+
</tr>
110+
<tr class="altColor" id="i4">
111+
<td class="colFirst"><a href="processing/sound/AudioSample.html" title="class in processing.sound">AudioSample</a></td>
112+
<th class="colLast" scope="row">
113+
<div class="block">This class allows you low-level access to an audio buffer to create, access,
114+
manipulate and play back sound samples.</div>
115+
</th>
116+
</tr>
117+
<tr class="rowColor" id="i5">
118+
<td class="colFirst"><a href="processing/sound/BandPass.html" title="class in processing.sound">BandPass</a></td>
119+
<th class="colLast" scope="row">
120+
<div class="block">This is a band pass filter.</div>
121+
</th>
122+
</tr>
123+
<tr class="altColor" id="i6">
124+
<td class="colFirst"><a href="processing/sound/BeatDetector.html" title="class in processing.sound">BeatDetector</a></td>
125+
<th class="colLast" scope="row">
126+
<div class="block">The BeatDetector analyzer looks for spikes in the energy of an audio signal
127+
which are often associated with rhythmic musical beats and can be used to trigger a
128+
response whenever the incoming audio signal pulses.</div>
129+
</th>
130+
</tr>
131+
<tr class="rowColor" id="i7">
132+
<td class="colFirst"><a href="processing/sound/BrownNoise.html" title="class in processing.sound">BrownNoise</a></td>
133+
<th class="colLast" scope="row">
134+
<div class="block">This is a brown noise generator.</div>
135+
</th>
136+
</tr>
137+
<tr class="altColor" id="i8">
138+
<td class="colFirst"><a href="processing/sound/Delay.html" title="class in processing.sound">Delay</a></td>
139+
<th class="colLast" scope="row">
140+
<div class="block">This is a simple delay effect.</div>
141+
</th>
142+
</tr>
143+
<tr class="rowColor" id="i9">
144+
<td class="colFirst"><a href="processing/sound/Effect.html" title="class in processing.sound">Effect</a>&lt;<a href="processing/sound/Effect.html" title="type parameter in Effect">EffectType</a> extends com.jsyn.unitgen.UnitFilter&gt;</td>
145+
<th class="colLast" scope="row">
146+
<div class="block">For advanced users: common superclass of all effect types</div>
147+
</th>
148+
</tr>
149+
<tr class="altColor" id="i10">
150+
<td class="colFirst"><a href="processing/sound/Env.html" title="class in processing.sound">Env</a></td>
151+
<th class="colLast" scope="row">
152+
<div class="block">This is an ASR (Attack Sustain Release) Envelope Generator</div>
153+
</th>
154+
</tr>
155+
<tr class="rowColor" id="i11">
156+
<td class="colFirst"><a href="processing/sound/FFT.html" title="class in processing.sound">FFT</a></td>
157+
<th class="colLast" scope="row">
158+
<div class="block">This is a Fast Fourier Transform (FFT) analyzer.</div>
159+
</th>
160+
</tr>
161+
<tr class="altColor" id="i12">
162+
<td class="colFirst"><a href="processing/sound/HighPass.html" title="class in processing.sound">HighPass</a></td>
163+
<th class="colLast" scope="row">
164+
<div class="block">This is a high pass filter</div>
165+
</th>
166+
</tr>
167+
<tr class="rowColor" id="i13">
168+
<td class="colFirst"><a href="processing/sound/LowPass.html" title="class in processing.sound">LowPass</a></td>
169+
<th class="colLast" scope="row">
170+
<div class="block">This is a low pass filter</div>
171+
</th>
172+
</tr>
173+
<tr class="altColor" id="i14">
174+
<td class="colFirst"><a href="processing/sound/Noise.html" title="class in processing.sound">Noise</a>&lt;<a href="processing/sound/Noise.html" title="type parameter in Noise">JSynNoise</a> extends com.jsyn.unitgen.UnitGenerator&gt;</td>
175+
<th class="colLast" scope="row">
176+
<div class="block">For advanced users: common superclass of all noise generators</div>
177+
</th>
178+
</tr>
179+
<tr class="rowColor" id="i15">
180+
<td class="colFirst"><a href="processing/sound/Oscillator.html" title="class in processing.sound">Oscillator</a>&lt;<a href="processing/sound/Oscillator.html" title="type parameter in Oscillator">JSynOscillator</a> extends com.jsyn.unitgen.UnitOscillator&gt;</td>
181+
<th class="colLast" scope="row">
182+
<div class="block">For advanced users: common superclass of all oscillator sound sources</div>
183+
</th>
184+
</tr>
185+
<tr class="altColor" id="i16">
186+
<td class="colFirst"><a href="processing/sound/PinkNoise.html" title="class in processing.sound">PinkNoise</a></td>
187+
<th class="colLast" scope="row">
188+
<div class="block">This is a pink noise generator.</div>
189+
</th>
190+
</tr>
191+
<tr class="rowColor" id="i17">
192+
<td class="colFirst"><a href="processing/sound/Pulse.html" title="class in processing.sound">Pulse</a></td>
193+
<th class="colLast" scope="row">
194+
<div class="block">This is a simple Pulse oscillator.</div>
195+
</th>
196+
</tr>
197+
<tr class="altColor" id="i18">
198+
<td class="colFirst"><a href="processing/sound/Reverb.html" title="class in processing.sound">Reverb</a></td>
199+
<th class="colLast" scope="row">
200+
<div class="block">This is a simple reverb effect.</div>
201+
</th>
202+
</tr>
203+
<tr class="rowColor" id="i19">
204+
<td class="colFirst"><a href="processing/sound/SawOsc.html" title="class in processing.sound">SawOsc</a></td>
205+
<th class="colLast" scope="row">
206+
<div class="block">This is a simple Saw Wave Oscillator</div>
207+
</th>
208+
</tr>
209+
<tr class="altColor" id="i20">
210+
<td class="colFirst"><a href="processing/sound/SinOsc.html" title="class in processing.sound">SinOsc</a></td>
211+
<th class="colLast" scope="row">
212+
<div class="block">This is a simple Sine Wave Oscillator</div>
213+
</th>
214+
</tr>
215+
<tr class="rowColor" id="i21">
216+
<td class="colFirst"><a href="processing/sound/Sound.html" title="class in processing.sound">Sound</a></td>
217+
<th class="colLast" scope="row">
218+
<div class="block">This class can be used for configuring the Processing Sound library.</div>
219+
</th>
220+
</tr>
221+
<tr class="altColor" id="i22">
222+
<td class="colFirst"><a href="processing/sound/SoundFile.html" title="class in processing.sound">SoundFile</a></td>
223+
<th class="colLast" scope="row">
224+
<div class="block">This is a Soundfile player which allows to play back and manipulate sound
225+
files.</div>
226+
</th>
227+
</tr>
228+
<tr class="rowColor" id="i23">
229+
<td class="colFirst"><a href="processing/sound/SoundObject.html" title="class in processing.sound">SoundObject</a></td>
230+
<th class="colLast" scope="row">
231+
<div class="block">For advanced users: common superclass of all sound sources (oscillators,
232+
noise, audio samples and even AudioIn).</div>
233+
</th>
234+
</tr>
235+
<tr class="altColor" id="i24">
236+
<td class="colFirst"><a href="processing/sound/SqrOsc.html" title="class in processing.sound">SqrOsc</a></td>
237+
<th class="colLast" scope="row">
238+
<div class="block">This is a simple Square Wave Oscillator</div>
239+
</th>
240+
</tr>
241+
<tr class="rowColor" id="i25">
242+
<td class="colFirst"><a href="processing/sound/TriOsc.html" title="class in processing.sound">TriOsc</a></td>
243+
<th class="colLast" scope="row">
244+
<div class="block">This is a simple triangle (or "saw") wave oscillator</div>
245+
</th>
246+
</tr>
247+
<tr class="altColor" id="i26">
248+
<td class="colFirst"><a href="processing/sound/Waveform.html" title="class in processing.sound">Waveform</a></td>
249+
<th class="colLast" scope="row">
250+
<div class="block">This is a Waveform analyzer.</div>
251+
</th>
252+
</tr>
253+
<tr class="rowColor" id="i27">
254+
<td class="colFirst"><a href="processing/sound/WhiteNoise.html" title="class in processing.sound">WhiteNoise</a></td>
255+
<th class="colLast" scope="row">
256+
<div class="block">This is a White Noise Generator.</div>
257+
</th>
258+
</tr>
259+
</tbody>
260+
</table>
261+
</div>
262+
</div>
263+
</div>
264+
</main>
265+
<footer role="contentinfo">
266+
<nav role="navigation">
267+
<!-- ======= START OF BOTTOM NAVBAR ====== -->
268+
<div class="bottomNav"><a id="navbar.bottom">
269+
<!-- -->
270+
</a>
271+
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
272+
<a id="navbar.bottom.firstrow">
273+
<!-- -->
274+
</a>
275+
<ul class="navList" title="Navigation">
276+
<li><a href="processing/sound/package-summary.html">Package</a></li>
277+
<li>Class</li>
278+
<li><a href="overview-tree.html">Tree</a></li>
279+
<li><a href="deprecated-list.html">Deprecated</a></li>
280+
<li><a href="index-all.html">Index</a></li>
281+
<li><a href="help-doc.html">Help</a></li>
282+
</ul>
283+
</div>
284+
<a id="skip.navbar.bottom">
285+
<!-- -->
286+
</a>
287+
<!-- ======== END OF BOTTOM NAVBAR ======= -->
288+
</nav>
289+
<p class="legalCopy"><small>Processing Sound</small></p>
290+
</footer>
291+
</body>
292+
</html>

0 commit comments

Comments
 (0)