Main Plugin Class. More...

#include <plugindrmdevice.h>

Public Member Functions
	cPluginDrmDevice (void)
	cPluginDrmDevice constructor

virtual	~cPluginDrmDevice (void)
	cPluginDrmDevice 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
cOutputDevice *	m_pDevice
	pointer to cOutputDevice object

cDeviceConfig *	m_pConfig
	pointer to cDeviceConfig object

Detailed Description

Main Plugin Class.

Definition at line 38 of file plugindrmdevice.h.

Constructor & Destructor Documentation

◆ cPluginDrmDevice()

cPluginDrmDevice::cPluginDrmDevice ( void )

cPluginDrmDevice 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 plugindrmdevice.cpp.

References m_pConfig, and m_pDevice.

◆ ~cPluginDrmDevice()

cPluginDrmDevice::~cPluginDrmDevice ( void )

virtual

cPluginDrmDevice destructor

Clean up after yourself!

Definition at line 80 of file plugindrmdevice.cpp.

References m_pConfig.

Member Function Documentation

◆ CommandLineHelp()

const char * cPluginDrmDevice::CommandLineHelp ( void )

virtual

Return a string that describes all known command line options.

Returns: the command line help as constant string

Definition at line 110 of file plugindrmdevice.cpp.

◆ Description()

const char * cPluginDrmDevice::Description ( void )

virtual

Return plugin short description.

Returns: a short description as constant string

Definition at line 100 of file plugindrmdevice.cpp.

References DESCRIPTION.

◆ Initialize()

bool cPluginDrmDevice::Initialize ( void )

virtual

Initializes the DVB devices.

Must be called before accessing any DVB functions

Definition at line 216 of file plugindrmdevice.cpp.

References cOutputDevice::Initialize(), and m_pDevice.

◆ MainMenuAction()

cOsdObject * cPluginDrmDevice::MainMenuAction ( void )

virtual

Perform the action when selected from the main VDR menu.

Definition at line 258 of file plugindrmdevice.cpp.

References m_pDevice.

◆ MainMenuEntry()

const char * cPluginDrmDevice::MainMenuEntry ( void )

virtual

Create main menu entry.

Definition at line 248 of file plugindrmdevice.cpp.

References cDeviceConfig::ConfigHideMainMenuEntry, m_pConfig, and MAINMENUENTRY.

◆ ProcessArgs()

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

virtual

Process the command line arguments.

Parameters

argc	number of arguments
argv	arguments vector

Definition at line 132 of file plugindrmdevice.cpp.

References cDeviceConfig::ConfigAudioMixerChannel, cDeviceConfig::ConfigAudioPCMDevice, cDeviceConfig::ConfigDisplayResolution, cDeviceConfig::ConfigDrmConnector, cDeviceConfig::ConfigDrmDevice, cDeviceConfig::ConfigOsdResolution, m_pConfig, m_pDevice, cOutputDevice::SetDisableOglOsd(), cOutputDevice::SetDisablePip(), cOutputDevice::SetStartDetached(), and cDeviceConfig::UserSetDrmMode.

◆ Service()

bool cPluginDrmDevice::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 300 of file plugindrmdevice.cpp.

◆ SetupMenu()

cMenuSetupPage * cPluginDrmDevice::SetupMenu ( void )

virtual

Return our setup menu.

Definition at line 268 of file plugindrmdevice.cpp.

References m_pDevice.

◆ SetupParse()

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

virtual

Parse setup parameters.

Parameters

name	paramter name (case sensetive)
value	value as string

Return values

true	if the parameter is supported
false	if the parameter is unsupported

Definition at line 288 of file plugindrmdevice.cpp.

References m_pConfig, and cDeviceConfig::SetupParse().

◆ Start()

bool cPluginDrmDevice::Start ( void )

virtual

Start any background activities the plugin shall perform.

Definition at line 226 of file plugindrmdevice.cpp.

References m_pDevice, and cOutputDevice::Start().

◆ Stop()

void cPluginDrmDevice::Stop ( void )

virtual

Shutdown plugin.

Stop any background activities the plugin is performing

Definition at line 238 of file plugindrmdevice.cpp.

References m_pDevice, and cOutputDevice::Stop().

◆ SVDRPCommand()

cString cPluginDrmDevice::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 354 of file plugindrmdevice.cpp.

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

◆ SVDRPHelpPages()

const char ** cPluginDrmDevice::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 342 of file plugindrmdevice.cpp.

References SVDRPHelpText.

◆ Version()

const char * cPluginDrmDevice::Version ( void )

virtual

Return plugin version number.

Returns: the version number as constant string

Definition at line 90 of file plugindrmdevice.cpp.

References VERSION.

Member Data Documentation

◆ m_pConfig

cDeviceConfig* cPluginDrmDevice::m_pConfig

private

pointer to cDeviceConfig object

Definition at line 58 of file plugindrmdevice.h.

Referenced by cPluginDrmDevice(), MainMenuEntry(), ProcessArgs(), SetupParse(), and ~cPluginDrmDevice().

◆ m_pDevice

cOutputDevice* cPluginDrmDevice::m_pDevice

private

pointer to cOutputDevice object

Definition at line 57 of file plugindrmdevice.h.

Referenced by cPluginDrmDevice(), Initialize(), 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

◆ cPluginDrmDevice()

◆ ~cPluginDrmDevice()

Member Function Documentation

◆ CommandLineHelp()

◆ Description()

◆ Initialize()

◆ MainMenuAction()

◆ MainMenuEntry()

◆ ProcessArgs()

◆ Service()

◆ SetupMenu()

◆ SetupParse()

◆ Start()

◆ Stop()

◆ SVDRPCommand()

◆ SVDRPHelpPages()

◆ Version()

Member Data Documentation

◆ m_pConfig

◆ m_pDevice