vdr-plugin-softhddevice-drm-gles 1.6.2
Main Plugin

Main Plugin Interface. More...

Classes

class  cPluginSoftHdDevice
 Main Plugin Class. More...
 

Functions

 cPluginSoftHdDevice::cPluginSoftHdDevice (void)
 cPluginSoftHdDevice constructor
 
virtual cPluginSoftHdDevice::~cPluginSoftHdDevice (void)
 cPluginSoftHdDevice destructor
 
virtual const charcPluginSoftHdDevice::Version (void)
 Return plugin version number.
 
virtual const charcPluginSoftHdDevice::Description (void)
 Return plugin short description.
 
virtual const charcPluginSoftHdDevice::CommandLineHelp (void)
 Return a string that describes all known command line options.
 
virtual bool cPluginSoftHdDevice::ProcessArgs (int, char *[])
 Process the command line arguments.
 
virtual bool cPluginSoftHdDevice::Initialize (void)
 Initializes the DVB devices.
 
virtual bool cPluginSoftHdDevice::Start (void)
 Start any background activities the plugin shall perform.
 
virtual void cPluginSoftHdDevice::Stop (void)
 Shutdown plugin.
 
virtual const charcPluginSoftHdDevice::MainMenuEntry (void)
 Create main menu entry.
 
virtual cOsdObjectcPluginSoftHdDevice::MainMenuAction (void)
 Perform the action when selected from the main VDR menu.
 
virtual cMenuSetupPage * cPluginSoftHdDevice::SetupMenu (void)
 Return our setup menu.
 
virtual bool cPluginSoftHdDevice::SetupParse (const char *, const char *)
 Parse setup parameters.
 
virtual bool cPluginSoftHdDevice::Service (const char *, void *=nullptr)
 Receive requests or messages.
 
virtual const char ** cPluginSoftHdDevice::SVDRPHelpPages (void)
 Return SVDRP commands help pages.
 
virtual cString cPluginSoftHdDevice::SVDRPCommand (const char *, const char *, int &)
 Handle SVDRP commands.
 

Variables

static const char *const VERSION = "1.6.2" GIT_DESCRIBE
 vdr-plugin version number Makefile extracts the version number for generating the file name for the distribution archive.
 
static const char *const DESCRIPTION = trNOOP("A software and GPU emulated HD device")
 vdr-plugin description.
 
static const char *const MAINMENUENTRY = trNOOP("Softhddevice")
 what is displayed in the main menu entry
 
static const charSVDRPHelpText []
 SVDRP commands help text.
 
static cSoftHdMenucSoftHdMenu::pSoftHdMenu = NULL
 

Detailed Description

Main Plugin Interface.

Function Documentation

◆ CommandLineHelp()

const char * cPluginSoftHdDevice::CommandLineHelp ( void  )
virtual

Return a string that describes all known command line options.

Returns
the command line help as constant string

Definition at line 109 of file softhddevice-drm-gles.cpp.

References cSoftHdDevice::CommandLineHelp(), and cPluginSoftHdDevice::m_pDevice.

◆ cPluginSoftHdDevice()

cPluginSoftHdDevice::cPluginSoftHdDevice ( void  )

cPluginSoftHdDevice constructor

Initialize any member variables here.

Note
DON'T DO ANYTHING ELSE THAT MAY HAVE SIDE EFFECTS, REQUIRE GLOBAL VDR OBJECTS TO EXIST OR PRODUCE ANY OUTPUT!

We only create the config and the device itself, because Plugin->SetupParse is done next and that one needs config to be available. SetupParse must not access any other objects!

Definition at line 68 of file softhddevice-drm-gles.cpp.

References cPluginSoftHdDevice::m_pConfig, and cPluginSoftHdDevice::m_pDevice.

◆ Description()

const char * cPluginSoftHdDevice::Description ( void  )
virtual

Return plugin short description.

Returns
a short description as constant string

Definition at line 99 of file softhddevice-drm-gles.cpp.

References DESCRIPTION.

◆ Initialize()

bool cPluginSoftHdDevice::Initialize ( void  )
virtual

Initializes the DVB devices.

Must be called before accessing any DVB functions

Return values
true(always)

Definition at line 131 of file softhddevice-drm-gles.cpp.

◆ MainMenuAction()

cOsdObject * cPluginSoftHdDevice::MainMenuAction ( void  )
virtual

Perform the action when selected from the main VDR menu.

Definition at line 173 of file softhddevice-drm-gles.cpp.

References cPluginSoftHdDevice::m_pDevice.

◆ MainMenuEntry()

const char * cPluginSoftHdDevice::MainMenuEntry ( void  )
virtual

Create main menu entry.

Definition at line 163 of file softhddevice-drm-gles.cpp.

References cSoftHdConfig::ConfigHideMainMenuEntry, cPluginSoftHdDevice::m_pConfig, and MAINMENUENTRY.

◆ ProcessArgs()

