Plugin_t Struct Reference
[Plugin Interface]

Structure used to define a plugin. More...

#include <plugin.h>


Data Fields

unsigned int requiredVersion
 Version of DVBStreamer required to run this plugin.
unsigned int pluginFor
 What type of transport stream this plugin is meant for.
char * name
 Name of the plugin.
char * version
 String describing the version of the plugin.
char * description
 Description of the plugin.
char * author
 Author/Contact address for bugs.
Command_tcommands
 NULL terminated array of commands or NULL for no commands.
PluginFeature_tfeatures
 A PLUGIN_FEATURE_NONE terminated list of features or NULL for no features.


Detailed Description

Structure used to define a plugin.

To create a plugin the shared object should have a global variable of this type called PluginInterface.

 Command_t myCommands[] = {...,
                              {NULL, FALSE, 0, 0, NULL,NULL}
                          };

 PluginFeature_t myFeatures[]  = {...,
                                      {PLUGIN_FEATURE_TYPE_NONE, NULL}
                                 };

 Plugin_t PluginInterface = {
  DVBSTREAMER_VERSION,
  "Example",
  "0.1",
  "Example Plugin",
  "An Author",
   myCommands,
   myFeatures
 };

Field Documentation

unsigned int Plugin_t::pluginFor

What type of transport stream this plugin is meant for.

A PLUGIN_FEATURE_NONE terminated list of features or NULL for no features.


The documentation for this struct was generated from the following file:

Generated on Thu Jun 26 12:58:32 2008 for DVBStreamer by  doxygen 1.5.5