TagLib 1.5 (TagLib: TagLib::ID3v2::TextIdentificationFrame Class Reference)

TagLib::ID3v2::TextIdentificationFrame Class Reference

An ID3v2 text identification frame implementation. More...

#include <textidentificationframe.h>

Inheritance diagram for TagLib::ID3v2::TextIdentificationFrame:

Inheritance graph
[legend]
Collaboration diagram for TagLib::ID3v2::TextIdentificationFrame:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 TextIdentificationFrame (const ByteVector &type, String::Type encoding)
 TextIdentificationFrame (const ByteVector &data)
virtual ~TextIdentificationFrame ()
void setText (const StringList &l)
virtual void setText (const String &s)
virtual String toString () const
String::Type textEncoding () const
void setTextEncoding (String::Type encoding)
StringList fieldList () const

Protected Member Functions

virtual void parseFields (const ByteVector &data)
virtual ByteVector renderFields () const
 TextIdentificationFrame (const ByteVector &data, Header *h)

Friends

class FrameFactory

Detailed Description

An ID3v2 text identification frame implementation.

This is an implementation of the most common type of ID3v2 frame -- text identification frames. There are a number of variations on this. Those enumerated in the ID3v2.4 standard are:

The ID3v2 Frames document gives a description of each of these formats and the expected order of strings in each. ID3v2::Header::frameID() can be used to determine the frame type.

Note:
If non-Latin1 compatible strings are used with this class, even if the text encoding is set to Latin1, the frame will be written using UTF8 (with the encoding flag appropriately set in the output).


Constructor & Destructor Documentation

TagLib::ID3v2::TextIdentificationFrame::TextIdentificationFrame ( const ByteVector type,
String::Type  encoding 
)

Construct an empty frame of type type. Uses encoding as the default text encoding.

Note:
In this case you must specify the text encoding as it resolves the ambiguity between constructors.

Please see the note in the class description regarding Latin1.

TagLib::ID3v2::TextIdentificationFrame::TextIdentificationFrame ( const ByteVector data  )  [explicit]

This is a dual purpose constructor. data can either be binary data that should be parsed or (at a minimum) the frame ID.

virtual TagLib::ID3v2::TextIdentificationFrame::~TextIdentificationFrame (  )  [virtual]

Destroys this TextIdentificationFrame instance.

TagLib::ID3v2::TextIdentificationFrame::TextIdentificationFrame ( const ByteVector data,
Header h 
) [protected]

The constructor used by the FrameFactory.


Member Function Documentation

StringList TagLib::ID3v2::TextIdentificationFrame::fieldList (  )  const

Returns a list of the strings in this frame.

Reimplemented in TagLib::ID3v2::UserTextIdentificationFrame.

virtual void TagLib::ID3v2::TextIdentificationFrame::parseFields ( const ByteVector data  )  [protected, virtual]

virtual ByteVector TagLib::ID3v2::TextIdentificationFrame::renderFields (  )  const [protected, virtual]

virtual void TagLib::ID3v2::TextIdentificationFrame::setText ( const String s  )  [virtual]

void TagLib::ID3v2::TextIdentificationFrame::setText ( const StringList l  ) 

Text identification frames are a list of string fields.

This function will accept either a StringList or a String (using the StringList constructor that accepts a single String).

Note:
This will not change the text encoding of the frame even if the strings passed in are not of the same encoding. Please use setEncoding(s.type()) if you wish to change the encoding of the frame.

Reimplemented in TagLib::ID3v2::UserTextIdentificationFrame.

void TagLib::ID3v2::TextIdentificationFrame::setTextEncoding ( String::Type  encoding  ) 

Sets the text encoding to be used when rendering this frame to encoding.

Note:
Please see the note in the class description regarding Latin1.
See also:
textEncoding()

render()

String::Type TagLib::ID3v2::TextIdentificationFrame::textEncoding (  )  const

Returns the text encoding that will be used in rendering this frame. This defaults to the type that was either specified in the constructor or read from the frame when parsed.

Note:
Please see the note in the class description regarding Latin1.
See also:
setTextEncoding()

render()

virtual String TagLib::ID3v2::TextIdentificationFrame::toString (  )  const [virtual]


Friends And Related Function Documentation

friend class FrameFactory [friend]


The documentation for this class was generated from the following file: