13 * |
13 * |
14 * Description: Defines VoIP DTMF tone player APIs. |
14 * Description: Defines VoIP DTMF tone player APIs. |
15 * |
15 * |
16 */ |
16 */ |
17 |
17 |
18 #ifndef __VOIPDTMFTONEPLAYER_H |
18 #ifndef VOIPDTMFTONEPLAYER_H |
19 #define __VOIPDTMFTONEPLAYER_H |
19 #define VOIPDTMFTONEPLAYER_H |
20 |
20 |
21 // FORWARD DECLARATIONS |
21 // FORWARD DECLARATIONS |
22 class CVoIPAudioUplinkStream; |
22 class CVoIPAudioUplinkStream; |
23 class CVoIPAudioDownlinkStream; |
23 class CVoIPAudioDownlinkStream; |
24 class CDTMFTonePlayer; |
24 class CDTMFTonePlayer; |
25 class CDTMFTonePlayerImpl; |
25 class CDTMFTonePlayerImpl; |
26 |
26 |
27 /** |
27 /** |
28 * MDTMFToneObserver class |
28 * MDTMFToneObserver class |
29 * |
|
30 * ?more_complete_description |
|
31 * |
29 * |
32 * @lib VoIPAudioIntfc.dll |
30 * @lib VoIPAudioIntfc.dll |
33 * |
31 * |
34 */ |
32 */ |
35 class MDTMFToneObserver |
33 class MDTMFToneObserver |
38 static const TUint KOpenCompleteDNL = 1; |
36 static const TUint KOpenCompleteDNL = 1; |
39 static const TUint KOpenCompleteUPL = 2; |
37 static const TUint KOpenCompleteUPL = 2; |
40 |
38 |
41 public: |
39 public: |
42 /** |
40 /** |
43 * ?description |
41 * Event |
44 * |
|
45 * @since S60 v5.0 |
|
46 * @param CDTMFTonePlayer& - DTMF tone player reference |
42 * @param CDTMFTonePlayer& - DTMF tone player reference |
47 * @param TInt - Event type |
43 * @param TInt - Event type |
48 * @param TInt - Status |
44 * @param TInt - Status |
49 * @return void |
45 * @return void |
50 */ |
46 */ |
64 { |
60 { |
65 public: |
61 public: |
66 |
62 |
67 /** |
63 /** |
68 * Destructor |
64 * Destructor |
69 * |
|
70 * @since S60 v5.0 |
|
71 * @param none |
65 * @param none |
72 * @return none |
66 * @return none |
73 */ |
67 */ |
74 IMPORT_C virtual ~CDTMFTonePlayer(); |
68 IMPORT_C virtual ~CDTMFTonePlayer(); |
75 |
69 |
76 /** |
70 /** |
77 * ?description |
71 * Open |
78 * |
|
79 * @since S60 v5.0 |
|
80 * @param MDTMFToneObserver& |
72 * @param MDTMFToneObserver& |
81 * @return TInt |
73 * @return TInt |
82 */ |
74 */ |
83 IMPORT_C TInt Open(MDTMFToneObserver& aObserver); |
75 IMPORT_C TInt Open(MDTMFToneObserver& aObserver); |
84 |
76 |
85 /** |
77 /** |
86 * ?description |
78 * Play |
87 * |
|
88 * @since S60 v5.0 |
|
89 * @param TPtr - |
79 * @param TPtr - |
90 * @return TInt - |
80 * @return TInt - |
91 */ |
81 */ |
92 IMPORT_C TInt Play(const TPtr aTones); |
82 IMPORT_C TInt Play(const TPtr aTones); |
93 |
83 |
94 /** |
84 /** |
95 * ?description |
85 * Stop |
96 * |
|
97 * @since S60 v5.0 |
|
98 * @param none |
86 * @param none |
99 * @return TInt |
87 * @return TInt |
100 */ |
88 */ |
101 IMPORT_C TInt Stop(); |
89 IMPORT_C TInt Stop(); |
102 |
90 |
103 /** |
91 /** |
104 * ?description |
92 * Close |
105 * |
|
106 * @since S60 v5.0 |
|
107 * @param none |
93 * @param none |
108 * @return void |
94 * @return void |
109 */ |
95 */ |
110 IMPORT_C void Close(); |
96 IMPORT_C void Close(); |
111 |
97 |
112 /** |
98 /** |
113 * ?description |
99 * AddVoIPAudioUplinkStream |
114 * |
|
115 * @since S60 v5.0 |
|
116 * @param CVoIPAudioUplinkStream& - |
100 * @param CVoIPAudioUplinkStream& - |
117 * @return TInt |
101 * @return TInt |
118 */ |
102 */ |
119 IMPORT_C TInt AddVoIPAudioUplinkStream(CVoIPAudioUplinkStream& aStream); |
103 IMPORT_C TInt AddVoIPAudioUplinkStream(CVoIPAudioUplinkStream& aStream); |
120 |
104 |
121 /** |
105 /** |
122 * ?description |
106 * RemoveVoIPAudioUplinkStream |
123 * |
|
124 * @since S60 v5.0 |
|
125 * @param CVoIPAudioUplinkStream& |
107 * @param CVoIPAudioUplinkStream& |
126 * @return TInt |
108 * @return TInt |
127 */ |
109 */ |
128 IMPORT_C TInt RemoveVoIPAudioUplinkStream(CVoIPAudioUplinkStream& aStream); |
110 IMPORT_C TInt RemoveVoIPAudioUplinkStream(CVoIPAudioUplinkStream& aStream); |
129 |
111 |
130 /** |
112 /** |
131 * ?description |
113 * AddVoIPAudioDownlinkStream |
132 * |
|
133 * @since S60 v5.0 |
|
134 * @param CVoIPAudioDownlinkStream& - |
114 * @param CVoIPAudioDownlinkStream& - |
135 * @return TInt |
115 * @return TInt |
136 */ |
116 */ |
137 IMPORT_C TInt AddVoIPAudioDownlinkStream(CVoIPAudioDownlinkStream& aStream); |
117 IMPORT_C TInt AddVoIPAudioDownlinkStream(CVoIPAudioDownlinkStream& aStream); |
138 |
118 |
139 /** |
119 /** |
140 * ?description |
120 * RemoveVoIPAudioDownlinkStream |
141 * |
|
142 * @since S60 v5.0 |
|
143 * @param CVoIPAudioDownlinkStream& - |
121 * @param CVoIPAudioDownlinkStream& - |
144 * @return TInt |
122 * @return TInt |
145 */ |
123 */ |
146 IMPORT_C TInt RemoveVoIPAudioDownlinkStream( |
124 IMPORT_C TInt RemoveVoIPAudioDownlinkStream( |
147 CVoIPAudioDownlinkStream& aStream); |
125 CVoIPAudioDownlinkStream& aStream); |
148 |
126 |
149 protected: |
127 protected: |
150 |
128 |
151 /** |
129 /** |
152 * Constructor |
130 * Constructor |
153 * |
|
154 * @since S60 v5.0 |
|
155 * @param none |
131 * @param none |
156 * @return none |
132 * @return none |
157 */ |
133 */ |
158 CDTMFTonePlayer(); |
134 CDTMFTonePlayer(); |
159 |
135 |
160 /** |
136 /** |
161 * Symbian constructor |
137 * Symbian constructor |
162 * |
|
163 * @since S60 v5.0 |
|
164 * @param none |
138 * @param none |
165 * @return void |
139 * @return void |
166 */ |
140 */ |
167 void ConstructL(CDTMFTonePlayerImpl* aDTMFTonePlayerImpl); |
141 void ConstructL(CDTMFTonePlayerImpl* aDTMFTonePlayerImpl); |
168 |
142 |
169 private: |
143 private: |
170 |
144 |
171 CDTMFTonePlayerImpl* iDTMFTonePlayerImpl; |
145 CDTMFTonePlayerImpl* iDTMFTonePlayerImpl; |
172 |
|
173 }; |
146 }; |
174 |
147 |
175 #endif //__VOIPDTMFTONEPLAYER_H |
148 #endif //VOIPDTMFTONEPLAYER_H |
176 |
149 |
177 // End of file |
150 // End of file |