Bases: object
Fundamental unit of ID3 data.
ID3 tags are split into frames. Each frame has a potentially different structure, and so this base class is not very featureful.
ID3v2 three or four character frame ID
An internal key used to ensure frame uniqueness in a tag
Python representation of a frame.
The string returned is a valid Python expression to construct a copy of this frame.
Return a human-readable representation of the frame.
Bases: mutagen.id3.Frame
Binary data
The ‘data’ attribute contains the raw byte string.
Bases: mutagen.id3.Frame
Paired text strings.
Some ID3 frames pair text strings, to associate names with a more specific involvement in the song. The ‘people’ attribute of these frames contains a list of pairs:
[['trumpet', 'Miles Davis'], ['bass', 'Paul Chambers']]
Like text frames, these frames also have an encoding attribute.
Bases: mutagen.id3.Frame
Text strings.
Text frames support casts to unicode or str objects, as well as list-like indexing, extend, and append.
Iterating over a TextFrame iterates over its strings, not its characters.
Text frames have a ‘text’ attribute which is the list of strings, and an ‘encoding’ attribute; 0 for ISO-8859 1, 1 UTF-16, 2 for UTF-16BE, and 3 for UTF-8. If you don’t want to worry about encodings, just set it to 3.
Append a string.
Extend the list by appending all strings from the given list.
Bases: mutagen.id3.Frame
A frame containing a URL string.
The ID3 specification is silent about IRIs and normalized URL forms. Mutagen assumes all URLs in files are encoded as Latin 1, but string conversion of this frame returns a UTF-8 representation for compatibility with other string conversions.
The only sane way to handle URLs in MP3s is to restrict them to ASCII.
Bases: mutagen.id3.TextFrame
Multivalue numerical text strings.
These strings indicate ‘part (e.g. track) X of Y’, and unary plus returns the first value:
frame = TRCK('4/15')
track = +frame # track == 4
Bases: mutagen.id3.TextFrame
Numerical text strings.
The numeric value of these frames can be gotten with unary plus, e.g.:
frame = TLEN('12345')
length = +frame
Return the numerical value of the string.
Bases: mutagen.id3.TextFrame
A list of time stamps.
The ‘text’ attribute in this frame is a list of ID3TimeStamp objects, not a list of strings.
Bases: mutagen.id3.UrlFrame
Bases: mutagen.id3.Frame
Audio encryption.
Attributes:
Mutagen cannot decrypt files.
Bases: mutagen.id3.Frame
Attached (or linked) Picture.
Attributes:
Mutagen will automatically compress large images when saving tags.
Bases: mutagen.id3.Frame
Audio seek point index.
Attributes: S, L, N, b, and Fi. For the meaning of these, see the ID3v2.4 specification. Fi is a list of integers.
Bases: mutagen.id3.Frame
Chapter
Bases: mutagen.id3.TextFrame
User comment.
User comment frames have a descrption, like TXXX, and also a three letter ISO language code in the ‘lang’ attribute.
Bases: mutagen.id3.Frame
Commercial frame.
Bases: mutagen.id3.Frame
Table of contents
Bases: mutagen.id3.Frame
Encryption method registration.
The standard does not allow multiple ENCR frames with the same owner or the same method. Mutagen only verifies that the owner is unique.
Bases: mutagen.id3.Frame
Equalisation (2).
Attributes: method – interpolation method (0 = band, 1 = linear) desc – identifying description adjustments – list of (frequency, vol_adjustment) pairs
Bases: mutagen.id3.Frame
Event timing codes.
Bases: mutagen.id3.Frame
General Encapsulated Object.
A blob of binary data, that is not a picture (those go in APIC).
Attributes:
Bases: mutagen.id3.Frame
Group identification registration.
Bases: mutagen.id3.TextFrame
iTunes Grouping
Bases: mutagen.id3.TIPL
Involved People List
Bases: mutagen.id3.Frame
Linked information.
Attributes:
Bases: mutagen.id3.BinaryFrame
Binary dump of CD’s TOC
Bases: mutagen.id3.Frame
MPEG location lookup table.
This frame’s attributes may be changed in the future based on feedback from real-world use.
Bases: mutagen.id3.NumericPartTextFrame
iTunes Movement Number/Count
Bases: mutagen.id3.TextFrame
iTunes Movement Name
Bases: mutagen.id3.Frame
Ownership frame.
Bases: mutagen.id3.Frame
Play counter.
The ‘count’ attribute contains the (recorded) number of times this file has been played.
This frame is basically obsoleted by POPM.
Bases: mutagen.id3.Frame
iTunes Podcast Flag
Bases: mutagen.id3.Frame
Popularimeter.
This frame keys a rating (out of 255) and a play count to an email address.
Attributes:
Bases: mutagen.id3.Frame
Position synchronisation frame
Attribute:
Bases: mutagen.id3.Frame
Private frame.
Bases: mutagen.id3.Frame
Recommended buffer size.
Attributes:
Mutagen will not find the next tag itself.
Bases: mutagen.id3.Frame
Relative volume adjustment (2).
This frame is used to implemented volume scaling, and in particular, normalization using ReplayGain.
Attributes:
When storing ReplayGain tags, use descriptions of ‘album’ and ‘track’ on channel 1.
Bases: mutagen.id3.Frame
Relative volume adjustment
Bases: mutagen.id3.Frame
Reverb.
Bases: mutagen.id3.Frame
Seek frame.
Mutagen does not find tags at seek offsets.
Bases: mutagen.id3.Frame
Signature frame.
Bases: mutagen.id3.Frame
Synchronised lyrics/text.
Bases: mutagen.id3.Frame
Synchronised tempo codes.
This frame’s attributes may be changed in the future based on feedback from real-world use.
Bases: mutagen.id3.TextFrame
Album
Bases: mutagen.id3.NumericTextFrame
Beats per minute
Bases: mutagen.id3.TextFrame
iTunes Podcast Category
Bases: mutagen.id3.NumericTextFrame
iTunes Compilation Flag
Bases: mutagen.id3.TextFrame
Composer
Bases: mutagen.id3.TextFrame
Content type (Genre)
ID3 has several ways genres can be represented; for convenience, use the ‘genres’ property rather than the ‘text’ attribute.
A list of genres parsed from the raw text data.
Bases: mutagen.id3.TextFrame
Copyright (c)
Bases: mutagen.id3.TextFrame
Date of recording (DDMM)
Bases: mutagen.id3.TimeStampTextFrame
Encoding Time
Bases: mutagen.id3.TextFrame
iTunes Podcast Description
Bases: mutagen.id3.NumericTextFrame
Audio Delay (ms)
Bases: mutagen.id3.TimeStampTextFrame
Original Release Time
Bases: mutagen.id3.TimeStampTextFrame
Recording Time
Bases: mutagen.id3.TimeStampTextFrame
Release Time
Bases: mutagen.id3.TimeStampTextFrame
Tagging Time
Bases: mutagen.id3.TextFrame
Encoder
Bases: mutagen.id3.TextFrame
Lyricist
Bases: mutagen.id3.TextFrame
File type
Bases: mutagen.id3.TextFrame
iTunes Podcast Identifier
Bases: mutagen.id3.TextFrame
Time of recording (HHMM)
Bases: mutagen.id3.PairedTextFrame
Involved People List
Bases: mutagen.id3.TextFrame
Content group description
Bases: mutagen.id3.TextFrame
Title
Bases: mutagen.id3.TextFrame
Subtitle/Description refinement
Bases: mutagen.id3.TextFrame
Starting Key
Bases: mutagen.id3.TextFrame
iTunes Podcast Keywords
Bases: mutagen.id3.TextFrame
Audio Languages
Bases: mutagen.id3.NumericTextFrame
Audio Length (ms)
Bases: mutagen.id3.PairedTextFrame
Musicians Credits List
Bases: mutagen.id3.TextFrame
Source Media Type
Bases: mutagen.id3.TextFrame
Mood
Bases: mutagen.id3.TextFrame
Original Album
Bases: mutagen.id3.TextFrame
Original Filename
Bases: mutagen.id3.TextFrame
Original Lyricist
Bases: mutagen.id3.TextFrame
Original Artist/Performer
Bases: mutagen.id3.NumericTextFrame
Original Release Year
Bases: mutagen.id3.TextFrame
Owner/Licensee
Bases: mutagen.id3.TextFrame
Lead Artist/Performer/Soloist/Group
Bases: mutagen.id3.TextFrame
Band/Orchestra/Accompaniment
Bases: mutagen.id3.TextFrame
Conductor
Bases: mutagen.id3.TextFrame
Interpreter/Remixer/Modifier
Bases: mutagen.id3.NumericPartTextFrame
Part of set
Bases: mutagen.id3.TextFrame
Produced (P)
Bases: mutagen.id3.TextFrame
Publisher
Bases: mutagen.id3.NumericPartTextFrame
Track Number
Bases: mutagen.id3.TextFrame
Recording Dates
Bases: mutagen.id3.TextFrame
Internet Radio Station Name
Bases: mutagen.id3.TextFrame
Internet Radio Station Owner
Bases: mutagen.id3.NumericTextFrame
Size of audio data (bytes)
Bases: mutagen.id3.TextFrame
iTunes Album Artist Sort
Bases: mutagen.id3.TextFrame
Album Sort Order key
Bases: mutagen.id3.TextFrame
iTunes Composer Sort
Bases: mutagen.id3.TextFrame
Perfomer Sort Order key
Bases: mutagen.id3.TextFrame
Title Sort Order key
Bases: mutagen.id3.TextFrame
International Standard Recording Code (ISRC)
Bases: mutagen.id3.TextFrame
Encoder settings
Bases: mutagen.id3.TextFrame
Set Subtitle
Bases: mutagen.id3.TextFrame
User-defined text data.
TXXX frames have a ‘desc’ attribute which is set to any Unicode value (though the encoding of the text and the description must be the same). Many taggers use this frame to store freeform keys.
Bases: mutagen.id3.NumericTextFrame
Year of recording
Bases: mutagen.id3.Frame
Unique file identifier.
Attributes:
Bases: mutagen.id3.Frame
Terms of use.
Attributes:
Bases: mutagen.id3.Frame
Unsynchronised lyrics/text transcription.
Lyrics have a three letter ISO language code (‘lang’), a description (‘desc’), and a block of plain text (‘text’).
Bases: mutagen.id3.UrlFrameU
Commercial Information
Bases: mutagen.id3.UrlFrame
Copyright Information
Bases: mutagen.id3.UrlFrame
iTunes Podcast Feed
Bases: mutagen.id3.UrlFrame
Official File Information
Bases: mutagen.id3.UrlFrameU
Official Artist/Performer Information
Bases: mutagen.id3.UrlFrame
Official Source Information
Bases: mutagen.id3.UrlFrame
Official Internet Radio Information
Bases: mutagen.id3.UrlFrame
Payment Information
Bases: mutagen.id3.UrlFrame
Official Publisher Information
Bases: mutagen.id3.UrlFrame
User-defined URL data.
Like TXXX, this has a freeform description associated with it.