Server

Arguments:

get/set the local server, stored in classvar local (created already on initClass)

get/set the internal server, stored in classvar internal (created already on initClass)

Get or set the default server. By default this is the local server (see above).

Discussion:

Setting this will also assign it to the Interpreter variable 's'.

Server.default = Server.internal; // set the internal Server to be the default Server
s.postln; // internal

get/set the set of all servers.

Returns:

quit all registered servers

query the system for any sc-server apps and hard quit them

free all nodes in all registered servers

send an osc message to the server.

Discussion:

s.sendMsg("/s_new", "default", s.nextNodeID, 0, 1);

send an osc bundle to the server.

Discussion:

Since the network may have irregular performance, time allows for the bundle to be evaluated at a specified point in the future. Thus all messages are synchronous relative to each other, but delayed by a constant offset. If such a bundle arrives late, the server replies with a late message but still evaluates it.

s.sendBundle(0.2, ["/s_new", "default", x = s.nextNodeID, 0, 1], ["/n_set", x, "freq", 500]);

as sendMsg, but takes an array as argument.

as sendBundle, but takes an array as argument.

Discussion:

This allows you to collect messages in an array and then send them.

s.listSendBundle(0.2, [["/s_new", "default", x = s.nextNodeID, 0, 1],
    ["/n_set", x, "freq", 600]]);

send a synthDef to the server that was written in a local directory

load a synthDef that resides in the remote directory

load all the SynthDefs in the directory dir.

Arguments:

get a unique nodeID.

get a permanent node ID. This node ID is in a reserved range and will be held until you explicitly free it.

free a permanent node ID for later reuse.

this can be used within a Routine to wait for a server reply

Evaluate "onComplete" as soon as the server has booted. This method will boot the server for you if it is not already running or booting. If the server is already running, "onComplete" is executed immediately.

Arguments:

Evaluate "onComplete" as soon as the server has booted. This method assumes the server is being booted explicitly through a separate boot call. If the server is already running, "onComplete" is executed immediately.

Arguments:

boot the remote server, create new allocators.

Arguments:

Discussion:

N.B. You cannot boot a server app on a remote machine.

quit the server application

quit and restart the server application

free all nodes in this server

query the server status

server sends notifications, for example if a node was created, a 'tr' message from a SendTrig, or a /done action. if flag is set to false, these messages are not sent. The default is true.

measure the time between server and client, which may vary. the func is evaluated after n number of times and is passed the resulting maximum.

Get or set this Server's ServerOptions object. Changes take effect when the server is rebooted.

Returns:

Get an instance of Volume that runs after the defualt group, or sets the Volume of the Server's output to level. Level is in db.

mute the server's output. This can also be toggled from the Server window with the 'm' key.

unmute the server. This can also be toggled from the Server window with the 'm' key.

Move the nodes in nodeList to the location specified by target and addAction, placing them there in the order indicated by nodeList.

Discussion:

Any nodes which have already been freed will be skipped. Passing nil for target and addAction will result in the location being the head of the default group.

g = Group.new;
x = Array.fill(5, {Synth(\default)});
s.queryAllNodes;
s.reorder(x, g, \addToTail);
s.queryAllNodes;

Return a Bus object that represents the input audio bus.

Return a Bus object that represents the output audio bus.

Arguments:

Post a representation of this Server's current node tree to the post window. See -plotTree for a graphical variant.

Discussion:

Very helpful for debugging. For local servers this uses g_dumpTree and for remote g_queryTree. See Group and Server Command Reference for more info.

s.boot;
s.queryAllNodes; // note the root node (ID 0) and the default group (ID 1)
s.quit;

Get peak and average CPU usage.

Get number of running Synths.

Get number of Groups.

Get number of running UGens.

Get number of loaded SynthDefinitions.

Get process ID of running server (if not internal).

Returns true if a ServerShmInterface is available. See also Synchronous Control Bus Methods.

Discussion:

The shared memory interface is initialized after first server boot.

The Function func is evaluated, and all OSC messages generated by it are deferred and added to a bundle.

Arguments:

Returns:

Discussion:

Calling sync inside func will split the bundle and wait for asynchronous actions to complete before continuing.

If an error is encountered while evaluating func this method will throw an Error and stop message deferral.

s.boot;
(
// send a synth def to server
SynthDef("tpulse", { arg out=0,freq=700,sawFreq=440.0;
	Out.ar(out, SyncSaw.ar(freq,  sawFreq,0.1) )
}).add;
)

// all OSC commands generated in the function contained below will be added to a bundle
// and executed simultaneously after 2 seconds.
(
s.makeBundle(2.0, {
	x = Synth.new("tpulse");
	a = Bus.control.set(440);
	x.map(\freq, a);
});
)
x.free;

