From 724cb5e3783311f6b8c808852dbe2de59f2399b0 Mon Sep 17 00:00:00 2001 From: Denis Loh Date: Mon, 25 Jan 2010 12:10:01 +0100 Subject: Fixed small bug which leads to an empty TV folder --- doc/html/classcPluginUpnp.html | 361 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 361 insertions(+) create mode 100644 doc/html/classcPluginUpnp.html (limited to 'doc/html/classcPluginUpnp.html') diff --git a/doc/html/classcPluginUpnp.html b/doc/html/classcPluginUpnp.html new file mode 100644 index 0000000..9c73a1e --- /dev/null +++ b/doc/html/classcPluginUpnp.html @@ -0,0 +1,361 @@ + + +UPnP/DLNA plugin for VDR: cPluginUpnp Class Reference + + + + + +
+

cPluginUpnp Class Reference

#include <upnp.h> +

+

+Collaboration diagram for cPluginUpnp:
+
+

Collaboration graph
+ + +
[legend]
+ +

+List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

virtual const char * Version (void)
virtual const char * Description (void)
virtual const char * CommandLineHelp (void)
virtual bool ProcessArgs (int argc, char *argv[])
virtual bool Initialize (void)
virtual bool Start (void)
virtual void Stop (void)
virtual cString Active (void)
virtual cMenuSetupPage * SetupMenu (void)
virtual bool SetupParse (const char *Name, const char *Value)

Static Public Member Functions

static const char * getConfigDirectory ()
+

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.

Member Function Documentation

+ +
+
+ + + + + + + + + +
cString cPluginUpnp::Active (void   )  [virtual]
+
+
+ +

+Message if still active

+This returns a message if the plugin is still active when a user attempts to shut down the VDR.

+

Returns:
the message shown on the screen.
+ +
+

+ +

+
+ + + + + + + + + +
const char * cPluginUpnp::CommandLineHelp (void   )  [virtual]
+
+
+ +

+Get the command line help

+This returns the command line help output, which comes, when the user types --help into the command line.

+

Returns:
the command line help
+ +
+

+ +

+
+ + + + + + + + + +
const char * cPluginUpnp::Description (void   )  [virtual]
+
+
+ +

+Get the description

+This returns a brief description of the plugin and what it does.

+

Returns:
the description of the plugin
+ +
+

+ +

+
+ + + + + + + + +
const char * cPluginUpnp::getConfigDirectory (  )  [static]
+
+
+ +

+Get the configuration directory

+This returns the directory, where configuration files are stored.

+

Returns:
the directory of the configuration files.
+ +
+

+ +

+
+ + + + + + + + + +
bool cPluginUpnp::Initialize (void   )  [virtual]
+
+
+ +

+Initializes the plugin

+This initializes any background activities of the plugin.

+

Returns:
returns
    +
  • true, if initializing was successful
  • false, otherwise
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
bool cPluginUpnp::ProcessArgs (int  argc,
char *  argv[] 
) [virtual]
+
+
+ +

+Processes the commandline arguments

+This processes the commandline arguments which the user specified at the start of the plugin.

+

Returns:
returns
    +
  • true, if processing was successful
  • false, otherwise
+
+
Parameters:
+ + + +
argc the number of arguments in the list
argv the arguments as a char array
+
+ +
+

+ +

+
+ + + + + + + + + +
cMenuSetupPage * cPluginUpnp::SetupMenu (void   )  [virtual]
+
+
+ +

+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

+

Returns:
the menu of the plugin
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
bool cPluginUpnp::SetupParse (const char *  Name,
const char *  Value 
) [virtual]
+
+
+ +

+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.

+

Returns:
returns
    +
  • true, if parsing was successful
  • false, otherwise
+
+
Parameters:
+ + + +
Name the name of the variable
Value the according value of the variable
+
+ +
+

+ +

+
+ + + + + + + + + +
bool cPluginUpnp::Start (void   )  [virtual]
+
+
+ +

+Starts the plugin

+This starts the plugin. It starts additional threads, which are required by the plugin.

+

Returns:
returns
    +
  • true, if starting was successful
  • false, otherwise
+
+ +
+

+ +

+
+ + + + + + + + + +
void cPluginUpnp::Stop (void   )  [virtual]
+
+
+ +

+Stops the plugin

+This stops the plugin and all its components +

+

+ +

+
+ + + + + + + + + +
const char * cPluginUpnp::Version (void   )  [virtual]
+
+
+ +

+Get the version of the plugin

+Returns the version string of the plugin

+

Returns:
a string representation of the plugin version
+ +
+

+

The documentation for this class was generated from the following files: +
+
Generated on Sun Nov 8 15:44:09 2009 for UPnP/DLNA plugin for VDR by  + +doxygen 1.5.8
+ + -- cgit v1.2.3