2
* Copyright (C) 2011 Tuomo Penttinen, all rights reserved.
4
* Author: Tuomo Penttinen <tp@herqq.org>
6
* This file is part of Herqq UPnP Av (HUPnPAv) library.
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.
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.
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/>.
22
#ifndef HAUDIOCHANNELGROUP_H_
23
#define HAUDIOCHANNELGROUP_H_
25
#include <HUpnpAv/HChannelGroup>
36
class HAudioChannelGroupPrivate;
39
* \brief This class is used to group together a set of items that
40
* correspond to individual but related audio broadcast channels.
42
* The class identifier specified by the AV Working Committee is
43
* \c object.container.channelGroup.audioChannelGroup.
45
* \headerfile haudiochannelgroup.h HAudioChannelGroup
47
* \ingroup hupnp_av_cds_objects
49
* \remarks This class is not thread-safe.
51
class H_UPNP_AV_EXPORT HAudioChannelGroup :
55
H_DISABLE_COPY(HAudioChannelGroup)
56
H_DECLARE_PRIVATE(HAudioChannelGroup)
61
* Constructs a new instance.
63
* \param clazz specifies the UPnP class of the object. This cannot be empty.
65
* \param cdsType specifies the CDS type of the object. This cannot be
66
* HObject::UndefinedCdsType.
70
HAudioChannelGroup(const QString& clazz = sClass(), CdsType cdsType = sType());
71
HAudioChannelGroup(HAudioChannelGroupPrivate&);
73
// Documented in HClonable
74
virtual HAudioChannelGroup* newInstance() const;
79
* \brief Creates a new instance.
81
* \param title specifies the title of the object.
83
* \param parentId specifies the ID of the object that contains this
84
* object. If the object has no parent, this has to be left empty.
86
* \param id specifies the ID of this object. If this is not specified,
87
* a unique identifier within the running process is created for the object.
93
const QString& parentId,
94
const QString& id = QString());
97
* \brief Destroys the instance.
99
virtual ~HAudioChannelGroup();
102
* \brief Returns the CdsType value of this class.
104
* \return The CdsType value of this class.
106
inline static CdsType sType() { return AudioChannelGroup; }
109
* \brief Returns the class identifier specified by the AV Working Committee.
111
* \return The class identifier specified by the AV Working Committee.
113
inline static QString sClass() { return "object.container.channelGroup.audioChannelGroup"; }
116
* Creates a new instance with no title or parentID.
118
* \return a pointer to the newly created instance.
120
* \remarks the ownership of the object is transferred to the caller. Make sure
121
* to delete the object.
123
inline static HAudioChannelGroup* create() { return new HAudioChannelGroup(); }
130
#endif /* HAUDIOCHANNELGROUP_H_ */