PsTaoSpeaker Class Reference

#include <PsTaoSpeaker.h>

Inheritance diagram for PsTaoSpeaker:

Collaboration diagram for PsTaoSpeaker:

Public Types
enum	VolumeLevel { OFF = 0, MIDDLE = 5, FULL = 10 }
Public Types inherited from PsTaoComponent
enum	PsComponentType {   BUTTON, DISPLAY, GRAPHIC_DISPLAY, HOOKSWITCH,   LAMP, MICROPHONE, RINGER, SPEAKER,   EXTERNAL_SPEAKER }

Public Member Functions
OsStatus	setVolume (int volume)
	enumcode: OFF - The speaker is turned off enumcode: MIDDLE - The speaker volume level is set to the middle of its range enumcode: FULL - The speaker volume is set to its maximum level More...
OsStatus	getVolume (int &rVolume)
	param: volume - The speaker volume level retcode: OS_SUCCESS - Success retcode: OS_INVALID_ARGUMENT - Invalid volume level retcode: OS_PROVIDER_UNAVAILABLE - The provider is not available More...
Public Member Functions inherited from PsTaoComponent
void	getName (UtlString &rName)
int	getType (void)

Protected Member Functions
	PsTaoSpeaker (const UtlString &rComponentName, int componentType)
	retcode: OS_SUCCESS - Success retcode: OS_PROVIDER_UNAVAILABLE - The provider is not available More...
	PsTaoSpeaker ()
virtual	~PsTaoSpeaker ()
Protected Member Functions inherited from PsTaoComponent
	PsTaoComponent (const UtlString &rComponentName, int componentType)
	PsTaoComponent ()
virtual	~PsTaoComponent ()
OsMutex *	getMutex (void)

Private Member Functions
	PsTaoSpeaker (const PsTaoSpeaker &rPsTaoSpeaker)
PsTaoSpeaker &	operator= (const PsTaoSpeaker &rhs)

Private Attributes
int	mVolume

Friends
class	PsPhoneTask

Additional Inherited Members
Protected Attributes inherited from PsTaoComponent
OsMutex	mMutex
UtlString	mName
int	mType

Member Enumeration Documentation

enum VolumeLevel

Enumerator
OFF
MIDDLE
FULL

Constructor & Destructor Documentation

PsTaoSpeaker ( const UtlString &  rComponentName, int  componentType  )

protected

retcode: OS_SUCCESS - Success retcode: OS_PROVIDER_UNAVAILABLE - The provider is not available

PsTaoSpeaker ( )

protected

~PsTaoSpeaker ( )

protectedvirtual

PsTaoSpeaker ( const PsTaoSpeaker &  rPsTaoSpeaker )

private

Member Function Documentation

OsStatus getVolume

(

int &

rVolume

)

param: volume - The speaker volume level retcode: OS_SUCCESS - Success retcode: OS_INVALID_ARGUMENT - Invalid volume level retcode: OS_PROVIDER_UNAVAILABLE - The provider is not available

PsTaoSpeaker & operator= ( const PsTaoSpeaker &  rhs )

private

OsStatus setVolume

(

int

volume

)

enumcode: OFF - The speaker is turned off enumcode: MIDDLE - The speaker volume level is set to the middle of its range enumcode: FULL - The speaker volume is set to its maximum level

Friends And Related Function Documentation

friend class PsPhoneTask

friend

Member Data Documentation

int mVolume

private