libjuce-doc 4.3.0~repack-1 / usr / share / doc / libjuce / apiref / classSynthesiserSound.html

This file is indexed.

/usr/share/doc/libjuce/apiref/classSynthesiserSound.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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
<!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: SynthesiserSound 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="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classSynthesiserSound-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">SynthesiserSound Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>Describes one of the sounds that a <a class="el" href="classSynthesiser.html" title="Base class for a musical device that can play sounds. ">Synthesiser</a> can play.  
 <a href="classSynthesiserSound.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for SynthesiserSound:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
 <div class="center">
  <img src="classSynthesiserSound.png" usemap="#SynthesiserSound_map" alt=""/>
  <map id="SynthesiserSound_map" name="SynthesiserSound_map">
<area href="classReferenceCountedObject.html" title="A base class which provides methods for reference-counting. " alt="ReferenceCountedObject" shape="rect" coords="0,0,155,24"/>
<area href="classSamplerSound.html" title="A subclass of SynthesiserSound that represents a sampled audio clip. " alt="SamplerSound" shape="rect" coords="0,112,155,136"/>
</map>
 </div></div>
<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:a602e767cdfca63dd73df1f0d5c723ef8"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classReferenceCountedObjectPtr.html">ReferenceCountedObjectPtr</a>&lt; <a class="el" href="classSynthesiserSound.html">SynthesiserSound</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSynthesiserSound.html#a602e767cdfca63dd73df1f0d5c723ef8">Ptr</a></td></tr>
<tr class="memdesc:a602e767cdfca63dd73df1f0d5c723ef8"><td class="mdescLeft">&#160;</td><td class="mdescRight">The class is reference-counted, so this is a handy pointer class for it.  <a href="#a602e767cdfca63dd73df1f0d5c723ef8">More...</a><br /></td></tr>
<tr class="separator:a602e767cdfca63dd73df1f0d5c723ef8"><td class="memSeparator" colspan="2">&#160;</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:a1565fcdfa4362d7b25c29178b4d39b76"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSynthesiserSound.html#a1565fcdfa4362d7b25c29178b4d39b76">~SynthesiserSound</a> ()</td></tr>
<tr class="memdesc:a1565fcdfa4362d7b25c29178b4d39b76"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a1565fcdfa4362d7b25c29178b4d39b76">More...</a><br /></td></tr>
<tr class="separator:a1565fcdfa4362d7b25c29178b4d39b76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc192aba46964c8539206db1e6f6f747"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSynthesiserSound.html#abc192aba46964c8539206db1e6f6f747">appliesToNote</a> (int midiNoteNumber)=0</td></tr>
<tr class="memdesc:abc192aba46964c8539206db1e6f6f747"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if this sound should be played when a given midi note is pressed.  <a href="#abc192aba46964c8539206db1e6f6f747">More...</a><br /></td></tr>
<tr class="separator:abc192aba46964c8539206db1e6f6f747"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3910c5fd83df051b05925bbddf4960cd"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSynthesiserSound.html#a3910c5fd83df051b05925bbddf4960cd">appliesToChannel</a> (int midiChannel)=0</td></tr>
<tr class="memdesc:a3910c5fd83df051b05925bbddf4960cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the sound should be triggered by midi events on a given channel.  <a href="#a3910c5fd83df051b05925bbddf4960cd">More...</a><br /></td></tr>
<tr class="separator:a3910c5fd83df051b05925bbddf4960cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classReferenceCountedObject"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classReferenceCountedObject')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classReferenceCountedObject.html">ReferenceCountedObject</a></td></tr>
<tr class="memitem:a878ca594f89f757d29af5a42ee51161f inherit pub_methods_classReferenceCountedObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classReferenceCountedObject.html#a878ca594f89f757d29af5a42ee51161f">incReferenceCount</a> () noexcept</td></tr>
<tr class="memdesc:a878ca594f89f757d29af5a42ee51161f inherit pub_methods_classReferenceCountedObject"><td class="mdescLeft">&#160;</td><td class="mdescRight">Increments the object's reference count.  <a href="classReferenceCountedObject.html#a878ca594f89f757d29af5a42ee51161f">More...</a><br /></td></tr>
<tr class="separator:a878ca594f89f757d29af5a42ee51161f inherit pub_methods_classReferenceCountedObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a523f06d996130f24b36996b28b83d802 inherit pub_methods_classReferenceCountedObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classReferenceCountedObject.html#a523f06d996130f24b36996b28b83d802">decReferenceCount</a> () noexcept</td></tr>
<tr class="memdesc:a523f06d996130f24b36996b28b83d802 inherit pub_methods_classReferenceCountedObject"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decreases the object's reference count.  <a href="classReferenceCountedObject.html#a523f06d996130f24b36996b28b83d802">More...</a><br /></td></tr>
<tr class="separator:a523f06d996130f24b36996b28b83d802 inherit pub_methods_classReferenceCountedObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2355316960a6bf2e9691fded43249254 inherit pub_methods_classReferenceCountedObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classReferenceCountedObject.html#a2355316960a6bf2e9691fded43249254">decReferenceCountWithoutDeleting</a> () noexcept</td></tr>
<tr class="memdesc:a2355316960a6bf2e9691fded43249254 inherit pub_methods_classReferenceCountedObject"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decreases the object's reference count.  <a href="classReferenceCountedObject.html#a2355316960a6bf2e9691fded43249254">More...</a><br /></td></tr>
<tr class="separator:a2355316960a6bf2e9691fded43249254 inherit pub_methods_classReferenceCountedObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0111caf12d101fc74abd832d44fbfa4f inherit pub_methods_classReferenceCountedObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classReferenceCountedObject.html#a0111caf12d101fc74abd832d44fbfa4f">getReferenceCount</a> () const noexcept</td></tr>
<tr class="memdesc:a0111caf12d101fc74abd832d44fbfa4f inherit pub_methods_classReferenceCountedObject"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the object's current reference count.  <a href="classReferenceCountedObject.html#a0111caf12d101fc74abd832d44fbfa4f">More...</a><br /></td></tr>
<tr class="separator:a0111caf12d101fc74abd832d44fbfa4f inherit pub_methods_classReferenceCountedObject"><td class="memSeparator" colspan="2">&#160;</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:a7446eb4d78aa0ce2dcd37ca1ff48dd3a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSynthesiserSound.html#a7446eb4d78aa0ce2dcd37ca1ff48dd3a">SynthesiserSound</a> ()</td></tr>
<tr class="separator:a7446eb4d78aa0ce2dcd37ca1ff48dd3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_classReferenceCountedObject"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classReferenceCountedObject')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classReferenceCountedObject.html">ReferenceCountedObject</a></td></tr>
<tr class="memitem:a86c1a0791cb6e98e63f7c1f7812c6eb5 inherit pro_methods_classReferenceCountedObject"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classReferenceCountedObject.html#a86c1a0791cb6e98e63f7c1f7812c6eb5">ReferenceCountedObject</a> ()</td></tr>
<tr class="memdesc:a86c1a0791cb6e98e63f7c1f7812c6eb5 inherit pro_methods_classReferenceCountedObject"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates the reference-counted object (with an initial ref count of zero).  <a href="classReferenceCountedObject.html#a86c1a0791cb6e98e63f7c1f7812c6eb5">More...</a><br /></td></tr>
<tr class="separator:a86c1a0791cb6e98e63f7c1f7812c6eb5 inherit pro_methods_classReferenceCountedObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ed87d7f91e5ae51c620947c61291375 inherit pro_methods_classReferenceCountedObject"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classReferenceCountedObject.html#a7ed87d7f91e5ae51c620947c61291375">~ReferenceCountedObject</a> ()</td></tr>
<tr class="memdesc:a7ed87d7f91e5ae51c620947c61291375 inherit pro_methods_classReferenceCountedObject"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="classReferenceCountedObject.html#a7ed87d7f91e5ae51c620947c61291375">More...</a><br /></td></tr>
<tr class="separator:a7ed87d7f91e5ae51c620947c61291375 inherit pro_methods_classReferenceCountedObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9bbeeab431755e2be8ff09dfe9ea4c4d inherit pro_methods_classReferenceCountedObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classReferenceCountedObject.html#a9bbeeab431755e2be8ff09dfe9ea4c4d">resetReferenceCount</a> () noexcept</td></tr>
<tr class="memdesc:a9bbeeab431755e2be8ff09dfe9ea4c4d inherit pro_methods_classReferenceCountedObject"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resets the reference count to zero without deleting the object.  <a href="classReferenceCountedObject.html#a9bbeeab431755e2be8ff09dfe9ea4c4d">More...</a><br /></td></tr>
<tr class="separator:a9bbeeab431755e2be8ff09dfe9ea4c4d inherit pro_methods_classReferenceCountedObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Describes one of the sounds that a <a class="el" href="classSynthesiser.html" title="Base class for a musical device that can play sounds. ">Synthesiser</a> can play. </p>
<p>A synthesiser can contain one or more sounds, and a sound can choose which midi notes and channels can trigger it.</p>
<p>The <a class="el" href="classSynthesiserSound.html" title="Describes one of the sounds that a Synthesiser can play. ">SynthesiserSound</a> is a passive class that just describes what the sound is - the actual audio rendering for a sound is done by a <a class="el" href="classSynthesiserVoice.html" title="Represents a voice that a Synthesiser can use to play a SynthesiserSound. ">SynthesiserVoice</a>. This allows more than one <a class="el" href="classSynthesiserVoice.html" title="Represents a voice that a Synthesiser can use to play a SynthesiserSound. ">SynthesiserVoice</a> to play the same sound at the same time.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classSynthesiser.html" title="Base class for a musical device that can play sounds. ">Synthesiser</a>, <a class="el" href="classSynthesiserVoice.html" title="Represents a voice that a Synthesiser can use to play a SynthesiserSound. ">SynthesiserVoice</a> </dd></dl>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a602e767cdfca63dd73df1f0d5c723ef8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a602e767cdfca63dd73df1f0d5c723ef8">&sect;&nbsp;</a></span>Ptr</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="classReferenceCountedObjectPtr.html">ReferenceCountedObjectPtr</a>&lt;<a class="el" href="classSynthesiserSound.html">SynthesiserSound</a>&gt; <a class="el" href="classSynthesiserSound.html#a602e767cdfca63dd73df1f0d5c723ef8">SynthesiserSound::Ptr</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The class is reference-counted, so this is a handy pointer class for it. </p>

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a7446eb4d78aa0ce2dcd37ca1ff48dd3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7446eb4d78aa0ce2dcd37ca1ff48dd3a">&sect;&nbsp;</a></span>SynthesiserSound()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">SynthesiserSound::SynthesiserSound </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="a1565fcdfa4362d7b25c29178b4d39b76"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1565fcdfa4362d7b25c29178b4d39b76">&sect;&nbsp;</a></span>~SynthesiserSound()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual SynthesiserSound::~SynthesiserSound </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">

