.. _moduleDuration:

music21.duration
================

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

.. automodule:: music21.duration

Functions
---------

.. autofunction:: music21.duration.convertQuarterLengthToType

.. autofunction:: music21.duration.convertTypeToNumber

.. autofunction:: music21.duration.convertTypeToQuarterLength

.. autofunction:: music21.duration.dottedMatch

.. autofunction:: music21.duration.nextLargerType

.. autofunction:: music21.duration.nextSmallerType

.. autofunction:: music21.duration.partitionQuarterLength

.. autofunction:: music21.duration.quarterLengthToClosestType

.. autofunction:: music21.duration.quarterLengthToDurations

.. autofunction:: music21.duration.quarterLengthToTuplet

.. autofunction:: music21.duration.unitSpec

.. autofunction:: music21.duration.updateTupletType

Duration
--------

.. autoclass:: music21.duration.Duration

.. rubric:: :class:`~music21.duration.Duration` bases

- :class:`~music21.duration.DurationCommon`
- :class:`~music21.common.SlottedObject`

.. rubric:: :class:`~music21.duration.Duration` read-only properties

.. autoattribute:: music21.duration.Duration.fullName

.. autoattribute:: music21.duration.Duration.isComplex

.. autoattribute:: music21.duration.Duration.isLinked

.. autoattribute:: music21.duration.Duration.ordinal

Read-only properties inherited from :class:`~music21.duration.DurationCommon`:

.. hlist::
   :columns: 3

   - :attr:`~music21.duration.DurationCommon.classes`

.. rubric:: :class:`~music21.duration.Duration` read/write properties

.. autoattribute:: music21.duration.Duration.components

.. autoattribute:: music21.duration.Duration.dotGroups

.. autoattribute:: music21.duration.Duration.dots

.. autoattribute:: music21.duration.Duration.quarterLength

.. autoattribute:: music21.duration.Duration.quarterLengthFloat

.. autoattribute:: music21.duration.Duration.tuplets

.. autoattribute:: music21.duration.Duration.type

.. rubric:: :class:`~music21.duration.Duration` methods

.. automethod:: music21.duration.Duration.addDurationUnit

.. automethod:: music21.duration.Duration.appendTuplet

.. automethod:: music21.duration.Duration.augmentOrDiminish

.. automethod:: music21.duration.Duration.clear

.. automethod:: music21.duration.Duration.componentIndexAtQtrPosition

.. automethod:: music21.duration.Duration.componentStartTime

.. automethod:: music21.duration.Duration.consolidate

.. automethod:: music21.duration.Duration.currentComponents

.. automethod:: music21.duration.Duration.expand

.. automethod:: music21.duration.Duration.fill

.. automethod:: music21.duration.Duration.getGraceDuration

.. automethod:: music21.duration.Duration.link

.. automethod:: music21.duration.Duration.setQuarterLengthUnlinked

.. automethod:: music21.duration.Duration.setTypeUnlinked

.. automethod:: music21.duration.Duration.sliceComponentAtPosition

.. automethod:: music21.duration.Duration.splitDotGroups

.. automethod:: music21.duration.Duration.unlink

.. automethod:: music21.duration.Duration.updateQuarterLength

Methods inherited from :class:`~music21.duration.DurationCommon`:

.. hlist::
   :columns: 3

   - :meth:`~music21.duration.DurationCommon.aggregateTupletMultiplier`

Tuplet
------

.. autoclass:: music21.duration.Tuplet

.. rubric:: :class:`~music21.duration.Tuplet` read-only properties

.. autoattribute:: music21.duration.Tuplet.fullName

.. rubric:: :class:`~music21.duration.Tuplet` read/write properties

.. autoattribute:: music21.duration.Tuplet.tupletActual

.. autoattribute:: music21.duration.Tuplet.tupletNormal

.. rubric:: :class:`~music21.duration.Tuplet` methods

.. automethod:: music21.duration.Tuplet.augmentOrDiminish

.. automethod:: music21.duration.Tuplet.setDurationType

.. automethod:: music21.duration.Tuplet.setRatio

.. automethod:: music21.duration.Tuplet.totalTupletLength

