← Back to branch summary

~ubuntu-branches/ubuntu/trusty/digikam/trusty

« back to all changes in this revision

Viewing changes to extra/kipi-plugins/dlnaexport/extra/hupnp_av/src/cds_model/cds_objects/hvideoitem.h

  • Committer: Package Import Robot
  • Author(s): Rohan Garg
  • Date: 2012-11-26 18:24:20 UTC
  • mfrom: (1.9.1) (3.1.23 experimental)
  • Revision ID: package-import@ubuntu.com-20121126182420-qoy6z0nx4ai0wzcl
Tags: 4:3.0.0~beta3-0ubuntu1
https://launchpad.net/bugs/890059
https://launchpad.net/bugs/1011211
https://launchpad.net/bugs/658047
* New upstream release
  - Add build-deps :  libhupnp-dev, libqtgstreamer-dev, libmagickcore-dev
* Merge from debian, remaining changes:
  - Make sure libqt4-opengl-dev, libgl1-mesa-dev and libglu1-mesa-dev only
    install on i386,amd64 and powerpc
  - Depend on libtiff-dev instead of libtiff4-dev
  - Drop digikam breaks/replaces kipi-plugins-common since we're past the
    LTS release now
  - digikam to recommend mplayerthumbs | ffmpegthumbs. We currently only
    have latter in the archives, even though former is also supposed to
    be part of kdemultimedia. (LP: #890059)
  - kipi-plugins to recommend www-browser rather than konqueror directly
    since 2.8 no direct usage of konqueror is present in the flickr
    plugin anymore (LP: #1011211)
  - Keep kubuntu_mysqld_executable_name.diff
  - Don't install libkipi translations
  - Keep deps on libcv-dev, libcvaux-dev
  - Keep split packaging of libraries
  - Replace icons from KDE 3 time in debian/xpm.d/*.xpm with the new
    versions (LP: #658047)
* Update debian/not-installed

Show diffs side-by-side

added added

removed removed

Lines of Context:
extra/kipi-plugins/dlnaexport/extra/hupnp_av/src/cds_model/cds_objects/hvideoitem.h
 
1
/*
 
2
 *  Copyright (C) 2011 Tuomo Penttinen, all rights reserved.
 
3
 *
 
4
 *  Author: Tuomo Penttinen <tp@herqq.org>
 
5
 *
 
6
 *  This file is part of Herqq UPnP Av (HUPnPAv) library.
 
7
 *
 
8
 *  Herqq UPnP Av is free software: you can redistribute it and/or modify
 
9
 *  it under the terms of the GNU General Public License as published by
 
10
 *  the Free Software Foundation, either version 3 of the License, or
 
11
 *  (at your option) any later version.
 
12
 *
 
13
 *  Herqq UPnP Av is distributed in the hope that it will be useful,
 
14
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 
15
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 
16
 *  GNU General Public License for more details.
 
17
 *
 
18
 *  You should have received a copy of the GNU General Public License
 
19
 *  along with Herqq UPnP Av. If not, see <http://www.gnu.org/licenses/>.
 
20
 */
 
21
 
 
22
#ifndef HVIDEOITEM_H_
 
23
#define HVIDEOITEM_H_
 
24
 
 
25
#include <HUpnpAv/HItem>
 
26
 
 
27
namespace Herqq
 
28
{
 
29
 
 
30
namespace Upnp
 
31
{
 
32
 
 
33
namespace Av
 
34
{
 
35
 
 
36
class HVideoItemPrivate;
 
37
 
 
38
/*!
 
39
 * \brief This class represents content intended for viewing.
 
40
 *
 
41
 * The class identifier specified by the AV Working Committee is
 
42
 * \c object.item.videoItem .
 
43
 *
 
44
 * \headerfile hvideoitem.h HVideoItem
 
45
 *
 
46
 * \ingroup hupnp_av_cds_objects
 
47
 *
 
48
 * \remarks This class is not thread-safe.
 
49
 */
 
50
class H_UPNP_AV_EXPORT HVideoItem :
 
51
    public HItem
 
52
{
 
53
Q_OBJECT
 
54
H_DISABLE_COPY(HVideoItem)
 
55
H_DECLARE_PRIVATE(HVideoItem)
 
56
 
 
57
protected:
 
58
 
 
59
    /*!
 
60
     * Constructs a new instance.
 
61
     *
 
62
     * \param clazz specifies the class identifier.
 
63
     *
 
64
     * \param cdsType specifies CDS type.
 
65
     */
 
66
    HVideoItem(const QString& clazz = sClass(), CdsType cdsType = sType());
 
67
    HVideoItem(HVideoItemPrivate&);
 
68
 
 
69
    // Documented in HClonable
 
70
    virtual HVideoItem* newInstance() const;
 
71
 
 
72
public:
 
73
 
 
74
    /*!
 
75
     * \brief Creates a new instance.
 
76
     *
 
77
     * \param title specifies the title of the object.
 
78
     *
 
79
     * \param parentId specifies the ID of the object that contains this
 
80
     * object. If the object has no parent, this has to be left empty.
 
81
     *
 
82
     * \param id specifies the ID of this object. If this is not specified,
 
83
     * a unique identifier within the running process is created for the object.
 
84
     *
 
85
     * \sa isValid()
 
86
     */
 
87
    HVideoItem(
 
88
        const QString& title,
 
89
        const QString& parentId,
 
90
        const QString& id = QString());
 
91
 
 
92
    /*!
 
93
     * \brief Destroys the instance.
 
94
     */
 
95
    virtual ~HVideoItem();
 
96
 
 
97
    /*!
 
98
     * \brief Returns the genres to which this item belongs.
 
99
     *
 
100
     * upnp:genre, ContentDirectory:3, Appendix B.4.1.
 
101
     *
 
102
     * \return The genres to which this item belongs.
 
103
     *
 
104
     * \sa setGenres()
 
105
     */
 
106
    QList<HGenre> genres() const;
 
107
 
 
108
    /*!
 
109
     * \brief Returns a few lines of description of the content item.
 
110
     *
 
111
     * upnp:longDescripion, ContentDirectory:3, Appendix B.7.2.
 
112
     *
 
113
     * \return a few lines of description of the content item.
 
114
     *
 
115
     * \sa setLongDescription()
 
116
     */
 
117
    QString longDescription() const;
 
118
 
 
119
    /*!
 
120
     * \brief Returns the producers of this item.
 
121
     *
 
122
     * upnp:producer, ContentDirectory:3, Appendix B.3.4.
 
123
     *
 
124
     * \return The producers of this item.
 
125
     *
 
126
     * \sa setProducers()
 
127
     */
 
128
    QStringList producers() const;
 
129
 
 
130
    /*!
 
131
     * \brief Returns the viewer ratings of this item.
 
132
     *
 
133
     * upnp:rating, ContentDirectory, Appendix B.8.9.
 
134
     *
 
135
     * \return The viewer ratings of this item.
 
136
     *
 
137
     * \sa setRatings()
 
138
     */
 
139
    QList<HRating> ratings() const;
 
140
 
 
141
    /*!
 
142
     * \brief Retrieves the actors of this item.
 
143
     *
 
144
     * upnp:actor, ContentDirectory:3, Appendix B.3.1.
 
145
     *
 
146
     * \return The actors of this item.
 
147
     *
 
148
     * \sa setActors()
 
149
     */
 
150
    QList<HPersonWithRole> actors() const;
 
151
 
 
152
    /*!
 
153
     * \brief Returns the directors of this item.
 
154
     *
 
155
     * upnp:director, ContentDirectory:3, Appendix B.3.5.
 
156
     *
 
157
     * \return The directors of this item.
 
158
     *
 
159
     * \sa setDirectors()
 
160
     */
 
161
    QStringList directors() const;
 
162
 
 
163
    /*!
 
164
     * \brief Returns a brief description of the content item.
 
165
     *
 
166
     * dc:description, ContentDirectory:3, Appendix B.7.1.
 
167
     *
 
168
     * \return a brief description of the content item.
 
169
     *
 
170
     * \sa setDescription()
 
171
     */
 
172
    QString description() const;
 
173
 
 
174
    /*!
 
175
     * \brief Returns the publishers of this item.
 
176
     *
 
177
     * dc:publisher, ContentDirectory:3, Appendix B.3.6.
 
178
     *
 
179
     * \return The publishers of this item.
 
180
     *
 
181
     * \sa setPublishers()
 
182
     */
 
183
    QStringList publishers() const;
 
184
 
 
185
    /*!
 
186
     * \brief Returns the languages used in the content.
 
187
     *
 
188
     * dc:language, ContentDirectory:3, Appendix B.7.7.
 
189
     *
 
190
     * \return The languages used in the content.
 
191
     *
 
192
     * \sa setLanguages()
 
193
     */
 
194
    QStringList languages() const;
 
195
 
 
196
    /*!
 
197
     * \brief Returns the URLs of resources to which this object relates.
 
198
     *
 
199
     * dc:language, ContentDirectory:3, Appendix B.5.4.
 
200
     *
 
201
     * \return The URLs of resources to which this object relates.
 
202
     *
 
203
     * \sa setRelations()
 
204
     */
 
205
    QList<QUrl> relations() const;
 
206
 
 
207
    /*!
 
208
     * \brief Returns the number of times the content has been played.
 
209
     *
 
210
     * upnp:playbackCount, ContentDirectory:3, Appendix B.7.8.
 
211
     *
 
212
     * \return The number of times the content has been played.
 
213
     *
 
214
     * \sa setPlaybackCount()
 
215
     */
 
216
    qint32 playbackCount() const;
 
217
 
 
218
    /*!
 
219
     * \brief Returns the date time when the item was played last.
 
220
     *
 
221
     * upnp:lastPlaybackTime, ContentDirectory:3, Appendix B.7.9.
 
222
     *
 
223
     * \return The date time when the item was played last.
 
224
     *
 
225
     * \sa setLastPlaybackTime()
 
226
     */
 
227
    QDateTime lastPlaybackTime() const;
 
228
 
 
229
    /*!
 
230
     * \brief Returns the time offset within the content where the last playback
 
231
     * was suspended.
 
232
     *
 
233
     * upnp:lastPlaybackPosition, ContentDirectory:3, Appendix B.7.10.
 
234
     *
 
235
     * \return The time offset within the content where the last playback
 
236
     * was suspended.
 
237
     *
 
238
     * \sa setLastPlaybackPosition()
 
239
     */
 
240
    HContentDuration lastPlaybackPosition() const;
 
241
 
 
242
    /*!
 
243
     * \brief Returns the day of the week when the recording started.
 
244
     *
 
245
     * upnp:recordedDayOfWeek, ContentDirectory:3, Appendix B.7.13.
 
246
     *
 
247
     * \return The day of the week when the recording started.
 
248
     *
 
249
     * \sa setRecordedDayOfWeek()
 
250
     */
 
251
    HDayOfWeek recordedDayOfWeek() const;
 
252
 
 
253
    /*!
 
254
     * \brief Returns the ID of the srs:recordSchedule object that was used to
 
255
     * create this recorded content.
 
256
     *
 
257
     * upnp:srsRecordScheduleID, ContentDirectory:3, Appendix B.7.14.
 
258
     *
 
259
     * \return The ID of the srs:recordSchedule object that was used to
 
260
     * create this recorded content.
 
261
     *
 
262
     * \sa setSrsRecordScheduleId()
 
263
     */
 
264
    QString srsRecordScheduleId() const;
 
265
 
 
266
    /*!
 
267
     * \brief Specifies the genres to which this item belongs.
 
268
     *
 
269
     * \param arg specifies the genres to which this item belongs.
 
270
     *
 
271
     * \sa genres()
 
272
     */
 
273
    void setGenres(const QList<HGenre>& arg);
 
274
 
 
275
    /*!
 
276
     * \brief Specifies a few lines of description of the content item.
 
277
     *
 
278
     * \param arg specifies a few lines of description of the content item.
 
279
     *
 
280
     * \sa longDescription()
 
281
     */
 
282
    void setLongDescription(const QString& arg);
 
283
 
 
284
    /*!
 
285
     * \brief Sets the producers of this item.
 
286
     *
 
287
     * \param arg specifies the producers of this item.
 
288
     *
 
289
     * \sa producers()
 
290
     */
 
291
    void setProducers(const QStringList& arg);
 
292
 
 
293
    /*!
 
294
     * \brief Specifies the viewer ratings of this item.
 
295
     *
 
296
     * \param arg specifies the viewer ratings of this item.
 
297
     *
 
298
     * \sa ratings()
 
299
     */
 
300
    void setRatings(const QList<HRating>& arg);
 
301
 
 
302
    /*!
 
303
     * \brief Sets the actors of this item.
 
304
     *
 
305
     * \param arg specifies the actors of this item.
 
306
     *
 
307
     * \sa actors()
 
308
     */
 
309
    void setActors(const QList<HPersonWithRole>& arg);
 
310
 
 
311
    /*!
 
312
     * \brief Sets the directors of this item.
 
313
     *
 
314
     * \param arg specifies the directors of this item.
 
315
     *
 
316
     * \sa directors()
 
317
     */
 
318
    void setDirectors(const QStringList& arg);
 
319
 
 
320
     /*!
 
321
     * \brief Specifies a brief description of the content item.
 
322
     *
 
323
     * \param arg specifies a brief description of the content item.
 
324
     *
 
325
     * \sa description()
 
326
     */
 
327
    void setDescription(const QString& arg);
 
328
 
 
329
    /*!
 
330
     * \brief Sets the publishers of this item.
 
331
     *
 
332
     * \param arg specifies the publishers of this item.
 
333
     *
 
334
     * \sa publishers()
 
335
     */
 
336
    void setPublishers(const QStringList& arg);
 
337
 
 
338
    /*!
 
339
     * \brief Specifies the languages used in the content.
 
340
     *
 
341
     * \param arg specifies the languages used in the content.
 
342
     *
 
343
     * \sa languages()
 
344
     */
 
345
    void setLanguages(const QStringList& arg);
 
346
 
 
347
    /*!
 
348
     * \brief Specifies the URLs of resources to which this object relates.
 
349
     *
 
350
     * \param arg specifies the URLs of resources to which this object relates.
 
351
     *
 
352
     * \sa relations()
 
353
     */
 
354
    void setRelations(const QList<QUrl>& arg);
 
355
 
 
356
    /*!
 
357
     * \brief Specifies the number of times the content has been played.
 
358
     *
 
359
     * \param arg specifies the number of times the content has been played.
 
360
     *
 
361
     * \sa playbackCount()
 
362
     */
 
363
    void setPlaybackCount(qint32 arg);
 
364
 
 
365
    /*!
 
366
     * \brief Specifies the date time when the item was played last.
 
367
     *
 
368
     * \param arg specifies the date time when the item was played last.
 
369
     *
 
370
     * \sa lastPlaybackTime()
 
371
     */
 
372
    void setLastPlaybackTime(const QDateTime& arg);
 
373
 
 
374
    /*!
 
375
     * \brief Specifies the time offset within the content where the last playback
 
376
     * was suspended.
 
377
     *
 
378
     * \param arg specifies the time offset within the content where the last playback
 
379
     * was suspended.
 
380
     *
 
381
     * \sa lastPlaybackPosition()
 
382
     */
 
383
    void setLastPlaybackPosition(const HContentDuration& arg);
 
384
 
 
385
    /*!
 
386
     * \brief Specifies the day of the week when the recording started.
 
387
     *
 
388
     * \param arg specifies the day of the week when the recording started.
 
389
     *
 
390
     * \sa recordedDayOfWeek()
 
391
     */
 
392
    void setRecordedDayOfWeek(HDayOfWeek arg);
 
393
 
 
394
    /*!
 
395
     * \brief Specifies the ID of the srs:recordSchedule object that was used to
 
396
     * create this recorded content.
 
397
     *
 
398
     * \param arg specifies the ID of the srs:recordSchedule object that was used to
 
399
     * create this recorded content.
 
400
     *
 
401
     * \sa srsRecordScheduleId()
 
402
     */
 
403
    void setSrsRecordScheduleId(const QString& arg);
 
404
 
 
405
    /*!
 
406
     * \brief Returns the CdsType value of this class.
 
407
     *
 
408
     * \return The CdsType value of this class.
 
409
     */
 
410
    inline static CdsType sType() { return VideoItem; }
 
411
 
 
412
    /*!
 
413
     * \brief Returns the class identifier specified by the AV Working Committee.
 
414
     *
 
415
     * \return The class identifier specified by the AV Working Committee.
 
416
     */
 
417
    inline static QString sClass() { return "object.item.videoItem"; }
 
418
 
 
419
    /*!
 
420
     * Creates a new instance with no title or parentID.
 
421
     *
 
422
     * \return a pointer to the newly created instance.
 
423
     *
 
424
     * \remarks the ownership of the object is transferred to the caller. Make sure
 
425
     * to delete the object.
 
426
     */
 
427
    inline static HVideoItem* create() { return new HVideoItem(); }
 
428
};
 
429
 
 
430
}
 
431
}
 
432
}
 
433
 
 
434
#endif /* HVIDEOITEM_H_ */