.. _moduleBrailleSegment: music21.braille.segment ======================= .. WARNING: DO NOT EDIT THIS FILE: AUTOMATICALLY GENERATED. PLEASE EDIT THE .py FILE DIRECTLY. .. automodule:: music21.braille.segment Affinity -------- .. autoclass:: music21.braille.segment.Affinity BrailleElementGrouping ---------------------- .. autoclass:: music21.braille.segment.BrailleElementGrouping .. rubric:: :class:`~music21.braille.segment.BrailleElementGrouping` bases - :class:`~music21.prebase.ProtoM21Object` .. rubric:: :class:`~music21.braille.segment.BrailleElementGrouping` read-only properties Read-only properties inherited from :class:`~music21.prebase.ProtoM21Object`: .. hlist:: :columns: 3 - :attr:`~music21.prebase.ProtoM21Object.classSet` - :attr:`~music21.prebase.ProtoM21Object.classes` .. rubric:: :class:`~music21.braille.segment.BrailleElementGrouping` methods .. automethod:: music21.braille.segment.BrailleElementGrouping.__getitem__ Methods inherited from :class:`~music21.prebase.ProtoM21Object`: .. hlist:: :columns: 3 - :meth:`~music21.prebase.ProtoM21Object.isClassOrSubclass` .. 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` bases - :class:`~music21.braille.segment.BrailleSegment` - :class:`~music21.braille.text.BrailleKeyboard` - :class:`~music21.braille.text.BrailleText` - :class:`~music21.prebase.ProtoM21Object` .. rubric:: :class:`~music21.braille.segment.BrailleGrandSegment` read-only properties .. autoattribute:: music21.braille.segment.BrailleGrandSegment.brailleText Read-only properties inherited from :class:`~music21.prebase.ProtoM21Object`: .. hlist:: :columns: 3 - :attr:`~music21.prebase.ProtoM21Object.classSet` - :attr:`~music21.prebase.ProtoM21Object.classes` .. rubric:: :class:`~music21.braille.segment.BrailleGrandSegment` read/write properties Read/write properties inherited from :class:`~music21.braille.text.BrailleText`: .. hlist:: :columns: 3 - :attr:`~music21.braille.text.BrailleText.showHand` .. rubric:: :class:`~music21.braille.segment.BrailleGrandSegment` methods .. automethod:: music21.braille.segment.BrailleGrandSegment.extractHeading .. automethod:: music21.braille.segment.BrailleGrandSegment.extractNoteGrouping .. automethod:: music21.braille.segment.BrailleGrandSegment.transcribe .. automethod:: music21.braille.segment.BrailleGrandSegment.yieldCombinedGroupingKeys Methods inherited from :class:`~music21.braille.segment.BrailleSegment`: .. hlist:: :columns: 3 - :meth:`~music21.braille.segment.BrailleSegment.__getitem__` - :meth:`~music21.braille.segment.BrailleSegment.addDummyRests` - :meth:`~music21.braille.segment.BrailleSegment.addGroupingAttributes` - :meth:`~music21.braille.segment.BrailleSegment.addRepeatSymbols` - :meth:`~music21.braille.segment.BrailleSegment.consolidate` - :meth:`~music21.braille.segment.BrailleSegment.extractInaccordGrouping` - :meth:`~music21.braille.segment.BrailleSegment.extractLongExpressionGrouping` - :meth:`~music21.braille.segment.BrailleSegment.extractMeasureNumber` - :meth:`~music21.braille.segment.BrailleSegment.extractSignatureGrouping` - :meth:`~music21.braille.segment.BrailleSegment.extractTempoTextGrouping` - :meth:`~music21.braille.segment.BrailleSegment.fixArticulations` - :meth:`~music21.braille.segment.BrailleSegment.needsSplitToFit` - :meth:`~music21.braille.segment.BrailleSegment.showLeadingOctaveFromNoteGrouping` - :meth:`~music21.braille.segment.BrailleSegment.splitNoteGroupingAndTranscribe` Methods inherited from :class:`~music21.braille.text.BrailleKeyboard`: .. hlist:: :columns: 3 - :meth:`~music21.braille.text.BrailleKeyboard.addNoteGroupings` - :meth:`~music21.braille.text.BrailleKeyboard.makeNewLines` Methods inherited from :class:`~music21.braille.text.BrailleText`: .. hlist:: :columns: 3 - :meth:`~music21.braille.text.BrailleText.addHeading` - :meth:`~music21.braille.text.BrailleText.addInaccord` - :meth:`~music21.braille.text.BrailleText.addLongExpression` - :meth:`~music21.braille.text.BrailleText.addMeasureNumber` - :meth:`~music21.braille.text.BrailleText.addSignatures` - :meth:`~music21.braille.text.BrailleText.addToNewLine` - :meth:`~music21.braille.text.BrailleText.appendOrInsertCurrent` - :meth:`~music21.braille.text.BrailleText.makeNewLine` - :meth:`~music21.braille.text.BrailleText.optionalAddKeyboardSymbolsAndDots` - :meth:`~music21.braille.text.BrailleText.recenterHeadings` Methods inherited from :class:`~music21.prebase.ProtoM21Object`: .. hlist:: :columns: 3 - :meth:`~music21.prebase.ProtoM21Object.isClassOrSubclass` .. rubric:: :class:`~music21.braille.segment.BrailleGrandSegment` instance variables Instance variables inherited from :class:`~music21.braille.segment.BrailleSegment`: .. hlist:: :columns: 3 - :attr:`~music21.braille.segment.BrailleSegment.beginsMidMeasure` - :attr:`~music21.braille.segment.BrailleSegment.cancelOutgoingKeySig` - :attr:`~music21.braille.segment.BrailleSegment.dummyRestLength` - :attr:`~music21.braille.segment.BrailleSegment.endHyphen` - :attr:`~music21.braille.segment.BrailleSegment.lineLength` - :attr:`~music21.braille.segment.BrailleSegment.showFirstMeasureNumber` - :attr:`~music21.braille.segment.BrailleSegment.showHand` - :attr:`~music21.braille.segment.BrailleSegment.showHeading` - :attr:`~music21.braille.segment.BrailleSegment.suppressOctaveMarks` BrailleSegment -------------- .. autoclass:: music21.braille.segment.BrailleSegment .. rubric:: :class:`~music21.braille.segment.BrailleSegment` bases - :class:`~music21.braille.text.BrailleText` - :class:`~music21.prebase.ProtoM21Object` .. rubric:: :class:`~music21.braille.segment.BrailleSegment` read-only properties .. autoattribute:: music21.braille.segment.BrailleSegment.brailleText Read-only properties inherited from :class:`~music21.prebase.ProtoM21Object`: .. hlist:: :columns: 3 - :attr:`~music21.prebase.ProtoM21Object.classSet` - :attr:`~music21.prebase.ProtoM21Object.classes` .. rubric:: :class:`~music21.braille.segment.BrailleSegment` read/write properties Read/write properties inherited from :class:`~music21.braille.text.BrailleText`: .. hlist:: :columns: 3 - :attr:`~music21.braille.text.BrailleText.showHand` .. rubric:: :class:`~music21.braille.segment.BrailleSegment` methods .. automethod:: music21.braille.segment.BrailleSegment.__getitem__ .. automethod:: music21.braille.segment.BrailleSegment.addDummyRests .. automethod:: music21.braille.segment.BrailleSegment.addGroupingAttributes .. automethod:: music21.braille.segment.BrailleSegment.addRepeatSymbols .. 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.extractMeasureNumber .. automethod:: music21.braille.segment.BrailleSegment.extractNoteGrouping .. automethod:: music21.braille.segment.BrailleSegment.extractSignatureGrouping .. automethod:: music21.braille.segment.BrailleSegment.extractTempoTextGrouping .. automethod:: music21.braille.segment.BrailleSegment.fixArticulations .. automethod:: music21.braille.segment.BrailleSegment.needsSplitToFit .. automethod:: music21.braille.segment.BrailleSegment.showLeadingOctaveFromNoteGrouping .. automethod:: music21.braille.segment.BrailleSegment.splitNoteGroupingAndTranscribe .. automethod:: music21.braille.segment.BrailleSegment.transcribe Methods inherited from :class:`~music21.braille.text.BrailleText`: .. hlist:: :columns: 3 - :meth:`~music21.braille.text.BrailleText.addHeading` - :meth:`~music21.braille.text.BrailleText.addInaccord` - :meth:`~music21.braille.text.BrailleText.addLongExpression` - :meth:`~music21.braille.text.BrailleText.addMeasureNumber` - :meth:`~music21.braille.text.BrailleText.addSignatures` - :meth:`~music21.braille.text.BrailleText.addToNewLine` - :meth:`~music21.braille.text.BrailleText.appendOrInsertCurrent` - :meth:`~music21.braille.text.BrailleText.makeNewLine` - :meth:`~music21.braille.text.BrailleText.optionalAddKeyboardSymbolsAndDots` - :meth:`~music21.braille.text.BrailleText.recenterHeadings` Methods inherited from :class:`~music21.prebase.ProtoM21Object`: .. hlist:: :columns: 3 - :meth:`~music21.prebase.ProtoM21Object.isClassOrSubclass` .. rubric:: :class:`~music21.braille.segment.BrailleSegment` instance variables .. attribute:: BrailleSegment.beginsMidMeasure 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.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 occurred in the middle of a measure. .. attribute:: BrailleSegment.lineLength The maximum amount of braille characters that should be present in a line. The standard is 40 characters. .. 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. GroupingGlobals --------------- .. autoclass:: music21.braille.segment.GroupingGlobals SegmentKey ---------- .. autoclass:: music21.braille.segment.SegmentKey Functions --------- .. autofunction:: music21.braille.segment.areGroupingsIdentical .. autofunction:: music21.braille.segment.extractBrailleElements .. autofunction:: music21.braille.segment.findSegments .. autofunction:: music21.braille.segment.getRawSegments .. autofunction:: music21.braille.segment.prepareBeamedNotes .. autofunction:: music21.braille.segment.prepareSlurredNotes .. autofunction:: music21.braille.segment.setAffinityCode .. autofunction:: music21.braille.segment.setGroupingGlobals .. autofunction:: music21.braille.segment.splitMeasure .. autofunction:: music21.braille.segment.splitNoteGrouping