TagLib API Documentation
matroskafile.h
Go to the documentation of this file.
1/***************************************************************************
2 * This library is free software; you can redistribute it and/or modify *
3 * it under the terms of the GNU Lesser General Public License version *
4 * 2.1 as published by the Free Software Foundation. *
5 * *
6 * This library is distributed in the hope that it will be useful, but *
7 * WITHOUT ANY WARRANTY; without even the implied warranty of *
8 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
9 * Lesser General Public License for more details. *
10 * *
11 * You should have received a copy of the GNU Lesser General Public *
12 * License along with this library; if not, write to the Free Software *
13 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA *
14 * 02110-1301 USA *
15 * *
16 * Alternatively, this file is available under the Mozilla Public *
17 * License Version 1.1. You may obtain a copy of the License at *
18 * http://www.mozilla.org/MPL/ *
19 ***************************************************************************/
20
21#ifndef TAGLIB_MATROSKAFILE_H
22#define TAGLIB_MATROSKAFILE_H
23
24#include "taglib_export.h"
25#include "tfile.h"
26#include "matroskaproperties.h"
27#include "matroskawritestyle.h"
28
30namespace TagLib::Matroska {
31 class Tag;
32 class Attachments;
33 class Chapters;
34
36
41 {
42 public:
50 explicit File(FileName file, bool readProperties = true,
51 Properties::ReadStyle readStyle = Properties::Average);
52
60 explicit File(IOStream *stream, bool readProperties = true,
61 Properties::ReadStyle readStyle = Properties::Average);
62
66 ~File() override;
67
68 File(const File &) = delete;
69 File &operator=(const File &) = delete;
70
80 TagLib::Tag *tag() const override;
81
93 Tag *tag(bool create) const;
94
98 PropertyMap properties() const override;
99
100 void removeUnsupportedProperties(const StringList &properties) override;
101
106
113
123 List<VariantMap> complexProperties(const String &key) const override;
124
134 bool setComplexProperties(const String &key, const List<VariantMap> &value) override;
135
140 Properties *audioProperties() const override;
141
147 bool save() override;
148
155
164 Attachments *attachments(bool create = false) const;
165
174 Chapters *chapters(bool create = false) const;
175
183 static bool isSupported(IOStream *stream);
184
185 private:
187 class FilePrivate;
188 friend class Properties;
190 std::unique_ptr<FilePrivate> d;
191 };
192}
193
194#endif
ReadStyle
Definition audioproperties.h:56
A file class with some useful methods for tag manipulation.
Definition tfile.h:51
An abstract class that provides operations on a sequence of bytes.
Definition tiostream.h:65
A generic, implicitly shared list.
Definition tlist.h:54
Collection of attached files.
Definition matroskaattachments.h:45
Collection of chapter editions.
Definition matroskachapters.h:50
An implementation of TagLib::File with Matroska specific methods.
Definition matroskafile.h:41
List< VariantMap > complexProperties(const String &key) const override
PropertyMap properties() const override
PropertyMap setProperties(const PropertyMap &) override
Attachments * attachments(bool create=false) const
Tag * tag(bool create) const
TagLib::Tag * tag() const override
bool save(WriteStyle style)
bool save() override
Chapters * chapters(bool create=false) const
File(IOStream *stream, bool readProperties=true, Properties::ReadStyle readStyle=Properties::Average)
static bool isSupported(IOStream *stream)
bool setComplexProperties(const String &key, const List< VariantMap > &value) override
void removeUnsupportedProperties(const StringList &properties) override
File(FileName file, bool readProperties=true, Properties::ReadStyle readStyle=Properties::Average)
File & operator=(const File &)=delete
StringList complexPropertyKeys() const override
Properties * audioProperties() const override
File(const File &)=delete
An implementation of Matroska audio properties.
Definition matroskaproperties.h:42
Matroska tag implementation.
Definition matroskatag.h:47
A map for format-independent <key,values> tag representations.
Definition tpropertymap.h:123
A list of strings.
Definition tstringlist.h:44
A wide string class suitable for unicode.
Definition tstring.h:83
A simple, generic interface to common audio metadata fields.
Definition tag.h:49
An implementation of Matroska metadata.
Definition matroskaattachedfile.h:32
WriteStyle
Definition matroskawritestyle.h:36
#define TAGLIB_EXPORT
Definition taglib_export.h:40
#define TAGLIB_MSVC_SUPPRESS_WARNING_NEEDS_TO_HAVE_DLL_INTERFACE
Definition taglib_export.h:55