1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#include "qmediaplaylistioplugin_p.h"
41
42QT_BEGIN_NAMESPACE
43
44/*!
45 \class QMediaPlaylistReader
46 \internal
47
48 \brief The QMediaPlaylistReader class provides an interface for reading a playlist file.
49 \inmodule QtMultimedia
50
51 \ingroup multimedia
52 \ingroup multimedia_playback
53
54 \sa QMediaPlaylistIOPlugin
55*/
56
57/*!
58 Destroys a media playlist reader.
59*/
60QMediaPlaylistReader::~QMediaPlaylistReader()
61{
62}
63
64/*!
65 \fn QMediaPlaylistReader::atEnd() const
66
67 Identifies if a playlist reader has reached the end of its input.
68
69 Returns true if the reader has reached the end; and false otherwise.
70*/
71
72/*!
73 \fn QMediaPlaylistReader::readItem()
74
75 Reads an item of media from a playlist file.
76
77 Returns the read media, or a null QMediaContent if no more media is available.
78*/
79
80/*!
81 \fn QMediaPlaylistReader::close()
82
83 Closes a playlist reader's input device.
84*/
85
86/*!
87 \class QMediaPlaylistWriter
88 \internal
89
90 \brief The QMediaPlaylistWriter class provides an interface for writing a playlist file.
91
92 \sa QMediaPlaylistIOPlugin
93*/
94
95/*!
96 Destroys a media playlist writer.
97*/
98QMediaPlaylistWriter::~QMediaPlaylistWriter()
99{
100}
101
102/*!
103 \fn QMediaPlaylistWriter::writeItem(const QMediaContent &media)
104
105 Writes an item of \a media to a playlist file.
106
107 Returns true if the media was written successfully; and false otherwise.
108*/
109
110/*!
111 \fn QMediaPlaylistWriter::close()
112
113 Finalizes the writing of a playlist and closes the output device.
114*/
115
116/*!
117 \class QMediaPlaylistIOPlugin
118 \internal
119
120 \brief The QMediaPlaylistIOPlugin class provides an interface for media playlist I/O plug-ins.
121*/
122
123/*!
124 Constructs a media playlist I/O plug-in with the given \a parent.
125*/
126QMediaPlaylistIOPlugin::QMediaPlaylistIOPlugin(QObject *parent)
127 :QObject(parent)
128{
129}
130
131/*!
132 Destroys a media playlist I/O plug-in.
133*/
134QMediaPlaylistIOPlugin::~QMediaPlaylistIOPlugin()
135{
136}
137
138/*!
139 \fn QMediaPlaylistIOPlugin::canRead(QIODevice *device, const QByteArray &format) const
140
141 Identifies if plug-in can read \a format data from an I/O \a device.
142
143 Returns true if the data can be read; and false otherwise.
144*/
145
146/*!
147 \fn QMediaPlaylistIOPlugin::canRead(const QUrl& location, const QByteArray &format) const
148
149 Identifies if a plug-in can read \a format data from a URL \a location.
150
151 Returns true if the data can be read; and false otherwise.
152*/
153
154/*!
155 \fn QMediaPlaylistIOPlugin::canWrite(QIODevice *device, const QByteArray &format) const
156
157 Identifies if a plug-in can write \a format data to an I/O \a device.
158
159 Returns true if the data can be written; and false otherwise.
160*/
161
162/*!
163 \fn QMediaPlaylistIOPlugin::createReader(QIODevice *device, const QByteArray &format)
164
165 Returns a new QMediaPlaylistReader which reads \a format data from an I/O \a device.
166
167 If the device is invalid or the format is unsupported this will return a null pointer.
168*/
169
170/*!
171 \fn QMediaPlaylistIOPlugin::createReader(const QUrl& location, const QByteArray &format)
172
173 Returns a new QMediaPlaylistReader which reads \a format data from a URL \a location.
174
175 If the location or the format is unsupported this will return a null pointer.
176*/
177
178/*!
179 \fn QMediaPlaylistIOPlugin::createWriter(QIODevice *device, const QByteArray &format)
180
181 Returns a new QMediaPlaylistWriter which writes \a format data to an I/O \a device.
182
183 If the device is invalid or the format is unsupported this will return a null pointer.
184*/
185
186QT_END_NAMESPACE
187
188#include "moc_qmediaplaylistioplugin_p.cpp"
189

source code of qtmultimedia/src/multimedia/playback/qmediaplaylistioplugin.cpp