.. _moduleBrailleSegment:

music21.braille.segment
=======================

.. WARNING: DO NOT EDIT THIS FILE:
   AUTOMATICALLY GENERATED.
   PLEASE EDIT THE .py FILE DIRECTLY.

.. automodule:: music21.braille.segment

Functions
---------

.. autofunction:: music21.braille.segment.addGroupingAttributes

.. autofunction:: music21.braille.segment.addSegmentAttributes

.. autofunction:: music21.braille.segment.compareNoteGroupings

.. autofunction:: music21.braille.segment.extractBrailleElements

.. autofunction:: music21.braille.segment.findSegments

.. autofunction:: music21.braille.segment.fixArticulations

.. autofunction:: music21.braille.segment.getRawSegments

.. autofunction:: music21.braille.segment.prepareBeamedNotes

.. autofunction:: music21.braille.segment.prepareSlurredNotes

.. autofunction:: music21.braille.segment.setAffinityCode

.. autofunction:: music21.braille.segment.splitMeasure

.. autofunction:: music21.braille.segment.splitNoteGrouping

BrailleElementGrouping
----------------------

.. autoclass:: music21.braille.segment.BrailleElementGrouping

.. rubric:: :class:`~music21.braille.segment.BrailleElementGrouping` instance variables

.. attribute:: BrailleElementGrouping.descendingChords

	True if a :class:`~music21.chord.Chord` should be spelled
	from highest to lowest pitch
	in braille, False if the opposite is the case.

.. attribute:: BrailleElementGrouping.keySignature

	The last :class:`~music21.key.KeySignature` preceding the grouping.

.. attribute:: BrailleElementGrouping.numRepeats

	The number of times this grouping is repeated.

.. attribute:: BrailleElementGrouping.showClefSigns

	If true, clef signs are shown in braille.
	Representation of music in braille is not
	dependent upon clefs and staves, so the clef signs would be displayed
	for referential or historical purposes.

.. attribute:: BrailleElementGrouping.timeSignature

	The last :class:`~music21.meter.TimeSignature` preceding the grouping.

.. attribute:: BrailleElementGrouping.withHyphen

	If True, this grouping will end with a music hyphen.

BrailleGrandSegment
-------------------

.. autoclass:: music21.braille.segment.BrailleGrandSegment

.. rubric:: :class:`~music21.braille.segment.BrailleGrandSegment` methods

.. automethod:: music21.braille.segment.BrailleGrandSegment.combineGroupingKeys

.. automethod:: music21.braille.segment.BrailleGrandSegment.extractHeading

.. automethod:: music21.braille.segment.BrailleGrandSegment.extractLongExpressionGrouping

.. automethod:: music21.braille.segment.BrailleGrandSegment.extractNoteGrouping

.. automethod:: music21.braille.segment.BrailleGrandSegment.extractSignatureGrouping

.. automethod:: music21.braille.segment.BrailleGrandSegment.extractTempoTextGrouping

.. automethod:: music21.braille.segment.BrailleGrandSegment.transcribe

BrailleSegment
--------------

.. autoclass:: music21.braille.segment.BrailleSegment

.. rubric:: :class:`~music21.braille.segment.BrailleSegment` methods

.. automethod:: music21.braille.segment.BrailleSegment.addDummyRests

.. automethod:: music21.braille.segment.BrailleSegment.addMeasureNumber

.. automethod:: music21.braille.segment.BrailleSegment.consolidate

.. automethod:: music21.braille.segment.BrailleSegment.extractHeading

.. automethod:: music21.braille.segment.BrailleSegment.extractInaccordGrouping

.. automethod:: music21.braille.segment.BrailleSegment.extractLongExpressionGrouping

.. automethod:: music21.braille.segment.BrailleSegment.extractNoteGrouping

.. automethod:: music21.braille.segment.BrailleSegment.extractSignatureGrouping

.. automethod:: music21.braille.segment.BrailleSegment.extractTempoTextGrouping

.. automethod:: music21.braille.segment.BrailleSegment.transcribe

.. rubric:: :class:`~music21.braille.segment.BrailleSegment` instance variables

.. attribute:: BrailleSegment.cancelOutgoingKeySig

	If True, the previous key signature should be
	cancelled immediately before a new key signature is encountered.

.. attribute:: BrailleSegment.dummyRestLength

	For a given positive integer n, adds n "dummy rests"
	near the beginning of a segment. Designed for test purposes, as they
	are used to demonstrate measure division at the end of braille lines.

.. attribute:: BrailleSegment.endHyphen

	If True, then the last
	:class:`~music21.braille.segment.BrailleElementGrouping` of this
	segment will be followed by a music hyphen.
	The last grouping is incomplete, because a segment
	break occured in the middle of a measure.

.. attribute:: BrailleSegment.maxLineLength

	The maximum amount of braille characters that should be
	present in a line. The standard is 40 characters.

.. attribute:: BrailleSegment.measureNumberWithDot

	If True, then the initial measure number of this
	segment should be followed by a dot. This segment
	is starting in the middle of a measure.

.. attribute:: BrailleSegment.showFirstMeasureNumber

	If True, then a measure number is shown
	following the heading (if applicable) and preceding the music.

.. attribute:: BrailleSegment.showHand

	If set to "right" or "left", shows the corresponding
	hand sign at the beginning of the first line.

.. attribute:: BrailleSegment.showHeading

	If True, then a braille heading is displayed.
	See :meth:`~music21.braille.basic.transcribeHeading`
	for more details on headings.

.. attribute:: BrailleSegment.suppressOctaveMarks

	If True, then all octave marks are suppressed.
	Designed for test purposes, as octave marks were not presented
	until Chapter 7 of BMTM.
