TagLib::ID3v2::CommentsFrame Class Reference
An implementation of
ID3v2 comments.
More...
#include <commentsframe.h>
Inheritance diagram for TagLib::ID3v2::CommentsFrame:
[legend]Collaboration diagram for TagLib::ID3v2::CommentsFrame:
[legend]List of all members.
Detailed Description
An implementation of
ID3v2 comments.
This implements the ID3v2 comment format. An ID3v2 comment concists of a language encoding, a description and a single text field.
Constructor & Destructor Documentation
TagLib::ID3v2::CommentsFrame::CommentsFrame |
( |
String::Type |
encoding = String::Latin1 |
) |
[explicit] |
|
|
Construct an empty comment frame that will use the text encoding encoding. |
TagLib::ID3v2::CommentsFrame::CommentsFrame |
( |
const ByteVector & |
data |
) |
[explicit] |
|
|
Construct a comment based on the data in data. |
virtual TagLib::ID3v2::CommentsFrame::~CommentsFrame |
( |
|
) |
[virtual] |
|
|
Destroys this CommentFrame instance. |
Member Function Documentation
String TagLib::ID3v2::CommentsFrame::description |
( |
|
) |
const |
|
|
Returns the description of this comment.
- Note:
- Most taggers simply ignore this value.
- See also:
- setDescription()
|
static CommentsFrame* TagLib::ID3v2::CommentsFrame::findByDescription |
( |
const Tag * |
tag, |
|
|
const String & |
d |
|
) |
[static] |
|
|
Comments each have a unique description. This searches for a comment frame with the decription d and returns a pointer to it. If no frame is found that matches the given description null is returned.
- See also:
- description()
|
ByteVector TagLib::ID3v2::CommentsFrame::language |
( |
|
) |
const |
|
|
Returns the language encoding as a 3 byte encoding as specified by ISO-639-2.
- Note:
- Most taggers simply ignore this value.
- See also:
- setLanguage()
|
virtual void TagLib::ID3v2::CommentsFrame::parseFields |
( |
const ByteVector & |
data |
) |
[protected, virtual] |
|
virtual ByteVector TagLib::ID3v2::CommentsFrame::renderFields |
( |
|
) |
const [protected, virtual] |
|
void TagLib::ID3v2::CommentsFrame::setDescription |
( |
const String & |
s |
) |
|
|
|
Sets the description of the comment to s.
- See also:
- decription()
|
void TagLib::ID3v2::CommentsFrame::setLanguage |
( |
const ByteVector & |
languageCode |
) |
|
|
|
Set the language using the 3 byte language code from ISO-639-2 to languageCode.
- See also:
- language()
|
virtual void TagLib::ID3v2::CommentsFrame::setText |
( |
const String & |
s |
) |
[virtual] |
|
|
Sets the text portion of the comment to s.
- See also:
- text()
|
void TagLib::ID3v2::CommentsFrame::setTextEncoding |
( |
String::Type |
encoding |
) |
|
|
|
Sets the text encoding to be used when rendering this frame to encoding.
- See also:
- textEncoding()
render()
|
String TagLib::ID3v2::CommentsFrame::text |
( |
|
) |
const |
|
|
Returns the text of this comment.
- See also:
- setText()
|
String::Type TagLib::ID3v2::CommentsFrame::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.
- See also:
- setTextEncoding()
render()
|
virtual String TagLib::ID3v2::CommentsFrame::toString |
( |
|
) |
const [virtual] |
|
|
Returns the text of this comment.
- See also:
- text()
|
Friends And Related Function Documentation
The documentation for this class was generated from the following file: