|
1 /**************************************************************************** |
|
2 ** |
|
3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). |
|
4 ** All rights reserved. |
|
5 ** Contact: Nokia Corporation (qt-info@nokia.com) |
|
6 ** |
|
7 ** This file is part of the Qt Mobility Components. |
|
8 ** |
|
9 ** $QT_BEGIN_LICENSE:LGPL$ |
|
10 ** No Commercial Usage |
|
11 ** This file contains pre-release code and may not be distributed. |
|
12 ** You may use this file in accordance with the terms and conditions |
|
13 ** contained in the Technology Preview License Agreement accompanying |
|
14 ** this package. |
|
15 ** |
|
16 ** GNU Lesser General Public License Usage |
|
17 ** Alternatively, this file may be used under the terms of the GNU Lesser |
|
18 ** General Public License version 2.1 as published by the Free Software |
|
19 ** Foundation and appearing in the file LICENSE.LGPL included in the |
|
20 ** packaging of this file. Please review the following information to |
|
21 ** ensure the GNU Lesser General Public License version 2.1 requirements |
|
22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. |
|
23 ** |
|
24 ** In addition, as a special exception, Nokia gives you certain additional |
|
25 ** rights. These rights are described in the Nokia Qt LGPL Exception |
|
26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. |
|
27 ** |
|
28 ** If you have questions regarding the use of this file, please contact |
|
29 ** Nokia at qt-info@nokia.com. |
|
30 ** |
|
31 ** |
|
32 ** |
|
33 ** |
|
34 ** |
|
35 ** |
|
36 ** |
|
37 ** |
|
38 ** $QT_END_LICENSE$ |
|
39 ** |
|
40 ****************************************************************************/ |
|
41 |
|
42 #include "qmediaplaylistioplugin.h" |
|
43 |
|
44 QT_BEGIN_NAMESPACE |
|
45 |
|
46 /*! |
|
47 \class QMediaPlaylistReader |
|
48 \preliminary |
|
49 \brief The QMediaPlaylistReader class provides an interface for reading a playlist file. |
|
50 |
|
51 \sa QMediaPlaylistIOPlugin |
|
52 */ |
|
53 |
|
54 /*! |
|
55 Destroys a media playlist reader. |
|
56 */ |
|
57 QMediaPlaylistReader::~QMediaPlaylistReader() |
|
58 { |
|
59 } |
|
60 |
|
61 /*! |
|
62 \fn QMediaPlaylistReader::atEnd() const |
|
63 |
|
64 Identifies if a playlist reader has reached the end of its input. |
|
65 |
|
66 Returns true if the reader has reached the end; and false otherwise. |
|
67 */ |
|
68 |
|
69 /*! |
|
70 \fn QMediaPlaylistReader::readItem() |
|
71 |
|
72 Reads an item of media from a playlist file. |
|
73 |
|
74 Returns the read media, or a null QMediaContent if no more media is available. |
|
75 */ |
|
76 |
|
77 /*! |
|
78 \fn QMediaPlaylistReader::close() |
|
79 |
|
80 Closes a playlist reader's input device. |
|
81 */ |
|
82 |
|
83 /*! |
|
84 \class QMediaPlaylistWriter |
|
85 \preliminary |
|
86 \brief The QMediaPlaylistWriter class provides an interface for writing a playlist file. |
|
87 |
|
88 \sa QMediaPlaylistIOPlugin |
|
89 */ |
|
90 |
|
91 /*! |
|
92 Destroys a media playlist writer. |
|
93 */ |
|
94 QMediaPlaylistWriter::~QMediaPlaylistWriter() |
|
95 { |
|
96 } |
|
97 |
|
98 /*! |
|
99 \fn QMediaPlaylistWriter::writeItem(const QMediaContent &media) |
|
100 |
|
101 Writes an item of \a media to a playlist file. |
|
102 |
|
103 Returns true if the media was written succesfully; and false otherwise. |
|
104 */ |
|
105 |
|
106 /*! |
|
107 \fn QMediaPlaylistWriter::close() |
|
108 |
|
109 Finalizes the writing of a playlist and closes the output device. |
|
110 */ |
|
111 |
|
112 /*! |
|
113 \class QMediaPlaylistIOPlugin |
|
114 \brief The QMediaPlaylistIOPlugin class provides an interface for media playlist I/O plug-ins. |
|
115 */ |
|
116 |
|
117 /*! |
|
118 Constructs a media playlist I/O plug-in with the given \a parent. |
|
119 */ |
|
120 QMediaPlaylistIOPlugin::QMediaPlaylistIOPlugin(QObject *parent) |
|
121 :QObject(parent) |
|
122 { |
|
123 } |
|
124 |
|
125 /*! |
|
126 Destroys a media playlist I/O plug-in. |
|
127 */ |
|
128 QMediaPlaylistIOPlugin::~QMediaPlaylistIOPlugin() |
|
129 { |
|
130 } |
|
131 |
|
132 /*! |
|
133 \fn QMediaPlaylistIOPlugin::canRead(QIODevice *device, const QByteArray &format) const |
|
134 |
|
135 Identifies if plug-in can read \a format data from an I/O \a device. |
|
136 |
|
137 Returns true if the data can be read; and false otherwise. |
|
138 */ |
|
139 |
|
140 /*! |
|
141 \fn QMediaPlaylistIOPlugin::canRead(const QUrl& location, const QByteArray &format) const |
|
142 |
|
143 Identifies if a plug-in can read \a format data from a URL \a location. |
|
144 |
|
145 Returns true if the data can be read; and false otherwise. |
|
146 */ |
|
147 |
|
148 /*! |
|
149 \fn QMediaPlaylistIOPlugin::canWrite(QIODevice *device, const QByteArray &format) const |
|
150 |
|
151 Identifies if a plug-in can write \a format data to an I/O \a device. |
|
152 |
|
153 Returns true if the data can be written; and false otherwise. |
|
154 */ |
|
155 |
|
156 /*! |
|
157 \fn QMediaPlaylistIOPlugin::keys() const |
|
158 |
|
159 Returns a list of format keys supported by a plug-in. |
|
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 |
|
186 #include "moc_qmediaplaylistioplugin.cpp" |
|
187 QT_END_NAMESPACE |
|
188 |