Fixed small bug which leads to an empty TV folder

1 files changed, 212 insertions, 0 deletions

diff --git a/doc/latex/classcPluginUpnp.tex b/doc/latex/classcPluginUpnp.tex
new file mode 100644
index 0000000..4f4deb0
--- /dev/null
+++ b/doc/latex/classcPluginUpnp.tex
@@ -0,0 +1,212 @@
+\hypertarget{classcPluginUpnp}{
+\section{cPluginUpnp Class Reference}
+\label{classcPluginUpnp}\index{cPluginUpnp@{cPluginUpnp}}
+}
+{\tt \#include $<$upnp.h$>$}
+
+Collaboration diagram for cPluginUpnp:\nopagebreak
+\begin{figure}[H]
+\begin{center}
+\leavevmode
+\includegraphics[width=400pt]{classcPluginUpnp__coll__graph}
+\end{center}
+\end{figure}
+\subsection*{Public Member Functions}
+\begin{CompactItemize}
+\item 
+virtual const char $\ast$ \hyperlink{classcPluginUpnp_584844bf459ec3eb7f6037f9cbb52fd5}{Version} (void)
+\item 
+virtual const char $\ast$ \hyperlink{classcPluginUpnp_6fc36c7fdf1f0deed776897725bcda9b}{Description} (void)
+\item 
+virtual const char $\ast$ \hyperlink{classcPluginUpnp_e2e63843aab64e06ce9b533f4893f7e0}{CommandLineHelp} (void)
+\item 
+virtual bool \hyperlink{classcPluginUpnp_acbc8a8b3f67d08ed20ff1c8beaa4fe2}{ProcessArgs} (int argc, char $\ast$argv\mbox{[}$\,$\mbox{]})
+\item 
+virtual bool \hyperlink{classcPluginUpnp_3f3daf1d0cd8d176cf1a349b9de10df7}{Initialize} (void)
+\item 
+virtual bool \hyperlink{classcPluginUpnp_4738d8a5d72e56ec8b7b2f4f0b3549fe}{Start} (void)
+\item 
+virtual void \hyperlink{classcPluginUpnp_f59cbb0bb2a3872e33461fb46b4f79b4}{Stop} (void)
+\item 
+virtual cString \hyperlink{classcPluginUpnp_6b220cadefe502e7dfa4d70acea35083}{Active} (void)
+\item 
+virtual cMenuSetupPage $\ast$ \hyperlink{classcPluginUpnp_9b1891ed7e2d3aa56dae03b778d616ee}{SetupMenu} (void)
+\item 
+virtual bool \hyperlink{classcPluginUpnp_3f8b911f1e452789110e69b11587ebce}{SetupParse} (const char $\ast$Name, const char $\ast$Value)
+\end{CompactItemize}
+\subsection*{Static Public Member Functions}
+\begin{CompactItemize}
+\item 
+static const char $\ast$ \hyperlink{classcPluginUpnp_ac2101984519b848cc04370b5527c145}{getConfigDirectory} ()
+\end{CompactItemize}
+
+
+\subsection{Detailed Description}
+The UPnP/DLNA plugin
+
+This is a UPnP/DLNA media server plugin. It supports live-TV and recordings of the VDR as well as custom video files. 
+
+\subsection{Member Function Documentation}
+\hypertarget{classcPluginUpnp_6b220cadefe502e7dfa4d70acea35083}{
+\index{cPluginUpnp@{cPluginUpnp}!Active@{Active}}
+\index{Active@{Active}!cPluginUpnp@{cPluginUpnp}}
+\subsubsection[{Active}]{\setlength{\rightskip}{0pt plus 5cm}cString cPluginUpnp::Active (void)\hspace{0.3cm}{\tt  \mbox{[}virtual\mbox{]}}}}
+\label{classcPluginUpnp_6b220cadefe502e7dfa4d70acea35083}
+
+
+Message if still active
+
+This returns a message if the plugin is still active when a user attempts to shut down the VDR.
+
+\begin{Desc}
+\item[Returns:]the message shown on the screen. \end{Desc}
+\hypertarget{classcPluginUpnp_e2e63843aab64e06ce9b533f4893f7e0}{
+\index{cPluginUpnp@{cPluginUpnp}!CommandLineHelp@{CommandLineHelp}}
+\index{CommandLineHelp@{CommandLineHelp}!cPluginUpnp@{cPluginUpnp}}
+\subsubsection[{CommandLineHelp}]{\setlength{\rightskip}{0pt plus 5cm}const char $\ast$ cPluginUpnp::CommandLineHelp (void)\hspace{0.3cm}{\tt  \mbox{[}virtual\mbox{]}}}}
+\label{classcPluginUpnp_e2e63843aab64e06ce9b533f4893f7e0}
+
+
+Get the command line help
+
+This returns the command line help output, which comes, when the user types {\tt --help} into the command line.
+
+\begin{Desc}
+\item[Returns:]the command line help \end{Desc}
+\hypertarget{classcPluginUpnp_6fc36c7fdf1f0deed776897725bcda9b}{
+\index{cPluginUpnp@{cPluginUpnp}!Description@{Description}}
+\index{Description@{Description}!cPluginUpnp@{cPluginUpnp}}
+\subsubsection[{Description}]{\setlength{\rightskip}{0pt plus 5cm}const char $\ast$ cPluginUpnp::Description (void)\hspace{0.3cm}{\tt  \mbox{[}virtual\mbox{]}}}}
+\label{classcPluginUpnp_6fc36c7fdf1f0deed776897725bcda9b}
+
+
+Get the description
+
+This returns a brief description of the plugin and what it does.
+
+\begin{Desc}
+\item[Returns:]the description of the plugin \end{Desc}
+\hypertarget{classcPluginUpnp_ac2101984519b848cc04370b5527c145}{
+\index{cPluginUpnp@{cPluginUpnp}!getConfigDirectory@{getConfigDirectory}}
+\index{getConfigDirectory@{getConfigDirectory}!cPluginUpnp@{cPluginUpnp}}
+\subsubsection[{getConfigDirectory}]{\setlength{\rightskip}{0pt plus 5cm}const char $\ast$ cPluginUpnp::getConfigDirectory ()\hspace{0.3cm}{\tt  \mbox{[}static\mbox{]}}}}
+\label{classcPluginUpnp_ac2101984519b848cc04370b5527c145}
+
+
+Get the configuration directory
+
+This returns the directory, where configuration files are stored.
+
+\begin{Desc}
+\item[Returns:]the directory of the configuration files. \end{Desc}
+\hypertarget{classcPluginUpnp_3f3daf1d0cd8d176cf1a349b9de10df7}{
+\index{cPluginUpnp@{cPluginUpnp}!Initialize@{Initialize}}
+\index{Initialize@{Initialize}!cPluginUpnp@{cPluginUpnp}}
+\subsubsection[{Initialize}]{\setlength{\rightskip}{0pt plus 5cm}bool cPluginUpnp::Initialize (void)\hspace{0.3cm}{\tt  \mbox{[}virtual\mbox{]}}}}
+\label{classcPluginUpnp_3f3daf1d0cd8d176cf1a349b9de10df7}
+
+
+Initializes the plugin
+
+This initializes any background activities of the plugin.
+
+\begin{Desc}
+\item[Returns:]returns\begin{itemize}
+\item {\bf {\tt true},} if initializing was successful\item {\bf {\tt false},} otherwise \end{itemize}
+\end{Desc}
+\hypertarget{classcPluginUpnp_acbc8a8b3f67d08ed20ff1c8beaa4fe2}{
+\index{cPluginUpnp@{cPluginUpnp}!ProcessArgs@{ProcessArgs}}
+\index{ProcessArgs@{ProcessArgs}!cPluginUpnp@{cPluginUpnp}}
+\subsubsection[{ProcessArgs}]{\setlength{\rightskip}{0pt plus 5cm}bool cPluginUpnp::ProcessArgs (int {\em argc}, \/  char $\ast$ {\em argv}\mbox{[}$\,$\mbox{]})\hspace{0.3cm}{\tt  \mbox{[}virtual\mbox{]}}}}
+\label{classcPluginUpnp_acbc8a8b3f67d08ed20ff1c8beaa4fe2}
+
+
+Processes the commandline arguments
+
+This processes the commandline arguments which the user specified at the start of the plugin.
+
+\begin{Desc}
+\item[Returns:]returns\begin{itemize}
+\item {\bf {\tt true},} if processing was successful\item {\bf {\tt false},} otherwise \end{itemize}
+\end{Desc}
+\begin{Desc}
+\item[Parameters:]
+\begin{description}
+\item[{\em argc}]the number of arguments in the list \item[{\em argv}]the arguments as a char array \end{description}
+\end{Desc}
+ \hypertarget{classcPluginUpnp_9b1891ed7e2d3aa56dae03b778d616ee}{
+\index{cPluginUpnp@{cPluginUpnp}!SetupMenu@{SetupMenu}}
+\index{SetupMenu@{SetupMenu}!cPluginUpnp@{cPluginUpnp}}
+\subsubsection[{SetupMenu}]{\setlength{\rightskip}{0pt plus 5cm}cMenuSetupPage $\ast$ cPluginUpnp::SetupMenu (void)\hspace{0.3cm}{\tt  \mbox{[}virtual\mbox{]}}}}
+\label{classcPluginUpnp_9b1891ed7e2d3aa56dae03b778d616ee}
+
+
+Setup menu
+
+This creates a new instance of the setup menu, which is shown to the user when he enters the VDR plugin setup menu
+
+\begin{Desc}
+\item[Returns:]the menu of the plugin \end{Desc}
+\hypertarget{classcPluginUpnp_3f8b911f1e452789110e69b11587ebce}{
+\index{cPluginUpnp@{cPluginUpnp}!SetupParse@{SetupParse}}
+\index{SetupParse@{SetupParse}!cPluginUpnp@{cPluginUpnp}}
+\subsubsection[{SetupParse}]{\setlength{\rightskip}{0pt plus 5cm}bool cPluginUpnp::SetupParse (const char $\ast$ {\em Name}, \/  const char $\ast$ {\em Value})\hspace{0.3cm}{\tt  \mbox{[}virtual\mbox{]}}}}
+\label{classcPluginUpnp_3f8b911f1e452789110e69b11587ebce}
+
+
+Parse setup variable
+
+This parses the setup variable with the according value. The value is a string representation and must be converted into the according data type.
+
+\begin{Desc}
+\item[Returns:]returns\begin{itemize}
+\item {\bf {\tt true},} if parsing was successful\item {\bf {\tt false},} otherwise \end{itemize}
+\end{Desc}
+\begin{Desc}
+\item[Parameters:]
+\begin{description}
+\item[{\em Name}]the name of the variable \item[{\em Value}]the according value of the variable \end{description}
+\end{Desc}
+ \hypertarget{classcPluginUpnp_4738d8a5d72e56ec8b7b2f4f0b3549fe}{
+\index{cPluginUpnp@{cPluginUpnp}!Start@{Start}}
+\index{Start@{Start}!cPluginUpnp@{cPluginUpnp}}
+\subsubsection[{Start}]{\setlength{\rightskip}{0pt plus 5cm}bool cPluginUpnp::Start (void)\hspace{0.3cm}{\tt  \mbox{[}virtual\mbox{]}}}}
+\label{classcPluginUpnp_4738d8a5d72e56ec8b7b2f4f0b3549fe}
+
+
+Starts the plugin
+
+This starts the plugin. It starts additional threads, which are required by the plugin.
+
+\begin{Desc}
+\item[Returns:]returns\begin{itemize}
+\item {\bf {\tt true},} if starting was successful\item {\bf {\tt false},} otherwise \end{itemize}
+\end{Desc}
+\hypertarget{classcPluginUpnp_f59cbb0bb2a3872e33461fb46b4f79b4}{
+\index{cPluginUpnp@{cPluginUpnp}!Stop@{Stop}}
+\index{Stop@{Stop}!cPluginUpnp@{cPluginUpnp}}
+\subsubsection[{Stop}]{\setlength{\rightskip}{0pt plus 5cm}void cPluginUpnp::Stop (void)\hspace{0.3cm}{\tt  \mbox{[}virtual\mbox{]}}}}
+\label{classcPluginUpnp_f59cbb0bb2a3872e33461fb46b4f79b4}
+
+
+Stops the plugin
+
+This stops the plugin and all its components \hypertarget{classcPluginUpnp_584844bf459ec3eb7f6037f9cbb52fd5}{
+\index{cPluginUpnp@{cPluginUpnp}!Version@{Version}}
+\index{Version@{Version}!cPluginUpnp@{cPluginUpnp}}
+\subsubsection[{Version}]{\setlength{\rightskip}{0pt plus 5cm}const char $\ast$ cPluginUpnp::Version (void)\hspace{0.3cm}{\tt  \mbox{[}virtual\mbox{]}}}}
+\label{classcPluginUpnp_584844bf459ec3eb7f6037f9cbb52fd5}
+
+
+Get the version of the plugin
+
+Returns the version string of the plugin
+
+\begin{Desc}
+\item[Returns:]a string representation of the plugin version \end{Desc}
+
+
+The documentation for this class was generated from the following files:\begin{CompactItemize}
+\item 
+upnp.h\item 
+upnp.cpp\end{CompactItemize}