Interface: PianoInputInstance

Defined in: dom/src/piano/index.ts:69

Properties

activeNotes

activeNotes: () => number[];

Defined in: dom/src/piano/index.ts:88

The notes currently sounding, ascending.

Returns

number[]

---

destroy

destroy: () => void;

Defined in: dom/src/piano/index.ts:90

Returns

void

---

noteOff

noteOff: (note, options?) => void;

Defined in: dom/src/piano/index.ts:85

Release a note held by source.

Parameters

Parameter	Type
note	number
options?	{ source?: string; }
options.source?	string

Returns

void

---

noteOn

noteOn: (note, options?) => void;

Defined in: dom/src/piano/index.ts:80

Start a note from something other than a pointer or a shortcut: a MIDI message, an imperative call.

Parameters

Parameter	Type
note	number
options?	{ source?: string; velocity?: number; }
options.source?	string
options.velocity?	number

Returns

void

---

update

update: (options) => void;

Defined in: dom/src/piano/index.ts:74

Replace the given options. Lets a wrapper feed a fresh layout in without tearing down the listeners, which would abort a drag in progress.

Parameters

Parameter	Type
options	Partial<PianoInputOptions>

Returns

void