.. _moduleSearchLyrics: music21.search.lyrics ===================== .. WARNING: DO NOT EDIT THIS FILE: AUTOMATICALLY GENERATED. PLEASE EDIT THE .py FILE DIRECTLY. .. automodule:: music21.search.lyrics LyricSearcher ------------- .. autoclass:: music21.search.lyrics.LyricSearcher .. rubric:: :class:`~music21.search.lyrics.LyricSearcher` read-only properties .. autoattribute:: music21.search.lyrics.LyricSearcher.indexText .. autoattribute:: music21.search.lyrics.LyricSearcher.indexTuples .. rubric:: :class:`~music21.search.lyrics.LyricSearcher` methods .. automethod:: music21.search.lyrics.LyricSearcher.index .. automethod:: music21.search.lyrics.LyricSearcher.search IndexedLyric ------------ .. autoclass:: music21.search.lyrics.IndexedLyric .. rubric:: :class:`~music21.search.lyrics.IndexedLyric` bases - :class:`~music21.search.lyrics.IndexedLyric` .. rubric:: :class:`~music21.search.lyrics.IndexedLyric` methods .. automethod:: music21.search.lyrics.IndexedLyric.modify .. rubric:: :class:`~music21.search.lyrics.IndexedLyric` instance variables .. attribute:: IndexedLyric.absoluteEnd the end position in all the lyrics .. attribute:: IndexedLyric.absoluteStart the position, not in the current identifier, but in all the lyrics .. attribute:: IndexedLyric.el the element that the lyric is attached to .. attribute:: IndexedLyric.end Suppose that the entire lyric for the stream were a single string: this is the index of the position in the string that this lyric ends at. .. attribute:: IndexedLyric.identifier The identifier of the lyric .. attribute:: IndexedLyric.lyric The :class:`~music21.note.Lyric` object itself .. attribute:: IndexedLyric.measure The measureNumber of the measure that the element is in in the stream. Same as .el.measureNumber .. attribute:: IndexedLyric.start Suppose that the entire lyric for the stream were a single string: this is the index of the position in the string that this lyric starts at. .. attribute:: IndexedLyric.text The text of the lyric as a string. SearchMatch ----------- .. autoclass:: music21.search.lyrics.SearchMatch .. rubric:: :class:`~music21.search.lyrics.SearchMatch` bases - :class:`~music21.search.lyrics.SearchMatch` .. rubric:: :class:`~music21.search.lyrics.SearchMatch` instance variables .. attribute:: SearchMatch.els A list of all lyric-containing elements that matched this text. .. attribute:: SearchMatch.identifier The identifier of (presumably all, but at least the first) lyric to match. .. attribute:: SearchMatch.indices A list of IndexedLyric objects that match. .. attribute:: SearchMatch.mEnd The measureNumber of the measure that the last matching lyric is in. .. attribute:: SearchMatch.mStart The measureNumber of the measure that the first matching lyric is in. .. attribute:: SearchMatch.matchText The text of the lyric that matched the search. For a plaintext search, this will be the same as the search term, but for a regular expression search this will be the text that matched the regular expression.