Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Pitch

Hierarchy

  • Pitch

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private accidental

accidental: AccidentalEnum = AccidentalEnum.NONE

Private accidentalXml

accidentalXml: string

Private frequency

frequency: number

Private fundamentalNote

fundamentalNote: NoteEnum

Private halfTone

halfTone: number

Private octave

octave: number

Static Private halftoneFactor

halftoneFactor: number = ...

Static Private octXmlDiff

octXmlDiff: number = 3

Static pitchEnumValues

pitchEnumValues: NoteEnum[] = ...

Accessors

Accidental

AccidentalHalfTones

  • get AccidentalHalfTones(): number

AccidentalXml

  • get AccidentalXml(): string

Frequency

  • get Frequency(): number

FundamentalNote

Octave

  • get Octave(): number

ToStringShortGet

  • get ToStringShortGet(): string

Static OctaveXmlDifference

  • get OctaveXmlDifference(): number

Methods

DoEnharmonicChange

  • DoEnharmonicChange(): void

OperatorEquals

  • OperatorEquals(p2: Pitch): boolean

OperatorFundamentalGreaterThan

  • OperatorFundamentalGreaterThan(p2: Pitch): boolean

OperatorFundamentalLessThan

  • OperatorFundamentalLessThan(p2: Pitch): boolean

OperatorNotEqual

  • OperatorNotEqual(p2: Pitch): boolean

ToString

  • ToString(): 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

getHalfTone

  • getHalfTone(): number

Private getHigherPitchByTransposeFactor

  • getHigherPitchByTransposeFactor(factor: number): Pitch

Private getLowerPitchByTransposeFactor

  • getLowerPitchByTransposeFactor(factor: number): Pitch

Private getNextFundamentalNote

Private getPreviousFundamentalNote

getTransposedPitch

  • getTransposedPitch(factor: number): Pitch

Static AccidentalFromHalfTones

Static CalculateTransposedHalfTone

  • 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!)

    • halftone: number
    • overflow: number

Static HalfTonesFromAccidental

Static WrapAroundCheck

  • 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 }

    • halftone: number
    • overflow: number

Static accidentalVexflow

  • 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

    Returns string

    Vexflow Accidental code

Static calcFractionalKey

  • calcFractionalKey(frequency: number): number

Static calcFrequency

  • calcFrequency(obj: number | Pitch): number

Static ceiling

Static floor

Static fromFrequency

  • fromFrequency(frequency: number): Pitch

Static fromHalftone

  • fromHalftone(halftone: number): Pitch

Static getNoteEnumString

  • getNoteEnumString(note: NoteEnum): string

Static lineShiftFromNoteEnum

  • 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

    Returns [NoteEnum, number]

Generated using TypeDoc