sipXcallLib home page


Public Types | Public Member Functions | Protected Attributes | Private Attributes | List of all members
PtPhoneExtSpeaker Class Reference

#include <PtPhoneExtSpeaker.h>

Inheritance diagram for PtPhoneExtSpeaker:
Inheritance graph
[legend]
Collaboration diagram for PtPhoneExtSpeaker:
Collaboration graph
[legend]

Public Types

enum  VolumeLevel { OFF = 0, MIDDLE = 5, FULL = 10 }
 
- Public Types inherited from PtComponent
enum  ComponentType {
  BUTTON, DISPLAY, GRAPHIC_DISPLAY, HOOKSWITCH,
  LAMP, MICROPHONE, RINGER, SPEAKER,
  TEXT_DISPLAY, EXTERNAL_SPEAKER, UNKNOWN
}
 

Public Member Functions

 PtPhoneExtSpeaker ()
 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...
 
 PtPhoneExtSpeaker (TaoClientTask *pClient)
 
 PtPhoneExtSpeaker (const PtPhoneExtSpeaker &rPtPhoneExtSpeaker)
 
PtPhoneExtSpeakeroperator= (const PtPhoneExtSpeaker &rhs)
 
virtual ~PtPhoneExtSpeaker ()
 
virtual PtStatus setVolume (int volume)
 
virtual PtStatus getVolume (int &rVolume)
 param: volume - The speaker volume level retcode: PT_SUCCESS - Success retcode: PT_INVALID_ARGUMENT - Invalid volume level retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 
virtual PtStatus getNominalVolume (int &rVolume)
 retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 
- Public Member Functions inherited from PtComponent
 PtComponent ()
 
 PtComponent (const PtComponent &rPtComponent)
 
PtComponentoperator= (const PtComponent &rhs)
 
 PtComponent (int componentType)
 
 PtComponent (const char *&rName)
 param: componentType - The type of telephone hardware modeled by this component More...
 
virtual ~PtComponent ()
 param: rName - The name of telephone hardware modeled by this component name: button name: hookswitch name: display name: graphic_display name: text_display name: lamp name: microphone name: ringer name: speaker name: unknown More...
 
void setGroupType (int groupType)
 
virtual PtStatus getName (char *rpName, int maxLen)
 
virtual PtStatus getType (int &rType)
 param: (out) rpName - The reference used to return the name retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 

Protected Attributes

TaoClientTaskmpClient
 retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 
OsTime mTimeOut
 
- Protected Attributes inherited from PtComponent
int mType
 
char mpName [21]
 

Private Attributes

OsProtectEventMgr * mpEventMgr
 

Additional Inherited Members

- Public Attributes inherited from PtComponent
int mGroupType
 

Member Enumeration Documentation

Enumerator
OFF 
MIDDLE 
FULL 

Constructor & Destructor Documentation

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

PtPhoneExtSpeaker ( const PtPhoneExtSpeaker rPtPhoneExtSpeaker)
~PtPhoneExtSpeaker ( )
virtual

Member Function Documentation

PtStatus getNominalVolume ( int &  rVolume)
virtual

retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

PtStatus getVolume ( int &  rVolume)
virtual

param: volume - The speaker volume level retcode: PT_SUCCESS - Success retcode: PT_INVALID_ARGUMENT - Invalid volume level retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

PtPhoneExtSpeaker & operator= ( const PtPhoneExtSpeaker rhs)
PtStatus setVolume ( int  volume)
virtual

Member Data Documentation

TaoClientTask* mpClient
protected

retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

OsProtectEventMgr* mpEventMgr
private
OsTime mTimeOut
protected