92 lines
2 KiB
Text
92 lines
2 KiB
Text
|
#lang scribble/manual
|
||
|
|
@(require (for-label racket))
|
||
|
|
|
||
|
|
@title{NodeWatcher}
|
||
|
|
notify sc-lang side node objects of their server sided state@section{related}
|
||
|
|
Reference/Server-Command-Reference, Classes/Node, Classes/DebugNodeWatcher
|
||
|
|
@section{categories}
|
||
|
|
Control, Server>Nodes
|
||
|
|
|
||
|
|
@section{description}
|
||
|
|
|
||
|
|
Node instances (Synths and Groups) can be registered with the NodeWatcher.
|
||
|
|
It watches for server node status messages:
|
||
|
|
n_go n_end n_off n_on
|
||
|
|
|
||
|
|
and sets the isPlaying and isRunning variables on the Node instance accordingly. A Node that ends is unregistered at that time.
|
||
|
|
|
||
|
|
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.
|
||
|
|
Note that server notification should be on. (this is default. see: aServer.notify)
|
||
|
|
|
||
|
|
|
||
|
|
@racketblock[
|
||
|
|
//the most common use:
|
||
|
|
NodeWatcher.register(aNode);
|
||
|
|
::
|
||
|
|
|
||
|
|
]
|
||
|
|
@section{ClassMethods}
|
||
|
|
|
||
|
|
|
||
|
|
@section{private}
|
||
|
|
initClass
|
||
|
|
|
||
|
|
@section{method}
|
||
|
|
new
|
||
|
|
Create a new instance listening to the server's address
|
||
|
|
|
||
|
|
@section{method}
|
||
|
|
newFrom
|
||
|
|
Create a new instance listening to the server's address. If there is one present already return that one.
|
||
|
|
|
||
|
|
@section{method}
|
||
|
|
register
|
||
|
|
|
||
|
|
@section{argument}
|
||
|
|
node
|
||
|
|
Can be a Group or a Synth. The NodeWatcher is created internally.
|
||
|
|
|
||
|
|
@section{argument}
|
||
|
|
assumePlaying
|
||
|
|
If true, the node's strong::isPlaying:: field is set to true.
|
||
|
|
|
||
|
|
@section{method}
|
||
|
|
unregister
|
||
|
|
Remove the node from the list of nodes. This happens also when a node is freed.
|
||
|
|
|
||
|
|
@section{InstanceMethods}
|
||
|
|
|
||
|
|
|
||
|
|
@section{method}
|
||
|
|
start
|
||
|
|
Add the OSCFunc to listen to the address.
|
||
|
|
|
||
|
|
@section{method}
|
||
|
|
stop
|
||
|
|
Remove the OSCFunc to stop listen to the address.
|
||
|
|
|
||
|
|
@section{Examples}
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
@racketblock[
|
||
|
|
(
|
||
|
|
b = s.makeBundle(false, {
|
||
|
|
a = Group.new(s); //create a node object
|
||
|
|
NodeWatcher.register(a); // register before creating on the server
|
||
|
|
});
|
||
|
|
)
|
||
|
|
a.isPlaying;
|
||
|
|
s.listSendBundle(nil, b); //start the node on the server
|
||
|
|
a.isPlaying;
|
||
|
|
a.isRunning;
|
||
|
|
a.run(false);
|
||
|
|
a.isRunning;
|
||
|
|
s.freeAll; //free all nodes
|
||
|
|
a.isPlaying;
|
||
|
|
a.isRunning;
|
||
|
|
::
|
||
|
|
]
|
||
|
|
|
||
|
|
|