.. _moduleMetadata:

music21.metadata
================

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

.. automodule:: music21.metadata

AmbitusShort
------------

.. autoclass:: music21.metadata.AmbitusShort

Metadata
--------

.. autoclass:: music21.metadata.Metadata

.. rubric:: :class:`~music21.metadata.Metadata` bases

- :class:`~music21.base.Music21Object`
- :class:`~music21.prebase.ProtoM21Object`

.. rubric:: :class:`~music21.metadata.Metadata` read-only properties

.. autoattribute:: music21.metadata.Metadata.bestTitle

.. autoattribute:: music21.metadata.Metadata.contributors

.. autoattribute:: music21.metadata.Metadata.software

Read-only properties inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.beat`
   - :attr:`~music21.base.Music21Object.beatDuration`
   - :attr:`~music21.base.Music21Object.beatStr`
   - :attr:`~music21.base.Music21Object.beatStrength`
   - :attr:`~music21.base.Music21Object.hasEditorialInformation`
   - :attr:`~music21.base.Music21Object.hasStyleInformation`
   - :attr:`~music21.base.Music21Object.measureNumber`

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.metadata.Metadata` read/write properties

.. autoattribute:: music21.metadata.Metadata.alternativeTitle

.. autoattribute:: music21.metadata.Metadata.composer

.. autoattribute:: music21.metadata.Metadata.composers

.. autoattribute:: music21.metadata.Metadata.copyright

.. autoattribute:: music21.metadata.Metadata.corpusFilePath

.. autoattribute:: music21.metadata.Metadata.date

.. autoattribute:: music21.metadata.Metadata.dateCreated

.. autoattribute:: music21.metadata.Metadata.fileFormat

.. autoattribute:: music21.metadata.Metadata.fileNumber

.. autoattribute:: music21.metadata.Metadata.filePath

.. autoattribute:: music21.metadata.Metadata.librettist

.. autoattribute:: music21.metadata.Metadata.librettists

.. autoattribute:: music21.metadata.Metadata.localeOfComposition

.. autoattribute:: music21.metadata.Metadata.lyricist

.. autoattribute:: music21.metadata.Metadata.lyricists

.. autoattribute:: music21.metadata.Metadata.movementName

.. autoattribute:: music21.metadata.Metadata.movementNumber

.. autoattribute:: music21.metadata.Metadata.number

.. autoattribute:: music21.metadata.Metadata.opusNumber

.. autoattribute:: music21.metadata.Metadata.title

