ID3_Frame Class Reference
The representative class of an id3v2 frame.
More...
#include <id3lib_frame.h>
List of all members.
Detailed Description
The representative class of an id3v2 frame.
id3lib defines frames in a funny way. Using some nice c++ conventions, ID3_FrameImpl class objects appear to be quite polymorphic; that is, they can take on many forms. The same ID3_FrameImpl class provides the facilities for the implementation of a complex APIC frame and for a simple text frame.
- Author:
- Dirk Mahoney
- Version:
- Id
- frame.cpp,v 1.35 2002/08/10 10:42:42 t1mpy Exp
- See also:
- ID3_Tag
-
ID3_Field
-
ID3_Err
Definition at line 38 of file id3lib_frame.h.
Constructor & Destructor Documentation
ID3_Frame::ID3_Frame |
( |
ID3_FrameID |
id = ID3FID_NOFRAME |
) |
|
Default constructor; accepts as a default parameter the type of frame to create.
The parameter which will internally set the frame's structure. See SetID() for more details.
- Parameters:
-
| id | The type of frame to create |
- See also:
- ID3_FrameID
-
SetID
Definition at line 62 of file frame.cpp.
ID3_Frame::ID3_Frame |
( |
const ID3_Frame & |
frame |
) |
|
ID3_Frame::~ID3_Frame |
( |
|
) |
[virtual] |
Member Function Documentation
void ID3_Frame::Clear |
( |
|
) |
|
Clears the frame of all data and resets the frame such that it can take on the form of any id3v2 frame that id3lib supports.
- See also:
- ID3_Tag::Clear
Definition at line 82 of file frame.cpp.
Returns a pointer to the frame's internal field indicated by the parameter.
- Parameters:
-
| name | The name of the field to be retrieved |
- Returns:
- A reference to the desired field
Definition at line 142 of file frame.cpp.
bool ID3_Frame::GetCompression |
( |
|
) |
const |
Returns whether or not the compression flag is set.
After parsing a tag, this will indicate whether or not the frame was compressed. After rendering a tag, however, it does not actually indicate if the frame is compressed rendering. It only indicates whether or not compression was attempted. A frame will not be compressed, even whent the compression flag is set, if the "compressed" data is no smaller than the "uncompressed" data.
Definition at line 232 of file frame.cpp.
size_t ID3_Frame::GetDataSize |
( |
|
) |
const |
const char * ID3_Frame::GetDescription |
( |
ID3_FrameID |
id |
) |
[static] |
const char * ID3_Frame::GetDescription |
( |
|
) |
const |
uchar ID3_Frame::GetEncryptionID |
( |
|
) |
const |
uchar ID3_Frame::GetGroupingID |
( |
|
) |
const |
Returns the type of frame that the object represents.
Useful in conjunction with ID3_Tag::Find() method
- Returns:
- The type, or id, of the frame
- See also:
- ID3_Tag::Find
Definition at line 94 of file frame.cpp.
const char * ID3_Frame::GetTextID |
( |
|
) |
const |
bool ID3_Frame::HasChanged |
( |
|
) |
const |
size_t ID3_Frame::NumFields |
( |
|
) |
const |
void ID3_Frame::Render |
( |
ID3_Writer & |
writer |
) |
const |
bool ID3_Frame::SetCompression |
( |
bool |
b |
) |
|
Sets the compression flag within the frame.
When the compression flag is is set, compression will be attempted. However, the frame might not actually be compressed after it is rendered if the "compressed" data is no smaller than the "uncompressed" data.
Definition at line 219 of file frame.cpp.
bool ID3_Frame::SetEncryptionID |
( |
uchar |
id |
) |
|
bool ID3_Frame::SetGroupingID |
( |
uchar |
id |
) |
|
Establishes the internal structure of an ID3_FrameImpl object so that it represents the id3v2 frame indicated by the parameter.
Given an ID3_FrameID (a list of which is found in <id3/field.h>), SetID() will structure the object according to the frame you wish to implement.
Either using this call or via the constructor, this must be the first command performed on an ID3_FrameImpl object.
- Parameters:
-
| id | The type of frame this frame should be set to |
- See also:
- ID3_FrameID
Definition at line 116 of file frame.cpp.
size_t ID3_Frame::Size |
( |
|
) |
|
The documentation for this class was generated from the following files: