cPluginSoftHdDevice - SoftHdDevice plugin class More...

#include <softhddevice-drm-gles.h>

Public Member Functions
	cPluginSoftHdDevice (void)
	cPluginSoftHdDevice constructor

virtual	~cPluginSoftHdDevice (void)
	cPluginSoftHdDevice destructor

virtual const char *	Version (void)
	Return plugin version number.

virtual const char *	Description (void)
	Return plugin short description.

virtual const char *	CommandLineHelp (void)
	Return a string that describes all known command line options.

virtual bool	ProcessArgs (int, char *[])
	Process the command line arguments.

virtual bool	Initialize (void)
	Initializes the DVB devices.

virtual bool	Start (void)
	Start any background activities the plugin shall perform.

virtual void	Stop (void)
	Shutdown plugin.

virtual const char *	MainMenuEntry (void)
	Create main menu entry.

virtual cOsdObject *	MainMenuAction (void)
	Perform the action when selected from the main VDR menu.

virtual cMenuSetupPage *	SetupMenu (void)
	Return our setup menu.

virtual bool	SetupParse (const char , const char )
	Parse setup parameters.

virtual bool	Service (const char , void =nullptr)
	Receive requests or messages.

virtual const char **	SVDRPHelpPages (void)
	Return SVDRP commands help pages.

virtual cString	SVDRPCommand (const char , const char , int &)
	Handle SVDRP commands.

Private Attributes
cSoftHdDevice *	m_pDevice
	pointer to cSoftHdDevice object

cSoftHdConfig *	m_pConfig
	pointer to cSoftHdConfig object

Detailed Description

cPluginSoftHdDevice - SoftHdDevice plugin class

Definition at line 43 of file softhddevice-drm-gles.h.

Constructor & Destructor Documentation

◆ 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 69 of file softhddevice-drm-gles.cpp.

References m_pConfig, and m_pDevice.

◆ ~cPluginSoftHdDevice()

cPluginSoftHdDevice::~cPluginSoftHdDevice ( void )

virtual

cPluginSoftHdDevice destructor

Clean up after yourself!

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

References m_pConfig.

Member Function Documentation

◆ CommandLineHelp()

const char * cPluginSoftHdDevice::CommandLineHelp ( void )

virtual

Return a string that describes all known command line options.

Returns: command line help as constant string

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

References cSoftHdDevice::CommandLineHelp(), and m_pDevice.

◆ Description()

const char * cPluginSoftHdDevice::Description ( void )

virtual

Return plugin short description.

Returns: short description as constant string

Definition at line 100 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

Returns: true if any devices are available.

Definition at line 132 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 174 of file softhddevice-drm-gles.cpp.

References m_pDevice.

◆ MainMenuEntry()

const char * cPluginSoftHdDevice::MainMenuEntry ( void )

virtual

Create main menu entry.

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

References cSoftHdConfig::ConfigHideMainMenuEntry, m_pConfig, and MAINMENUENTRY.

◆ ProcessArgs()

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

virtual

Process the command line arguments.

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

References m_pDevice, and cSoftHdDevice::ProcessArgs().

◆ Service()

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

virtual

Receive requests or messages.

Parameters

id	unique identification string that identifies the service protocol
data	custom 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 184 of file softhddevice-drm-gles.cpp.

References m_pDevice.

◆ SetupParse()

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

virtual

Parse setup parameters.

Parameters

name	paramter name (case sensetive)
value	value as string

Returns: true if the parameter is supported, false otherwise

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

References m_pConfig, and cSoftHdConfig::SetupParse().

◆ Start()

bool cPluginSoftHdDevice::Start ( void )

virtual

Start any background activities the plugin shall perform.

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

References m_pDevice, and cSoftHdDevice::Start().

◆ Stop()

void cPluginSoftHdDevice::Stop ( void )

virtual

Shutdown plugin.

Stop any background activities the plugin is performing

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

References m_pDevice, and cSoftHdDevice::Stop().

◆ SVDRPCommand()

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

virtual

Handle SVDRP commands.

Parameters

command	SVDRP command
option	all command arguments
reply_code	reply code

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

References cSoftHdDevice::Attach(), cSoftHdDevice::Detach(), cSoftHdDevice::IsDetached(), L_MEDIA, LOGDEBUG, LOGDEBUG2, m_pDevice, cSoftHdDevice::PipChannelChange(), cSoftHdDevice::PipChannelSwap(), cSoftHdDevice::PipDisable(), cSoftHdDevice::PipEnable(), cSoftHdDevice::PipIsEnabled(), cSoftHdDevice::PipSwapPosition(), and cSoftHdDevice::UsePip().

◆ 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: version number as constant string

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

References VERSION.

Member Data Documentation

◆ m_pConfig

cSoftHdConfig* cPluginSoftHdDevice::m_pConfig

private

pointer to cSoftHdConfig object

Definition at line 64 of file softhddevice-drm-gles.h.

Referenced by cPluginSoftHdDevice(), MainMenuEntry(), SetupParse(), and ~cPluginSoftHdDevice().

◆ m_pDevice

cSoftHdDevice* cPluginSoftHdDevice::m_pDevice

private

pointer to cSoftHdDevice object

Definition at line 63 of file softhddevice-drm-gles.h.

Referenced by CommandLineHelp(), cPluginSoftHdDevice(), MainMenuAction(), ProcessArgs(), SetupMenu(), Start(), Stop(), and SVDRPCommand().

The documentation for this class was generated from the following files:

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ cPluginSoftHdDevice()

◆ ~cPluginSoftHdDevice()

Member Function Documentation

◆ CommandLineHelp()

◆ Description()

◆ Initialize()

◆ MainMenuAction()

◆ MainMenuEntry()

◆ ProcessArgs()

◆ Service()

◆ SetupMenu()

◆ SetupParse()

◆ Start()

◆ Stop()

◆ SVDRPCommand()

◆ SVDRPHelpPages()

◆ Version()

Member Data Documentation

◆ m_pConfig

◆ m_pDevice