API.md

API

This file lists all possible osc-messages which the server can handle.

Arc

Title	Description
Set	Sets the volume of the note	Details Path: /arc/set Arguments: [ { s,note }, // Expects a note as string { f,strength }, // Expects the strength in [0, 1] of the note as a float ]
Activate/deactivate note	Activates/deactivates a specific note	Details Path: /arc/switch/velocity Arguments: [ { s,note }, // Expects a note as string without octave at the end { i,state }, // Expects a boolean as integer ]
Activate/deactivate velocity	Activates/deactivates whether the arc instrument can send velocity for notes	Details Path: /arc/switch/velocity Arguments: [ { i,state }, // Expects a boolean as integer ]
Activate/deactivate velocity reversed mode	Activates/deactivates whether the sent velocity values are reversed	Details Path: /arc/switch/reversed Arguments: [ { i,state }, // Expects a boolean as integer ]

Box

Title	Description
Start playing a note	Triggers a note to start playing	Details Path: /box/trigger Arguments: [ { s,note }, // Expects a note as string { f,velocity }, // Expects the velocity [0,1] of the note as float ]
Detune the Box	Shift the pitch of all notes	Details Path: /box/detune Arguments: [ { i,cents }, // Expects the pitch-shift in cents as integer ]
Stop playing a note	Release a note to stop playing it	Details Path: /box/release Arguments: [ { s,note }, // Expects a note as string ]
Set the volume of the Box	Set the instrument-level volume	Details Path: /box/setVolume Arguments: [ { f,loudness }, // Expects the new loudness [0,1] as float ]
Switch Sound	Switch the sound of the box instrument	Details Path: /box/switch Arguments: [ { s,sound }, // Expects either "synth" or "kalimba" as string argument ]

Cello

Title	Description
Set	Sets the volume of the note	Details Path: /cello/set Arguments: [ { s,note }, // Expects a note as string { f,velocity }, // Expects the strength in [0, 1] of the note as a float ]

Drums

Title	Description
Play Snare	Plays the snare from the snare sampler	Details Path: /drums/snare Arguments: [ { s,duration }, // Expects the duration of the snare note as string { f,velocity }, // Expects the velocity of the snare note as float ]
Play Kick	Plays the basedrum (kick) from the kick sampler	Details Path: /drums/kick Arguments: [ { s,duration }, // Expects the duration of the kick note as string { f,velocity }, // Expects the velocity of the kick note as float ]
Play HiHat	Plays the HiHat from the hihat synth	Details Path: /drums/hihat Arguments: [ { s,duration }, // Expects the duration of the hihat note as string { f,velocity }, // Expects the velocity of the hihat note as float ]

Effects

Title	Description
Switch Instrument Reverb Effect	Adds/removes reverb effect for specified instrument	Details Path: /effect/instrument/reverb Arguments: [ { s,name }, // Expects the name of the instrument as string { i,state }, // Expects 1 (on) or 0 (off) as integer (boolean) ]
Switch Instrument Autofilter Effect	Adds/removes autofilter effect for specified instrument	Details Path: /effect/instrument/autofilter Arguments: [ { s,name }, // Expects the name of the instrument as string { i,state }, // Expects 1 (on) or 0 (off) as integer (boolean) ]
Switch Instrument AutoWah Effect	Adds/removes AutoWah effect for specified instrument	Details Path: /effect/instrument/autowah Arguments: [ { s,name }, // Expects the name of the instrument as string { i,state }, // Expects 1 (on) or 0 (off) as integer (boolean) ]
Switch Instrument chorus Effect	Adds/removes chorus effect for specified instrument	Details Path: /effect/instrument/chorus Arguments: [ { s,name }, // Expects the name of the instrument as string { i,state }, // Expects 1 (on) or 0 (off) as integer (boolean) ]
Switch Instrument PingPongDeleay Effect	Adds/removes pingpongdelay effect for specified instrument	Details Path: /effect/instrument/pingpongdelay Arguments: [ { s,name }, // Expects the name of the instrument as string { i,state }, // Expects 1 (on) or 0 (off) as integer (boolean) ]
Switch Master Reverb Effect	Adds/removes reverb effect to/from master output	Details Path: /effect/master/reverb Arguments: [ { i,state }, // Expects 1 (on) or 0 (off) as integer (boolean) ]
Switch Master PingPongDeleay Effect	Adds/removes pingpongdelay effect to/from master output	Details Path: /effect/master/pingpongdelay Arguments: [ { i,state }, // Expects 1 (on) or 0 (off) as integer (boolean) ]
Switch Master Chorus Effect	Adds/removes chorus effect to/from master output	Details Path: /effect/master/chorus Arguments: [ { i,state }, // Expects 1 (on) or 0 (off) as integer (boolean) ]
Change Decay Master Reverb Effect	Changes the decay of the master reverb effect	Details Path: /effect/master/reverb/decay Arguments: [ { f,seconds }, // Expects seconds (> 0) as float value ]
Change Dry/Wet Master Reverb Effect	Changes the dry/wet ration of the master reverb effect	Details Path: /effect/master/reverb/wet Arguments: [ { f,ratio }, // Expects the ratio for the wet signal as float value between [0,1] ]
Change Delay Time Master PingPongDelay Effect	Changes the delay time between consecutive echos of the master pingpongdelay effect	Details Path: /effect/master/pingpongdelay/delay Arguments: [ { f,delay }, // Expects the delay in seconds (> 0) as float value ]
Change Feedback Master PingPongDelay Effect	Changes the amount of the effected signal which is fed back through the master pingpongdelay effect	Details Path: /effect/master/pingpongdelay/feedback Arguments: [ { f,feedback }, // Expects a float value between [0,1] ]
Switch Master EQ Effect	Adds/removes EQ effect to/from master output	Details Path: /effect/master/eq Arguments: [ { i,state }, // Expects 1 (on) or 0 (off) as integer (boolean) ]
Change High Gain Master	Changes the gain applied to the high of the master output	Details Path: /effect/master/eq/high Arguments: [ { i,decibel }, // Expects an integer between [-20,10] ]
Change Mid Gain Master	Changes the gain applied to the mid of the master output	Details Path: /effect/master/eq/mid Arguments: [ { i,decibel }, // Expects an integer between [-20,10] ]
Change Low Gain Master	Changes the gain applied to the low of the master output	Details Path: /effect/master/eq/low Arguments: [ { i,decibel }, // Expects an integer between [-20,10] ]
Switch Instrument EQ Effect	Adds/removes EQ effect for specified instrument	Details Path: /effect/instrument/eq Arguments: [ { s,name }, // Expects the name of the instrument as string { i,state }, // Expects 1 (on) or 0 (off) as integer (boolean) ]
Change High Gain Instrument	Changes the gain applied to the high of the output of the specified instrument	Details Path: /effect/instrument/eq/high Arguments: [ { s,name }, // Expects the name of the instrument as string { i,decibel }, // Expects an integer between [-20,10] ]
Change High Mid Instrument	Changes the gain applied to the mid of the output of the specified instrument	Details Path: /effect/instrument/eq/mid Arguments: [ { s,name }, // Expects the name of the instrument as string { i,decibel }, // Expects an integer between [-20,10] ]
Change Low Gain Instrument	Changes the gain applied to the low of the output of the specified instrument	Details Path: /effect/instrument/eq/low Arguments: [ { s,name }, // Expects the name of the instrument as string { i,decibel }, // Expects an integer between [-20,10] ]

Mat

Title	Description
Play a note	Plays a note for a fixed duration	Details Path: /mat/play Arguments: [ { i,buttonIndex }, // Expects a button index as integer { f,velocity }, // Expects the velocity [0,1] of the note as float ]
Start playing a note	Triggers a note to start playing	Details Path: /mat/trigger Arguments: [ { i,index }, // Expects an index between 0 and 7 as integer { f,velocity }, // Expects the velocity [0,1] of the note as float ]
Stop playing a note	Release a note to stop playing it	Details Path: /mat/release Arguments: [ { i,index }, // Expects an index between 0 and 7 as integer ]
Octave change	Changes the octave of all the playable notes	Details Path: /mat/change_octave Arguments: [ { i,octave }, // Expects a octave as integer value between 1 and 5 ]
Root note change	Changes the root note of the scale	Details Path: /mat/change_root Arguments: [ { s,note }, // Expects a note without octave (e.g. 'C' or 'Db') as string ]
Scale change	Changes the scale	Details Path: /mat/change_scale Arguments: [ { s,scale }, // Expects the scale as string (e.g. 'major' or 'minor') ]
Swap two button's notes	Swaps the notes that are assigned to the buttons with the provided indices	Details Path: /mat/swap Arguments: [ { i,buttonIndex }, // Expects a button index as integer { i,buttonIndex }, // Expects a button index as integer ]
Switch Chord Mode	Activates/deactivates chord mode	Details Path: /mat/chords Arguments: [ { i,state }, // Expects a boolean that expresses whether chords should be played or not ]
Switch Sound	Switch the sound of the mat instrument	Details Path: /mat/switch Arguments: [ { s,sound }, // Expects either "synth" or "sawtooth" as string argument ]

Piano

Title	Description
Play Note	Plays a note from the piano sampler	Details Path: /piano/play_note Arguments: [ { s,note }, // Expects a note as string { s,duration }, // Expects the duration of the note as string { f,velocity }, // Expects the velocity [0,1] of the note as float ]

PlayNoteSynth

Title	Description
Plays a note	Trigger and Release a note	Details Path: /play_note Arguments: [ { s,note }, // Expects a note as string { s,duration }, // Expects the duration of the note as string { f,velocity }, // Expects the velocity [0,1] of the note as float ]
Start playing a note	Triggers a note to start playing	Details Path: /play_note/trigger Arguments: [ { s,index }, // Expects a note as a string { f,velocity }, // Expects the velocity [0,1] of the note as float ]
Detune the PlayNoteSynth	Shift the pitch of all notes	Details Path: /play_note/detune Arguments: [ { i,cents }, // Expects the pitch-shift in cents as integer ]
Stop playing a note	Release a note to stop playing it	Details Path: /play_note/release Arguments: [ { s,index }, // Expects a note as string ]