PsTaoMicrophone Class Reference

#include <PsTaoMicrophone.h>

Inheritance diagram for PsTaoMicrophone:

Collaboration diagram for PsTaoMicrophone:

Public Types
enum	GainLevel { 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	setGain (int gain)
	enumcode: OFF - The microphone is turned off enumcode: MIDDLE - The microphone gain is set to the middle of its range enumcode: FULL - The microphone gain is set to its maximum level More...
OsStatus	getGain (int &rGain)
	param: gain - The microphone gain level retcode: OS_SUCCESS - Success retcode: OS_INVALID_ARGUMENT - invalid gain 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
	PsTaoMicrophone (const UtlString &rComponentName, int componentType)
	retcode: OS_SUCCESS - Success retcode: OS_PROVIDER_UNAVAILABLE - The provider is not available More...
	PsTaoMicrophone ()
virtual	~PsTaoMicrophone ()
Protected Member Functions inherited from PsTaoComponent
	PsTaoComponent (const UtlString &rComponentName, int componentType)
	PsTaoComponent ()
virtual	~PsTaoComponent ()
OsMutex *	getMutex (void)

Private Member Functions
	PsTaoMicrophone (const PsTaoMicrophone &rPsTaoMicrophone)
PsTaoMicrophone &	operator= (const PsTaoMicrophone &rhs)

Private Attributes
int	mGain

Friends
class	PsPhoneTask

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

Member Enumeration Documentation

enum GainLevel

Enumerator
OFF
MIDDLE
FULL

Constructor & Destructor Documentation

PsTaoMicrophone ( const UtlString &  rComponentName, int  componentType  )

protected

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

PsTaoMicrophone ( )

protected

~PsTaoMicrophone ( )

protectedvirtual

PsTaoMicrophone ( const PsTaoMicrophone &  rPsTaoMicrophone )

private

Member Function Documentation

OsStatus getGain

(

int &

rGain

)

param: gain - The microphone gain level retcode: OS_SUCCESS - Success retcode: OS_INVALID_ARGUMENT - invalid gain level retcode: OS_PROVIDER_UNAVAILABLE - The provider is not available

PsTaoMicrophone & operator= ( const PsTaoMicrophone &  rhs )

private

OsStatus setGain

(

int

gain

)

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

Friends And Related Function Documentation

friend class PsPhoneTask

friend

Member Data Documentation

int mGain

private