- Source:
Methods
group(group)
Assign instrument to a library group.
Parameters:
Name | Type | Description |
---|---|---|
group |
string |
- Source:
description(description)
Give the instrument a description.
Parameters:
Name | Type | Description |
---|---|---|
description |
string |
- Source:
author(author)
Denote the author of the instrument, if applicable.
Parameters:
Name | Type | Description |
---|---|---|
author |
string |
- Source:
url(url)
Set website of the instrument, if applicable.
Parameters:
Name | Type | Description |
---|---|---|
url |
string |
- Source:
documentationUrl(documentationUrl)
Set documentation URL.
Parameters:
Name | Type | Description |
---|---|---|
documentationUrl |
string |
- Source:
options(options)
Options that should be passed to the builder function at runtime.
Parameters:
Name | Type | Description |
---|---|---|
options |
object |
- Source:
defaultOptions(defaultOptions)
Default options passed to builder function at runtime; overridden by #options
.
Parameters:
Name | Type | Description |
---|---|---|
defaultOptions |
object |
- Source:
suggestedOctave(suggestedOctave)
Octave most relevant to the instrument's pitch and timbre.
Parameters:
Name | Type | Description |
---|---|---|
suggestedOctave |
integer |
- Source:
fn(defaultOptions)
Set runtime builder function that returns an Web Audio Node.
Parameters:
Name | Type | Description |
---|---|---|
defaultOptions |
object |
- Source:
pitchAliases(pitchAliases)
Map of pitch aliases, for example "snare" may refer to "c4".
Parameters:
Name | Type | Description |
---|---|---|
pitchAliases |
object |
- Source: