OSC Command Reference
as of: 05-nov-08
warning: OSC command set may be subject to changes.
/dumpOSC <(int) incomingMode> [<(int) outgoingMode>]
/main
quit [<(int) force=(0|1)>]
- query properties:
version | : | <(float) version> |
/sc
boot
terminate
volume <(float) vol>
allocBus ("audio"|"control") [<(int) numChannels>]
freeBus <(int) index>
allocBuf <(int) numFrames> [<(int) numChannels>]
freeBuf <(int) bufNum>
- query properties:
port | : | <(int) oscPort> |
protocol | : | <(String) protocol=("tcp"|"udp")> |
running | : | <(int) isRunning=(0|1)> |
volume | : | <(float) vol> |
masterGroup | : | <(int) masterGroup-nodeID> |
/doc
open <(String) path>
- query properties:
count | : | <(int) numberOfDocs> |
/doc/<address>
- where
<address>
is one of:
active
index/<(int) idx>
id/<(int) id>
close [<(int) force=(0|1)>]
activate
cut
copy
paste
delete
insertSilence <(long) numFrames>
replace <(String) fileName>[, <(long) fileOffset>]
editMode <(String) mode=("insert"|"overwrite"|"mix")>
- query properties:
id | : | <(int) id> |
dirty | : | <(int) isDirty=(0|1)> |
editMode | : | <(String) mode=("insert"|"overwrite"|"mix")> |
name | : | <(String) name> |
file | : | <(String) path[:path2...]> |
/doc/<address>/markers
add [ <(long) pos>, <(String) name> ] * N
- remove
span <(long) startPos> <(long) stopPos>
range <(int) startIdx> <(int) stopIdx>
at [ <(int) idx> ] * N
trackSelected <(int) selected=(0|1)>
NOTYETWORKING
- query properties:
spanStart | : | <(long) startFrame> |
spanStop | : | <(long) stopFrame> |
count | : | <(long) numberOfMarkers> |
trackSelected | : | <(int) trackSelected=(0|1)> |
- getter commands:
span <(long) startPos> <(long) stopPos> | : | T.B.A. |
range <(int) startIdx> <(int) stopIdx> | : | T.B.A. |
at [ <(int) idx> ] * N | : | T.B.A. |
indexOf [ <(long) pos> ] * N | : | T.B.A. |
/doc/<address>/audio
- query properties:
count | : | <(int) numberOfAudioTracks> |
/doc/<address>/audio/<trackIndex>
trackSelected <(int) selected=(0|1)>
NOTYETWORKING
flags <(int) flagsToSet>, <(int) flagsToClear>
pan <(float) azimuth=(0...360)>, <(float) spread=(0...1)>
- query properties:
flags | : | <(int) flags> |
trackSelected | : | <(int) selected=(0|1)> |
panAzimuth | : | <(float) azimuth=(0...360)> |
panSpread | : | <(float) spread=(0...1)> |
/doc/<address>/transport
play [<(float) rate>]
stop
- query properties:
position | : | <(long) currentFrame> |
running | : | <(int) running=(0|1)> |
/doc/<address>/timeline
position <(long) frame>
select <(long) start> <(long) stop>
view <(long) start> <(long) stop>
- query properties:
position | : | <(long) currentFrame> |
length | : | <(long) numFrames> |
selectionStart | : | <(long) startFrame> |
selectionStop | : | <(long) stopFrame> |
viewStart | : | <(long) startFrame> |
viewStop | : | <(long) stopFrame> |
rate | : | <(double) sampleRate> |
/doc/<address>/sc
- query properties:
inputGroup | : | <(int) inputGroup-nodeID> |
outputGroup | : | <(int) outputGroup-nodeID> |
diskBusIndex | : | <(int) diskBus-index> |
diskBusNumChannels | : | <(int) diskBus-numChannels> |
panBusIndex | : | <(int) panBus-index> |
panBusNumChannels | : | <(int) panBus-numChannels> |
/doc/<address>/recorder
resetHeadroom
- query properties:
recording | : | <(int) isRecording=(0|1)> |
monitoring | : | <(int) isMonitoring=(0|1)> |
headroom | : | <(float) headroomDecibels> |
length | : | <(long) recordedFrames> |
/gui
initSwing
- query properties:
swingPort | : | <(int) swingOSCPort> |
swingProtocol | : | <(String) swingOSCProtocol=("tcp"|"udp")> |
swingRunning | : | <(int) swingOSCIsRunning=(0|1)> |
/gui/menu
add <(int) id>, <(String) type=("item"|"group"|"separator"|"check")>, <(String) menuHierarchy>, [ <(String) text>, <(String) keystroke|(int) 0> ]
remove <(int) id>
querying single values
query <id> [ <(String) property> ] * N
replies with
/query.reply <id> [ <(Object) value> ] * N
getting complex objects
get <id> <... args>
replies with
/get.reply <id> <... args>