← 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/hvideobroadcast.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/hvideobroadcast.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 HVIDEOBROADCAST_H_
 
23
#define HVIDEOBROADCAST_H_
 
24
 
 
25
#include <HUpnpAv/HVideoItem>
 
26
 
 
27
namespace Herqq
 
28
{
 
29
 
 
30
namespace Upnp
 
31
{
 
32
 
 
33
namespace Av
 
34
{
 
35
 
 
36
class HVideoBroadcastPrivate;
 
37
 
 
38
/*!
 
39
 * \brief This class represents a continuous stream from a video broadcast.
 
40
 *
 
41
 * The class identifier specified by the AV Working Committee is
 
42
 * \c object.item.videoItem.videoBroadcast.
 
43
 *
 
44
 * \headerfile hvideobroadcast.h HVideoBroadcast
 
45
 *
 
46
 * \ingroup hupnp_av_cds_objects
 
47
 *
 
48
 * \remarks This class is not thread-safe.
 
49
 */
 
50
class H_UPNP_AV_EXPORT HVideoBroadcast :
 
51
    public HVideoItem
 
52
{
 
53
Q_OBJECT
 
54
H_DISABLE_COPY(HVideoBroadcast)
 
55
H_DECLARE_PRIVATE(HVideoBroadcast)
 
56
 
 
57
protected:
 
58
 
 
59
    /*!
 
60
     * Constructs a new instance.
 
61
     *
 
62
     * \param clazz specifies the UPnP class of the object. This cannot be empty.
 
63
     *
 
64
     * \param cdsType specifies the CDS type of the object. This cannot be
 
65
     * HObject::UndefinedCdsType.
 
66
     *
 
67
     * \sa isInitialized()
 
68
     */
 
69
    HVideoBroadcast(const QString& clazz = sClass(), CdsType cdsType = sType());
 
70
    HVideoBroadcast(HVideoBroadcastPrivate&);
 
71
 
 
72
    // Documented in HClonable
 
73
    virtual HVideoBroadcast* newInstance() const;
 
74
 
 
75
public:
 
76
 
 
77
    /*!
 
78
     * \brief Creates a new instance.
 
79
     *
 
80
     * \param title specifies the title of the object.
 
81
     *
 
82
     * \param parentId specifies the ID of the object that contains this
 
83
     * object. If the object has no parent, this has to be left empty.
 
84
     *
 
85
     * \param id specifies the ID of this object. If this is not specified,
 
86
     * a unique identifier within the running process is created for the object.
 
87
     *
 
88
     * \sa isValid()
 
89
     */
 
90
    HVideoBroadcast(
 
91
        const QString& title,
 
92
        const QString& parentId,
 
93
        const QString& id = QString());
 
94
 
 
95
    /*!
 
96
     * \brief Destroys the instance.
 
97
     */
 
98
    virtual ~HVideoBroadcast();
 
99
 
 
100
    /*!
 
101
     * \brief Returns a location to an icon that can be used as a descriptive short-cut
 
102
     * to display the content.
 
103
     *
 
104
     * upnp:icon, ContentDirectory:3, Appendix B.7.3.
 
105
     *
 
106
     * \return a location to an icon that can be used as a descriptive short-cut
 
107
     * to display the content.
 
108
     *
 
109
     * \sa setIcon()
 
110
     */
 
111
    QUrl icon() const;
 
112
 
 
113
    /*!
 
114
     * \brief Returns some information of the region, associated with the source of the
 
115
     * object.
 
116
     *
 
117
     * upnp:region, ContentDirectory, Appendix B.7.4.
 
118
     *
 
119
     * \return some information of the region, associated with the source of the
 
120
     * object.
 
121
     *
 
122
     * \sa setRegion()
 
123
     */
 
124
    QString region() const;
 
125
 
 
126
    /*!
 
127
     * \brief Returns the number of the broadcast channel.
 
128
     *
 
129
     * upnp:channelNr, ContentDirectory, Appendix B.11.1.
 
130
     *
 
131
     * \return The number of the broadcast channel.
 
132
     *
 
133
     * \sa setChannelNr()
 
134
     */
 
135
    qint32 channelNr() const;
 
136
 
 
137
    /*!
 
138
     * \brief Returns the relative strength of the signal that is used to retrieve
 
139
     * the content of the item.
 
140
     *
 
141
     * upnp:signalStrenth, ContentDirectory, Appendix B.12.1.
 
142
     *
 
143
     * \return The relative strength of the signal that is used to retrieve
 
144
     * the content of the item.
 
145
     *
 
146
     * \sa setSignalStrength()
 
147
     */
 
148
    qint32 signalStrength() const;
 
149
 
 
150
    /*!
 
151
     * \brief Indicates whether the signal strength is sufficient for a hardware to
 
152
     * lock onto the signal at the current frequency.
 
153
     *
 
154
     * upnp:signalLocked, ContentDirectory, Appendix B.12.2.
 
155
     *
 
156
     * \return \e true if the signal strength is sufficient for a hardware to
 
157
     * lock onto the signal at the current frequency.
 
158
     *
 
159
     * \sa setSignalLocked()
 
160
     */
 
161
    bool signalLocked() const;
 
162
 
 
163
    /*!
 
164
     * \brief Indicates whether a hardware resource is currently tuned to retrieve
 
165
     * the content represented by this item.
 
166
     *
 
167
     * upnp:tuned, ContentDirectory, Appendix B.12.3.
 
168
     *
 
169
     * \return \e true if a hardware resource is currently tuned to retrieve
 
170
     * the content represented by this item.
 
171
     *
 
172
     * \sa setTuned()
 
173
     */
 
174
    bool tuned() const;
 
175
 
 
176
    /*!
 
177
     * \brief Indicates if the object can be used for recording purposes.
 
178
     *
 
179
     * upnp:recordable, ContentDirectory:3, Appendix B.7.16.
 
180
     *
 
181
     * \return \e true if the content represented by this object can potentially
 
182
     * be used for recording purposes.
 
183
     *
 
184
     * \sa setRecordable()
 
185
     */
 
186
    bool recordable() const;
 
187
 
 
188
    /*!
 
189
     * \brief Returns the broadcast station call sign of the associated broadcast
 
190
     * channel.
 
191
     *
 
192
     * upnp:callSign, ContentDirectory:3, Appendix B.9.2.
 
193
     *
 
194
     * \return The broadcast station call sign of the associated broadcast
 
195
     * channel.
 
196
     *
 
197
     * \sa setCallSign()
 
198
     */
 
199
    QString callSign() const;
 
200
 
 
201
    /*!
 
202
     * \brief Returns the price of the content item.
 
203
     *
 
204
     * upnp:price, ContentDirectory:3, Appendix B.9.5.
 
205
     *
 
206
     * \return The price of the content item.
 
207
     *
 
208
     * \sa setPrice()
 
209
     */
 
210
    HPrice price() const;
 
211
 
 
212
    /*!
 
213
     * \brief Indicates whether the content is pay-per-view.
 
214
     *
 
215
     * upnp:payPerView, ContentDirectory:3, Appendix B.9.6.
 
216
     *
 
217
     * \return \e true if the content is pay-per-view.
 
218
     *
 
219
     * \sa setPayPerView()
 
220
     */
 
221
    bool payPerView() const;
 
222
 
 
223
    /*!
 
224
     * \brief Specifies a location to an icon that can be used as a descriptive short-cut
 
225
     * to display the content.
 
226
     *
 
227
     * \param arg specifies a location to an icon that can be used as a descriptive short-cut
 
228
     * to display the content.
 
229
     *
 
230
     * \sa icon()
 
231
     */
 
232
    void setIcon(const QUrl& arg);
 
233
 
 
234
    /*!
 
235
     * \brief Specifies some information of the region, associated with the source of the
 
236
     * object.
 
237
     *
 
238
     * \param arg specifies some information of the region, associated with the source of the
 
239
     * object.
 
240
     *
 
241
     * \sa region()
 
242
     */
 
243
    void setRegion(const QString& arg);
 
244
 
 
245
    /*!
 
246
     * \brief Specifies the number of the broadcast channel.
 
247
     *
 
248
     * \param arg specifies the number of the broadcast channel.
 
249
     *
 
250
     * \sa channelNr()
 
251
     */
 
252
    void setChannelNr(qint32 arg);
 
253
 
 
254
    /*!
 
255
     * \brief Specifies the relative strength of the signal that is used to retrieve
 
256
     * the content of the item.
 
257
     *
 
258
     * \param arg specifies the relative strength of the signal that is used to retrieve
 
259
     * the content of the item.
 
260
     *
 
261
     * \sa signalStrength()
 
262
     */
 
263
    void setSignalStrength(qint32 arg);
 
264
 
 
265
    /*!
 
266
     * \brief Specifies whether the signal strength is sufficient for a hardware to
 
267
     * lock onto the signal at the current frequency.
 
268
     *
 
269
     * \param arg specifies whether the signal strength is sufficient for a hardware to
 
270
     * lock onto the signal at the current frequency.
 
271
     *
 
272
     * \sa signalLocked()
 
273
     */
 
274
    void setSignalLocked(bool arg);
 
275
 
 
276
    /*!
 
277
     * \brief Specifies whether a hardware resource is currently tuned to retrieve
 
278
     * the content represented by this item.
 
279
     *
 
280
     * \param arg specifies whether a hardware resource is currently tuned to retrieve
 
281
     * the content represented by this item.
 
282
     *
 
283
     * \sa tuned()
 
284
     */
 
285
    void setTuned(bool arg);
 
286
 
 
287
    /*!
 
288
     * \brief Specifies whether the object can be used for recording purposes.
 
289
     *
 
290
     * \param arg specifies whether the object can be used for recording purposes.
 
291
     *
 
292
     * \sa recordable()
 
293
     */
 
294
    void setRecordable(bool arg);
 
295
 
 
296
    /*!
 
297
     * \brief Specifies the broadcast station call sign of the associated broadcast
 
298
     * channel.
 
299
     *
 
300
     * \param arg specifies the broadcast station call sign of the associated broadcast
 
301
     * channel.
 
302
     *
 
303
     * \sa callSign()
 
304
     */
 
305
    void setCallSign(const QString& arg);
 
306
 
 
307
    /*!
 
308
     * \brief Specifies the price of the content item.
 
309
     *
 
310
     * \param arg specifies the price of the content item.
 
311
     *
 
312
     * \sa price()
 
313
     */
 
314
    void setPrice(const HPrice& arg);
 
315
 
 
316
    /*!
 
317
     * \brief Specifies whether the content is pay-per-view.
 
318
     *
 
319
     * \param arg specifies whether the content is pay-per-view.
 
320
     *
 
321
     * \sa payPerView()
 
322
     */
 
323
    void setPayPerView(bool arg);
 
324
 
 
325
    /*!
 
326
     * \brief Returns the CdsType value of this class.
 
327
     *
 
328
     * \return The CdsType value of this class.
 
329
     */
 
330
    inline static CdsType sType() { return VideoBroadcast; }
 
331
 
 
332
    /*!
 
333
     * \brief Returns the class identifier specified by the AV Working Committee.
 
334
     *
 
335
     * \return The class identifier specified by the AV Working Committee.
 
336
     */
 
337
    inline static QString sClass() { return "object.item.videoItem.videoBroadcast"; }
 
338
 
 
339
    /*!
 
340
     * Creates a new instance with no title or parentID.
 
341
     *
 
342
     * \return a pointer to the newly created instance.
 
343
     *
 
344
     * \remarks the ownership of the object is transferred to the caller. Make sure
 
345
     * to delete the object.
 
346
     */
 
347
    inline static HVideoBroadcast* create() { return new HVideoBroadcast(); }
 
348
};
 
349
 
 
350
}
 
351
}
 
352
}
 
353
 
 
354
#endif /* HVIDEOBROADCAST_H_ */