.. _moduleStreamIterator:

music21.stream.iterator
=======================

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

.. automodule:: music21.stream.iterator

RecursiveIterator
-----------------

.. autoclass:: music21.stream.iterator.RecursiveIterator

.. rubric:: :class:`~music21.stream.iterator.RecursiveIterator` bases

- :class:`~music21.stream.iterator.StreamIterator`

.. rubric:: :class:`~music21.stream.iterator.RecursiveIterator` read-only properties

Read-only properties inherited from :class:`~music21.stream.iterator.StreamIterator`:

.. hlist::
   :columns: 3

   - :attr:`~music21.stream.iterator.StreamIterator.notes`
   - :attr:`~music21.stream.iterator.StreamIterator.notesAndRests`

.. rubric:: :class:`~music21.stream.iterator.RecursiveIterator` methods

.. automethod:: music21.stream.iterator.RecursiveIterator.next

Methods inherited from :class:`~music21.stream.iterator.StreamIterator`:

.. hlist::
   :columns: 3

   - :meth:`~music21.stream.iterator.StreamIterator.addFilter`
   - :meth:`~music21.stream.iterator.StreamIterator.cleanup`
   - :meth:`~music21.stream.iterator.StreamIterator.getElementsByClass`
   - :meth:`~music21.stream.iterator.StreamIterator.getElementsByGroup`
   - :meth:`~music21.stream.iterator.StreamIterator.getElementsByOffset`
   - :meth:`~music21.stream.iterator.StreamIterator.getElementsNotOfClass`
   - :meth:`~music21.stream.iterator.StreamIterator.matchesFilters`
   - :meth:`~music21.stream.iterator.StreamIterator.stream`

StreamIterator
--------------

.. autoclass:: music21.stream.iterator.StreamIterator

.. rubric:: :class:`~music21.stream.iterator.StreamIterator` read-only properties

.. autoattribute:: music21.stream.iterator.StreamIterator.notes

.. autoattribute:: music21.stream.iterator.StreamIterator.notesAndRests

.. rubric:: :class:`~music21.stream.iterator.StreamIterator` methods

.. automethod:: music21.stream.iterator.StreamIterator.addFilter

.. automethod:: music21.stream.iterator.StreamIterator.cleanup

.. automethod:: music21.stream.iterator.StreamIterator.getElementsByClass

.. automethod:: music21.stream.iterator.StreamIterator.getElementsByGroup

.. automethod:: music21.stream.iterator.StreamIterator.getElementsByOffset

.. automethod:: music21.stream.iterator.StreamIterator.getElementsNotOfClass

.. automethod:: music21.stream.iterator.StreamIterator.matchesFilters

.. automethod:: music21.stream.iterator.StreamIterator.next

.. automethod:: music21.stream.iterator.StreamIterator.stream
