eyed3 package
Subpackages
- eyed3.id3 package
- Submodules
- eyed3.id3.apple module
- eyed3.id3.frames module
FrameException
Frame
TextFrame
UserTextFrame
DateFrame
UrlFrame
UserUrlFrame
UnknownFrame
ImageFrame
ImageFrame.OTHER
ImageFrame.ICON
ImageFrame.OTHER_ICON
ImageFrame.FRONT_COVER
ImageFrame.BACK_COVER
ImageFrame.LEAFLET
ImageFrame.MEDIA
ImageFrame.LEAD_ARTIST
ImageFrame.ARTIST
ImageFrame.CONDUCTOR
ImageFrame.BAND
ImageFrame.COMPOSER
ImageFrame.LYRICIST
ImageFrame.RECORDING_LOCATION
ImageFrame.DURING_RECORDING
ImageFrame.DURING_PERFORMANCE
ImageFrame.VIDEO
ImageFrame.BRIGHT_COLORED_FISH
ImageFrame.ILLUSTRATION
ImageFrame.BAND_LOGO
ImageFrame.PUBLISHER_LOGO
ImageFrame.MIN_TYPE
ImageFrame.MAX_TYPE
ImageFrame.URL_MIME_TYPE
ImageFrame.URL_MIME_TYPE_STR
ImageFrame.URL_MIME_TYPE_VALUES
ImageFrame.description
ImageFrame.mime_type
ImageFrame.picture_type
ImageFrame.parse()
ImageFrame.render()
ImageFrame.picTypeToString()
ImageFrame.stringToPicType()
ImageFrame.makeFileName()
ObjectFrame
PrivateFrame
MusicCDIdFrame
PlayCountFrame
PopularityFrame
UniqueFileIDFrame
LanguageCodeMixin
DescriptionLangTextFrame
CommentFrame
LyricsFrame
TermsOfUseFrame
TocFrame
RelVolAdjFrameV24
RelVolAdjFrameV24.CHANNEL_TYPE_OTHER
RelVolAdjFrameV24.CHANNEL_TYPE_MASTER
RelVolAdjFrameV24.CHANNEL_TYPE_FRONT_RIGHT
RelVolAdjFrameV24.CHANNEL_TYPE_FRONT_LEFT
RelVolAdjFrameV24.CHANNEL_TYPE_BACK_RIGHT
RelVolAdjFrameV24.CHANNEL_TYPE_BACK_LEFT
RelVolAdjFrameV24.CHANNEL_TYPE_FRONT_CENTER
RelVolAdjFrameV24.CHANNEL_TYPE_BACK_CENTER
RelVolAdjFrameV24.CHANNEL_TYPE_BASS
RelVolAdjFrameV24.identifier
RelVolAdjFrameV24.channel_type
RelVolAdjFrameV24.adjustment
RelVolAdjFrameV24.peak
RelVolAdjFrameV24.parse()
RelVolAdjFrameV24.render()
RelVolAdjFrameV23
RelVolAdjFrameV23.FRONT_CHANNEL_RIGHT_BIT
RelVolAdjFrameV23.FRONT_CHANNEL_LEFT_BIT
RelVolAdjFrameV23.BACK_CHANNEL_RIGHT_BIT
RelVolAdjFrameV23.BACK_CHANNEL_LEFT_BIT
RelVolAdjFrameV23.FRONT_CENTER_CHANNEL_BIT
RelVolAdjFrameV23.BASS_CHANNEL_BIT
RelVolAdjFrameV23.CHANNEL_DEFN
RelVolAdjFrameV23.VolumeAdjustments
RelVolAdjFrameV23.toV24()
RelVolAdjFrameV23.parse()
RelVolAdjFrameV23.render()
StartEndTuple
ChapterFrame
FrameSet
deunsyncData()
createFrame()
decodeUnicode()
splitUnicode()
id3EncodingToString()
stringToEncoding()
map2_2FrameId()
- eyed3.id3.headers module
TagHeader
ExtendedTagHeader
ExtendedTagHeader.RESTRICT_TAG_SZ_LARGE
ExtendedTagHeader.RESTRICT_TAG_SZ_MED
ExtendedTagHeader.RESTRICT_TAG_SZ_SMALL
ExtendedTagHeader.RESTRICT_TAG_SZ_TINY
ExtendedTagHeader.RESTRICT_TEXT_ENC_NONE
ExtendedTagHeader.RESTRICT_TEXT_ENC_UTF8
ExtendedTagHeader.RESTRICT_TEXT_LEN_NONE
ExtendedTagHeader.RESTRICT_TEXT_LEN_1024
ExtendedTagHeader.RESTRICT_TEXT_LEN_128
ExtendedTagHeader.RESTRICT_TEXT_LEN_30
ExtendedTagHeader.RESTRICT_IMG_ENC_NONE
ExtendedTagHeader.RESTRICT_IMG_ENC_PNG_JPG
ExtendedTagHeader.RESTRICT_IMG_SZ_NONE
ExtendedTagHeader.RESTRICT_IMG_SZ_256
ExtendedTagHeader.RESTRICT_IMG_SZ_64
ExtendedTagHeader.RESTRICT_IMG_SZ_64_EXACT
ExtendedTagHeader.update_bit
ExtendedTagHeader.crc_bit
ExtendedTagHeader.crc
ExtendedTagHeader.restrictions_bit
ExtendedTagHeader.tag_size_restriction
ExtendedTagHeader.tag_size_restriction_description
ExtendedTagHeader.text_enc_restriction
ExtendedTagHeader.text_enc_restriction_description
ExtendedTagHeader.text_length_restriction
ExtendedTagHeader.text_length_restriction_description
ExtendedTagHeader.image_enc_restriction
ExtendedTagHeader.image_enc_restriction_description
ExtendedTagHeader.image_size_restriction
ExtendedTagHeader.image_size_restriction_description
ExtendedTagHeader.render()
ExtendedTagHeader.parse()
FrameHeader
FrameHeader.TAG_ALTER
FrameHeader.FILE_ALTER
FrameHeader.READ_ONLY
FrameHeader.COMPRESSED
FrameHeader.ENCRYPTED
FrameHeader.GROUPED
FrameHeader.UNSYNC
FrameHeader.DATA_LEN
FrameHeader.copyFlags()
FrameHeader.major_version
FrameHeader.minor_version
FrameHeader.version
FrameHeader.tag_alter
FrameHeader.file_alter
FrameHeader.read_only
FrameHeader.compressed
FrameHeader.encrypted
FrameHeader.grouped
FrameHeader.unsync
FrameHeader.data_length_indicator
FrameHeader.render()
FrameHeader.parse()
- eyed3.id3.tag module
TagException
Tag
Tag.clear()
Tag.parse()
Tag.version
Tag.isV1()
Tag.isV2()
Tag.setTextFrame()
Tag.getTextFrame()
Tag.composer
Tag.comments
Tag.bpm
Tag.play_count
Tag.publisher
Tag.cd_id
Tag.unknown_frame_ids
Tag.images
Tag.encoding_date
Tag.best_release_date
Tag.getBestDate()
Tag.release_date
Tag.original_release_date
Tag.recording_date
Tag.tagging_date
Tag.lyrics
Tag.disc_num
Tag.objects
Tag.privates
Tag.popularities
Tag.genre
Tag.non_std_genre
Tag.user_text_frames
Tag.commercial_url
Tag.copyright_url
Tag.audio_file_url
Tag.audio_source_url
Tag.artist_url
Tag.internet_radio_url
Tag.payment_url
Tag.publisher_url
Tag.user_url_frames
Tag.unique_file_ids
Tag.terms_of_use
Tag.copyright
Tag.encoded_by
Tag.save()
Tag.remove()
Tag.chapters
Tag.table_of_contents
Tag.album_type
Tag.artist_origin
Tag.frameiter()
Tag.original_artist
FileInfo
AccessorBase
DltAccessor
CommentsAccessor
LyricsAccessor
ImagesAccessor
ObjectsAccessor
PrivatesAccessor
UserTextsAccessor
UniqueFileIdAccessor
UserUrlsAccessor
PopularitiesAccessor
ChaptersAccessor
TocAccessor
TagTemplate
- Module contents
- eyed3.mp3 package
- eyed3.plugins package
- Submodules
- eyed3.plugins.art module
- eyed3.plugins.classic module
- eyed3.plugins.extract module
- eyed3.plugins.fixup module
- eyed3.plugins.genres module
- eyed3.plugins.itunes module
- eyed3.plugins.jsontag module
- eyed3.plugins.lameinfo module
- eyed3.plugins.lastfm module
- eyed3.plugins.mimetype module
- eyed3.plugins.nfo module
- eyed3.plugins.pymod module
- eyed3.plugins.stats module
- eyed3.plugins.xep_118 module
- eyed3.plugins.yamltag module
- Module contents
- eyed3.utils package
- Submodules
- eyed3.utils.art module
- eyed3.utils.binfuncs module
- eyed3.utils.console module
AnsiCodes
AnsiFore
AnsiBack
AnsiStyle
AnsiStyle.RESET_ALL
AnsiStyle.BRIGHT
AnsiStyle.RESET_BRIGHT
AnsiStyle.DIM
AnsiStyle.RESET_DIM
AnsiStyle.ITALICS
AnsiStyle.RESET_ITALICS
AnsiStyle.UNDERLINE
AnsiStyle.RESET_UNDERLINE
AnsiStyle.BLINK_SLOW
AnsiStyle.RESET_BLINK_SLOW
AnsiStyle.BLINK_FAST
AnsiStyle.RESET_BLINK_FAST
AnsiStyle.INVERSE
AnsiStyle.RESET_INVERSE
AnsiStyle.STRIKE_THRU
AnsiStyle.RESET_STRIKE_THRU
ERROR_COLOR()
WARNING_COLOR()
HEADER_COLOR()
Spinner
ProgressBar
printMsg()
printError()
printWarning()
printHeader()
boldText()
formatText()
cformat()
getTtySize()
cprint()
- eyed3.utils.log module
- eyed3.utils.prompt module
- Module contents
Submodules
eyed3.core module
Basic core types and utilities.
- class eyed3.core.CountAndTotalTuple(count, total)
Bases:
tuple
Create new instance of CountAndTotalTuple(count, total)
- count
Alias for field number 0
- total
Alias for field number 1
- class eyed3.core.AudioInfo(time_secs: float, size_bytes: int)[source]
Bases:
object
A base container for common audio details.
- class eyed3.core.Tag(title=None, artist=None, album=None, album_artist=None, track_num=None)[source]
Bases:
object
An abstract interface for audio tag (meta) data (e.g. artist, title, etc.)
- property title
- property artist
- property album
- property album_artist
- property track_num: CountAndTotalTuple
Track number property. Must return a 2-tuple of (track-number, total-number-of-tracks). Either tuple value may be
None
.
- class eyed3.core.AudioFile(path)[source]
Bases:
object
Abstract base class for audio file types (AudioInfo + Tag)
Construct with a path and invoke
_read
. All other members are set to None.- rename(name, fsencoding='utf-8', preserve_file_time=False)[source]
Rename the file to
name
. The encoding used for the file name iseyed3.LOCAL_FS_ENCODING
unless overridden byfsencoding
. Note, if the target file already exists, or the full path contains non-existent directories the operation will fail withIOError
. File times are not modified whenpreserve_file_time
isTrue
,False
is the default.
- property info: AudioInfo
Returns a concrete implementation of
eyed3.core.AudioInfo
- property tag
Returns a concrete implementation of
eyed3.core.Tag
- property path
The absolute path of this file.
- class eyed3.core.Date(*args, **kwargs)[source]
Bases:
object
A class for representing a date and time (optional). This class differs from
datetime.datetime
in that the default values for month, day, hour, minute, and second isNone
and not ‘January 1, 00:00:00’. This allows for an object that is simply 1987, and not January 1 12AM, for example. But when more resolution is required those vales can be set as well.- TIME_STAMP_FORMATS = ['%Y', '%Y-%m', '%Y-%m-%d', '%Y-%m-%dT%H', '%Y-%m-%dT%H:%M', '%Y-%m-%dT%H:%M:%S', '%Y-%m-%dT%HZ', '%Y-%m-%dT%H:%MZ', '%Y-%m-%dT%H:%M:%SZ', '%Y-%m-%d %H:%M:%S', '%Y-00-00', '%Y%m%d', 'D%d-%m', 'T%H:%M']
Valid time stamp formats per ISO 8601 and used by strptime.
- property year
- property month
- property day
- property hour
- property minute
- property second
- eyed3.core.parseError(ex) None [source]
A function that is invoked when non-fatal parse, format, etc. errors occur. In most cases the invalid values will be ignored or possibly fixed. This function simply logs the error.
- eyed3.core.load(path, tag_version=None) AudioFile | None [source]
Loads the file identified by
path
and returns a concrete type ofeyed3.core.AudioFile
. Ifpath
is not a file anIOError
is raised.None
is returned when the file type (i.e. mime-type) is not recognized. The following AudioFile types are supported:eyed3.mp3.Mp3AudioFile
- For mp3 audio files.eyed3.id3.TagFile
- For raw ID3 data files.
If
tag_version
is not None (the default) only a specific version of metadata is loaded. This value must be a version constant specific to the eventual format of the metadata.
eyed3.main module
- eyed3.main.profileMain(args, config)[source]
This is the main function for profiling http://code.google.com/appengine/kb/commontasks.html#profiling
eyed3.mimetype module
- class eyed3.mimetype.Mp2x[source]
Bases:
Type
Implements the MP2.x audio type matcher.
- MIME = 'audio/mpeg'
- EXTENSION = 'mp3'
- class eyed3.mimetype.Mp3Invalids[source]
Bases:
Type
Implements a MP3 audio type matcher this is odd or/corrupt mp3.
- MIME = 'audio/mpeg'
- EXTENSION = 'mp3'
Module contents
- class eyed3.AudioFile(path)[source]
Bases:
object
Abstract base class for audio file types (AudioInfo + Tag)
Construct with a path and invoke
_read
. All other members are set to None.- property info: AudioInfo
Returns a concrete implementation of
eyed3.core.AudioInfo
- property path
The absolute path of this file.
- rename(name, fsencoding='utf-8', preserve_file_time=False)[source]
Rename the file to
name
. The encoding used for the file name iseyed3.LOCAL_FS_ENCODING
unless overridden byfsencoding
. Note, if the target file already exists, or the full path contains non-existent directories the operation will fail withIOError
. File times are not modified whenpreserve_file_time
isTrue
,False
is the default.
- property tag
Returns a concrete implementation of
eyed3.core.Tag
- eyed3.load(path, tag_version=None) AudioFile | None [source]
Loads the file identified by
path
and returns a concrete type ofeyed3.core.AudioFile
. Ifpath
is not a file anIOError
is raised.None
is returned when the file type (i.e. mime-type) is not recognized. The following AudioFile types are supported:eyed3.mp3.Mp3AudioFile
- For mp3 audio files.eyed3.id3.TagFile
- For raw ID3 data files.
If
tag_version
is not None (the default) only a specific version of metadata is loaded. This value must be a version constant specific to the eventual format of the metadata.