namespace ID3v2 {
/*!
- * This is an implementation of ID3v2 chapter frames. The purpose of this
+ * This is an implementation of ID3v2 chapter frames. The purpose of this
* frame is to describe a single chapter within an audio file.
*/
* start time \a sT, end time \a eT, start offset \a sO,
* end offset \a eO and embedded frames, that are in \a eF.
*/
- ChapterFrame(const ByteVector &eID, const uint &sT, const uint &eT, const uint &sO, const uint &eO, const FrameList &eF);
+ ChapterFrame(const ByteVector &eID, const uint &sT, const uint &eT, const uint &sO,
+ const uint &eO, const FrameList &eF);
/*!
* Destroys the frame.
*/
~ChapterFrame();
-
+
/*!
* Returns the element ID of the frame. Element ID
* is a null terminated string, however it's not human-readable.
- *
+ *
* \see setElementID()
*/
ByteVector elementID() const;
-
+
/*!
* Returns time of chapter's start (in miliseconds).
- *
+ *
* \see setStartTime()
*/
uint startTime() const;
-
+
/*!
* Returns time of chapter's end (in miliseconds).
- *
+ *
* \see setEndTime()
*/
uint endTime() const;
-
+
/*!
* Returns zero based byte offset (count of bytes from the beginning
* of the audio file) of chapter's start.
- *
+ *
* \note If returned value is 0xFFFFFFFF, start time should be used instead.
* \see setStartOffset()
*/
uint startOffset() const;
-
+
/*!
* Returns zero based byte offset (count of bytes from the beginning
* of the audio file) of chapter's end.
- *
+ *
* \note If returned value is 0xFFFFFFFF, end time should be used instead.
* \see setEndOffset()
*/
/*!
* Sets the element ID of the frame to \a eID. If \a eID isn't
* null terminated, a null char is appended automatically.
- *
+ *
* \see elementID()
*/
void setElementID(const ByteVector &eID);
-
+
/*!
* Sets time of chapter's start (in miliseconds) to \a sT.
- *
+ *
* \see startTime()
*/
void setStartTime(const uint &sT);
-
+
/*!
* Sets time of chapter's end (in miliseconds) to \a eT.
- *
+ *
* \see endTime()
*/
void setEndTime(const uint &eT);
-
+
/*!
* Sets zero based byte offset (count of bytes from the beginning
* of the audio file) of chapter's start to \a sO.
- *
+ *
* \see startOffset()
*/
void setStartOffset(const uint &sO);
-
+
/*!
* Sets zero based byte offset (count of bytes from the beginning
* of the audio file) of chapter's end to \a eO.
- *
+ *
* \see endOffset()
*/
void setEndOffset(const uint &eO);
-
+
/*!
* Returns a reference to the frame list map. This is an FrameListMap of
* all of the frames embedded in the CHAP frame.
*
- * This is the most convenient structure for accessing the CHAP frame's
- * embedded frames. Many frame types allow multiple instances of the same
- * frame type so this is a map of lists. In most cases however there will
+ * This is the most convenient structure for accessing the CHAP frame's
+ * embedded frames. Many frame types allow multiple instances of the same
+ * frame type so this is a map of lists. In most cases however there will
* only be a single frame of a certain type.
*
* \warning You should not modify this data structure directly, instead
* \see embeddedFrameList()
*/
const FrameListMap &embeddedFrameListMap() const;
-
+
/*!
- * Returns a reference to the embedded frame list. This is an FrameList
+ * Returns a reference to the embedded frame list. This is an FrameList
* of all of the frames embedded in the CHAP frame in the order that they
* were parsed.
*
- * This can be useful if for example you want iterate over the CHAP frame's
+ * This can be useful if for example you want iterate over the CHAP frame's
* embedded frames in the order that they occur in the CHAP frame.
*
* \warning You should not modify this data structure directly, instead
const FrameList &embeddedFrameList() const;
/*!
- * Returns the embedded frame list for frames with the id \a frameID
+ * Returns the embedded frame list for frames with the id \a frameID
* or an empty list if there are no embedded frames of that type. This
* is just a convenience and is equivalent to:
*
const FrameList &embeddedFrameList(const ByteVector &frameID) const;
/*!
- * Add an embedded frame to the CHAP frame. At this point the CHAP frame
+ * Add an embedded frame to the CHAP frame. At this point the CHAP frame
* takes ownership of the embedded frame and will handle freeing its memory.
*
* \note Using this method will invalidate any pointers on the list
void addEmbeddedFrame(Frame *frame);
/*!
- * Remove an embedded frame from the CHAP frame. If \a del is true the frame's
+ * Remove an embedded frame from the CHAP frame. If \a del is true the frame's
* memory will be freed; if it is false, it must be deleted by the user.
*
* \note Using this method will invalidate any pointers on the list
void removeEmbeddedFrame(Frame *frame, bool del = true);
/*!
- * Remove all embedded frames of type \a id from the CHAP frame and free their
+ * Remove all embedded frames of type \a id from the CHAP frame and free their
* memory.
*
* \note Using this method will invalidate any pointers on the list