/usr/share/SuperCollider/HelpSource/Classes/BusPlug.schelp is in supercollider-common 1:3.6.3~repack-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 | class:: BusPlug
summary:: a listener on a bus
categories:: Libraries>JITLib>NodeProxy
related:: Classes/Bus
description::
BusPlug is mainly in use as a basic superclass of NodeProxy, but it can be applied for other things as well. Most methods are documented in the link::Classes/NodeProxy:: helpfile.
ClassMethods::
method::new
Create a new (neutral) instance on the given server
method::audio
Create a new audio rate instance on the given server
method::control
Create a new audio rate instance on the given server
InstanceMethods::
method::clear
Free the bus, end the monitor
method::ar, kr
Return a link to my output, which is limited by strong::numChannels::. If uninitialized, creates a matching bus. Normally, strong::ar defaults to stereo, kr to mono::. This can be set in the classvars: link::#*defaultNumAudio::, link::#*defaultNumControl::
method::play
Plays from a bus index ( strong::out:: ) with a number of channels to another index with a number of channels, within a strong::group:: (ie a target group or server).
argument::out
bus index
argument::numChannels
an link::Classes/Integer::
argument::group
target link::Classes/Group:: or link::Classes/Server::
argument::multi
keep old links and add new one
argument::vol
volume at which to monitor
argument::fadeTime
fade in fade out time
argument:: addAction
method::playN
argument::outs
array of destination channels
argument::amps
array of amplitudes for each channel
argument::ins
array of source channels
argument:: vol
argument:: fadetime
argument:: group
argument:: addAction
method::monitor
returns the current monitor (see link::Classes/Monitor::)
Examples::
code::
// using as a control bus listener
s.boot;
z = Bus.control(s, 16);
a = BusPlug.for(z);
m = { Mix(SinOsc.ar(a.kr(16), 0, 0.1)) }.play;
z.setn(Array.rand(16, 300, 320).put(16.rand, rrand(500, 1000)));
z.setn(Array.rand(16, 300, 320).put(16.rand, rrand(500, 1000)));
z.setn(Array.rand(16, 300, 320).put(16.rand, rrand(500, 1000)));
m.free;
m = { SinOsc.ar(a.kr(2, MouseX.kr(0, 19)), 0, 0.1) }.play; // modulate channel offset
z.setn(Array.rand(16, 300, 1320).put(16.rand, rrand(500, 1000)));
m.free; z.free;
// using as a audio monitor
p = BusPlug.audio(s,2);
d = { Out.ar(p.index, PinkNoise.ar([0.1, 0.1])) }.play;
p.play; // monitor whatever plays in p (the execution order does not matter)
d.free;
d = { Out.ar(p.index, PinkNoise.ar([0.1, 0.1])) }.play;
p.stop;
p.play;
// also p can play to another bus:
p.stop;
p.play(12);
// listen to that bus for a test:
x = { InFeedback.ar(12,2) }.play;
x.free;
::
|