1 <!DOCTYPE html PUBLIC
"-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
4 <meta http-equiv=
"Content-Type" content=
"text/html; charset=UTF-8">
5 <meta http-equiv=
"Content-Style-Type" content=
"text/css">
7 <meta name=
"Generator" content=
"Cocoa HTML Writer">
8 <meta name=
"CocoaVersion" content=
"949.43">
9 <style type=
"text/css">
10 p
.p1
{margin: 0.0px 0.0px 0.0px 0.0px; font: 13.0px Helvetica
}
11 p
.p2
{margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco
; color: #0021e7}
12 p
.p3
{margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco
; min-height: 12.0px}
13 p
.p4
{margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica
}
14 p
.p5
{margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco
}
15 p
.p6
{margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica
; min-height: 14.0px}
16 p
.p7
{margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco
; color: #bf0000}
17 p
.p8
{margin: 0.0px 0.0px 0.0px 0.0px; font: 10.0px Monaco
; min-height: 14.0px}
18 p
.p9
{margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco
; color: #000000}
19 p
.p10
{margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco
; color: #000000; min-height: 12.0px}
20 p
.p11
{margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco
; color: #0000bf}
21 span
.s1
{color: #000000}
22 span
.s2
{text-decoration: underline
}
23 span
.Apple-tab-span
{white-space:pre
}
27 <p class=
"p1"><b>Short Overview of Server Commands
</b></p>
28 <p class=
"p2"><span class=
"s1">see also [
<a href=
"Server-Command-Reference.html"><span class=
"s2">Server-Command-Reference
</span></a>]
</span></p>
29 <p class=
"p3"><br></p>
30 <p class=
"p4"><b>Server Commands
</b></p>
31 <p class=
"p3"><br></p>
32 <p class=
"p5">/quit
</p>
33 <p class=
"p5">/notify
<span class=
"Apple-converted-space"> </span>flag
</p>
34 <p class=
"p5">/status
</p>
35 <p class=
"p5">/cmd_error flag
</p>
36 <p class=
"p5">/cmd name args ...
</p>
37 <p class=
"p5">/dumpOSC [
0: off
1: on
2: hex
3: both]
</p>
38 <p class=
"p3"><br></p>
39 <p class=
"p5">/d_recv bytes [complBytes]
</p>
40 <p class=
"p5">/d_load path [complBytes]
</p>
41 <p class=
"p5">/d_loadDir path [complBytes]
</p>
42 <p class=
"p5">/d_free defName ...
<span class=
"Apple-converted-space"> </span></p>
43 <p class=
"p3"><br></p>
44 <p class=
"p4"><b>Node:
</b></p>
45 <p class=
"p6"><br></p>
46 <p class=
"p5">/n_free nodeID ...
</p>
47 <p class=
"p5">/n_run | nodeID flag | ...
<span class=
"Apple-converted-space"> </span></p>
48 <p class=
"p5">/n_set nodeID
<span class=
"Apple-converted-space"> </span>| control value | ...
</p>
49 <p class=
"p5">/n_setn nodeID | control numCtl values.. | ...
</p>
50 <p class=
"p5">/n_fill nodeID | control numCtl value | ...
</p>
51 <p class=
"p5">/n_map
<span class=
"Apple-converted-space"> </span>nodeID | control busIndex | ...
</p>
52 <p class=
"p5">/n_mapn nodeID | control busIndex numCtl | ...
</p>
53 <p class=
"p5">/n_mapa
<span class=
"Apple-converted-space"> </span>nodeID | control busIndex | ...
</p>
54 <p class=
"p5">/n_mapan nodeID | control busIndex numCtl | ...
</p>
55 <p class=
"p3"><br></p>
56 <p class=
"p5">/n_before | movedNodeID targetNodeID | ...
</p>
57 <p class=
"p5">/n_after | movedNodeID targetNodeID | ...
</p>
58 <p class=
"p5">/n_query nodeID ...
</p>
59 <p class=
"p5">/n_trace nodeID ...
</p>
60 <p class=
"p3"><br></p>
61 <p class=
"p5">addAction:
</p>
62 <p class=
"p5">0 add to head
</p>
63 <p class=
"p5">1 add to tail
</p>
64 <p class=
"p5">2 add before
</p>
65 <p class=
"p5">3 add after
</p>
66 <p class=
"p5">4 replace
</p>
67 <p class=
"p3"><br></p>
68 <p class=
"p3"><br></p>
69 <p class=
"p5">alternative syntax for
"nodeID"</p>
70 <p class=
"p5">positionArg | nodeID
</p>
71 <p class=
"p5">"h" - head of the current group
</p>
72 <p class=
"p5">"t" - tail of the current group
</p>
73 <p class=
"p5">"u" - up. the parent of the current node.
</p>
74 <p class=
"p5">"p" - the previous node.
</p>
75 <p class=
"p5">"n" - the next node.
</p>
76 <p class=
"p3"><br></p>
77 <p class=
"p4"><b>Synth:
</b></p>
78 <p class=
"p6"><br></p>
79 <p class=
"p5">/s_new defName nodeID addAction targetNodeID | control value | ...
</p>
80 <p class=
"p7"><span class=
"s1">/s_newargs
</span>// to document.
</p>
81 <p class=
"p5">/s_get nodeID control ...
</p>
82 <p class=
"p5">/s_getn nodeID | control numControls | ...
</p>
83 <p class=
"p5">/s_noid nodeID ...
</p>
84 <p class=
"p3"><br></p>
85 <p class=
"p4"><b>Group:
</b></p>
86 <p class=
"p6"><br></p>
87 <p class=
"p5">/g_new nodeID addAction targetNodeID
</p>
88 <p class=
"p5">/g_head | groupID nodeID | ...
</p>
89 <p class=
"p5">/g_tail | groupID nodeID | ...
</p>
90 <p class=
"p5">/g_freeAll groupID ...
</p>
91 <p class=
"p5">/g_deepFree groupID ...
</p>
92 <p class=
"p5">/g_dumpTree
</p>
93 <p class=
"p5">/g_queryTree
</p>
94 <p class=
"p3"><br></p>
95 <p class=
"p4"><b>UGen:
</b></p>
96 <p class=
"p6"><br></p>
97 <p class=
"p5">/u_cmd nodeID ugenIndex string arg ...
</p>
98 <p class=
"p3"><br></p>
99 <p class=
"p4"><b>Buffer:
</b></p>
100 <p class=
"p6"><br></p>
101 <p class=
"p5">/b_alloc bufnum numFrames numChannels [complBytes]
</p>
102 <p class=
"p5">/b_allocRead bufnum path startFrame numFrames [complBytes]
</p>
103 <p class=
"p5">/b_allocReadChannel
<span class=
"Apple-converted-space"> </span>bufnum path startFrame numFrames channels [complBytes]
</p>
104 <p class=
"p5">/b_read bufnum path startFrameFile numFrames startFrameBuf numChannels leaveOpen [complBytes]
</p>
105 <p class=
"p5">/b_write bufnum path headerFormat sampleFormat numFrames startFrameBuf leaveOpen [complBytes]
<span class=
"Apple-converted-space"> </span></p>
106 <p class=
"p5">/b_readChannel bufnum path fileStartFrame numFrames bufStartFrame leaveOpen [complBytes]
</p>
107 <p class=
"p5">/b_free bufnum
<span class=
"Apple-converted-space"> </span>[complBytes]
</p>
108 <p class=
"p5">/b_zero bufnum
<span class=
"Apple-converted-space"> </span>[complBytes]
</p>
109 <p class=
"p5">/b_set bufnum | index value | ...
</p>
110 <p class=
"p5">/b_setn bufnum | startIndex numSamples values .. | ...
</p>
111 <p class=
"p5">/b_fill bufnum | startIndex numSamples value | ...
</p>
112 <p class=
"p5">/b_gen
<span class=
"Apple-converted-space"> </span>bufnum command args ...
</p>
113 <p class=
"p5">/b_close
<span class=
"Apple-converted-space"> </span>bufnum
</p>
114 <p class=
"p5">/b_query
<span class=
"Apple-converted-space"> </span>bufnum ...
<span class=
"Apple-converted-space"> </span>(returns /b_info message: /b_info bufnum numFrames numChannels sampleRate)
</p>
115 <p class=
"p5">/b_get bufnum sampleIndex ... (returns corresponding b_set message)
</p>
116 <p class=
"p5">/b_getn bufnum startIndex numFrames (returns corresponding b_setn message)
</p>
117 <p class=
"p3"><br></p>
118 <p class=
"p4"><b>Control Bus:
</b></p>
119 <p class=
"p6"><br></p>
120 <p class=
"p5">/c_set | index value | ...
</p>
121 <p class=
"p5">/c_setn | startIndex num values .. | ...
</p>
122 <p class=
"p5">/c_fill | startIndex num value | ...
<span class=
"Apple-converted-space"> </span></p>
123 <p class=
"p5">/c_get
<span class=
"Apple-converted-space"> </span>index ... (returns corresponding c_set message)
</p>
124 <p class=
"p5">/c_getn | startIndex num | ... (returns corresponding c_setn message)
</p>
125 <p class=
"p3"><br></p>
126 <p class=
"p3"><br></p>
127 <p class=
"p4"><b>Replies:
</b></p>
128 <p class=
"p6"><br></p>
129 <p class=
"p5">/done commandName
</p>
130 <p class=
"p5">/fail commandName errorMsg
</p>
131 <p class=
"p5">/late timeStamp-hiBits timeStamp-loBits execTime-hiBits execTime-loBits
</p>
132 <p class=
"p3"><br></p>
133 <p class=
"p4"><b>Notifications:
</b></p>
134 <p class=
"p3"><br></p>
135 <p class=
"p5">all notifications have the same format:
</p>
136 <p class=
"p5">cmd nodeID parentNodeID prevNodeID nextNodeID synthFlag (-
1:group
0 synth) headNodeID tailNodeID
</p>
137 <p class=
"p5">/n_go /n_end /n_on /n_off /n_move /n_info
</p>
138 <p class=
"p3"><br></p>
139 <p class=
"p4"><b>Trigger Notifications:
</b></p>
140 <p class=
"p6"><br></p>
141 <p class=
"p5">/tr nodeID triggerID value
</p>
142 <p class=
"p3"><br></p>
143 <p class=
"p4"><b>Buffer Fill Commands:
</b></p>
144 <p class=
"p6"><br></p>
145 <p class=
"p5">flag:
<span class=
"Apple-converted-space"> </span></p>
146 <p class=
"p5"><span class=
"Apple-tab-span"> </span>1: normalize
</p>
147 <p class=
"p5"><span class=
"Apple-tab-span"> </span>2: wavetable
</p>
148 <p class=
"p5"><span class=
"Apple-tab-span"> </span>4: clear and then write
</p>
149 <p class=
"p3"><br></p>
150 <p class=
"p5">sine1 flag partialAmp ...
</p>
151 <p class=
"p5">sine2 flag | partialFreq partialAmp |
</p>
152 <p class=
"p5">sine3 flag | partialFreq partialAmp partialPhase |
</p>
153 <p class=
"p5">cheby flag | amp |
</p>
154 <p class=
"p6"><br></p>
155 <p class=
"p5">copy posDest bufNumSrc posSrc numFrames
</p>
156 <p class=
"p3"><br></p>
157 <p class=
"p3"><br></p>
158 <p class=
"p4"><b>Glossary:
</b></p>
159 <p class=
"p6"><br></p>
160 <p class=
"p5">flag:
<span class=
"Apple-converted-space"> </span></p>
161 <p class=
"p5"><span class=
"Apple-tab-span"> </span>0 (false)
<span class=
"Apple-converted-space"> </span></p>
162 <p class=
"p5"><span class=
"Apple-tab-span"> </span>1 (true)
</p>
163 <p class=
"p5">complBytes:
<span class=
"Apple-converted-space"> </span></p>
164 <p class=
"p5"><span class=
"Apple-tab-span"> </span>an osc message to evaluate after completion (array): this also means command is asynchronous
</p>
165 <p class=
"p5">control:
<span class=
"Apple-converted-space"> </span></p>
166 <p class=
"p5"><span class=
"Apple-tab-span"> </span>index or name
</p>
167 <p class=
"p3"><br></p>
168 <p class=
"p5">-
1 is the equivalent of nil
</p>
169 <p class=
"p5">'nothing' is replaced by
0</p>
170 <p class=
"p3"><br></p>
171 <p class=
"p3"><br></p>
172 <p class=
"p3"><br></p>
173 <p class=
"p4"><b>CommandNumbers:
</b></p>
174 <p class=
"p8"><br></p>
175 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_none =
0,
</p>
176 <p class=
"p10"><br></p>
177 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_notify =
1,
</p>
178 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_status =
2,
</p>
179 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_quit =
3,
</p>
180 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_cmd =
4,
</p>
181 <p class=
"p10"><br></p>
182 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_d_recv =
5,
</p>
183 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_d_load =
6,
</p>
184 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_d_loadDir =
7,
</p>
185 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_d_freeAll =
8,
</p>
186 <p class=
"p10"><br></p>
187 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_s_new =
9,
</p>
188 <p class=
"p10"><span class=
"Apple-tab-span"> </span></p>
189 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_n_trace =
10,
</p>
190 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_n_free =
11,
</p>
191 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_n_run =
12,
</p>
192 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_n_cmd =
13,
</p>
193 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_n_map =
14,
</p>
194 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_n_set =
15,
</p>
195 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_n_setn =
16,
</p>
196 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_n_fill =
17,
</p>
197 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_n_before =
18,
</p>
198 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_n_after =
19,
</p>
199 <p class=
"p10"><br></p>
200 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_u_cmd =
20,
</p>
201 <p class=
"p10"><br></p>
202 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_g_new =
21,
</p>
203 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_g_head =
22,
</p>
204 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_g_tail =
23,
</p>
205 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_g_freeAll =
24,
</p>
206 <p class=
"p10"><span class=
"Apple-tab-span"> </span></p>
207 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_c_set =
25,
</p>
208 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_c_setn =
26,
</p>
209 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_c_fill =
27,
</p>
210 <p class=
"p10"><br></p>
211 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_b_alloc =
28,
</p>
212 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_b_allocRead =
29,
</p>
213 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_b_read =
30,
</p>
214 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_b_write =
31,
</p>
215 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_b_free =
32,
</p>
216 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_b_close =
33,
</p>
217 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_b_zero =
34,
</p>
218 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_b_set =
35,
</p>
219 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_b_setn =
36,
</p>
220 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_b_fill =
37,
</p>
221 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_b_gen =
38,
</p>
222 <p class=
"p10"><span class=
"Apple-tab-span"> </span></p>
223 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_dumpOSC =
39,
</p>
224 <p class=
"p10"><br></p>
225 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_c_get =
40,
</p>
226 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_c_getn =
41,
</p>
227 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_b_get =
42,
</p>
228 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_b_getn =
43,
</p>
229 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_s_get =
44,
</p>
230 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_s_getn =
45,
</p>
231 <p class=
"p10"><span class=
"Apple-tab-span"> </span></p>
232 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_n_query =
46,
</p>
233 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_b_query =
47,
</p>
234 <p class=
"p10"><br></p>
235 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_n_mapn =
48,
</p>
236 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_s_noid =
49,
</p>
237 <p class=
"p10"><br></p>
238 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_g_deepFree =
50,
</p>
239 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_clearSched =
51,
</p>
240 <p class=
"p10"><br></p>
241 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_sync =
52,
</p>
242 <p class=
"p10"><span class=
"Apple-tab-span"> </span></p>
243 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_d_free =
53,
</p>
244 <p class=
"p10"><br></p>
245 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_b_allocReadChannel =
54,
</p>
246 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_b_readChannel =
55,
</p>
247 <p class=
"p10"><span class=
"Apple-tab-span"> </span></p>
248 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_g_dumpTree =
56,
</p>
249 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_g_queryTree =
57,
</p>
250 <p class=
"p10"><br></p>
251 <p class=
"p10"><span class=
"Apple-tab-span"> </span></p>
252 <p class=
"p9"><span class=
"Apple-converted-space"> </span>cmd_error =
58,
</p>
253 <p class=
"p10"><br></p>
254 <p class=
"p9"><span class=
"Apple-converted-space"> </span>cmd_s_newargs =
59,
</p>
255 <p class=
"p10"><br></p>
256 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_n_mapa =
60,
</p>
257 <p class=
"p9"><span class=
"Apple-tab-span"> </span>cmd_n_mapan =
61,
</p>
258 <p class=
"p10"><span class=
"Apple-tab-span"> </span></p>
259 <p class=
"p11"><span class=
"s1"><span class=
"Apple-tab-span"> </span></span>NUMBER_OF_COMMANDS
<span class=
"s1"> =
62</span></p>
260 <p class=
"p3"><br></p>
