From 6596d67f3b43b9534acf1a9466e339fd85dbebd3 Mon Sep 17 00:00:00 2001
From: mark <mark@cfc7b370-4200-0410-a6e3-cb6bdb053afe>
Date: Wed, 6 Dec 2006 08:35:55 +0000
Subject: [PATCH] Add API docs for preloader.

---
 .../playlistExecutor/src/GstreamerPlayer.h    | 31 +++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/campcaster/src/modules/playlistExecutor/src/GstreamerPlayer.h b/campcaster/src/modules/playlistExecutor/src/GstreamerPlayer.h
index d296b16b2..709ba47ec 100644
--- a/campcaster/src/modules/playlistExecutor/src/GstreamerPlayer.h
+++ b/campcaster/src/modules/playlistExecutor/src/GstreamerPlayer.h
@@ -150,10 +150,24 @@ class GstreamerPlayer : virtual public Configurable,
          */
         std::string             m_audioDevice;
 
+        /**
+         *  The URL of the preloaded file. Empty if nothing is preloaded.
+         */
         std::string             m_preloadUrl;
+
+        /**
+         *  The filesrc element created by the preloader.
+         */
         GstElement            * m_preloadFilesrc;
+
+        /**
+         *  The decoder element created by the preloader
+         */
         GstElement            * m_preloadDecoder;
 
+        /**
+         *  The thread that runs the preloader instance.
+         */
         Ptr<Thread>::Ref        m_preloadThread;
 
         /**
@@ -438,6 +452,16 @@ class GstreamerPlayer : virtual public Configurable,
 
 
 
+/**
+ *  A class for preloading GStreamer SMIL decoder instances.
+ *
+ *  Preloading initializes the decoder element in a helper thread, so
+ *  that most of the initialization overhead is eleminated when playback
+ *  is started.
+ *
+ *  @author  $Author$
+ *  @version $Revision$
+ */
 class Preloader : public RunnableInterface
 {
     public:
@@ -449,7 +473,14 @@ class Preloader : public RunnableInterface
         void stop()                                         throw();
 
     private:
+        /**
+         *  Pointer to GstreamerPlayer class instance.
+         */
         GstreamerPlayer* m_player;
+
+        /**
+         *  The URL of the file to be preloaded.
+         */
         std::string      m_fileUrl;
 };