summaryrefslogtreecommitdiff
path: root/libresourceqt/include/qt4
diff options
context:
space:
mode:
authorWolf Bergenheim <ext-wolf.2.bergenheim@nokia.com>2010-09-16 15:22:53 +0300
committerWolf Bergenheim <ext-wolf.2.bergenheim@nokia.com>2010-09-16 15:22:53 +0300
commitc73a1276632331efff4074931e6e9dcb61f85e92 (patch)
treef79dd079af9557b5c063cc7dba50558a41c4541a /libresourceqt/include/qt4
parent5f82fc3a95dd342ad2ae16007dcf36bae632568a (diff)
downloadlibresourceqt-c73a1276632331efff4074931e6e9dcb61f85e92.tar.gz
Updated documentation
Diffstat (limited to 'libresourceqt/include/qt4')
-rw-r--r--libresourceqt/include/qt4/policy/audio-resource.h25
-rw-r--r--libresourceqt/include/qt4/policy/resource-set.h7
2 files changed, 27 insertions, 5 deletions
diff --git a/libresourceqt/include/qt4/policy/audio-resource.h b/libresourceqt/include/qt4/policy/audio-resource.h
index bb0783f..4da4b30 100644
--- a/libresourceqt/include/qt4/policy/audio-resource.h
+++ b/libresourceqt/include/qt4/policy/audio-resource.h
@@ -8,15 +8,27 @@
namespace ResourcePolicy
{
+/**
+ * The AudioResource class represents the audio device. It is a bit
+ * different from other resource types in that in takes more parameters to
+ * allow the programmer to classify the audio stream used by the application.
+ */
class AudioResource: public QObject, public Resource
{
Q_OBJECT
public:
+ /**
+ * The constructor.
+ * \param audioGroup The audio group which this application belongs to.
+ * This is an optional parameter.
+ */
AudioResource(const QString &audioGroup = QString());
AudioResource(const AudioResource &other);
virtual ~AudioResource();
+ //! Accessor for the audioGroup.
QString audioGroup() const;
+ //! A test to check whether the audio group is set or not.
bool audioGroupIsSet() const;
/**
* Set the audio group (classification)
@@ -24,19 +36,26 @@ public:
*/
void setAudioGroup(const QString & newGroup);
+ //! \return The PID of the process which is responsible for rendering the audio stream.
quint32 processID() const;
/**
- * Set the PID of the process which will render the audio. Use this if the
- * audio renderer is in a separate process.
+ * Use this to indicate to the Resource Manager the PID of the audio
+ * stream renderer.
+ * \param newPID Set this to the PID of the process which will render the audio.
*/
void setProcessID(quint32 newPID);
+ //! \return the name of the stream tag.
QString streamTagName() const;
+ //! \return the value of the stream tag.
QString streamTagValue() const;
+ //! A test to check whether the stream tag has been set or not.
bool streamTagIsSet() const;
/**
* Set the tream tag to help policy to correctly identify the audio stream
- * beloning to you
+ * beloning to you.
+ * \param name The name of the tag. For example "media.name"
+ * \param value The value of the stream tag.
*/
void setStreamTag(const QString &name, const QString &value);
diff --git a/libresourceqt/include/qt4/policy/resource-set.h b/libresourceqt/include/qt4/policy/resource-set.h
index 710dc7d..2ce18c4 100644
--- a/libresourceqt/include/qt4/policy/resource-set.h
+++ b/libresourceqt/include/qt4/policy/resource-set.h
@@ -31,7 +31,7 @@
* resources->addResource(VideoPlaybackType);
* \endcode
* If you want to pre-populate the AudioResource with the audio group (it is a good idea)
- * and other oudio parameters you can create an audio object yourself and then
+ * and other audio parameters you can create an audio object yourself and then
* give that to the ResourcePolicy::ResourceSet. Note that you should NOT free this object.
* The ResourcePolicy::ResourceSet takes ownership of this pointer.
* \code
@@ -59,7 +59,8 @@
*/
/**
- * The Namespace for Resource Policy.
+ * \brief The Namespace for Resource Policy.
+ * All Resource Policy Qt APIs reside under the ResourcePolicy namespace.
*/
namespace ResourcePolicy
{
@@ -81,6 +82,8 @@ public:
* The application class is used to determine the priority order of the
* application.
* \param parent The optional parent of of this class.
+ * \param alwaysReply Set this to true to always get a reply from the
+ * Resource Manager. This optional parameter defaults to false.
*/
ResourceSet(const QString &applicationClass, QObject *parent = NULL,
bool alwaysReply = false, bool autoRelease = false);