Skip to content

Commit

Permalink
update doc for osc output
Browse files Browse the repository at this point in the history
  • Loading branch information
tmhglnd committed Nov 2, 2023
1 parent b44c39f commit b9a5a4d
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/02-instrument.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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.
Expand Down

0 comments on commit b9a5a4d

Please sign in to comment.