Help/ServerArchitecture/Volume.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <meta http-equiv="Content-Style-Type" content="text/css">
   6 <title></title>
   7 <meta name="Generator" content="Cocoa HTML Writer">
   8 <meta name="CocoaVersion" content="949.43">
   9 <style type="text/css">
  10 p.p1 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica}
  11 p.p2 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; min-height: 14.0px}
  12 p.p3 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; min-height: 12.0px}
  13 p.p4 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; color: #0026e6; min-height: 14.0px}
  14 p.p5 {margin: 0.0px 0.0px 0.0px 0.0px; font: 14.0px Helvetica; min-height: 17.0px}
  15 p.p6 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 9.0px Monaco; min-height: 12.0px}
  16 p.p7 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 12.0px Helvetica}
  17 p.p8 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 12.0px Helvetica; min-height: 14.0px}
  18 p.p9 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 9.0px Monaco; color: #8a301d; min-height: 12.0px}
  19 p.p10 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 9.0px Monaco; color: #bf0000}
  20 p.p11 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 9.0px Monaco; color: #000000; min-height: 12.0px}
  21 p.p12 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 9.0px Monaco; color: #000000}
  22 p.p13 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #000000}
  23 p.p14 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #000000; min-height: 12.0px}
  24 p.p15 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #bf0000}
  25 span.s1 {font: 18.0px Helvetica}
  26 span.s2 {color: #034ceb}
  27 span.s3 {color: #0000ff}
  28 span.s4 {color: #000000}
  29 span.Apple-tab-span {white-space:pre}
  30 </style>
  31 </head>
  32 <body>
  33 <p class="p1"><span class="s1"><b>Volume<span class="Apple-tab-span">   </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span></b></span><b>model for the global volume of the synthesis server</b></p>
  34 <p class="p2"><br></p>
  35 <p class="p1">superclass: <a href="../Core/Object.html"><span class="s2">Object</span></a></p>
  36 <p class="p3"><br></p>
  37 <p class="p2"><br></p>
  38 <p class="p1">Internally used by <a href="Server.html"><span class="s3">Server</span></a>.</p>
  39 <p class="p2"><br></p>
  40 <p class="p4"><br></p>
  41 <p class="p5"><br></p>
  42 <p class="p6"><br></p>
  43 <p class="p7"><b><span class="Apple-tab-span">  </span>*new(server, startBus, numChans, min, max, persist)</b></p>
  44 <p class="p8"><b><span class="Apple-tab-span">  </span></b></p>
  45 <p class="p7"><b><span class="Apple-tab-span">  </span><span class="Apple-tab-span">    </span></b>Create and return a new instance of Volume for a given <b>server</b>,<span class="Apple-converted-space"> </span></p>
  46 <p class="p7"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span>ranging from <b>startBus</b> over <b>numChans</b> (usually the server's number of output bus channels).</p>
  47 <p class="p7"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><b>min</b>: minimum volume in decibel (default: -90)</p>
  48 <p class="p7"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><b>max</b>: minimum volume in decibel (default: -90)</p>
  49 <p class="p7"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><b>persist</b>: whether to persist a reset (default: false)</p>
  50 <p class="p6"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span></p>
  51 <p class="p8"><b><span class="Apple-tab-span">  </span></b></p>
  52 <p class="p7"><b><span class="Apple-tab-span">  </span>play(mute)</b></p>
  53 <p class="p8"><b><span class="Apple-tab-span">  </span></b><span class="Apple-tab-span">        </span></p>
  54 <p class="p7"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span>run the synth that controls the volume. If mute is true, mute the output. (default: false)</p>
  55 <p class="p8"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span></p>
  56 <p class="p7"><span class="Apple-tab-span">     </span><b>free</b></p>
  57 <p class="p7"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span>free the synth that controls the volume.</p>
  58 <p class="p8"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span></p>
  59 <p class="p7"><span class="Apple-tab-span">     </span><b>mute</b><span class="Apple-converted-space"> </span></p>
  60 <p class="p7"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span>mute output</p>
  61 <p class="p8"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span></p>
  62 <p class="p7"><span class="Apple-tab-span">     </span><b>unmute</b><span class="Apple-converted-space"> </span></p>
  63 <p class="p7"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span>unmute output</p>
  64 <p class="p8"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span></p>
  65 <p class="p7"><span class="Apple-tab-span">     </span><b>volume_(aVolume)</b></p>
  66 <p class="p7"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span>set the volume (in db)</p>
  67 <p class="p8"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span></p>
  68 <p class="p7"><span class="Apple-tab-span">     </span><b>lag_ (aLagTime)</b></p>
  69 <p class="p7"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span>set the lag time that dampens volume changes</p>
  70 <p class="p8"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span></p>
  71 <p class="p7"><span class="Apple-tab-span">     </span><b>setVolumeRange(argMin, argMax)</b></p>
  72 <p class="p7"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span>set the volume range</p>
  73 <p class="p8"><span class="Apple-tab-span">     </span></p>
  74 <p class="p7"><span class="Apple-tab-span">     </span><b>gui(window, bounds)</b></p>
  75 <p class="p7"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span>create a volume gui.</p>
  76 <p class="p8"><br></p>
  77 <p class="p9"><br></p>
  78 <p class="p10"><span class="s4"><span class="Apple-tab-span">   </span></span>// examples</p>
  79 <p class="p11"><br></p>
  80 <p class="p12"><span class="Apple-tab-span">    </span>v = s.volume;</p>
  81 <p class="p11"><span class="Apple-tab-span">    </span></p>
  82 <p class="p13"><span class="Apple-tab-span">    </span>v.min;</p>
  83 <p class="p13"><span class="Apple-tab-span">    </span>v.max;</p>
  84 <p class="p13"><span class="Apple-tab-span">    </span>v.volume = rrand(-50, 5);</p>
  85 <p class="p13"><span class="Apple-tab-span">    </span>v.setVolumeRange(-90, 8);</p>
  86 <p class="p13"><span class="Apple-tab-span">    </span>v.mute;</p>
  87 <p class="p13"><span class="Apple-tab-span">    </span>v.unmute;</p>
  88 <p class="p14"><span class="Apple-tab-span">    </span></p>
  89 <p class="p15"><span class="s4"><span class="Apple-tab-span">   </span></span>// separate window</p>
  90 <p class="p13"><span class="Apple-tab-span">    </span>v.gui;</p>
  91 <p class="p14"><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span></p>
  92 </body>
  93 </html>