// don't send
(
b = s.makeBundle(false, {
	x = { PinkNoise.ar(0.1) * In.kr(0, 1); }.play;
});
)
// now pass b as a pre-existing bundle, and start both synths synchronously
(
s.makeBundle(nil, { // nil executes ASAP
	y = { SinOsc.kr(0.2).abs }.play(x, 0, 0, \addBefore); // sine envelope
}, b);
)
x.free; y.free;

// Throw an Error
(
try {
	s.makeBundle(nil, {
		s.farkermartin;
	});
} { |error|
	("Look Ma, normal operations resume even though:\n" + error.errorString).postln;
	x = { FSinOsc.ar(440, 0, 0.2) }.play; // This works fine
}
)
x.free;

// use sync
(
s.makeBundle(nil, {
	b = Buffer.read(s, Help.dir +/+ "sounds/a11wlk01.wav");
	s.sync; // wait until load is done and then send the rest of the bundle
	x = { PlayBuf.ar(1, b) * 0.5 }.play;
});
)
x.free; b.free;

Just as in makeBundle, the Function func is evaluated, and all OSC messages generated by it are deferred and added to a bundle, which is sent to the server, using the server default latency.

Discussion:

(
s.bind {
	a = { |freq=100| SinOsc.ar(freq, LFTri.ar(freq)) * 0.2 }.play;
	a.set(\freq, 400);
}
)

get the current value of a shared control bus. num is the index of the bus to poll. This command is synchronous and only works with the internal server.

set the current value of a shared control bus to value. num is the index of the bus to set. This command is synchronous and only works with the internal server.

set the number of shared control buses. Must be done before the internal server is booted. The default is 1024.

This method initializes the default_group and runs ServerTree.

Discussion:

This method is called automatically when you boot a Server from the language. N.B. If you started a server app from the command line you will have to call initTree manually if you need this functionality.

s.quit;
f = {Group.new(s.defaultGroup); "Other code can be evaluated too".postln;};
ServerTree.add(f);
s.boot;
s.queryAllNodes; // note the group within the default group
ServerTree.remove(f);

ServerBoot and ServerQuit provide similar functionality at boot and quit times.

Create and show the server window. The window responds to a number of keyboard shortcuts:

key	action
n	Post a representation of this Server's current node tree to the post window. (See -queryAllNodes)
N	As 'n' above but include controls.
l	Show input/output level meters. (See -meter)
p	Show graphical view of the node tree. (See -plotTree)
(space)	Boot server if not already booted. (See -boot)
s	Show scope window. (See -scope)
f	Show frequency analyzer window. (See -freqscope)
d	Toggle dumping of OSC messages.
m	Toggle mute.
0	Reset volume to 0 db.

Open a scope window showing the output of the Server. see Stethoscope for further details.

Arguments:

Show frequency analyzer window.

Show input/output level meters.

Plot the node/group tree. As -queryAllNodes but graphical.

Allocates the necessary buffer, etc. for recording the server's output. (See record below.)

Arguments:

Discussion:

If you do not specify a path than a file will be created in your recordings folder (see the note above on this) called SC_thisDateAndTime. Changes to the header or sample format, or to the number of channels must be made before calling this.

Starts or resumes recording the output.

Arguments:

Discussion:

If you have not called prepareForRecord first (see above) then it will be invoked for you (but that adds a slight delay before recording starts for real).

Pauses recording. Can be resumed by executing record again.

Stops recording, closes the file, and frees the associated resources.

Discussion:

You must call this when finished recording or the output file will be unusable. Cmd-. while recording has the same effect.

Returns:

Get/set the number of channels (int) to record. The default is two. Must be called before prepareForRecord.

Get/set the header format (string) of the output file. The default is "aiff". Must be called before prepareForRecord.

Get/set the sample format (string) of the output file. The default is "float". Must be called before prepareForRecord.

Boot the Server and wait until it has completed before resuming the thread.

Arguments:

Send the following message to the wait until it has completed before resuming the thread.

Arguments:

Send a /sync message to the server, which will replie with the message /synced when all pending asynchronous commands have been completed.

Arguments:

Discussion:

This may be slightly less safe then sendMsgSync under UDP on a wide area network, as packets may arrive out of order, but on a local network should be okay. Under TCP this should always be safe.

(
Routine.run {
	var c;

	// create a condition variable to control execution of the Routine
	c = Condition.new;

	s.bootSync(c);
	\BOOTED.postln;

	s.sendMsgSync(c, "/b_alloc", 0, 44100, 2);
	s.sendMsgSync(c, "/b_alloc", 1, 44100, 2);
	s.sendMsgSync(c, "/b_alloc", 2, 44100, 2);
	\b_alloc_DONE.postln;
};
)

(
Routine.run {
	var c;

	// create a condition variable to control execution of the Routine
	c = Condition.new;

	s.bootSync(c);
	\BOOTED.postln;

	s.sendMsg("/b_alloc", 0, 44100, 2);
	s.sendMsg("/b_alloc", 1, 44100, 2);
	s.sendMsg("/b_alloc", 2, 44100, 2);
	s.sync(c);
	\b_alloc_DONE.postln;
};
)