HelpSource/Classes/SharedOut.schelp

   1 class:: SharedOut
   2 summary:: Write to a shared control bus.
   3 related:: Classes/SharedIn
   4 categories::  UGens>InOut
   5
   6
   7 Description::
   8
   9 warning::
  10 SharedIn has been deprecated. Synchronous access to busses on local servers is possible via
  11 link::Classes/Bus#-getSynchronous:: and link::Classes/Bus#-setSynchronous::
  12 ::
  13
  14
  15 Reads from a control bus shared between the internal server and the SC
  16 client. Control rate only. Reading from a shared control bus on the
  17 client is synchronous. When not using the internal server use the get
  18 method of Bus (or /c_get in messaging style) or
  19 link::Classes/SendTrig:: with an link::Classes/OSCFunc::.
  20
  21
  22 classmethods::
  23
  24 method::kr
  25
  26 argument::bus
  27
  28 The index of the shared control bus to write to.
  29
  30
  31 argument::channelsArray
  32
  33 An Array of channels or single output to write out. You cannot
  34 change the size of this once a SynthDef has been built.
  35
  36
  37 Examples::
  38
  39 code::
  40
  41 (
  42 // only works with the internal server
  43 s = Server.internal;
  44 s.boot;
  45 )
  46
  47 (
  48 SynthDef("help-SharedOut", {
  49         SharedOut.kr(0, SinOsc.kr(0.2));
  50 }).send(s);
  51 )
  52
  53 (
  54 s.sendMsg(\s_new, "help-SharedOut", x = s.nextNodeID, 0, 1);
  55 s.sendMsg(\n_trace, x);
  56
  57 // poll the shared control bus
  58 Routine({
  59         30.do({
  60                 s.getSharedControl(0).postln;
  61                 0.2.wait;
  62         });
  63 }).play;
  64 )
  65
  66
  67 s.quit;
  68
  69 ::
  70