.. automethod:: music21.duration.Tuplet.tupletMultiplier

DurationUnit
------------

.. autoclass:: music21.duration.DurationUnit

.. rubric:: :class:`~music21.duration.DurationUnit` bases

- :class:`~music21.duration.DurationCommon`
- :class:`~music21.common.SlottedObject`

.. rubric:: :class:`~music21.duration.DurationUnit` read-only properties

.. autoattribute:: music21.duration.DurationUnit.fullName

.. autoattribute:: music21.duration.DurationUnit.isLinked

.. autoattribute:: music21.duration.DurationUnit.ordinal

Read-only properties inherited from :class:`~music21.duration.DurationCommon`:

.. hlist::
   :columns: 3

   - :attr:`~music21.duration.DurationCommon.classes`

.. rubric:: :class:`~music21.duration.DurationUnit` read/write properties

.. autoattribute:: music21.duration.DurationUnit.dotGroups

.. autoattribute:: music21.duration.DurationUnit.dots

.. autoattribute:: music21.duration.DurationUnit.quarterLength

.. autoattribute:: music21.duration.DurationUnit.quarterLengthFloat

.. autoattribute:: music21.duration.DurationUnit.tuplets

.. autoattribute:: music21.duration.DurationUnit.type

.. rubric:: :class:`~music21.duration.DurationUnit` methods

.. automethod:: music21.duration.DurationUnit.appendTuplet

.. automethod:: music21.duration.DurationUnit.augmentOrDiminish

.. automethod:: music21.duration.DurationUnit.link

.. automethod:: music21.duration.DurationUnit.setTypeFromNum

.. automethod:: music21.duration.DurationUnit.unlink

.. automethod:: music21.duration.DurationUnit.updateQuarterLength

.. automethod:: music21.duration.DurationUnit.updateType

Methods inherited from :class:`~music21.duration.DurationCommon`:

.. hlist::
   :columns: 3

   - :meth:`~music21.duration.DurationCommon.aggregateTupletMultiplier`

TupletFixer
-----------

.. autoclass:: music21.duration.TupletFixer

.. rubric:: :class:`~music21.duration.TupletFixer` methods

.. automethod:: music21.duration.TupletFixer.findTupletGroups

.. automethod:: music21.duration.TupletFixer.fixBrokenTupletDuration

.. automethod:: music21.duration.TupletFixer.setStream

AppogiaturaDuration
-------------------

.. autoclass:: music21.duration.AppogiaturaDuration

.. rubric:: :class:`~music21.duration.AppogiaturaDuration` bases

- :class:`~music21.duration.GraceDuration`
- :class:`~music21.duration.Duration`
- :class:`~music21.duration.DurationCommon`
- :class:`~music21.common.SlottedObject`

.. rubric:: :class:`~music21.duration.AppogiaturaDuration` read-only properties

Read-only properties inherited from :class:`~music21.duration.Duration`:

.. hlist::
   :columns: 3

   - :attr:`~music21.duration.Duration.fullName`
   - :attr:`~music21.duration.Duration.isComplex`
   - :attr:`~music21.duration.Duration.isLinked`
   - :attr:`~music21.duration.Duration.ordinal`

Read-only properties inherited from :class:`~music21.duration.DurationCommon`:

.. hlist::
   :columns: 3

   - :attr:`~music21.duration.DurationCommon.classes`

.. rubric:: :class:`~music21.duration.AppogiaturaDuration` read/write properties

Read/write properties inherited from :class:`~music21.duration.GraceDuration`:

.. hlist::
   :columns: 3

   - :attr:`~music21.duration.GraceDuration.makeTime`
   - :attr:`~music21.duration.GraceDuration.slash`

Read/write properties inherited from :class:`~music21.duration.Duration`:

.. hlist::
   :columns: 3

   - :attr:`~music21.duration.Duration.components`
   - :attr:`~music21.duration.Duration.dotGroups`
   - :attr:`~music21.duration.Duration.dots`
   - :attr:`~music21.duration.Duration.quarterLength`
   - :attr:`~music21.duration.Duration.quarterLengthFloat`
   - :attr:`~music21.duration.Duration.tuplets`
   - :attr:`~music21.duration.Duration.type`