<p>Destructor. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="abc192aba46964c8539206db1e6f6f747"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc192aba46964c8539206db1e6f6f747">&sect;&nbsp;</a></span>appliesToNote()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool SynthesiserSound::appliesToNote </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>midiNoteNumber</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>Returns true if this sound should be played when a given midi note is pressed. </p>
<p>The <a class="el" href="classSynthesiser.html" title="Base class for a musical device that can play sounds. ">Synthesiser</a> will use this information when deciding which sounds to trigger for a given note. </p>

<p>Implemented in <a class="el" href="classSamplerSound.html#ac579ceea6ee78e6dae8026b4b9b33038">SamplerSound</a>.</p>

<p>Referenced by <a class="el" href="classSamplerSound.html#aa684e03887c9f213102ce7a0557e6f89">SamplerSound::getAudioData()</a>.</p>

</div>
</div>
<a id="a3910c5fd83df051b05925bbddf4960cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3910c5fd83df051b05925bbddf4960cd">&sect;&nbsp;</a></span>appliesToChannel()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool SynthesiserSound::appliesToChannel </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>midiChannel</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>Returns true if the sound should be triggered by midi events on a given channel. </p>
<p>The <a class="el" href="classSynthesiser.html" title="Base class for a musical device that can play sounds. ">Synthesiser</a> will use this information when deciding which sounds to trigger for a given note. </p>

<p>Implemented in <a class="el" href="classSamplerSound.html#a6f69ffcba849228995ab63d93439a339">SamplerSound</a>.</p>

<p>Referenced by <a class="el" href="classSamplerSound.html#aa684e03887c9f213102ce7a0557e6f89">SamplerSound::getAudioData()</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__Synthesiser_8h.html">juce_Synthesiser.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content &copy ROLI Ltd.</small></address><br/>
</body>
</html>

APT Browse - Built by Thomas Orozco.