diff --git a/README.md b/README.md index 3429a20..eaeff49 100644 --- a/README.md +++ b/README.md @@ -108,32 +108,32 @@ The commands supported by mod-host are: add * add an LV2 plugin encapsulated as a jack client - e.g.: add http://lv2plug.in/plugins/eg-amp 0 - instance_number must be any value between 0 ~ 9999, inclusively + e.g.: add "http://lv2plug.in/plugins/eg-amp" 0 + instance_number must be any value between 0 ~ 9990, inclusively remove * remove an LV2 plugin instance (and also the jack client) e.g.: remove 0 preset_load - * load a preset state to given effect instance + * load a preset state of an effect instance e.g.: preset_load 0 "http://drobilla.net/plugins/mda/presets#JX10-moogcury-lite" preset_save - * save a preset state from given effect instance - e.g.: preset_save 0 "My Preset" /home/user/.lv2/my-presets.lv2 mypreset.ttl + * save a preset state of an effect instance + e.g.: preset_save 0 "My Preset" "/home/user/.lv2/my-presets.lv2" "mypreset.ttl" - preset_show - * show the preset information of requested instance / URI - e.g.: preset_show 0 http://drobilla.net/plugins/mda/presets#EPiano-bright + preset_show + * show the preset information of requested URI + e.g.: preset_show "http://drobilla.net/plugins/mda/presets#EPiano-bright" connect - * connect two effect audio ports - e.g.: connect system:capture_1 effect_0:in + * connect two jack ports + e.g.: connect "system:capture_1" "effect_0:in" disconnect - * disconnect two effect audio ports - e.g.: disconnect system:capture_1 effect_0:in + * disconnect two jack ports + e.g.: disconnect "system:capture_1" "effect_0:in" bypass * toggle effect processing @@ -142,42 +142,54 @@ The commands supported by mod-host are: if bypass_value = 0 process effect param_set - * set a value to given control - e.g.: param_set 0 gain 2.50 + * set the value of a control port + e.g.: param_set 0 "gain" 2.5 param_get - * get the value of the request control - e.g.: param_get 0 gain + * get the value of a control port + e.g.: param_get 0 "gain" param_monitor - * do monitoring a effect instance control port according given condition - e.g: param_monitor 0 gain > 2.50 + * monitor a control port according to a condition + e.g: param_monitor 0 "gain" ">" 2.5 + + patch_set + * set the value of a control port + e.g.: patch_set 0 "gain" 2.5 + + patch_get + * get the value of a control port + e.g.: patch_get 0 "gain" licensee * get the licensee name for a commercial plugin e.g.: licensee 0 monitor - * open a socket port to monitoring parameters + * open a socket port for monitoring parameter changes e.g: monitor localhost 12345 1 if status = 1 start monitoring if status = 0 stop monitoring monitor_output - * request monitoring of an output control port in the feedback port - e.g.: monitor_output 0 meter + * request monitoring of an output control port (on the feedback port) + e.g.: monitor_output 0 "meter" midi_learn - * start MIDI learn for a parameter - e.g.: midi_learn 0 gain 0.0 1.0 + * start MIDI learn for a control port + e.g.: midi_learn 0 "gain" 0.0 1.0 midi_map - * map a MIDI controller to a parameter - e.g.: midi_map 0 gain 0 7 0.0 1.0 + * map a MIDI controller to a control port + e.g.: midi_map 0 "gain" 0 7 0.0 1.0 midi_unmap - * unmap the MIDI controller from a parameter - e.g.: unmap 0 gain + * unmap the MIDI controller from a control port + e.g.: midi_unmap 0 "gain" + + monitor_midi_program + * listen to MIDI program change messages (on the feedback port) + e.g.: monitor_midi_program 0 1 set_midi_program_change_pedalboard_bank_channel * set the MIDI channel which changes pedalboard banks on MIDI program change. is in the range of [0,15]. @@ -188,20 +200,24 @@ The commands supported by mod-host are: e.g.: set_midi_program_change_pedalboard_snapshot_channel 1 4 to enable listening for preset changes on channel 5 cc_map