Home       Trees       Index       Help   
Package tagger :: Module id3v2frame :: Class ID3v2_3_Frame
[show private | hide private]
[frames | no frames]

Class ID3v2_3_Frame

ID3v2BaseFrame --+
                 |
                ID3v2_3_Frame

Known Subclasses:
ID3v2_4_Frame
Method Summary
  getformat(self)
  getstatus(self)
  output(self)
Create a bytestring representing the frame contents and the field
  parse_frame_header(self, frame)
Parse the frame header from a bytestring
    Inherited from ID3v2BaseFrame
  __init__(self, frame, fid)
creates an ID3v2BaseFrame structure.
  new_frame_header(self)
creates a new frame header
  o_apic(self)
  o_bin(self)
  o_comm(self)
  o_geob(self)
  o_pcnt(self)
  o_string(self, s, toenc, fromenc)
Converts a String or Unicode String to a byte string of specified encoding.
  o_text(self)
Output text bytestring
  o_url(self)
  o_wxxx(self)
  output_field(self)
  parse_field(self)
  x_apic(self)
Extract APIC
  x_bin(self)
  x_comm(self)
extract comment field
  x_geob(self)
Extract GEOB
  x_pcnt(self)
Extract Play Count
  x_text(self)
Extract Text Fields
  x_url(self)
  x_wxxx(self)
Extract URL

Instance Variable Summary
    Inherited from ID3v2BaseFrame
  counter: for playcount (PCNT)
  desc: for geob and URL
  encoding: optional - for text fields we have the encoding name
  fid: frame id code
  filename: filename for GEOB
  flags: dictionary of flags for this frame
  language: set if this frame is a comment (2 character code)
  length: length of the frame in bytes
  longcomment: set if this frame is a comment (optional)
  mimetype: mimetype for GEOB, APIC
  obj: data for GEOB
  rawdata: rawdata of the rest of the frame minus the header
  shortcomment: set if this frame is a comment
  strings: a list of strings for text fields
  url: for URL

Class Variable Summary
dict format_flags: format flags required
int header_length: header portion length
dict status_flags: status flags required
dict supported: supported frame ids
float version = 2.2999999999999998                                                    

Method Details

output(self)

Create a bytestring representing the frame contents and the field
Overrides:
tagger.id3v2frame.ID3v2BaseFrame.output (inherited documentation)

To Do:

  • no syncsafing
  • no status format flags used

parse_frame_header(self, frame)

Parse the frame header from a bytestring
Parameters:
frame - bytestring of the frame
           (type=string)
Overrides:
tagger.id3v2frame.ID3v2BaseFrame.parse_frame_header (inherited documentation)

To Do: apple's id3 tags doesn't seem to follow the unsync safe format


Class Variable Details

format_flags

format flags required
Type:
dict
Value:
[('groupinfo', 6),
 ('compression', 3),
 ('encryption', 2),
 ('sync', 1),
 ('datalength', 0)]

header_length

header portion length
Type:
int
Value:
10                                                                    

status_flags

status flags required
Type:
dict
Value:
[('tagpreserve', 6), ('filepreserve', 5), ('readonly', 4)]

supported

supported frame ids
Type:
dict
Value:
{'ENCR': ('bin', 'Encryption method registration'),
 'LINK': ('link', 'Linked Information'),
 'POPM': ('bin', 'Popularimeter'),
 'PRIV': ('bin', 'Private frame'),
 'SYTC': ('bin', 'Synchronised tempo codes'),
 'TDAT': ('text', 'Date'),
 'TEXT': ('text', 'Lyricist/Text writer'),
 'WOAR': ('url', 'Official artist performance webpage'),
...

version

Type:
float
Value:
2.2999999999999998                                                    

   Home       Trees       Index       Help   
Generated by Epydoc 2.0 on Sun Apr 10 14:44:00 2005 http://epydoc.sf.net