From b9a5a4de27853a3b2ce6e8fbd52428ca773190aa Mon Sep 17 00:00:00 2001 From: tmhglnd Date: Thu, 2 Nov 2023 10:53:28 +0100 Subject: [PATCH] update doc for osc output --- docs/02-instrument.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/02-instrument.md b/docs/02-instrument.md index 5a7f8f40..3dd5eb6c 100644 --- a/docs/02-instrument.md +++ b/docs/02-instrument.md @@ -13,7 +13,7 @@ For instrument specific functions see below: ## name -Set the name for this instrument. This can be any string of 2 or more characters. The `name` is used as a reference to the instrument when the `set` method is used to call methods for a specific instrument. +Set the name for this instrument. This can be any string of 2 or more characters. The `name` is used as a reference to the instrument when the `set` method is used to call methods for a specific instrument. The name is also used to generate an OSC message that is send out from Mercury to trigger external things in sync with the instrument. **arguments** - {Name} -> an instrument name (default=null) @@ -25,6 +25,12 @@ new sample kick_909 name(alice) set alice gain(1.2) time(1/4) ``` +``` +// expected osc messages: +/bob 1 +/alice 1 +``` + ## group Set the group-name for this instrument. This can be any string of 2 or more characters. The `group` is used as reference to multiple instruments with the same groupname when the `set` method is used.