Class Pitch

constructor

• new Pitch(
      fundamentalNote: NoteEnum,
      octave: number,
      accidental: AccidentalEnum,
      accidentalXml?: string,
      isRest?: boolean,
      octaveShiftApplied?: boolean,
  ): Pitch

  Parameters

  • fundamentalNote: NoteEnum
  • octave: number
  • accidental: AccidentalEnum
  • accidentalXml: string = undefined
  • isRest: boolean = false
  • octaveShiftApplied: boolean = undefined

  Returns Pitch

OctaveShiftApplied

StaticpitchEnumValues

Accidental

• get Accidental(): AccidentalEnum

  Returns AccidentalEnum

AccidentalHalfTones

• get AccidentalHalfTones(): number

  Returns number

AccidentalXml

• get AccidentalXml(): string

  Returns string

Frequency

• get Frequency(): number

  Returns number

FundamentalNote

• get FundamentalNote(): NoteEnum

  Returns NoteEnum

Octave

• get Octave(): number

  Returns number

ToStringShortGet

• get ToStringShortGet(): string

  A shortcut getter for ToStringShort that can be useful for debugging.

  Returns string

StaticOctaveXmlDifference

• get OctaveXmlDifference(): number

  Returns number

DoEnharmonicChange

• DoEnharmonicChange(): void

  Returns void

getHalfTone

• getHalfTone(): number

  Returns number

getTransposedPitch

• getTransposedPitch(factor: number): Pitch

  Parameters

  • factor: number

  Returns Pitch

OperatorEquals

• OperatorEquals(p2: Pitch): boolean

  Parameters

  • p2: Pitch

  Returns boolean

OperatorFundamentalGreaterThan

• OperatorFundamentalGreaterThan(p2: Pitch): boolean

  Parameters

  • p2: Pitch

  Returns boolean

OperatorFundamentalLessThan

• OperatorFundamentalLessThan(p2: Pitch): boolean

  Parameters

  • p2: Pitch

  Returns boolean

OperatorNotEqual

• OperatorNotEqual(p2: Pitch): boolean

  Parameters

  • p2: Pitch

  Returns boolean

ToString

• ToString(): string

  Returns string

ToStringShort

• ToStringShort(octaveOffset?: number): string

  A short representation of the note like A4 (A, octave 4), Ab5 or C#4.

  Parameters

  • octaveOffset: number = 0

  Returns string

StaticAccidentalFromHalfTones

• AccidentalFromHalfTones(halfTones: number): AccidentalEnum

  Parameters

  • halfTones: number

  Returns AccidentalEnum

StaticaccidentalVexflow

• accidentalVexflow(accidental: AccidentalEnum): string

  Converts AccidentalEnum to a string which represents an accidental in VexFlow Can also be useful in other cases, but has to match Vexflow accidental codes.

  Parameters

  • accidental: AccidentalEnum

  Returns string

  Vexflow Accidental code

StaticcalcFractionalKey

• calcFractionalKey(frequency: number): number

  Parameters

  • frequency: number

  Returns number

StaticcalcFrequency

• calcFrequency(obj: number | Pitch): number

  Parameters

  • obj: number | Pitch

  Returns number

StaticCalculateTransposedHalfTone

• CalculateTransposedHalfTone(
      pitch: Pitch,
      transpose: number,
  ): { halftone: number; overflow: number }

  Parameters

  • pitch: Pitch
  • transpose: number

  Returns { halftone: number; overflow: number }

  ret[0] = the transposed fundamental. ret[1] = the octave shift (not the new octave!)

Staticceiling

• ceiling(halftone: number): NoteEnum

  Parameters

  • halftone: number

  Returns NoteEnum

Staticfloor

• floor(halftone: number): NoteEnum

  Parameters

  • halftone: number

  Returns NoteEnum

StaticfromFrequency

• fromFrequency(frequency: number): Pitch

  Parameters

  • frequency: number

  Returns Pitch

StaticfromHalftone

• fromHalftone(halftone: number): Pitch

  Parameters

  • halftone: number

  Returns Pitch

StaticgetNoteEnumString

• getNoteEnumString(note: NoteEnum): string

  Parameters

  • note: NoteEnum

  Returns string

StaticHalfTonesFromAccidental

• HalfTonesFromAccidental(accidental: AccidentalEnum): number

  Turns an AccidentalEnum into half tone steps for pitch calculation.

  Parameters

  • accidental: AccidentalEnum

  Returns number

StaticlineShiftFromNoteEnum

• lineShiftFromNoteEnum(noteEnum: NoteEnum, lines: number): [NoteEnum, number]

  Changes a note x lines/steps up (+) or down (-) from a NoteEnum on a staffline/keyboard (white keys). E.g. Two lines down (-2) from a D is a B. Two lines up from an A is a C. (e.g. in the treble/violin clef, going one line up: E -> F (semitone), F -> G (2 semitones)). Returns new NoteEnum and the octave shift (e.g. -1 = new octave is one octave down).

  Parameters

  • noteEnum: NoteEnum
  • lines: number

  Returns [NoteEnum, number]

StaticWrapAroundCheck

• WrapAroundCheck(
      value: number,
      limit: number,
  ): { halftone: number; overflow: number }

  Returns the fundamental note x (0 <= x <= 11, e.g. 0 = C) with octave change/overflow. The halftone will be one of the values in the enum NoteEnum, converted to number here as we need numbers for calculation.

  Parameters

  • value: number
  • limit: number

  Returns { halftone: number; overflow: number }