HelpSource/Guides/OSC_commands.schelp

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