HelpSource/Classes/NodeWatcher.schelp

   1 class:: NodeWatcher
   2 summary:: notify sc-lang side node objects of their server sided state
   3 related:: Reference/Server-Command-Reference, Classes/Node, Classes/DebugNodeWatcher
   4 categories:: Control, Server>Nodes
   5
   6 description::
   7 Node instances (Synths and Groups) can be registered with the NodeWatcher.
   8 It watches for server node status messages:
   9 n_go n_end n_off n_on
  10
  11 and sets the isPlaying and isRunning variables on the Node instance accordingly. A Node that ends is unregistered at that time.
  12
  13 In some cases this can be an invaluable service. The use of an independant object to maintain the state keeps the implementation of the Node classes simple.
  14 Note that server notification should be on. (this is default. see: aServer.notify)
  15
  16 code::
  17 //the most common use:
  18 NodeWatcher.register(aNode);
  19 ::
  20
  21 ClassMethods::
  22
  23 private::initClass
  24
  25 method::new
  26 Create a new instance listening to the server's address
  27
  28 method::newFrom
  29 Create a new instance listening to the server's address. If there is one present already return that one.
  30
  31 method::register
  32
  33 argument::node
  34 Can be a Group or a Synth. The NodeWatcher is created internally.
  35
  36 argument::assumePlaying
  37 If true, the node's strong::isPlaying:: field is set to true.
  38
  39 method::unregister
  40 Remove the node from the list of nodes. This happens also when a node is freed.
  41
  42 InstanceMethods::
  43
  44 method::start
  45 Add the OSCFunc to listen to the address.
  46
  47 method::stop
  48 Remove the OSCFunc to stop listen to the address.
  49
  50 Examples::
  51
  52 code::
  53 (
  54 b = s.makeBundle(false, {
  55         a = Group.new(s);       //create a node object
  56         NodeWatcher.register(a); // register before creating on the server
  57 });
  58 )
  59 a.isPlaying;
  60 s.listSendBundle(nil, b);       //start the node on the server
  61 a.isPlaying;
  62 a.isRunning;
  63 a.run(false);
  64 a.isRunning;
  65 s.freeAll;      //free all nodes
  66 a.isPlaying;
  67 a.isRunning;
  68 ::