summaryrefslogtreecommitdiff
path: root/PLUGINS.html
diff options
context:
space:
mode:
authorKlaus Schmidinger <vdr@tvdr.de>2013-09-11 12:20:37 +0200
committerKlaus Schmidinger <vdr@tvdr.de>2013-09-11 12:20:37 +0200
commit3971cc6e8845f2a70018b20706f4a30d71edd41d (patch)
tree37a9211b2a65f972b17f3b302d16c9711146de33 /PLUGINS.html
parent209b8500670f0504a37232facdbed2acf68df086 (diff)
downloadvdr-3971cc6e8845f2a70018b20706f4a30d71edd41d.tar.gz
vdr-3971cc6e8845f2a70018b20706f4a30d71edd41d.tar.bz2
Removed the code for distributing recordings over several video directories; added the cVideoDirectory plugin API
Diffstat (limited to 'PLUGINS.html')
-rw-r--r--PLUGINS.html37
1 files changed, 37 insertions, 0 deletions
diff --git a/PLUGINS.html b/PLUGINS.html
index 5260c4bf..71d840ea 100644
--- a/PLUGINS.html
+++ b/PLUGINS.html
@@ -104,6 +104,7 @@ structures and allows it to hook itself into specific areas to perform special a
<li><a href="#Remote Control">Remote Control</a>
<li><a href="#Conditional Access">Conditional Access</a>
<li><a href="#Electronic Program Guide">Electronic Program Guide</a>
+<li><modified><a href="#The video directory">The video directory</a></modified>
</ul>
</ul>
@@ -2300,5 +2301,41 @@ to signal VDR that no other EPG handlers shall be queried after this one.
<p>
See <tt>VDR/epg.h</tt> for details.
+<div class="modified">
+<hr><h2><a name="The video directory">The video directory</a></h2>
+
+<div class="blurb">Bits and pieces...</div><p>
+
+By default VDR assumes that the video directory consists of one large
+volume, on which it can store its recordings. If you want to distribute your
+recordings over several physical drives, you can derive from <tt>cVideoDirectory</tt>,
+as in
+
+<p><table><tr><td class="code"><pre>
+#include &lt;vdr/videodir.h&gt;
+
+class cMyVideoDirectory : public cVideoDirectory {
+public:
+ cMyVideoDirectory(void);
+ virtual ~cMyVideoDirectory();
+ virtual int FreeMB(int *UsedMB = NULL);
+ virtual bool Register(const char *FileName);
+ virtual bool Rename(const char *OldName, const char *NewName);
+ virtual bool Move(const char *FromName, const char *ToName);
+ virtual bool Remove(const char *Name);
+ virtual void Cleanup(const char *IgnoreFiles[] = NULL);
+ virtual bool Contains(const char *Name);
+ };
+</pre></td></tr></table><p>
+
+See the description in <tt>videodir.h</tt> for details.
+<p>
+You should create your derived video directory object in the
+<a href="#Getting started"><tt>Start()</tt></a> function of your plugin.
+Note that the object has to be created on the heap (using <tt>new</tt>),
+and you shall not delete it at any point (it will be deleted automatically
+when the program ends).
+</div modified>
+
</body>
</html>