.. rubric:: :class:`~music21.duration.AppogiaturaDuration` methods

Methods inherited from :class:`~music21.duration.Duration`:

.. hlist::
   :columns: 3

   - :meth:`~music21.duration.Duration.addDurationUnit`
   - :meth:`~music21.duration.Duration.appendTuplet`
   - :meth:`~music21.duration.Duration.augmentOrDiminish`
   - :meth:`~music21.duration.Duration.clear`
   - :meth:`~music21.duration.Duration.componentIndexAtQtrPosition`
   - :meth:`~music21.duration.Duration.componentStartTime`
   - :meth:`~music21.duration.Duration.consolidate`
   - :meth:`~music21.duration.Duration.currentComponents`
   - :meth:`~music21.duration.Duration.expand`
   - :meth:`~music21.duration.Duration.fill`
   - :meth:`~music21.duration.Duration.getGraceDuration`
   - :meth:`~music21.duration.Duration.link`
   - :meth:`~music21.duration.Duration.setQuarterLengthUnlinked`
   - :meth:`~music21.duration.Duration.setTypeUnlinked`
   - :meth:`~music21.duration.Duration.sliceComponentAtPosition`
   - :meth:`~music21.duration.Duration.splitDotGroups`
   - :meth:`~music21.duration.Duration.unlink`
   - :meth:`~music21.duration.Duration.updateQuarterLength`

Methods inherited from :class:`~music21.duration.DurationCommon`:

.. hlist::
   :columns: 3

   - :meth:`~music21.duration.DurationCommon.aggregateTupletMultiplier`

.. rubric:: :class:`~music21.duration.AppogiaturaDuration` instance variables

Instance variables inherited from :class:`~music21.duration.GraceDuration`:

.. hlist::
   :columns: 3

   - :attr:`~music21.duration.GraceDuration.stealTimePrevious`
   - :attr:`~music21.duration.GraceDuration.stealTimeFollowing`

DurationCommon
--------------

.. autoclass:: music21.duration.DurationCommon

.. rubric:: :class:`~music21.duration.DurationCommon` bases

- :class:`~music21.common.SlottedObject`

.. rubric:: :class:`~music21.duration.DurationCommon` read-only properties

.. autoattribute:: music21.duration.DurationCommon.classes

.. rubric:: :class:`~music21.duration.DurationCommon` methods

.. automethod:: music21.duration.DurationCommon.aggregateTupletMultiplier

GraceDuration
-------------

.. autoclass:: music21.duration.GraceDuration

.. rubric:: :class:`~music21.duration.GraceDuration` bases

- :class:`~music21.duration.Duration`
- :class:`~music21.duration.DurationCommon`
- :class:`~music21.common.SlottedObject`

.. rubric:: :class:`~music21.duration.GraceDuration` read-only properties

Read-only properties inherited from :class:`~music21.duration.Duration`:

.. hlist::
   :columns: 3

   - :attr:`~music21.duration.Duration.fullName`
   - :attr:`~music21.duration.Duration.isComplex`
   - :attr:`~music21.duration.Duration.isLinked`
   - :attr:`~music21.duration.Duration.ordinal`

Read-only properties inherited from :class:`~music21.duration.DurationCommon`:

.. hlist::
   :columns: 3

   - :attr:`~music21.duration.DurationCommon.classes`

.. rubric:: :class:`~music21.duration.GraceDuration` read/write properties

.. autoattribute:: music21.duration.GraceDuration.makeTime

.. autoattribute:: music21.duration.GraceDuration.slash

Read/write properties inherited from :class:`~music21.duration.Duration`:

.. hlist::
   :columns: 3

   - :attr:`~music21.duration.Duration.components`
   - :attr:`~music21.duration.Duration.dotGroups`
   - :attr:`~music21.duration.Duration.dots`
   - :attr:`~music21.duration.Duration.quarterLength`
   - :attr:`~music21.duration.Duration.quarterLengthFloat`
   - :attr:`~music21.duration.Duration.tuplets`
   - :attr:`~music21.duration.Duration.type`

.. rubric:: :class:`~music21.duration.GraceDuration` methods

Methods inherited from :class:`~music21.duration.Duration`:

