HelpSource/Classes/SendTrig.schelp

   1 class:: SendTrig
   2 summary:: Send a trigger message from the server back to the client.
   3 categories::  UGens>Triggers
   4 related:: Classes/OSCFunc
   5
   6
   7 Description::
   8
   9 On receiving a trigger (a non-positive to positive transition), send a
  10 trigger message from the server back to the client.
  11
  12
  13 The trigger message sent back to the client is this:
  14
  15 table::
  16
  17 ## /tr || A trigger message.
  18
  19 ## int: || Node ID.
  20
  21 ## int: || Trigger ID.
  22
  23 ## float: || Trigger value.
  24
  25 ::
  26
  27
  28 This command is the mechanism that synths can use to trigger events in
  29 clients. The node ID is the node that is sending the trigger. The trigger
  30 ID and value are determined by inputs to the SendTrig unit generator
  31 which is the originator of this message.
  32
  33
  34 classmethods::
  35
  36 method::ar, kr
  37
  38 argument::in
  39
  40 The trigger.
  41
  42
  43 argument::id
  44
  45 An integer that will be passed with the trigger message. This is
  46 useful if you have more than one SendTrig in a SynthDef.
  47
  48
  49 argument::value
  50
  51 A UGen or float that will be polled at the time of trigger, and
  52 its value passed with the trigger message.
  53
  54
  55 Examples::
  56
  57 code::
  58
  59 s = Server.local;
  60 s.boot;
  61
  62 (
  63 SynthDef("help-SendTrig",{
  64         SendTrig.kr(Dust.kr(1.0),0,0.9);
  65 }).send(s);
  66
  67 // register to receive this message
  68 o = OSCFunc({ arg msg, time;
  69         [time, msg].postln;
  70 },'/tr', s.addr);
  71 )
  72
  73 Synth("help-SendTrig");
  74
  75 o.free;
  76 ::