Use-chromatone documentation / Exports / MIDI
Module: MIDI
Table of contents
Interfaces
Variables
Functions
Variables
midi
• Const midi: MidiInterface
Defined in
Functions
forwardMidi
▸ forwardMidi(iid, oid): void
Sets a forwarding route from an Input to an Output
Parameters
| Name | Type | Description |
|---|---|---|
iid | string | Input ID |
oid | string | Output ID |
Returns
void
Defined in
learnCC
▸ learnCC(«destructured»): Ref<number>
Parameters
| Name | Type |
|---|---|
«destructured» | Object |
› channel | number |
› number | number |
Returns
Ref<number>
Defined in
midiAttack
▸ midiAttack(note, options): void
Parameters
| Name | Type |
|---|---|
note | Object |
note.channel | number |
note.number | string | number |
options | Object |
options.attack? | number |
options.channels? | number | number[] |
options.duration? | number |
options.rawAttack? | number |
options.rawRelease? | number |
options.release? | number |
options.time? | string | number |
Returns
void
Defined in
midiOnce
▸ midiOnce(note, options?): void
Parameters
| Name | Type |
|---|---|
note | string | number | string[] | number[] | Note | Note[] |
options? | Object |
options.attack? | any |
options.channels | number | number[] |
options.duration? | number |
options.rawAttack? | number |
options.rawRelease | number |
options.release | number |
options.time | string | number |
Returns
void
Defined in
midiPlay
▸ midiPlay(note, options?): void
Parameters
| Name | Type |
|---|---|
note | string | number | string[] | number[] | Note | Note[] |
options? | Object |
options.attack? | number |
options.channels? | number | number[] |
options.duration? | number |
options.rawAttack? | number |
options.rawRelease? | number |
options.release? | number |
options.time? | string | number |
Returns
void
Defined in
midiRelease
▸ midiRelease(note): void
Parameters
| Name | Type |
|---|---|
note | Object |
note.channel | number |
note.number | string | number |
Returns
void
Defined in
midiStop
▸ midiStop(note?, options?): void
Parameters
| Name | Type |
|---|---|
note? | string | number | string[] | number[] | Note | Note[] |
options? | Object |
options.channels? | number | number[] |
options.rawRelease? | number |
options.release? | number |
options.time? | string | number |
Returns
void
Defined in
playKey
▸ playKey(name, offset?, off?, velocity?, duration?): void
Parameters
| Name | Type | Default value |
|---|---|---|
name | string | undefined |
offset | number | 0 |
off? | boolean | undefined |
velocity | number | 1 |
duration? | number | undefined |
Returns
void
Defined in
setCC
▸ setCC(cc, value): void
Parameters
| Name | Type |
|---|---|
cc | Object |
cc.channel | Object |
cc.channel.channels? | number | number[] |
cc.channel.time? | string | number |
cc.number | string | number |
value | number |
Returns
void
Defined in
sortNotes
▸ sortNotes(notes, reverse?): any[]
Parameters
| Name | Type | Default value |
|---|---|---|
notes | Note | undefined |
reverse | boolean | false |
Returns
any[]
Defined in
stopAll
▸ stopAll(): void
Returns
void
Defined in
useMidi
▸ useMidi(): Object
Returns
Object
| Name | Type |
|---|---|
midi | MidiInterface |
midiAttack | (note: { channel: number ; number: string | number }, options: { attack?: number ; channels?: number | number[] ; duration?: number ; rawAttack?: number ; rawRelease?: number ; release?: number ; time?: string | number }) => void |
midiOnce | (note: string | number | string[] | number[] | Note | Note[], options?: { attack?: any ; channels: number | number[] ; duration?: number ; rawAttack?: number ; rawRelease: number ; release: number ; time: string | number }) => void |
midiPlay | (note: string | number | string[] | number[] | Note | Note[], options?: { attack?: number ; channels?: number | number[] ; duration?: number ; rawAttack?: number ; rawRelease?: number ; release?: number ; time?: string | number }) => void |
midiRelease | (note: { channel: number ; number: string | number }) => void |
midiStop | (note?: string | number | string[] | number[] | Note | Note[], options?: { channels?: number | number[] ; rawRelease?: number ; release?: number ; time?: string | number }) => void |
setCC | (cc: { channel: { channels?: number | number[] ; time?: string | number } ; number: string | number }, value: number) => void |