From 2bec1d5ca0aad0bc18d99ed33c1b1ce443abb699 Mon Sep 17 00:00:00 2001 From: Klaus Schmidinger Date: Sun, 30 Jan 2005 14:23:01 +0100 Subject: Added cPlugin::Stop() --- PLUGINS.html | 59 +++++++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 39 insertions(+), 20 deletions(-) (limited to 'PLUGINS.html') diff --git a/PLUGINS.html b/PLUGINS.html index e8f456a6..df6d0fad 100644 --- a/PLUGINS.html +++ b/PLUGINS.html @@ -14,18 +14,18 @@ Copyright © 2004 Klaus Schmidinger
www.cadsoft.de/vdr

-
  -Important modifications introduced in version 1.3.7 are marked like this. -
-
  +
  Important modifications introduced in version 1.3.8 are marked like this.
-
  +
  Important modifications introduced in version 1.3.18 are marked like this.
-
  +
  Important modifications introduced in version 1.3.19 are marked like this.
+
  +Important modifications introduced in version 1.3.20 are marked like this. +

VDR provides an easy to use plugin interface that allows additional functionality to be added to the program by implementing a dynamically loadable library file. @@ -58,6 +58,9 @@ structures and allows it to hook itself into specific areas to perform special a

  • Command line arguments
  • Command line help
  • Getting started +
      +
  • Shutting down +
  • Main menu entry
  • User interaction
  • Housekeeping @@ -75,10 +78,8 @@ structures and allows it to hook itself into specific areas to perform special a
  • Receivers
  • Filters
  • The On Screen Display -
     
  • Skins
  • Themes -
  • Devices
  • Dolby Digital
  • Remote Control @@ -304,8 +305,11 @@ Constructing a plugin object shall not have any side effects or produce any outp since VDR, for instance, has to create the plugin objects in order to get their command line help - and after that immediately destroys them again.

    -The destructor has to clean up any data created by the plugin, and has to -take care that any threads the plugin may have created will be stopped. +The destructor has to clean up any data created by the plugin. +
      +Any threads the plugin may have created shall be stopped in the +Stop() function. +

    Of course, if your plugin doesn't define any member variables that need to be initialized (and deleted), you don't need to implement either of these functions. @@ -500,6 +504,25 @@ VDR to exit. If the plugin doesn't implement any background functionality or internationalized texts, it doesn't need to implement either of these functions. +
      +

    Shutting down

    + +
    Stop it, right there!

    + +If a plugin performs any background tasks, it shall implement the function + +

    +virtual void Stop(void);
+

    + +in which it shall stop them. +

    +The Stop() function will only be called if a previous call to the +Start() function of that plugin has +returned true. The Stop() functions are called in the reverse order +as the Start() functions were called. +

    +

    Main menu entry

    Today's special is...

    @@ -1021,7 +1044,7 @@ public: Take a look at the files player.h and dvbplayer.c to see how VDR implements its own player for the VDR recordings.

    -
      +
      To play the actual data, the player needs to call its member function 

    @@ -1044,7 +1067,7 @@ bool DevicePoll(cPoller &Poller, int TimeoutMs = 0);
 
 to determine whether the device is ready for further data.
 
    
-
     
+
     
 By default all audio track handling is done by the device a player is
 attached to.
 If the player can provide more than a single audio track, and has special
@@ -1181,7 +1204,7 @@ public:
   };
 
 cMyReceiver::cMyReceiver(int Pid)
-
     
+
     
 :cReceiver(0, -1, Pid)
 
    
 {
@@ -1267,7 +1290,6 @@ and will automatically detach itself from the cDevice.
 
    
 See VDR/eit.c or VDR/pat.c to learn how to process filter data.
 
-
     
 
    The On Screen Display
    
 
 
    Window to the world
    
@@ -1360,7 +1382,7 @@ public:
   virtual cSkinDisplayMenu *DisplayMenu(void);
   virtual cSkinDisplayReplay *DisplayReplay(bool ModeOnly);
   virtual cSkinDisplayVolume *DisplayVolume(void);
-
     
+
     
   virtual cSkinDisplayMessage *DisplayTrack(int NumTracks, const char * const *Tracks);
 
    
   virtual cSkinDisplayMessage *DisplayMessage(void);
@@ -1382,7 +1404,7 @@ new cMySkin;
 in the Start() function of your plugin.
 Do not delete this object, it will be automatically deleted when the program ends.
 
    
-
     
+
     
 In order to be able to easily identify plugins that implement a skin it is recommended
 that the name of such a plugin should be
 
@@ -1441,7 +1463,6 @@ osd->DrawText(x, y, s, Theme.Color(clrButtonRedFg), Theme.Color(clrButtonRedB
 By default this will use the colors that have been defined in the respective
 THEME_CLR() line, but may be overwritten through user supplied theme
 files (see man vdr(5) for information about the format of a theme file).
-
    
 
 
    Devices
    
 
@@ -1493,7 +1514,7 @@ repectively.
 If the device can provide more than a single audio track, it can implement the
 following function to make them available:
 
-
     
+
     
 
     virtual void SetAudioTrackDevice(eTrackType Type);
 virtual int GetAudioChannelDevice(void);
@@ -1584,7 +1605,6 @@ handle section data.
 
    
 On Screen Display
 
    
-
     
 If your device provides On Screen Display (OSD) capabilities (which every device
 that is supposed to be used as a primary device should do), it shall implement
 an "OSD provider" class, derived from cOsdProvider, which, when its CreateOsd()
@@ -1618,7 +1638,6 @@ in any way. All it needs to make sure is that the OSD will be visible to the
 user - whether this goes through OSD facilities of the physical device (like
 a "full featured" DVB card) or through a graphics adapter that overlays its
 output with the video signal, doesn't matter.
-
    
 
 
    
 Initializing new devices
-- 
cgit v1.2.3