bool cPluginSoftHdDevice::ProcessArgs ( int  argc,
char argv[] 
)
virtual

Process the command line arguments.

Definition at line 117 of file softhddevice-drm-gles.cpp.

References cPluginSoftHdDevice::m_pDevice, and cSoftHdDevice::ProcessArgs().

◆ Service()

bool cPluginSoftHdDevice::Service ( const char id,
void data = nullptr 
)
virtual

Receive requests or messages.

Parameters
idunique identification string that identifies the service protocol
datacustom data structure

Definition at line 215 of file softhddevice-drm-gles.cpp.

◆ SetupMenu()

cMenuSetupPage * cPluginSoftHdDevice::SetupMenu ( void  )
virtual

Return our setup menu.

Definition at line 183 of file softhddevice-drm-gles.cpp.

References cPluginSoftHdDevice::m_pDevice.

◆ SetupParse()

bool cPluginSoftHdDevice::SetupParse ( const char name,
const char value 
)
virtual

Parse setup parameters.

Parameters
nameparamter name (case sensetive)
valuevalue as string
Return values
trueif the parameter is supported
falseif the parameter is unsupported

Definition at line 203 of file softhddevice-drm-gles.cpp.

References cPluginSoftHdDevice::m_pConfig, and cSoftHdConfig::SetupParse().

◆ Start()

bool cPluginSoftHdDevice::Start ( void  )
virtual

Start any background activities the plugin shall perform.

Definition at line 141 of file softhddevice-drm-gles.cpp.

References cPluginSoftHdDevice::m_pDevice, and cSoftHdDevice::Start().

◆ Stop()

void cPluginSoftHdDevice::Stop ( void  )
virtual

Shutdown plugin.

Stop any background activities the plugin is performing

Definition at line 153 of file softhddevice-drm-gles.cpp.

References cPluginSoftHdDevice::m_pDevice, and cSoftHdDevice::Stop().

◆ SVDRPCommand()

cString cPluginSoftHdDevice::SVDRPCommand ( const char command,
const char option,
int reply_code 
)
virtual

◆ SVDRPHelpPages()

const char ** cPluginSoftHdDevice::SVDRPHelpPages ( void  )
virtual

Return SVDRP commands help pages.

return a pointer to a list of help strings for all of the plugin's SVDRP commands.

Definition at line 255 of file softhddevice-drm-gles.cpp.

References SVDRPHelpText.

◆ Version()

const char * cPluginSoftHdDevice::Version ( void  )
virtual

Return plugin version number.

Returns
the version number as constant string

Definition at line 89 of file softhddevice-drm-gles.cpp.

References VERSION.

◆ ~cPluginSoftHdDevice()

cPluginSoftHdDevice::~cPluginSoftHdDevice ( void  )
virtual

cPluginSoftHdDevice destructor

Clean up after yourself!

Definition at line 79 of file softhddevice-drm-gles.cpp.

References cPluginSoftHdDevice::m_pConfig.

Variable Documentation

◆ DESCRIPTION

const char* const DESCRIPTION = trNOOP("A software and GPU emulated HD device")
static

vdr-plugin description.

Definition at line 44 of file softhddevice-drm-gles.cpp.

Referenced by cPluginSoftHdDevice::Description().

◆ MAINMENUENTRY

const char* const MAINMENUENTRY = trNOOP("Softhddevice")
static

what is displayed in the main menu entry

Definition at line 47 of file softhddevice-drm-gles.cpp.

Referenced by cPluginSoftHdDevice::MainMenuEntry().

◆ pSoftHdMenu

cSoftHdMenu * cSoftHdMenu::pSoftHdMenu = NULL
static

◆ SVDRPHelpText

const char* SVDRPHelpText[]
static
Initial value:
= {
"PLAY Url\n" " Play the media from the given url.\n",
"DETA\n" " Detach the plugin.\n",
"ATTA\n" " Attach the plugin.\n",
"STAT\n" " Get attached/detached status.\n"
" ATTACHED -> 910\n"
" DETACHED -> 911\n",
"PION\n" " Enable picture-in-picture.\n",
"PIOF\n" " Disable picture-in-picture.\n",
"PITO\n" " Toggle picture-in-picture.\n",
"PIPU\n" " Pip channel up.\n",
"PIPD\n" " Pip channel down.\n",
"PIPC\n" " Pip swap channels.\n",
"PIPS\n" " Pip switch main stream to pip channel and close pip.\n",
"PIIP\n" " Pip swap positions.\n",
}

SVDRP commands help text.

Definition at line 231 of file softhddevice-drm-gles.cpp.

Referenced by cPluginSoftHdDevice::SVDRPHelpPages().

◆ VERSION

const char* const VERSION = "1.6.2" GIT_DESCRIBE
static

vdr-plugin version number Makefile extracts the version number for generating the file name for the distribution archive.

Definition at line 40 of file softhddevice-drm-gles.cpp.

Referenced by cPluginSoftHdDevice::Version().