#include <PtPhoneMicrophone.h>
Inheritance diagram for PtPhoneMicrophone:
Collaboration diagram for PtPhoneMicrophone:
Public Types | |
| enum | GainLevel { 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 | |
| PtPhoneMicrophone () | |
| 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... | |
| PtPhoneMicrophone (TaoClientTask *pClient) | |
| PtPhoneMicrophone (const PtPhoneMicrophone &rPtPhoneMicrophone) | |
| PtPhoneMicrophone & | operator= (const PtPhoneMicrophone &rhs) |
| virtual | ~PtPhoneMicrophone () |
| virtual PtStatus | setGain (int gain) |
| virtual PtStatus | getGain (int &rGain) |
| param: gain - The microphone gain level retcode: PT_SUCCESS - Success retcode: PT_INVALID_ARGUMENT - invalid gain level retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More... | |
| Public Member Functions inherited from PtComponent | |
| PtComponent () | |
| PtComponent (const PtComponent &rPtComponent) | |
| PtComponent & | operator= (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 | |
| TaoClientTask * | mpClient |
| 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
| enum GainLevel |
Constructor & Destructor Documentation
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
| PtPhoneMicrophone | ( | TaoClientTask * | pClient | ) |
| PtPhoneMicrophone | ( | const PtPhoneMicrophone & | rPtPhoneMicrophone | ) |
|
virtual |
Member Function Documentation
|
virtual |
param: gain - The microphone gain level retcode: PT_SUCCESS - Success retcode: PT_INVALID_ARGUMENT - invalid gain level retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
| PtPhoneMicrophone & operator= | ( | const PtPhoneMicrophone & | rhs | ) |
|
virtual |
Member Data Documentation
|
protected |
retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
|
private |
|
protected |