RenderingControl Service client class. More...

#include <renderingcontrol.hxx>

Inheritance diagram for UPnPClient::RenderingControl:

Public Member Functions
	RenderingControl (const UPnPDeviceDesc &device, const UPnPServiceDesc &service)
	Construct by copying data from device and service objects. More...

virtual bool	serviceTypeMatch (const std::string &tp)
	Perform a comparison to the service type string for this specific service. More...

int	setVolume (int volume, const std::string &channel="Master")
	Set volume to input value (0-100). More...

int	getVolume (const std::string &channel="Master")

int	setMute (bool mute, const std::string &channel="Master")

bool	getMute (const std::string &channel="Master")

Public Member Functions inherited from UPnPClient::Service
	Service (const UPnPDeviceDesc &device, const UPnPServiceDesc &service)
	Construct by copying data from device and service objects. More...

	Service ()
	Empty object. More...

bool	initFromDescription (const UPnPDeviceDesc &description)
	Initialize empty object from device description. More...

virtual bool	reSubscribe ()
	Restart the subscription to get all the State variable values, in case we get the events before we are ready (e.g. More...

const std::string &	getFriendlyName () const
	Accessors for the values extracted from the device description during initialization.

const std::string &	getDeviceId () const

const std::string &	getServiceType () const

const std::string &	getActionURL () const

const std::string &	getModelName () const

const std::string &	getManufacturer () const

virtual int	runAction (const UPnPP::SoapOutgoing &args, UPnPP::SoapIncoming &data)
	Call Soap action and return resulting data. More...

int	runTrivialAction (const std::string &actionName)
	Run trivial action where there are neither input parameters nor return data (beyond the status)

template<class T >
int	runSimpleGet (const std::string &actnm, const std::string &valnm, T *valuep)
	Run action where there are no input parameters and a single named value is to be retrieved from the result.

template<class T >
int	runSimpleAction (const std::string &actnm, const std::string &valnm, T value)
	Run action with a single input parameter and no return data.

virtual VarEventReporter *	getReporter ()
	Get pointer to installed event reporter. More...

virtual void	installReporter (VarEventReporter *reporter)
	Install or uninstall event data reporter object. More...

Static Public Member Functions
static bool	isRDCService (const std::string &st)
	Test service type from discovery message.

Protected Member Functions
virtual bool	serviceInit (const UPnPDeviceDesc &device, const UPnPServiceDesc &service)
	Service-specific part of initialization. More...

Protected Member Functions inherited from UPnPClient::Service
bool	registerCallback (evtCBFunc c)
	Used by a derived class to register its callback method. More...

void	unregisterCallback ()
	Cancel subscription to the service events, forget installed callback.

Protected Attributes
int	m_volmin {0}

int	m_volmax {100}

int	m_volstep {1}

Static Protected Attributes
static const std::string	SType

Detailed Description

RenderingControl Service client class.

Constructor & Destructor Documentation

◆ RenderingControl()

UPnPClient::RenderingControl::RenderingControl	(	const UPnPDeviceDesc &	device,
		const UPnPServiceDesc &	service
	)

Construct by copying data from device and service objects.

Member Function Documentation

◆ getVolume()

int UPnPClient::RenderingControl::getVolume ( const std::string & channel = "Master" )

Returns: current volume value (0-100) or negative for error.

◆ serviceInit()

bool UPnPClient::RenderingControl::serviceInit	(	const UPnPDeviceDesc &	,
		const UPnPServiceDesc &
	)

protectedvirtual

Service-specific part of initialization.

This can be called from the constructor or from initFromDescription(). Most services don't need specific initialization, so we provide a default implementation.

Reimplemented from UPnPClient::Service.

◆ serviceTypeMatch()

bool UPnPClient::RenderingControl::serviceTypeMatch ( const std::string & tp )

virtual

Perform a comparison to the service type string for this specific service.

This allows embedding knowledge of the service type string inside the derived class. It is used, e.g., by initFromDescription() to look up an appropriate entry from the device description service list. Can also be used by external code wishing to do the same.

Parameters

tp	Service type string to be compared with the one for the derived class.

Implements UPnPClient::Service.

◆ setVolume()

int UPnPClient::RenderingControl::setVolume	(	int	volume,
		const std::string &	channel = `"Master"`
	)

Set volume to input value (0-100).

Returns: 0 for success, upnp error else

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

/home/dockes/projets/mpdupnp/libupnpp/libupnpp/control/renderingcontrol.hxx
/home/dockes/projets/mpdupnp/libupnpp/libupnpp/control/renderingcontrol.cxx

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes