1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
//
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp. All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$
///////////////////////////////////////////////////////////////////////////////
#ifndef _PsTaoMicrophone_h_
#define _PsTaoMicrophone_h_
// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include "ps/PsTaoComponent.h"
// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
//:The PsTaoMicrophone class models the keypad and feature buttons.
class PsTaoMicrophone : public PsTaoComponent
{
friend class PsPhoneTask;
// The PsPhoneTask is responsible for creating and destroying
// all objects derived from the PsTaoComponent class. No other entity
// should invoke the constructors or destructors for these classes.
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:
enum GainLevel
{
OFF = 0,
MIDDLE = 5,
FULL = 10
};
//!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
/* ============================ CREATORS ================================== */
/* ============================ MANIPULATORS ============================== */
OsStatus setGain(int gain);
//:Sets the microphone gain (volume) to a value between OFF and
//:FULL (inclusive).
//!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
/* ============================ ACCESSORS ================================= */
OsStatus getGain(int& rGain);
//:Sets <i>rGain</i> to the current microphone gain level.
//!retcode: OS_SUCCESS - Success
//!retcode: OS_PROVIDER_UNAVAILABLE - The provider is not available
/* ============================ INQUIRY =================================== */
/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:
PsTaoMicrophone(const UtlString& rComponentName, int componentType);
PsTaoMicrophone();
//:Default constructor
virtual
~PsTaoMicrophone();
//:Destructor
/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
int mGain; // the gain
PsTaoMicrophone(const PsTaoMicrophone& rPsTaoMicrophone);
//:Copy constructor (not implemented for this class)
PsTaoMicrophone& operator=(const PsTaoMicrophone& rhs);
//:Assignment operator (not implemented for this class)
};
/* ============================ INLINE METHODS ============================ */
#endif // _PsTaoMicrophone_h_
|
