|
sl@0
|
1 |
// Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
2 |
// All rights reserved.
|
|
sl@0
|
3 |
// This component and the accompanying materials are made available
|
|
sl@0
|
4 |
// under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
5 |
// which accompanies this distribution, and is available
|
|
sl@0
|
6 |
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
7 |
//
|
|
sl@0
|
8 |
// Initial Contributors:
|
|
sl@0
|
9 |
// Nokia Corporation - initial contribution.
|
|
sl@0
|
10 |
//
|
|
sl@0
|
11 |
// Contributors:
|
|
sl@0
|
12 |
//
|
|
sl@0
|
13 |
// Description:
|
|
sl@0
|
14 |
//
|
|
sl@0
|
15 |
|
|
sl@0
|
16 |
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
/**
|
|
sl@0
|
19 |
@file
|
|
sl@0
|
20 |
@publishedPartner
|
|
sl@0
|
21 |
@released
|
|
sl@0
|
22 |
*/
|
|
sl@0
|
23 |
|
|
sl@0
|
24 |
#ifndef TTONEDATA_H
|
|
sl@0
|
25 |
#define TTONEDATA_H
|
|
sl@0
|
26 |
|
|
sl@0
|
27 |
#include <e32base.h>
|
|
sl@0
|
28 |
|
|
sl@0
|
29 |
const TInt KMdaInfiniteDurationDTMFToneOnLength = -1;
|
|
sl@0
|
30 |
|
|
sl@0
|
31 |
/*
|
|
sl@0
|
32 |
* Includes information about tone type, data, length.
|
|
sl@0
|
33 |
* @lib ttonedata.lib
|
|
sl@0
|
34 |
*/
|
|
sl@0
|
35 |
class TToneData
|
|
sl@0
|
36 |
{
|
|
sl@0
|
37 |
public:
|
|
sl@0
|
38 |
|
|
sl@0
|
39 |
enum TToneType
|
|
sl@0
|
40 |
{
|
|
sl@0
|
41 |
/* Simple Tone */
|
|
sl@0
|
42 |
ESimple = 0,
|
|
sl@0
|
43 |
/* Dual Tone */
|
|
sl@0
|
44 |
EDual = 1,
|
|
sl@0
|
45 |
/* TMF String Tone */
|
|
sl@0
|
46 |
EDtmfString = 2,
|
|
sl@0
|
47 |
/* Sequence */
|
|
sl@0
|
48 |
ESequence = 3,
|
|
sl@0
|
49 |
/* Fixed Sequence*/
|
|
sl@0
|
50 |
EFixedSequence = 4
|
|
sl@0
|
51 |
};
|
|
sl@0
|
52 |
|
|
sl@0
|
53 |
|
|
sl@0
|
54 |
IMPORT_C TToneData();
|
|
sl@0
|
55 |
|
|
sl@0
|
56 |
/*
|
|
sl@0
|
57 |
* Sets type of the tone. (Simple, Dual, Sequence etc.)
|
|
sl@0
|
58 |
*
|
|
sl@0
|
59 |
* @param aType Type of the tone.
|
|
sl@0
|
60 |
*/
|
|
sl@0
|
61 |
IMPORT_C void SetType(TToneType aType);
|
|
sl@0
|
62 |
|
|
sl@0
|
63 |
/*
|
|
sl@0
|
64 |
* Sets tone duration in micro seconds.
|
|
sl@0
|
65 |
*
|
|
sl@0
|
66 |
* @param aDuration Tone duration in microseconds.
|
|
sl@0
|
67 |
*/
|
|
sl@0
|
68 |
IMPORT_C void SetDuration(TTimeIntervalMicroSeconds aDuration);
|
|
sl@0
|
69 |
|
|
sl@0
|
70 |
/*
|
|
sl@0
|
71 |
* Sets tone one freqyency.
|
|
sl@0
|
72 |
*
|
|
sl@0
|
73 |
* @param aFrequencyOne Frequency of the tone one.
|
|
sl@0
|
74 |
*/
|
|
sl@0
|
75 |
IMPORT_C void SetFrequencyOne(TInt aFrequencyOne);
|
|
sl@0
|
76 |
|
|
sl@0
|
77 |
/*
|
|
sl@0
|
78 |
* Sets tone two freqyency.
|
|
sl@0
|
79 |
*
|
|
sl@0
|
80 |
* @param aFrequencyOne Frequency of the tone two.
|
|
sl@0
|
81 |
*/
|
|
sl@0
|
82 |
IMPORT_C void SetFrequencyTwo(TInt aFrequencyTwo);
|
|
sl@0
|
83 |
|
|
sl@0
|
84 |
/*
|
|
sl@0
|
85 |
* Sets tone sequence number.
|
|
sl@0
|
86 |
*
|
|
sl@0
|
87 |
* @param aSequenceNumber Number of the sequence.
|
|
sl@0
|
88 |
*/
|
|
sl@0
|
89 |
IMPORT_C void SetSequenceNumber(TInt aSequenceNumber);
|
|
sl@0
|
90 |
|
|
sl@0
|
91 |
/*
|
|
sl@0
|
92 |
* Sets tone sequence data.
|
|
sl@0
|
93 |
*
|
|
sl@0
|
94 |
* @param aSequenceData Reference of the sequence data.
|
|
sl@0
|
95 |
*/
|
|
sl@0
|
96 |
IMPORT_C void SetSequenceData(TDesC8& aSequenceData);
|
|
sl@0
|
97 |
|
|
sl@0
|
98 |
/*
|
|
sl@0
|
99 |
* Sets tone repeat count, if count is KMdaRepeatForever, tone will be repeated indefinitely.
|
|
sl@0
|
100 |
*
|
|
sl@0
|
101 |
* @param aRepeatCount Repeat count of the tone.
|
|
sl@0
|
102 |
*/
|
|
sl@0
|
103 |
IMPORT_C void SetRepeatCount(TInt aRepeatCount);
|
|
sl@0
|
104 |
|
|
sl@0
|
105 |
/*
|
|
sl@0
|
106 |
* Sets tone trailing silence.
|
|
sl@0
|
107 |
*
|
|
sl@0
|
108 |
* @param aRepeatTrailingSilence An interval of silence which will be played after each tone.
|
|
sl@0
|
109 |
*/
|
|
sl@0
|
110 |
IMPORT_C void SetRepeatTrailingSilence(TTimeIntervalMicroSeconds aRepeatTrailingSilence);
|
|
sl@0
|
111 |
|
|
sl@0
|
112 |
/*
|
|
sl@0
|
113 |
* Defines the duration of tone on, tone off and tone pause to be used during the DTMF tone playback operation.
|
|
sl@0
|
114 |
*
|
|
sl@0
|
115 |
* @param aToneOnLength The period over which the tone will be played. If this is set to zero, then the tone is not played.
|
|
sl@0
|
116 |
* @param aToneOffLength The period over which the no tone will be played.
|
|
sl@0
|
117 |
* @param aPauseLength The period over which the tone playing will be paused.
|
|
sl@0
|
118 |
*/
|
|
sl@0
|
119 |
IMPORT_C void SetDtmfLengths(TTimeIntervalMicroSeconds32 aToneOnLength, TTimeIntervalMicroSeconds32 aToneOffLength, TTimeIntervalMicroSeconds32 aPauseLength);
|
|
sl@0
|
120 |
|
|
sl@0
|
121 |
/*
|
|
sl@0
|
122 |
* Sets tone DTMF string.
|
|
sl@0
|
123 |
*
|
|
sl@0
|
124 |
* @param aDTMFString Reference of the DTMF string.
|
|
sl@0
|
125 |
*/
|
|
sl@0
|
126 |
IMPORT_C void SetDTMFString(TDesC& aDTMFString);
|
|
sl@0
|
127 |
|
|
sl@0
|
128 |
/*
|
|
sl@0
|
129 |
* Gets tone type. (Simple, Dual, Sequence etc.)
|
|
sl@0
|
130 |
*
|
|
sl@0
|
131 |
* @param aType Type of the tone.
|
|
sl@0
|
132 |
*/
|
|
sl@0
|
133 |
IMPORT_C void GetType(TToneType& aType);
|
|
sl@0
|
134 |
|
|
sl@0
|
135 |
/*
|
|
sl@0
|
136 |
* Gets tone duration in micro seconds.
|
|
sl@0
|
137 |
*
|
|
sl@0
|
138 |
* @param aDuration Tone duration in microseconds.
|
|
sl@0
|
139 |
*/
|
|
sl@0
|
140 |
IMPORT_C void GetDuration(TTimeIntervalMicroSeconds& aDuration);
|
|
sl@0
|
141 |
|
|
sl@0
|
142 |
/*
|
|
sl@0
|
143 |
* Gets frequency of the tone one.
|
|
sl@0
|
144 |
*
|
|
sl@0
|
145 |
* @return Frequency of the tone one.
|
|
sl@0
|
146 |
*/
|
|
sl@0
|
147 |
IMPORT_C TInt GetFrequencyOne();
|
|
sl@0
|
148 |
|
|
sl@0
|
149 |
/*
|
|
sl@0
|
150 |
* Gets frequency of the tone two.
|
|
sl@0
|
151 |
*
|
|
sl@0
|
152 |
* @return Frequency of the tone two.
|
|
sl@0
|
153 |
*/
|
|
sl@0
|
154 |
IMPORT_C TInt GetFrequencyTwo();
|
|
sl@0
|
155 |
|
|
sl@0
|
156 |
/*
|
|
sl@0
|
157 |
* Gets sequence number.
|
|
sl@0
|
158 |
*
|
|
sl@0
|
159 |
* @return Sequence number.
|
|
sl@0
|
160 |
*/
|
|
sl@0
|
161 |
IMPORT_C TInt GetSequenceNumber();
|
|
sl@0
|
162 |
|
|
sl@0
|
163 |
/*
|
|
sl@0
|
164 |
* Gets sequence data of the tone.
|
|
sl@0
|
165 |
* Client should not delete this pointer.
|
|
sl@0
|
166 |
*
|
|
sl@0
|
167 |
* @return Pointer to tone sequence data.
|
|
sl@0
|
168 |
*/
|
|
sl@0
|
169 |
IMPORT_C TDesC8* GetSequenceData();
|
|
sl@0
|
170 |
|
|
sl@0
|
171 |
/*
|
|
sl@0
|
172 |
* Gets tone repeat count.
|
|
sl@0
|
173 |
*
|
|
sl@0
|
174 |
* @return Repeat count.
|
|
sl@0
|
175 |
*/
|
|
sl@0
|
176 |
IMPORT_C TInt GetRepeatCount();
|
|
sl@0
|
177 |
|
|
sl@0
|
178 |
/*
|
|
sl@0
|
179 |
* Gets tone trailing silence duration.
|
|
sl@0
|
180 |
*
|
|
sl@0
|
181 |
* @param aRepeatTrailingSilence Trailing silence duration.
|
|
sl@0
|
182 |
*/
|
|
sl@0
|
183 |
IMPORT_C void GetRepeatTrailingSilence(TTimeIntervalMicroSeconds& aRepeatTrailingSilence);
|
|
sl@0
|
184 |
|
|
sl@0
|
185 |
/*
|
|
sl@0
|
186 |
* Gets tone DTMF lengts duration.
|
|
sl@0
|
187 |
*
|
|
sl@0
|
188 |
* @param aToneOnLength The period over which the tone will be played.
|
|
sl@0
|
189 |
* @param aToneOffLength The period over which the no tone will be played.
|
|
sl@0
|
190 |
* @param aPauseLength The period over which the tone playing will be paused.
|
|
sl@0
|
191 |
*/
|
|
sl@0
|
192 |
IMPORT_C void GetDtmfLenghts(TTimeIntervalMicroSeconds32& aToneOnLength, TTimeIntervalMicroSeconds32& aToneOffLength, TTimeIntervalMicroSeconds32& aPauseLength);
|
|
sl@0
|
193 |
|
|
sl@0
|
194 |
/*
|
|
sl@0
|
195 |
* Gets DTMF string of the tone.
|
|
sl@0
|
196 |
* Client should not delete this pointer
|
|
sl@0
|
197 |
*
|
|
sl@0
|
198 |
* @return Pointer to tone DTMF string.
|
|
sl@0
|
199 |
*/
|
|
sl@0
|
200 |
IMPORT_C TDesC* GetDTMFString();
|
|
sl@0
|
201 |
|
|
sl@0
|
202 |
private: // data
|
|
sl@0
|
203 |
|
|
sl@0
|
204 |
|
|
sl@0
|
205 |
/* Type of the tone. */
|
|
sl@0
|
206 |
|
|
sl@0
|
207 |
TToneType iType;
|
|
sl@0
|
208 |
|
|
sl@0
|
209 |
|
|
sl@0
|
210 |
/* Duration of the tone. */
|
|
sl@0
|
211 |
|
|
sl@0
|
212 |
TTimeIntervalMicroSeconds iDuration;
|
|
sl@0
|
213 |
|
|
sl@0
|
214 |
|
|
sl@0
|
215 |
/* Frequency of the tone one. */
|
|
sl@0
|
216 |
|
|
sl@0
|
217 |
TInt iFrequencyOne;
|
|
sl@0
|
218 |
|
|
sl@0
|
219 |
|
|
sl@0
|
220 |
/* Frequency of the tone two. */
|
|
sl@0
|
221 |
|
|
sl@0
|
222 |
TInt iFrequencyTwo;
|
|
sl@0
|
223 |
|
|
sl@0
|
224 |
|
|
sl@0
|
225 |
/* Sequence number of the tone. */
|
|
sl@0
|
226 |
|
|
sl@0
|
227 |
TInt iSequenceNumber;
|
|
sl@0
|
228 |
|
|
sl@0
|
229 |
|
|
sl@0
|
230 |
/* Repeat count of the tone. */
|
|
sl@0
|
231 |
|
|
sl@0
|
232 |
TInt iRepeatCount;
|
|
sl@0
|
233 |
|
|
sl@0
|
234 |
|
|
sl@0
|
235 |
/* Repeat traingling silence of the tone. */
|
|
sl@0
|
236 |
|
|
sl@0
|
237 |
TTimeIntervalMicroSeconds iRepeatTrainglingSilence;
|
|
sl@0
|
238 |
|
|
sl@0
|
239 |
|
|
sl@0
|
240 |
/* The period over which the tone will be played. */
|
|
sl@0
|
241 |
|
|
sl@0
|
242 |
TTimeIntervalMicroSeconds32 iToneOnLength;
|
|
sl@0
|
243 |
|
|
sl@0
|
244 |
|
|
sl@0
|
245 |
/* The period over which the no tone will be played. */
|
|
sl@0
|
246 |
|
|
sl@0
|
247 |
TTimeIntervalMicroSeconds32 iToneOffLength;
|
|
sl@0
|
248 |
|
|
sl@0
|
249 |
|
|
sl@0
|
250 |
/* The period over which the tone playing will be paused. */
|
|
sl@0
|
251 |
|
|
sl@0
|
252 |
TTimeIntervalMicroSeconds32 iPauseLength;
|
|
sl@0
|
253 |
|
|
sl@0
|
254 |
|
|
sl@0
|
255 |
/* Pointer to data of the tone sequence.
|
|
sl@0
|
256 |
* Not own.
|
|
sl@0
|
257 |
*/
|
|
sl@0
|
258 |
|
|
sl@0
|
259 |
TDesC8 *iSequenceData;
|
|
sl@0
|
260 |
|
|
sl@0
|
261 |
|
|
sl@0
|
262 |
/* Pointer to string of the DTMF tone.
|
|
sl@0
|
263 |
* Not own.
|
|
sl@0
|
264 |
*/
|
|
sl@0
|
265 |
|
|
sl@0
|
266 |
TDesC *iDTMFString;
|
|
sl@0
|
267 |
};
|
|
sl@0
|
268 |
|
|
sl@0
|
269 |
#endif // TTONEDATA_H
|