HelpSource/Classes/Volume.schelp

   1 class:: Volume
   2 summary:: Model for the global volume of the synthesis server
   3 categories:: Server
   4
   5 description::
   6 Internally used by Server.
   7
   8 classmethods::
   9 method:: new
  10 Create and return a new instance of Volume for a given server,
  11 ranging from code::startBus:: over code::numChans:: (usually the server's number of output bus channels).
  12 argument:: startBus
  13 start bus
  14 argument:: numChans
  15 number of channels
  16 argument:: min
  17 minimum volume in decibel
  18 argument:: max
  19 minimum volume in decibel
  20 argument:: persist
  21 whether to persist a reset
  22
  23 instancemethods::
  24
  25 method:: play
  26 run the synth that controls the volume. If mute is true, mute the output. (default: false)
  27
  28 method:: free
  29 free the synth that controls the volume.
  30
  31 method:: mute
  32 mute output
  33
  34 method:: unmute
  35 unmute output
  36
  37 method:: volume
  38 set the volume (in db)
  39
  40 method:: lag
  41 set the lag time that dampens volume changes
  42
  43 method:: setVolumeRange
  44 set the volume range
  45
  46 method:: gui(window, bounds)
  47 create a volume gui.
  48
  49 examples::
  50 code::
  51 v = s.volume;
  52
  53 v.min;
  54 v.max;
  55 v.volume = rrand(-50, 5);
  56 v.setVolumeRange(-90, 8);
  57 v.mute;
  58 v.unmute;
  59
  60 // separate window
  61 v.gui;
  62 ::
  63