From fc81e337cb7ed6c176354f06f563ef2d4136bc8a Mon Sep 17 00:00:00 2001 From: Klaus Schmidinger Date: Sun, 10 Feb 2008 14:25:07 +0100 Subject: Prepared version number and copyright year for version 1.6 --- PLUGINS.html | 35 ++--------------------------------- 1 file changed, 2 insertions(+), 33 deletions(-) (limited to 'PLUGINS.html') diff --git a/PLUGINS.html b/PLUGINS.html index 5644b684..71286b3b 100644 --- a/PLUGINS.html +++ b/PLUGINS.html @@ -6,27 +6,14 @@

The VDR Plugin System

-
Version 1.5.8
+
Version 1.6

-Copyright © 2006 Klaus Schmidinger
+Copyright © 2008 Klaus Schmidinger
kls@cadsoft.de
www.cadsoft.de/vdr

-
  -Important modifications introduced in version 1.5.7 are marked like this. -
-
  -Important modifications introduced in version 1.5.8 are marked like this. -
-
  -Important modifications introduced in version 1.5.10 are marked like this. -
-
  -Important modifications introduced in version 1.5.13 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. This interface allows programmers to develop additional functionality for VDR completely @@ -59,9 +46,7 @@ structures and allows it to hook itself into specific areas to perform special a

  • Command line help
  • Getting started
  • Shutting down -
     
  • Logging -
  • Main menu entry
  • User interaction
  • Housekeeping @@ -543,7 +528,6 @@ The Stop() function will only be called if a previous call to the returned true. The Stop() functions are called in the reverse order as the Start() functions were called. -
     

    Logging

    If the plugin should print log messages, you can use dsyslog(), isyslog() or esyslog().
    @@ -561,7 +545,6 @@ esyslog("pluginname: error #%d has occurred", ErrorNumber); Note that the log messages will be given as provided, the plugin's name will not automatically be added, so make shure your log messages are obvious enough. -

    Main menu entry

    @@ -929,7 +912,6 @@ const char *MyConfigDir = cPlugin::ConfigDirectory();
    Welcome to Babylon!

    -
      If a plugin displays texts to the user, it should prepare for internationalization of these texts. All that is necessary for this is to mark every text that is presented to the user as translatable, as in @@ -940,12 +922,10 @@ const char *s = tr("Hello world!"); The text given here must be the English version, and the returned pointer is either a translated version (if available) or the original string. -
      Texts are searched for in the domain registered for this plugin. If a plugin wants to make use of texts defined by the core VDR code, it can use the special trVDR() macro to mark these texts without having them appear in its own translation file. -

    Sometimes texts are stored in an array, in which case they need to be marked differently, using the trNOOP() macro. The actual translation is then done @@ -973,7 +953,6 @@ character set. The names of these functions and macros are all of the form U and are defined in VDR/tools.h. Most of the time a plugin doesn't need to care about this, but when it comes to handling individual characters these functions may come in handy. -


    Custom services

    @@ -1349,9 +1328,7 @@ A player that has special requirements about audio tracks should announce its available audio tracks by calling

    -
      bool DeviceSetAvailableTrack(eTrackType Type, int Index, uint16_t Id, const char *Language = NULL, const char *Description = NULL) -

    See device.h for details about the parameters for track handling. @@ -1477,19 +1454,15 @@ public: }; cMyReceiver::cMyReceiver(int Pid) -
      :cReceiver(tChannelID(), -1, Pid) -
    { } -
     
     cMyReceiver::~cMyReceiver()
     {
       cReceiver::Detach();
       ...
     }
    -
    void cMyReceiver::Activate(bool On) { @@ -1851,9 +1824,7 @@ virtual bool HasDecoder(void) const; virtual bool CanReplay(void) const; virtual bool SetPlayMode(ePlayMode PlayMode); virtual int64_t GetSTC(void); -
      virtual bool HasIBPTrickSpeed(void); -
    virtual void TrickSpeed(int Speed); virtual void Clear(void); virtual void Play(void); @@ -1881,9 +1852,7 @@ the functions

     virtual int OpenFilter(u_short Pid, u_char Tid, u_char Mask);
    -
      virtual void CloseFilter(int Handle); -

    which must open and close a file handle that delivers section data for the given -- cgit v1.2.3