Interface BrailleOptions

When true (and multiStaff is active), use bar-over-bar format instead of sequential multi-staff layout. Bar-over-bar vertically aligns measures between staves, with measure numbers at the left margin and a music heading (key/time) centered above the first parallel. BANA standard format for keyboard music (Music Braille Code 2015, Chapter 28 + Par. 29.3).

Default: false (uses sequential M8a format).

Whether to generate debug/translation info. Default: true

When true, render as an ensemble score with instrument abbreviations and all chord intervals reading upward (Music Braille Code 2015, Chapter 33). Each instrument gets its own line in each parallel, with abbreviation prefix. Measure numbers appear in a free line above each parallel.

Must be set explicitly — not auto-detected, since MusicXML often splits keyboard instruments into separate parts which would be falsely detected.

Default: false.

Output format. Default: "nonfacsimile"

The rendered graphical sheet. Required for facsimile mode. Available from osmd.GraphicSheet after calling render(). Provides system layout information for line-break placement.

Maximum cells per braille line in bar-over-bar mode. Default: 40 (standard braille display width).

When true, render with lyrics in word-line + music-line parallel format (Music Braille Code 2015, Section 35). Word line (literary braille) at cell 1, music line indented 2 cells.

Must be set explicitly — not auto-detected, since many instrumental scores carry stray lyric metadata that would falsely trigger it.

Default: false.

When true, render all staves (e.g. both hands for piano) with hand sign prefixes. Each staff is rendered on its own line, separated by newlines. RH (staff 0) gets right-hand sign, LH (staff 1) gets left-hand sign. Key/time signatures are rendered only on the first (RH) line.

Default: auto-detected. If staffIndex is not explicitly set and the score has multiple staves, multi-staff mode is enabled automatically. Set to false to force single-staff output (renders staffIndex only).

Which staff to render (0-based). Default: 0. Ignored when multiStaff is true.