midi

Type Aliases

NoteKey

type NoteKey = typeof noteKeys[number];

Defined in: midi.ts:22

---

WhiteKey

type WhiteKey = typeof whiteKeys[number];

Defined in: midi.ts:5

Variables

noteKeys

const noteKeys: readonly ["C", "C#", "D", "D#", "E", "F", "F#", "G", "G#", "A", "A#", "B"];

Defined in: midi.ts:7

---

whiteKeys

const whiteKeys: readonly ["A", "B", "C", "D", "E", "F", "G"];

Defined in: midi.ts:3

Functions

isBlackKey()

function isBlackKey(note): boolean;

Defined in: midi.ts:83

Parameters

Parameter	Type	Description
note	string | number	noteNumber: 0 ~ 127 or noteName e.g. 'C3'

Returns

boolean

---

isWhiteKey()

function isWhiteKey(note): boolean;

Defined in: midi.ts:67

Parameters

Parameter	Type	Description
note	string | number	noteNumber: 0 ~ 127 or noteName e.g. 'C3'

Returns

boolean

---

noteKey()

function noteKey(noteNumber): "A" | "B" | "C" | "D" | "E" | "F" | "G" | "C#" | "D#" | "F#" | "G#" | "A#";

Defined in: midi.ts:60

Convert noteNumber to noteKey

Parameters

Parameter	Type
noteNumber	number

Returns

"A" | "B" | "C" | "D" | "E" | "F" | "G" | "C#" | "D#" | "F#" | "G#" | "A#"

---

noteName()

function noteName(noteNumber): 
  | `A${number}`
  | `B${number}`
  | `C${number}`
  | `D${number}`
  | `E${number}`
  | `F${number}`
  | `G${number}`
  | `C#${number}`
  | `D#${number}`
  | `F#${number}`
  | `G#${number}`
  | `A#${number}`;

Defined in: midi.ts:51

Convert noteNumber to noteName C-1 = 0 G9 = 127

Parameters

Parameter	Type	Description
noteNumber	number	noteNumber

Returns

| `A${number}` | `B${number}` | `C${number}` | `D${number}` | `E${number}` | `F${number}` | `G${number}` | `C#${number}` | `D#${number}` | `F#${number}` | `G#${number}` | `A#${number}`

---

noteNumber()

function noteNumber(noteName): number;

Defined in: midi.ts:38

Convert noteName to noteNumber

Parameters

Parameter	Type
noteName	string

Returns

number

---

noteToFrequency()

function noteToFrequency(
   note, 
   detune?, 
   a4?): number;

Defined in: midi.ts:93

Parameters

Parameter	Type	Default value	Description
note	string | number	undefined	noteNumber: 0 ~ 127 or noteName e.g. 'C3'
detune	number	0	[cent]
a4	number	440	A4 frequency [Hz]

Returns

number

frequency [Hz]

---

parseNoteName()

function parseNoteName(noteName): object;

Defined in: midi.ts:24

Parameters

Parameter	Type
noteName	string

Returns

object

accidental

accidental: "" | "#" | "##" | "b" | "bb";

letter

letter: "A" | "B" | "C" | "D" | "E" | "F" | "G";

octave

octave: number;