Read/write properties inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.activeSite`
   - :attr:`~music21.base.Music21Object.derivation`
   - :attr:`~music21.base.Music21Object.duration`
   - :attr:`~music21.base.Music21Object.editorial`
   - :attr:`~music21.base.Music21Object.id`
   - :attr:`~music21.base.Music21Object.offset`
   - :attr:`~music21.base.Music21Object.priority`
   - :attr:`~music21.base.Music21Object.quarterLength`
   - :attr:`~music21.base.Music21Object.seconds`
   - :attr:`~music21.base.Music21Object.style`

.. rubric:: :class:`~music21.metadata.Metadata` methods

.. automethod:: music21.metadata.Metadata.__getitem__

.. automethod:: music21.metadata.Metadata.add

.. automethod:: music21.metadata.Metadata.addContributor

.. automethod:: music21.metadata.Metadata.addCustom

.. automethod:: music21.metadata.Metadata.all

.. automethod:: music21.metadata.Metadata.getContributorsByRole

.. automethod:: music21.metadata.Metadata.getCustom

.. automethod:: music21.metadata.Metadata.isContributorUniqueName

.. automethod:: music21.metadata.Metadata.isStandardName

.. automethod:: music21.metadata.Metadata.namespaceNameToUniqueName

.. automethod:: music21.metadata.Metadata.search

.. automethod:: music21.metadata.Metadata.setCustom

.. automethod:: music21.metadata.Metadata.uniqueNameToNamespaceName

Methods inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :meth:`~music21.base.Music21Object.__eq__`
   - :meth:`~music21.base.Music21Object.clearCache`
   - :meth:`~music21.base.Music21Object.containerHierarchy`
   - :meth:`~music21.base.Music21Object.contextSites`
   - :meth:`~music21.base.Music21Object.getAllContextsByClass`
   - :meth:`~music21.base.Music21Object.getContextByClass`
   - :meth:`~music21.base.Music21Object.getOffsetBySite`
   - :meth:`~music21.base.Music21Object.getOffsetInHierarchy`
   - :meth:`~music21.base.Music21Object.getSpannerSites`
   - :meth:`~music21.base.Music21Object.informSites`
   - :meth:`~music21.base.Music21Object.mergeAttributes`
   - :meth:`~music21.base.Music21Object.next`
   - :meth:`~music21.base.Music21Object.previous`
   - :meth:`~music21.base.Music21Object.purgeLocations`
   - :meth:`~music21.base.Music21Object.purgeOrphans`
   - :meth:`~music21.base.Music21Object.setOffsetBySite`
   - :meth:`~music21.base.Music21Object.show`
   - :meth:`~music21.base.Music21Object.sortTuple`
   - :meth:`~music21.base.Music21Object.splitAtDurations`
   - :meth:`~music21.base.Music21Object.splitAtQuarterLength`
   - :meth:`~music21.base.Music21Object.splitByQuarterLengths`
   - :meth:`~music21.base.Music21Object.write`

Methods inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :meth:`~music21.prebase.ProtoM21Object.isClassOrSubclass`

.. rubric:: :class:`~music21.metadata.Metadata` instance variables

Instance variables inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.classSortOrder`
   - :attr:`~music21.base.Music21Object.groups`
   - :attr:`~music21.base.Music21Object.isStream`
   - :attr:`~music21.base.Music21Object.sites`

RichMetadata
------------

.. autoclass:: music21.metadata.RichMetadata

.. rubric:: :class:`~music21.metadata.RichMetadata` bases

- :class:`~music21.metadata.Metadata`
- :class:`~music21.base.Music21Object`
- :class:`~music21.prebase.ProtoM21Object`

.. rubric:: :class:`~music21.metadata.RichMetadata` read-only properties

Read-only properties inherited from :class:`~music21.metadata.Metadata`:

.. hlist::
   :columns: 3

   - :attr:`~music21.metadata.Metadata.bestTitle`
   - :attr:`~music21.metadata.Metadata.contributors`
   - :attr:`~music21.metadata.Metadata.software`

Read-only properties inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.beat`
   - :attr:`~music21.base.Music21Object.beatDuration`
   - :attr:`~music21.base.Music21Object.beatStr`
   - :attr:`~music21.base.Music21Object.beatStrength`
   - :attr:`~music21.base.Music21Object.hasEditorialInformation`
   - :attr:`~music21.base.Music21Object.hasStyleInformation`
   - :attr:`~music21.base.Music21Object.measureNumber`

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.metadata.RichMetadata` read/write properties

Read/write properties inherited from :class:`~music21.metadata.Metadata`:

.. hlist::
   :columns: 3

   - :attr:`~music21.metadata.Metadata.alternativeTitle`
   - :attr:`~music21.metadata.Metadata.composer`
   - :attr:`~music21.metadata.Metadata.composers`
   - :attr:`~music21.metadata.Metadata.copyright`
   - :attr:`~music21.metadata.Metadata.corpusFilePath`
   - :attr:`~music21.metadata.Metadata.date`
   - :attr:`~music21.metadata.Metadata.dateCreated`
   - :attr:`~music21.metadata.Metadata.fileFormat`
   - :attr:`~music21.metadata.Metadata.fileNumber`
   - :attr:`~music21.metadata.Metadata.filePath`
   - :attr:`~music21.metadata.Metadata.librettist`
   - :attr:`~music21.metadata.Metadata.librettists`
   - :attr:`~music21.metadata.Metadata.localeOfComposition`
   - :attr:`~music21.metadata.Metadata.lyricist`
   - :attr:`~music21.metadata.Metadata.lyricists`
   - :attr:`~music21.metadata.Metadata.movementName`
   - :attr:`~music21.metadata.Metadata.movementNumber`
   - :attr:`~music21.metadata.Metadata.number`
   - :attr:`~music21.metadata.Metadata.opusNumber`
   - :attr:`~music21.metadata.Metadata.title`

