Class HauptstimmeJs

Entry point for exposed public API methods

Hierarchy

HauptstimmeJs

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new HauptstimmeJs(): HauptstimmeJs

- Defined in src/hauptstimme.ts:20
Returns HauptstimmeJs

Properties

Private availableChords

availableChords: ChordInterface[] = []

Private availableInstruments

availableInstruments: InstrumentInterface[] = []

Private availableScales

availableScales: ScaleInterface[] = []

Methods

getAvailableChords

getAvailableChords(): Promise<ChordInterface[]>

- Defined in src/hauptstimme.ts:49
Returns Promise<ChordInterface[]>

list of available chords

getAvailableInstruments

getAvailableInstruments(): Promise<InstrumentInterface[]>

- Defined in src/hauptstimme.ts:31
Returns Promise<InstrumentInterface[]>

list of available instruments

getAvailableScales

getAvailableScales(): Promise<ScaleInterface[]>

- Defined in src/hauptstimme.ts:40
Returns Promise<ScaleInterface[]>

list of available scales

search

search(searchRequest: SearchRequestInterface): Promise<SearchResponseInterface>

- Defined in src/hauptstimme.ts:59
Parameters
- searchRequest: SearchRequestInterface
  
  selected notes and optional root note to search for
Returns Promise<SearchResponseInterface>

list of scales and chords that match the search request parameters

Static addHalfStepsToNote

addHalfStepsToNote(note: NoteConstant, halfSteps: number): NoteConstant

- Defined in src/hauptstimme.ts:77
Parameters
- note: NoteConstant
  
  note to modulate
- halfSteps: number
  
  number of half steps to add to note
Returns NoteConstant

noteConstant after adding half steps

Static getFormattedNoteString

getFormattedNoteString(note: NoteConstant, noteArray?: NoteConstant[]): string

- Defined in src/hauptstimme.ts:68
Parameters
- note: NoteConstant
  
  the note to stringify
- Default value noteArray: NoteConstant[] = []
  
  optional param to help determine whether to sharpen or flatten intermediate notes
Returns string

string representation of note constant

Static subtractHalfStepsFromNote

subtractHalfStepsFromNote(note: NoteConstant, halfSteps: number): NoteConstant

- Defined in src/hauptstimme.ts:86
Parameters
- note: NoteConstant
  
  note to modulate
- halfSteps: number
  
  number of half steps to add to note
Returns NoteConstant

noteConstant after adding half steps

Generated using TypeDoc