CRemConAbsoluteVolumeController Class Reference

#include <mw/absolutevolumeapicontroller.h>

Link against: remconabsolutevolume.lib

class CRemConAbsoluteVolumeController : public CRemConInterfaceBase

Inherits from

CRemConAbsoluteVolumeController

Public Member Functions
	~CRemConAbsoluteVolumeController()
IMPORT_C void	CancelAbsoluteVolumeNotification()
IMPORT_C void	CancelSetAbsoluteVolume()
IMPORT_C CRemConAbsoluteVolumeController *	NewL(CRemConInterfaceSelector &, MRemConAbsoluteVolumeControllerObserver &, TUint32)
IMPORT_C void	RegisterAbsoluteVolumeNotification()
IMPORT_C void	SetAbsoluteVolume(TRequestStatus &, TUint32, TUint &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()
	CRemConInterfaceBase::BaseConstructL()
	CRemConInterfaceBase::BaseConstructL(RRemConInterfaceFeatures &)
	CRemConInterfaceBase::BaseConstructL(RRemConInterfaceFeatures &,TBool)
	CRemConInterfaceBase::Bulk()const
	CRemConInterfaceBase::CRemConInterfaceBase(TUid,TUint,CRemConInterfaceSelector &,TRemConClientType)
	CRemConInterfaceBase::Cancel()
	CRemConInterfaceBase::InterfaceSelector()
	CRemConInterfaceBase::InterfaceUid()const
	CRemConInterfaceBase::MaxLength()const
	CRemConInterfaceBase::Target(TRemConClientType)
	CRemConInterfaceBase::Type()const
	CRemConInterfaceBase::~CRemConInterfaceBase()

Detailed Description

This class is used to set and observer the volume level on a remote device.

An active scheduler is required in order to use this class.

Constructor & Destructor Documentation

~CRemConAbsoluteVolumeController ( )

IMPORT_C

~CRemConAbsoluteVolumeController

(

)

Member Function Documentation

CancelAbsoluteVolumeNotification ( )

IMPORT_C void

CancelAbsoluteVolumeNotification

(

)

Called by the client to tell the controller that the client doesn't wish to receicve the volume change notification until the client re-register again.

CancelSetAbsoluteVolume ( )

IMPORT_C void

CancelSetAbsoluteVolume

(

)

NewL ( CRemConInterfaceSelector &, MRemConAbsoluteVolumeControllerObserver &, TUint32 )

IMPORT_C CRemConAbsoluteVolumeController *	NewL	(	CRemConInterfaceSelector &	aInterfaceSelector,
			MRemConAbsoluteVolumeControllerObserver &	aObserver,
			TUint32	aMaxVolume
		)	[static]

Allocates and constructs a new CRemConAbsoluteVolumeController object

panic: AbsoluteVolumeController 0 if aMaxVolume is zero.

Parameter	Description
aInterfaceSelector	The interface selector. The client must have created one of these first.
aObserver	The observer. The client must have implemented the observer, owned by the client.
aMaxVolume	The client maximum volume.

Returns: A new CRemConAbsoluteVolumeController, owned by the interface selector

RegisterAbsoluteVolumeNotification ( )

IMPORT_C void

RegisterAbsoluteVolumeNotification

(

)

Requests notification when the volume on the target device changes, Any responses will be returned via the observer interface.

Volume changes will continue to be provided until either the CancelAbsoluteVolumeNotification function is called, or MrcavcoCurrentVolume is called on the client with an error.

Pre-condition: The client is not currently registered to receive absolute volume notifications.

SetAbsoluteVolume ( TRequestStatus &, TUint32, TUint & )

IMPORT_C void	SetAbsoluteVolume	(	TRequestStatus &	aStatus,
			TUint32	aVolume,
			TUint &	aNumRemotes
		)

Sets an absolute volume on the target device, Any responses will be returned via the observer interface.

Pre-condition: The send of any previous SetAbsoluteVolume command has completed.

panic: AbsoluteVolumeController 1, if aVolume greater than the client max volume.

Parameter	Description
aStatus	Indicates the completion of the send request. The client must not block execution by using User::WaitForRequest to await completion of this send.
aVolume	The relative volume against the client max volume.
aNumRemotes	The number of remotes to which the command was sent.