| TagLib 1.13 |  |

chapterframe.h
Go to the documentation of this file.
1/***************************************************************************
2 copyright : (C) 2013 by Lukas Krejci
3 email : krejclu6@fel.cvut.cz
4 ***************************************************************************/
5
6/***************************************************************************
7 * This library is free software; you can redistribute it and/or modify *
8 * it under the terms of the GNU Lesser General Public License version *
9 * 2.1 as published by the Free Software Foundation. *
10 * *
11 * This library is distributed in the hope that it will be useful, but *
12 * WITHOUT ANY WARRANTY; without even the implied warranty of *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
14 * Lesser General Public License for more details. *
15 * *
16 * You should have received a copy of the GNU Lesser General Public *
17 * License along with this library; if not, write to the Free Software *
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA *
19 * 02110-1301 USA *
20 * *
21 * Alternatively, this file is available under the Mozilla Public *
22 * License Version 1.1. You may obtain a copy of the License at *
23 * http://www.mozilla.org/MPL/ *
24 ***************************************************************************/
25
26#ifndef TAGLIB_CHAPTERFRAME
27#define TAGLIB_CHAPTERFRAME
28
29#include "id3v2tag.h"
30#include "id3v2frame.h"
31#include "taglib_export.h"
32
33 namespace TagLib {
34
35 namespace ID3v2 {
36
43
44 class TAGLIB_EXPORT ChapterFrame : public ID3v2::Frame
45 {
46 friend class FrameFactory;
47
48 public:
53 ChapterFrame(const ID3v2::Header *tagHeader, const ByteVector &data);
54
64 ChapterFrame(const ByteVector &elementID,
65 unsigned int startTime, unsigned int endTime,
66 unsigned int startOffset, unsigned int endOffset,
67 const FrameList &embeddedFrames = FrameList());
68
72 virtual ~ChapterFrame();
73
80 ByteVector elementID() const;
81
87 unsigned int startTime() const;
88
94 unsigned int endTime() const;
95
103 unsigned int startOffset() const;
104
112 unsigned int endOffset() const;
113
120 void setElementID(const ByteVector &eID);
121
127 void setStartTime(const unsigned int &sT);
128
134 void setEndTime(const unsigned int &eT);
135
142 void setStartOffset(const unsigned int &sO);
143
150 void setEndOffset(const unsigned int &eO);
151
166 const FrameListMap &embeddedFrameListMap() const;
167
179 const FrameList &embeddedFrameList() const;
180
192 const FrameList &embeddedFrameList(const ByteVector &frameID) const;
193
201 void addEmbeddedFrame(Frame *frame);
202
210 void removeEmbeddedFrame(Frame *frame, bool del = true);
211
219 void removeEmbeddedFrames(const ByteVector &id);
220
221 virtual String toString() const;
222
223 PropertyMap asProperties() const;
224
232 static ChapterFrame *findByElementID(const Tag *tag, const ByteVector &eID);
233
234 protected:
235 virtual void parseFields(const ByteVector &data);
236 virtual ByteVector renderFields() const;
237
238 private:
239 ChapterFrame(const ID3v2::Header *tagHeader, const ByteVector &data, Header *h);
240 ChapterFrame(const ChapterFrame &);
241 ChapterFrame &operator=(const ChapterFrame &);
242
243 class ChapterFramePrivate;
244 ChapterFramePrivate *d;
245 };
246 }
247}
248
249#endif
TagLib::ByteVector
A byte vector.
Definition: tbytevector.h:46
TagLib::ID3v2::ChapterFrame
An implementation of ID3v2 chapter frames.
Definition: chapterframe.h:45
TagLib::ID3v2::ChapterFrame::elementID
ByteVector elementID() const
TagLib::ID3v2::ChapterFrame::ChapterFrame
ChapterFrame(const ID3v2::Header *tagHeader, const ByteVector &data)
TagLib::ID3v2::ChapterFrame::~ChapterFrame
virtual ~ChapterFrame()
TagLib::ID3v2::ChapterFrame::addEmbeddedFrame
void addEmbeddedFrame(Frame *frame)
TagLib::ID3v2::ChapterFrame::setEndTime
void setEndTime(const unsigned int &eT)
TagLib::ID3v2::ChapterFrame::endTime
unsigned int endTime() const
TagLib::ID3v2::ChapterFrame::embeddedFrameListMap
const FrameListMap & embeddedFrameListMap() const
TagLib::ID3v2::ChapterFrame::startTime
unsigned int startTime() const
TagLib::ID3v2::ChapterFrame::setElementID
void setElementID(const ByteVector &eID)
TagLib::ID3v2::ChapterFrame::renderFields
virtual ByteVector renderFields() const
TagLib::ID3v2::ChapterFrame::endOffset
unsigned int endOffset() const
TagLib::ID3v2::ChapterFrame::removeEmbeddedFrames
void removeEmbeddedFrames(const ByteVector &id)
TagLib::ID3v2::ChapterFrame::embeddedFrameList
const FrameList & embeddedFrameList() const
TagLib::ID3v2::ChapterFrame::ChapterFrame
ChapterFrame(const ByteVector &elementID, unsigned int startTime, unsigned int endTime, unsigned int startOffset, unsigned int endOffset, const FrameList &embeddedFrames=FrameList())
TagLib::ID3v2::ChapterFrame::removeEmbeddedFrame
void removeEmbeddedFrame(Frame *frame, bool del=true)
TagLib::ID3v2::ChapterFrame::setStartTime
void setStartTime(const unsigned int &sT)
TagLib::ID3v2::ChapterFrame::setEndOffset
void setEndOffset(const unsigned int &eO)
TagLib::ID3v2::ChapterFrame::parseFields
virtual void parseFields(const ByteVector &data)
TagLib::ID3v2::ChapterFrame::embeddedFrameList
const FrameList & embeddedFrameList(const ByteVector &frameID) const
TagLib::ID3v2::ChapterFrame::setStartOffset
void setStartOffset(const unsigned int &sO)
TagLib::ID3v2::ChapterFrame::findByElementID
static ChapterFrame * findByElementID(const Tag *tag, const ByteVector &eID)
TagLib::ID3v2::ChapterFrame::asProperties
PropertyMap asProperties() const
TagLib::ID3v2::ChapterFrame::toString
virtual String toString() const
TagLib::ID3v2::ChapterFrame::startOffset
unsigned int startOffset() const
TagLib::ID3v2::FrameFactory
A factory for creating ID3v2 frames during parsing.
Definition: id3v2framefactory.h:66
TagLib::ID3v2::Frame
ID3v2 frame implementation.
Definition: id3v2frame.h:55
TagLib::ID3v2::Header
An implementation of ID3v2 headers.
Definition: id3v2header.h:49
TagLib::ID3v2::Tag
The main class in the ID3v2 implementation.
Definition: id3v2tag.h:128
TagLib::List
A generic, implicitly shared list.
Definition: tlist.h:54
TagLib::Map
A generic, implicitly shared map.
Definition: tmap.h:44
TagLib::PropertyMap
A map for format-independent <key,valuelist> tag representations.
Definition: tpropertymap.h:119
TagLib::String
A wide string class suitable for unicode.
Definition: tstring.h:85
id3v2frame.h
id3v2tag.h
TagLib::ID3v2::FrameList
List< Frame * > FrameList
Definition: id3v2tag.h:47
TagLib
A namespace for all TagLib related classes and functions.
Definition: apefile.h:41
taglib_export.h
TAGLIB_EXPORT
#define TAGLIB_EXPORT
Definition: taglib_export.h:40