|
1 /* |
|
2 * Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies). |
|
3 * All rights reserved. |
|
4 * This component and the accompanying materials are made available |
|
5 * under the terms of "Eclipse Public License v1.0" |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: Encapsulates DTMF Event Payload field values. |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 |
|
20 |
|
21 #ifndef TDTMFEVENTPAYLOADINFO_H |
|
22 #define TDTMFEVENTPAYLOADINFO_H |
|
23 |
|
24 // INCLUDES |
|
25 #include <e32base.h> |
|
26 |
|
27 /** |
|
28 * Class to encapsulate event payload related information. |
|
29 * |
|
30 * @lib mmccdtmfplformat.dll |
|
31 * @since Series 60 3.2 |
|
32 */ |
|
33 class TDTMFEventPayloadInfo |
|
34 { |
|
35 public: // Constructors and destructor |
|
36 |
|
37 /** |
|
38 * C++ default constructor. |
|
39 */ |
|
40 TDTMFEventPayloadInfo(); |
|
41 |
|
42 public: // New functions |
|
43 |
|
44 /** |
|
45 * Return Event Field value of the payload. |
|
46 * |
|
47 * @since Series 60 3.2 |
|
48 * @return TChar representing event (0-9, *, #, A, B, C, D) |
|
49 */ |
|
50 inline TChar Event() const; |
|
51 |
|
52 /** |
|
53 * Set Event Field value to the payload. |
|
54 * |
|
55 * @since Series 60 3.2 |
|
56 * @param aEvent Event Field value to set |
|
57 */ |
|
58 inline void SetEvent( const TChar& aEvent ); |
|
59 |
|
60 /** |
|
61 * Return End Bit value of the payload. |
|
62 * |
|
63 * @since Series 60 3.2 |
|
64 * @return Boolean indicating whether end bit is set |
|
65 */ |
|
66 inline TBool EndBit() const; |
|
67 |
|
68 /** |
|
69 * Set End Bit value to the payload. |
|
70 * |
|
71 * @since Series 60 3.2 |
|
72 * @param aEndBit End Bit value to set |
|
73 */ |
|
74 inline void SetEndBit( TBool aEndBit ); |
|
75 |
|
76 /** |
|
77 * Get Volume field of the payload. |
|
78 * |
|
79 * @since Series 60 3.2 |
|
80 * @return Volume Field value |
|
81 */ |
|
82 inline TUint Volume() const; |
|
83 |
|
84 /** |
|
85 * Set Volume Field to the payload. |
|
86 * |
|
87 * @since Series 60 3.2 |
|
88 * @param aVolume Volume Field value to set |
|
89 */ |
|
90 inline void SetVolume( TUint aVolume ); |
|
91 |
|
92 /** |
|
93 * Get Duration Field of the payload. |
|
94 * |
|
95 * @since Series 60 3.2 |
|
96 * @return Duration Field value |
|
97 */ |
|
98 inline TUint Duration() const; |
|
99 |
|
100 /** |
|
101 * Set Duration Field to the payload. |
|
102 * |
|
103 * @since Series 60 3.2 |
|
104 * @param aDuration Duration Field value to set |
|
105 */ |
|
106 inline void SetDuration( TUint aDuration ); |
|
107 |
|
108 /** |
|
109 * Get TimeStamp. |
|
110 * |
|
111 * @since Series 60 3.2 |
|
112 * @return TimeStamp indicating where to place this |
|
113 * event at a time line |
|
114 */ |
|
115 inline TTimeIntervalMicroSeconds32 TimeStamp() const; |
|
116 |
|
117 /** |
|
118 * Set TimeStamp, which syncronizes this event with audio stream. |
|
119 * |
|
120 * @since Series 60 3.2 |
|
121 * @param aTimeStamp Indicates where to place this event |
|
122 * at a time line |
|
123 */ |
|
124 inline void SetTimeStamp( |
|
125 const TTimeIntervalMicroSeconds32& aTimeStamp ); |
|
126 |
|
127 private: // Data |
|
128 |
|
129 /** |
|
130 * Event Field of Payload |
|
131 */ |
|
132 TChar iEvent; |
|
133 |
|
134 /** |
|
135 * End bit of Payload |
|
136 */ |
|
137 TBool iEndBit; |
|
138 |
|
139 /** |
|
140 * Volume Field of Payload |
|
141 */ |
|
142 TUint iVolume; |
|
143 |
|
144 /** |
|
145 * Duration Field of Payload |
|
146 */ |
|
147 TUint iDuration; |
|
148 |
|
149 /** |
|
150 * Time stamp of the RTP packet which was carrying this payload |
|
151 */ |
|
152 TTimeIntervalMicroSeconds32 iTimeStamp; |
|
153 }; |
|
154 |
|
155 #include "dtmfeventpayloadinfo.inl" |
|
156 |
|
157 #endif // TDTMFEVENTPAYLOADINFO_H |
|
158 |
|
159 // End of File |