doc/pv2way_html/classCPVUserInputDtmf.html


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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>pv2way_engine: CPVUserInputDtmf Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>CPVUserInputDtmf Class Reference</h1><!-- doxytag: class="CPVUserInputDtmf" --><!-- doxytag: inherits="CPVUserInput" -->
<p><code>#include &lt;<a class="el" href="pv__2way__h324m__types_8h_source.html">pv_2way_h324m_types.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for CPVUserInputDtmf:</div>
<div class="dynsection">
 <div class="center">
  <img src="classCPVUserInputDtmf.png" usemap="#CPVUserInputDtmf_map" alt=""/>
  <map id="CPVUserInputDtmf_map" name="CPVUserInputDtmf_map">
<area href="classCPVUserInput.html" alt="CPVUserInput" shape="rect" coords="0,0,116,24"/>
</map>
 </div>
</div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPVUserInputDtmf.html#ad290ec76caddd6ee11b01fd6712754d6">CPVUserInputDtmf</a> (uint8 aInput, bool aUpdate, uint16 aDuration=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPVUserInputDtmf.html#a8c69586eaef99d318417dd98420ea58e">~CPVUserInputDtmf</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF <a class="el" href="pv__2way__h324m__types_8h.html#af5f88d26becc61f93f23d5022152fe39">PV2WayUserInputType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPVUserInputDtmf.html#ae45d362581462c169063f68db2ed10b9">GetType</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF uint8&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPVUserInputDtmf.html#ad2a4385443f6e13cc1c910a57ac2cc23">GetInput</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPVUserInputDtmf.html#a144596e586e27b41c82c841f02d5d53c">IsUpdate</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF uint16&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPVUserInputDtmf.html#a7f70d31216f04562d991a7ec7896cef1">GetDuration</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="classCPVUserInputDtmf.html">CPVUserInputDtmf</a> Class</p>
<p><a class="el" href="classCPVUserInputDtmf.html">CPVUserInputDtmf</a> class contains DTMF signal information from an H.245 UserInputIndication message. </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ad290ec76caddd6ee11b01fd6712754d6"></a><!-- doxytag: member="CPVUserInputDtmf::CPVUserInputDtmf" ref="ad290ec76caddd6ee11b01fd6712754d6" args="(uint8 aInput, bool aUpdate, uint16 aDuration=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_IMPORT_REF CPVUserInputDtmf::CPVUserInputDtmf </td>
          <td>(</td>
          <td class="paramtype">uint8&nbsp;</td>
          <td class="paramname"> <em>aInput</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>aUpdate</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint16&nbsp;</td>
          <td class="paramname"> <em>aDuration</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Constructor of <a class="el" href="classCPVUserInputDtmf.html">CPVUserInputDtmf</a> class.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>aInput</em>&nbsp;</td><td>The input DTMF tone. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>aUpdate</em>&nbsp;</td><td>Indicates if this is an update to a continuing DTMF tone. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>aDuration</em>&nbsp;</td><td>The duration of the update in milli-seconds.  This method can leave with one of the following error codes KErrNoMemory if the SDK failed to allocate memory during this operation. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>void </dd></dl>

</div>
</div>
<a class="anchor" id="a8c69586eaef99d318417dd98420ea58e"></a><!-- doxytag: member="CPVUserInputDtmf::~CPVUserInputDtmf" ref="a8c69586eaef99d318417dd98420ea58e" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_IMPORT_REF CPVUserInputDtmf::~CPVUserInputDtmf </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Destructor. </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7f70d31216f04562d991a7ec7896cef1"></a><!-- doxytag: member="CPVUserInputDtmf::GetDuration" ref="a7f70d31216f04562d991a7ec7896cef1" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_IMPORT_REF uint16 CPVUserInputDtmf::GetDuration </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return the duration of the update.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns the duration of the update. </dd></dl>

</div>
</div>
<a class="anchor" id="ad2a4385443f6e13cc1c910a57ac2cc23"></a><!-- doxytag: member="CPVUserInputDtmf::GetInput" ref="ad2a4385443f6e13cc1c910a57ac2cc23" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_IMPORT_REF uint8 CPVUserInputDtmf::GetInput </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return the user input DTMF tone</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns the input DTMF tone. </dd></dl>

</div>
</div>
<a class="anchor" id="ae45d362581462c169063f68db2ed10b9"></a><!-- doxytag: member="CPVUserInputDtmf::GetType" ref="ae45d362581462c169063f68db2ed10b9" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_IMPORT_REF <a class="el" href="pv__2way__h324m__types_8h.html#af5f88d26becc61f93f23d5022152fe39">PV2WayUserInputType</a> CPVUserInputDtmf::GetType </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Virtual function to return the user input type </p>

<p>Implements <a class="el" href="classCPVUserInput.html#a2d9ffe661e7f9a2308b937a7d96e8a85">CPVUserInput</a>.</p>

</div>
</div>
<a class="anchor" id="a144596e586e27b41c82c841f02d5d53c"></a><!-- doxytag: member="CPVUserInputDtmf::IsUpdate" ref="a144596e586e27b41c82c841f02d5d53c" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OSCL_IMPORT_REF bool CPVUserInputDtmf::IsUpdate </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return if the DTMF tone is an update</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns if the input DTMF tone is an update. </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="pv__2way__h324m__types_8h_source.html">pv_2way_h324m_types.h</a></li>
</ul>
</div>
<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>PV2Way Engine</small>
<address style="align: left;"><small>Posting Version: CORE_9.004.1.1 </small>
</small></address>
</body>
</html>