.. hlist::
   :columns: 3

   - :meth:`~music21.duration.Duration.addDurationUnit`
   - :meth:`~music21.duration.Duration.appendTuplet`
   - :meth:`~music21.duration.Duration.augmentOrDiminish`
   - :meth:`~music21.duration.Duration.clear`
   - :meth:`~music21.duration.Duration.componentIndexAtQtrPosition`
   - :meth:`~music21.duration.Duration.componentStartTime`
   - :meth:`~music21.duration.Duration.consolidate`
   - :meth:`~music21.duration.Duration.currentComponents`
   - :meth:`~music21.duration.Duration.expand`
   - :meth:`~music21.duration.Duration.fill`
   - :meth:`~music21.duration.Duration.getGraceDuration`
   - :meth:`~music21.duration.Duration.link`
   - :meth:`~music21.duration.Duration.setQuarterLengthUnlinked`
   - :meth:`~music21.duration.Duration.setTypeUnlinked`
   - :meth:`~music21.duration.Duration.sliceComponentAtPosition`
   - :meth:`~music21.duration.Duration.splitDotGroups`
   - :meth:`~music21.duration.Duration.unlink`
   - :meth:`~music21.duration.Duration.updateQuarterLength`

Methods inherited from :class:`~music21.duration.DurationCommon`:

.. hlist::
   :columns: 3

   - :meth:`~music21.duration.DurationCommon.aggregateTupletMultiplier`

.. rubric:: :class:`~music21.duration.GraceDuration` instance variables

.. attribute:: GraceDuration.stealTimeFollowing

	Number from 0 to 1 or None (default) for the amount of time to steal from the following note.

.. attribute:: GraceDuration.stealTimePrevious

	Number from 0 to 1 or None (default) for the amount of time to steal from the previous note.

ZeroDuration
------------

.. autoclass:: music21.duration.ZeroDuration

.. rubric:: :class:`~music21.duration.ZeroDuration` bases

- :class:`~music21.duration.DurationUnit`
- :class:`~music21.duration.DurationCommon`
- :class:`~music21.common.SlottedObject`

.. rubric:: :class:`~music21.duration.ZeroDuration` read-only properties

Read-only properties inherited from :class:`~music21.duration.DurationUnit`:

.. hlist::
   :columns: 3

   - :attr:`~music21.duration.DurationUnit.fullName`
   - :attr:`~music21.duration.DurationUnit.isLinked`
   - :attr:`~music21.duration.DurationUnit.ordinal`

Read-only properties inherited from :class:`~music21.duration.DurationCommon`:

.. hlist::
   :columns: 3

   - :attr:`~music21.duration.DurationCommon.classes`

.. rubric:: :class:`~music21.duration.ZeroDuration` read/write properties

Read/write properties inherited from :class:`~music21.duration.DurationUnit`:

.. hlist::
   :columns: 3

   - :attr:`~music21.duration.DurationUnit.dotGroups`
   - :attr:`~music21.duration.DurationUnit.dots`
   - :attr:`~music21.duration.DurationUnit.quarterLength`
   - :attr:`~music21.duration.DurationUnit.quarterLengthFloat`
   - :attr:`~music21.duration.DurationUnit.tuplets`
   - :attr:`~music21.duration.DurationUnit.type`

.. rubric:: :class:`~music21.duration.ZeroDuration` methods

Methods inherited from :class:`~music21.duration.DurationUnit`:

.. hlist::
   :columns: 3

   - :meth:`~music21.duration.DurationUnit.appendTuplet`
   - :meth:`~music21.duration.DurationUnit.augmentOrDiminish`
   - :meth:`~music21.duration.DurationUnit.link`
   - :meth:`~music21.duration.DurationUnit.setTypeFromNum`
   - :meth:`~music21.duration.DurationUnit.unlink`
   - :meth:`~music21.duration.DurationUnit.updateQuarterLength`
   - :meth:`~music21.duration.DurationUnit.updateType`

Methods inherited from :class:`~music21.duration.DurationCommon`:

.. hlist::
   :columns: 3

   - :meth:`~music21.duration.DurationCommon.aggregateTupletMultiplier`
