Version 1, 1.0 or 1.1
Version 1.0, specifically
Version 1.1, specifically
Version 2, 2.2, 2.3 or 2.4
Version 2.2, specifically
Version 2.3, specifically
Version 2.4, specifically
The default version for eyeD3 tags and save operations.
Useful for operations where any version will suffice.
Byte code for latin1
Byte code for UTF-16
Byte code for UTF-16 (big endian)
Byte code for UTF-8 (Not supported in ID3 versions < 2.4)
Default language code for frames that contain a language portion.
Check the tuple v against the list of valid ID3 version constants. If fully_qualified is True it is enforced that there are 3 components to the version in v. Returns True when valid and False otherwise.
If version tuple v is of the non-specific type (v1 or v2, any, etc.) a fully qualified version is returned.
Conversion version tuple v to a string description.
Excpetion type for exceptions related to genres.
A genre in terms of a name and and id. Only when name is a “standard” genre (as defined by ID3 v1) will id be a value other than None.
The Genre’s id property. When setting the value is strictly enforced and if the value is not a valid genre code a ValueError is raised. Otherwise the id is set and the name property is updated to the code’s string name.
The Genre’s name property. When setting the value the name is looked up in the standard genre map and if found the id ppropery is set to the numeric valud and the name is normalized to the sting found in the map. Non standard genres are set (with a warning log) and the id is set to None. It is valid to set the value to None.
Classic genres defined around ID3 v1 but suitable anywhere. This class is used primarily as a way to map numeric genre values to a string name. Genre strings on the other hand are not required to exist in this list.
The optional *args are passed directly to the dict constructor.
A shim class for dealing with files that contain only ID3 data, no audio.
Add a id3.Tag to the file (removing any existing tag if one exists).
ID3 genres, as defined in ID3 v1. The position in the list is the genre’s numeric byte value.
A map of standard genre names and IDs per the ID3 v1 genre definition.
Text frames. Data string format: encoding (one byte) + text
Data string format: encoding (one byte) + description + “” + text
Data string format: encoding (one byte) + description + “” + url (ascii)
Parse the frame from data bytes using details from frame_header.
Data string format: <Header for ‘General encapsulated object’, ID: “GEOB”> Text encoding $xx MIME type <text string> $00 Filename <text string according to encoding> $00 (00) Content description <text string according to encoding> $00 (00) Encapsulated object <binary data>
Frame type for ‘POPM’ frames; popularity. Frame format: <Header for ‘Popularimeter’, ID: “POPM”> Email to user <text string> $00 Rating $xx Counter $xx xx xx xx (xx ...)
Data format Owner identifier <text string> $00 Identifier up to 64 bytes binary data>
Table of content frame. There may be more than one, but only one may have the top-level flag set.
Data format: Element ID: <string>TOC flags: %000000ab Entry count: %xx Child elem IDs: <string>(... num entry count) Description: TIT2 frame (optional)
A 2-tuple, with names ‘start’ and ‘end’.
Alias for field number 1
Alias for field number 0
Frame type for chapter/section of the audio file. <ID3v2.3 or ID3v2.4 frame header, ID: “CHAP”> (10 bytes) Element ID <text string> $00 Start time $xx xx xx xx End time $xx xx xx xx Start offset $xx xx xx xx End offset $xx xx xx xx <Optional embedded sub-frames>
No offset value, aka “0xff0xff0xff0xff”
Read frames starting from the current read position of the file object. Returns the amount of padding which occurs after the tag, but before the audio content. A return valule of 0 does not mean error.
Return all the frames in the set as a list. The list is sorted in an arbitrary but consistent order.
Parse an ID3 v2 header starting at the current position of f. If a header is parsed True is returned, otherwise False. If a header is found but malformed an eyed3.id3.tag.TagException is thrown.
Parse an ID3 v2 extended header starting at the current position of fp and per the format defined by version. This method should only be called when the presence of an extended header is known since it moves the file position. If a header is found but malformed an eyed3.id3.tag.TagException is thrown. The return value is None.
Test ID3 major version for v1.x
Test ID3 major version for v2.x
This method tries its best to return a date of some sort, amongst alll the possible date frames. The order of preference for a release date is 1) date of original release 2) date of this versions release 3) the recording date. Or None is returned.
This method returns a date of some sort, amongst all the possible date frames. The order of preference is:
Unless prefer_recording_date is True in which case the order is 3, 1, 2.
None will be returned if no dates are available.
The date the audio was released. This is NOT the original date the work was released, instead it is more like the pressing or version of the release. Original release date is usually what is intended but many programs use this frame and/or don’t distinguish between the two.
The date the work was originally released.
The date of the recording. Many applications use this for release date regardless of the fact that this value is rarely known, and release dates are more correct.
Save the tag. If filename is not give the value from the file_info member is used, or a TagException is raised. The version argument can be used to select an ID3 version other than the version read. Select text encoding with ``encoding or use the existing (or default) encoding. If backup is True the orignal file is preserved; likewise if preserve_file_time is True the file´s modification/access times are not updated.
Returns a 3-tuple: (city, state, country) Any may be None.
This class is for storing information about a parsed file. It containts info such as the filename, original tag size, and amount of padding; all of which can make rewriting faster.
times is a 2-tuple of (atime, mtime).
Returns the removed item or None if not found.