UPnPClient::OHVolume Class Reference

OHVolume Service client class. More...

#include <ohvolume.hxx>

Inheritance diagram for UPnPClient::OHVolume:

Public Member Functions
	OHVolume (const UPnPDeviceDesc &device, const UPnPServiceDesc &service)
virtual bool	serviceTypeMatch (const std::string &tp)
	Perform a comparison to the service type string for this specific service. More...
int	characteristics (OHVCharacteristics *c)
int	volume (int *value)
	Retrieve volume level. More...
int	setVolume (int value)
	Set volume level. More...
int	volumeLimit (int *value)
int	mute (bool *value)
int	setMute (bool value)
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	isOHVLService (const std::string &st)
	Test service type from discovery message.

Static Protected Attributes
static const std::string	SType

Additional Inherited Members
Protected Member Functions inherited from UPnPClient::Service
virtual bool	serviceInit (const UPnPDeviceDesc &, const UPnPServiceDesc &)
	Service-specific part of initialization. More...
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.

Detailed Description

OHVolume Service client class.

Member Function Documentation

serviceTypeMatch()

bool UPnPClient::OHVolume::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::OHVolume::setVolume

(

int

value

)

Set volume level.

Parameters

value

volume level to set (0-100).

Returns

0 for success or < 0 for error.

volume()

int UPnPClient::OHVolume::volume

(

int *

value

)

Retrieve volume level.

Parameters

---

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

• /home/dockes/projets/mpdupnp/libupnpp/libupnpp/control/ohvolume.hxx
• /home/dockes/projets/mpdupnp/libupnpp/libupnpp/control/ohvolume.cxx