Read/write properties inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.activeSite`
   - :attr:`~music21.base.Music21Object.derivation`
   - :attr:`~music21.base.Music21Object.duration`
   - :attr:`~music21.base.Music21Object.editorial`
   - :attr:`~music21.base.Music21Object.id`
   - :attr:`~music21.base.Music21Object.offset`
   - :attr:`~music21.base.Music21Object.priority`
   - :attr:`~music21.base.Music21Object.quarterLength`
   - :attr:`~music21.base.Music21Object.seconds`
   - :attr:`~music21.base.Music21Object.style`

.. rubric:: :class:`~music21.metadata.RichMetadata` methods

.. automethod:: music21.metadata.RichMetadata.all

.. automethod:: music21.metadata.RichMetadata.getSourcePath

.. automethod:: music21.metadata.RichMetadata.merge

.. automethod:: music21.metadata.RichMetadata.update

Methods inherited from :class:`~music21.metadata.Metadata`:

.. hlist::
   :columns: 3

   - :meth:`~music21.metadata.Metadata.__getitem__`
   - :meth:`~music21.metadata.Metadata.add`
   - :meth:`~music21.metadata.Metadata.addContributor`
   - :meth:`~music21.metadata.Metadata.addCustom`
   - :meth:`~music21.metadata.Metadata.getContributorsByRole`
   - :meth:`~music21.metadata.Metadata.getCustom`
   - :meth:`~music21.metadata.Metadata.isContributorUniqueName`
   - :meth:`~music21.metadata.Metadata.isStandardName`
   - :meth:`~music21.metadata.Metadata.namespaceNameToUniqueName`
   - :meth:`~music21.metadata.Metadata.search`
   - :meth:`~music21.metadata.Metadata.setCustom`
   - :meth:`~music21.metadata.Metadata.uniqueNameToNamespaceName`

Methods inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :meth:`~music21.base.Music21Object.__eq__`
   - :meth:`~music21.base.Music21Object.clearCache`
   - :meth:`~music21.base.Music21Object.containerHierarchy`
   - :meth:`~music21.base.Music21Object.contextSites`
   - :meth:`~music21.base.Music21Object.getAllContextsByClass`
   - :meth:`~music21.base.Music21Object.getContextByClass`
   - :meth:`~music21.base.Music21Object.getOffsetBySite`
   - :meth:`~music21.base.Music21Object.getOffsetInHierarchy`
   - :meth:`~music21.base.Music21Object.getSpannerSites`
   - :meth:`~music21.base.Music21Object.informSites`
   - :meth:`~music21.base.Music21Object.mergeAttributes`
   - :meth:`~music21.base.Music21Object.next`
   - :meth:`~music21.base.Music21Object.previous`
   - :meth:`~music21.base.Music21Object.purgeLocations`
   - :meth:`~music21.base.Music21Object.purgeOrphans`
   - :meth:`~music21.base.Music21Object.setOffsetBySite`
   - :meth:`~music21.base.Music21Object.show`
   - :meth:`~music21.base.Music21Object.sortTuple`
   - :meth:`~music21.base.Music21Object.splitAtDurations`
   - :meth:`~music21.base.Music21Object.splitAtQuarterLength`
   - :meth:`~music21.base.Music21Object.splitByQuarterLengths`
   - :meth:`~music21.base.Music21Object.write`

Methods inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :meth:`~music21.prebase.ProtoM21Object.isClassOrSubclass`

.. rubric:: :class:`~music21.metadata.RichMetadata` instance variables

Instance variables inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.classSortOrder`
   - :attr:`~music21.base.Music21Object.groups`
   - :attr:`~music21.base.Music21Object.isStream`
   - :attr:`~music21.base.Music21Object.sites`