Class BrailleChordRenderer

Converts a chord (multiple simultaneous notes in a VoiceEntry) to braille.

In braille music, chords are encoded as:

One "written note" rendered as a full note character (accidental + octave + pitch/duration + dots)
Remaining notes rendered as interval signs from the written note

The written note depends on the clef:

G clef (treble) / C clef: highest note, intervals read downward
F clef (bass): lowest note, intervals read upward

See Music Braille Code 2015, Chapter 5.

Index

Constructors

Methods

Constructors

constructor

new BrailleChordRenderer(): BrailleChordRenderer
Returns BrailleChordRenderer
- Defined in Plugins/Braille/BrailleChordRenderer.ts:32

Methods

render

render(
    notes: Note[],
    clefType: ClefEnum,
    octaveTracker: BrailleOctaveTracker,
    voiceEntry?: VoiceEntry,
    activeOctaveShift?: OctaveShift,
    forceUpward?: boolean,
): BrailleNoteResult
Render a chord to braille.
Parameters
- notes: Note[]
  All notes in the chord (from VoiceEntry.Notes[])
- clefType: ClefEnum
  The current clef (determines interval direction)
- octaveTracker: BrailleOctaveTracker
  Tracks octave context for the written note
- OptionalvoiceEntry: VoiceEntry
  Optional VoiceEntry for articulation/ornament data
- OptionalactiveOctaveShift: OctaveShift
  Optional active ottava for facsimile pitch adjustment
- OptionalforceUpward: boolean
  When true, always read intervals upward (ensemble mode, Par. 33.4.2)
Returns BrailleNoteResult
BrailleNoteResult with braille string and debug info
- Defined in Plugins/Braille/BrailleChordRenderer.ts:47