HelpSource/Classes/ControlName.schelp

   1 class:: ControlName
   2 summary:: Object to store control information of SynthDef (used internally)
   3 related:: Classes/SynthDesc, Classes/SynthDef
   4 categories:: UGens>Synth control
   5
   6 description::
   7 For an explicit creation of control names see: link::Classes/NamedControl::, link::Classes/Control::
   8
   9 examples::
  10 code::
  11 a = SynthDescLib.global; // the global library of SynthDescs
  12 x = a.synthDescs.at(\default); // get the default SynthDesc
  13 x.controls.do { |ctl| [\name, ctl.name, \defaultValue, ctl.defaultValue].postln };"";
  14 ::
  15
  16 instancemethods::
  17 private:: printOn
  18
  19 method::name
  20 The name of the control.
  21 returns:: a link::Classes/Symbol::
  22
  23 method::index
  24 The index of the control.
  25 returns:: an link::Classes/Integer::
  26
  27 method::rate
  28 The rate of the control.
  29 returns:: a link::Classes/Symbol:: like code::'audio':: or code::'control'::
  30
  31 method::defaultValue
  32 Default value of this control. Will be an link::Classes/Array:: for multichannel controls.
  33
  34 method::numChannels
  35 The number of channels.
  36 returns:: an link::Classes/Integer::
  37