summaryrefslogtreecommitdiff
path: root/receiver/recplayer.h
diff options
context:
space:
mode:
Diffstat (limited to 'receiver/recplayer.h')
-rw-r--r--receiver/recplayer.h18
1 files changed, 18 insertions, 0 deletions
diff --git a/receiver/recplayer.h b/receiver/recplayer.h
index 8295539..a2e69ac 100644
--- a/receiver/recplayer.h
+++ b/receiver/recplayer.h
@@ -12,8 +12,26 @@
#include "filehandle.h"
#include <vdr/recording.h>
+/**
+ * The recording player
+ *
+ * This class provides the ability to play VDR records. The difference between
+ * usual files and VDR recording files is, that recordings are possibly splitted
+ * into multiple files. The class will scan those files and tries to dynamically
+ * navigate in them like it would do, if it is a single file.
+ *
+ */
class cRecordingPlayer : cFileHandle {
public:
+ /**
+ * Get a new instance of a recording player
+ *
+ * This returns a new instance of a recording player which plays the
+ * specified VDR recording.
+ *
+ * @param Recording the recording to play
+ * @return the new instance of the recording player
+ */
static cRecordingPlayer *newInstance(cRecording *Recording);
virtual ~cRecordingPlayer();
virtual void open(UpnpOpenFileMode mode);