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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
|
<!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: pv_2way_basic_types.h File 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 Page</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>pv_2way_basic_types.h File Reference</h1><code>#include "pvmf_format_type.h"</code><br/>
<code>#include "oscl_vector.h"</code><br/>
<code>#include "oscl_mem.h"</code><br/>
<p><a href="pv__2way__basic__types_8h_source.html">Go to the source code of this file.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classPV2WayInitInfo.html">PV2WayInitInfo</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classPV2WayConnectOptions.html">PV2WayConnectOptions</a></td></tr>
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="pv__2way__basic__types_8h.html#a30d734629f3bf8d2e82f5f82c780cac9">TPVTerminalType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="pv__2way__basic__types_8h.html#aff2847674fc35c64db5a489ba9533d96">PV2WayTerminalType</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="pv__2way__basic__types_8h.html#a93656b326057b808a92717d7f06141aa">TPVLoopbackMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="pv__2way__basic__types_8h.html#a74ee3bbabecc3d4cb64b9d16d9fe1b7a">PV2WayLoopbackMode</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="pv__2way__basic__types_8h.html#a5cb9071bcf8f11ba40a1ae878607005b">TPVDirection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="pv__2way__basic__types_8h.html#ac317ca49ff6a168a50adbda432171232">PV2WayDirection</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="pv__2way__basic__types_8h.html#af4551e1a20a6ab7cfc828dae30f4e918">TPVMediaType_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="pv__2way__basic__types_8h.html#adc451c18cbf156f04578a9e06533d80b">PV2WayMediaType</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="pv__2way__basic__types_8h.html#a022c1dc5949f6008004878e5ae663de4">PVTrackId</a></td></tr>
<tr><td colspan="2"><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="pv__2way__basic__types_8h.html#a30d734629f3bf8d2e82f5f82c780cac9">TPVTerminalType</a> { <a class="el" href="pv__2way__basic__types_8h.html#a30d734629f3bf8d2e82f5f82c780cac9a07b34eabb691fd8be64ec9892ef7cfd1">PV_323</a>,
<a class="el" href="pv__2way__basic__types_8h.html#a30d734629f3bf8d2e82f5f82c780cac9aa5a38abacef5de5ecc773e8c4d4226b0">PV_324M</a>,
<a class="el" href="pv__2way__basic__types_8h.html#a30d734629f3bf8d2e82f5f82c780cac9a196e7367449d6a722c45bc0fa7b2dae6">PV_SIP</a>,
<a class="el" href="pv__2way__basic__types_8h.html#a30d734629f3bf8d2e82f5f82c780cac9aab88b4fbfd4b605b392ef375418586da">PV_TERMINAL_TYPE_NONE</a>
}</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="pv__2way__basic__types_8h.html#a93656b326057b808a92717d7f06141aa">TPVLoopbackMode</a> { <a class="el" href="pv__2way__basic__types_8h.html#a93656b326057b808a92717d7f06141aaa99aecd0f45fce38bd3b9ac090006ffaf">PV_LOOPBACK_NONE</a>,
<a class="el" href="pv__2way__basic__types_8h.html#a93656b326057b808a92717d7f06141aaa89c39bec4c237c2b651185842e1a97c3">PV_LOOPBACK_COMM</a>,
<a class="el" href="pv__2way__basic__types_8h.html#a93656b326057b808a92717d7f06141aaaf315f4338937fb7b4120483a81a05bc8">PV_LOOPBACK_ENGINE</a>,
<a class="el" href="pv__2way__basic__types_8h.html#a93656b326057b808a92717d7f06141aaa9479581358351ac35be54092e2325684">PV_LOOPBACK_MUX</a>
}</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="pv__2way__basic__types_8h.html#a5cb9071bcf8f11ba40a1ae878607005b">TPVDirection</a> { <a class="el" href="pv__2way__basic__types_8h.html#a5cb9071bcf8f11ba40a1ae878607005baa6ed63754beade7053040674bc5296bb">PV_DIRECTION_NONE</a> = 0,
<a class="el" href="pv__2way__basic__types_8h.html#a5cb9071bcf8f11ba40a1ae878607005ba54d50bc8ec508c1e156ae98e994d1fbd">INCOMING</a> = 1,
<a class="el" href="pv__2way__basic__types_8h.html#a5cb9071bcf8f11ba40a1ae878607005bab7e585d7370b6e932e98c044ba08b139">OUTGOING</a> = 2,
<a class="el" href="pv__2way__basic__types_8h.html#a5cb9071bcf8f11ba40a1ae878607005baaa6aaa3f3edcd29272c4ff8fc7c74cd8">PV_DIRECTION_BOTH</a> = 3
}</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="pv__2way__basic__types_8h.html#af4551e1a20a6ab7cfc828dae30f4e918">TPVMediaType_t</a> { <br/>
<a class="el" href="pv__2way__basic__types_8h.html#af4551e1a20a6ab7cfc828dae30f4e918ae488036e063704bac904e3587afcf892">PV_MEDIA_NONE</a> = 0,
<a class="el" href="pv__2way__basic__types_8h.html#af4551e1a20a6ab7cfc828dae30f4e918a851244b1a2173fc72e409fa1b68d272d">PV_CONTROL</a> = 1,
<a class="el" href="pv__2way__basic__types_8h.html#af4551e1a20a6ab7cfc828dae30f4e918a3e9e91a8689fa9bb3278403f979b7796">PV_AUDIO</a> = 2,
<a class="el" href="pv__2way__basic__types_8h.html#af4551e1a20a6ab7cfc828dae30f4e918a972ff568e58584fe1d3324dbe5a4a2bc">PV_VIDEO</a> = 4,
<br/>
<a class="el" href="pv__2way__basic__types_8h.html#af4551e1a20a6ab7cfc828dae30f4e918affe36f675ca0fc8493c0ee6299aad0b1">PV_DATA</a> = 8,
<a class="el" href="pv__2way__basic__types_8h.html#af4551e1a20a6ab7cfc828dae30f4e918aae67c80f9cfb1cc09b652536b2feadbf">PV_USER_INPUT</a> = 16,
<a class="el" href="pv__2way__basic__types_8h.html#af4551e1a20a6ab7cfc828dae30f4e918ae0b0a427bcba031f83d5a360186c1c17">PV_MULTIPLEXED</a> = 32,
<a class="el" href="pv__2way__basic__types_8h.html#af4551e1a20a6ab7cfc828dae30f4e918a2414954ce662126133b7e4562324b918">PV_MEDIA_ALL</a> = 0xFFFF
<br/>
}</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="pv__2way__basic__types_8h.html#aa30e8f44267fe77fd99d7923b498cd43">PV2WayState</a> { <br/>
<a class="el" href="pv__2way__basic__types_8h.html#aa30e8f44267fe77fd99d7923b498cd43a8615468e605ae577a62e21b3e1256f53">EIdle</a> = 0,
<a class="el" href="pv__2way__basic__types_8h.html#aa30e8f44267fe77fd99d7923b498cd43aa32f14040654e4c9579db0cbb187e949">EInitializing</a>,
<a class="el" href="pv__2way__basic__types_8h.html#aa30e8f44267fe77fd99d7923b498cd43a130544051d35e496a2e45a9373b3735f">ESetup</a>,
<a class="el" href="pv__2way__basic__types_8h.html#aa30e8f44267fe77fd99d7923b498cd43a95bb4c75cf55e376d39416f039d497c7">EConnecting</a>,
<br/>
<a class="el" href="pv__2way__basic__types_8h.html#aa30e8f44267fe77fd99d7923b498cd43a79291ef141073f9bb84726b3beaf3ea2">EConnected</a>,
<a class="el" href="pv__2way__basic__types_8h.html#aa30e8f44267fe77fd99d7923b498cd43a6387b2e5575c38fec46fc118c5725c23">EDisconnecting</a>,
<a class="el" href="pv__2way__basic__types_8h.html#aa30e8f44267fe77fd99d7923b498cd43adee17f7f8f307b3d519e72965e99b7fd">EResetting</a>
<br/>
}</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="pv__2way__basic__types_8h.html#a9a3063089cef7f69c7da40561324af82">TPVTIndicationType</a> { <br/>
<a class="el" href="pv__2way__basic__types_8h.html#a9a3063089cef7f69c7da40561324af82afc87862d1c289f94bd0bffeba4b47cd6">PVT_INDICATION_INCOMING_TRACK</a>,
<a class="el" href="pv__2way__basic__types_8h.html#a9a3063089cef7f69c7da40561324af82ae2e4d79d11a2268d62bfe09f2b3c8204">PVT_INDICATION_OUTGOING_TRACK</a>,
<a class="el" href="pv__2way__basic__types_8h.html#a9a3063089cef7f69c7da40561324af82acd71f161168ce287c7f37810f33ae9a8">PVT_INDICATION_DISCONNECT</a>,
<a class="el" href="pv__2way__basic__types_8h.html#a9a3063089cef7f69c7da40561324af82a52763ba18f4ceeee24017119c10d381c">PVT_INDICATION_CLOSING_TRACK</a>,
<br/>
<a class="el" href="pv__2way__basic__types_8h.html#a9a3063089cef7f69c7da40561324af82a170519fbbe41ee9b6e210961d366452e">PVT_INDICATION_CLOSE_TRACK</a>,
<a class="el" href="pv__2way__basic__types_8h.html#a9a3063089cef7f69c7da40561324af82a6ed13ef9ff0953b572a20ce66e5886fd">PVT_INDICATION_PAUSE_TRACK</a>,
<a class="el" href="pv__2way__basic__types_8h.html#a9a3063089cef7f69c7da40561324af82ae375bca99eee589286675372be4f1617">PVT_INDICATION_RESUME_TRACK</a>,
<a class="el" href="pv__2way__basic__types_8h.html#a9a3063089cef7f69c7da40561324af82abbeb972d976d3b5912f34ddbfb120132">PVT_INDICATION_INTERNAL_ERROR</a>
<br/>
}</td></tr>
<tr><td colspan="2"><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const int </td><td class="memItemRight" valign="bottom"><a class="el" href="pv__2way__basic__types_8h.html#a605f81e129aae6058ed3105abab9274e">PV2WayErrorStatusStart</a> = (-10500)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const int </td><td class="memItemRight" valign="bottom"><a class="el" href="pv__2way__basic__types_8h.html#a1742b962cedb4c4d644299ad741f9bcd">PV2WayDispatchError</a> = <a class="el" href="pv__2way__basic__types_8h.html#a605f81e129aae6058ed3105abab9274e">PV2WayErrorStatusStart</a> - 1</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const int </td><td class="memItemRight" valign="bottom"><a class="el" href="pv__2way__basic__types_8h.html#ab004b306f796b1def2656bc579669ead">PV2WayDisconnectError</a> = <a class="el" href="pv__2way__basic__types_8h.html#a605f81e129aae6058ed3105abab9274e">PV2WayErrorStatusStart</a> - 2</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const int </td><td class="memItemRight" valign="bottom"><a class="el" href="pv__2way__basic__types_8h.html#a291325bc893ef1b90922b14338dfc93b">PV2WayErrorRejected</a> = <a class="el" href="pv__2way__basic__types_8h.html#a605f81e129aae6058ed3105abab9274e">PV2WayErrorStatusStart</a> - 5</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const int </td><td class="memItemRight" valign="bottom"><a class="el" href="pv__2way__basic__types_8h.html#a091da477fc63d62845e4ab9822590847">PV2WayErrReplaced</a> = <a class="el" href="pv__2way__basic__types_8h.html#a605f81e129aae6058ed3105abab9274e">PV2WayErrorStatusStart</a> - 6</td></tr>
</table>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="ac317ca49ff6a168a50adbda432171232"></a><!-- doxytag: member="pv_2way_basic_types.h::PV2WayDirection" ref="ac317ca49ff6a168a50adbda432171232" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="pv__2way__basic__types_8h.html#a5cb9071bcf8f11ba40a1ae878607005b">TPVDirection</a> <a class="el" href="pv__2way__basic__types_8h.html#ac317ca49ff6a168a50adbda432171232">PV2WayDirection</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>TPVDirection Enum</p>
<p>TPVDirection emumerates the direction of the track. </p>
</div>
</div>
<a class="anchor" id="a74ee3bbabecc3d4cb64b9d16d9fe1b7a"></a><!-- doxytag: member="pv_2way_basic_types.h::PV2WayLoopbackMode" ref="a74ee3bbabecc3d4cb64b9d16d9fe1b7a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="pv__2way__basic__types_8h.html#a93656b326057b808a92717d7f06141aa">TPVLoopbackMode</a> <a class="el" href="pv__2way__basic__types_8h.html#a74ee3bbabecc3d4cb64b9d16d9fe1b7a">PV2WayLoopbackMode</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>TPVLoopbackMode Enum</p>
<p>TPVLoopbackMode emumerates the possible loopback options that can be used with the pv2way SDK </p>
</div>
</div>
<a class="anchor" id="adc451c18cbf156f04578a9e06533d80b"></a><!-- doxytag: member="pv_2way_basic_types.h::PV2WayMediaType" ref="adc451c18cbf156f04578a9e06533d80b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="pv__2way__basic__types_8h.html#af4551e1a20a6ab7cfc828dae30f4e918">TPVMediaType_t</a> <a class="el" href="pv__2way__basic__types_8h.html#adc451c18cbf156f04578a9e06533d80b">PV2WayMediaType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Enumeration of high level media types supported by the SDK </p>
</div>
</div>
<a class="anchor" id="aff2847674fc35c64db5a489ba9533d96"></a><!-- doxytag: member="pv_2way_basic_types.h::PV2WayTerminalType" ref="aff2847674fc35c64db5a489ba9533d96" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="pv__2way__basic__types_8h.html#a30d734629f3bf8d2e82f5f82c780cac9">TPVTerminalType</a> <a class="el" href="pv__2way__basic__types_8h.html#aff2847674fc35c64db5a489ba9533d96">PV2WayTerminalType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>TPVTerminalType enum TPVTerminalType enumerates the possible 2-way protocols </p>
</div>
</div>
<a class="anchor" id="a022c1dc5949f6008004878e5ae663de4"></a><!-- doxytag: member="pv_2way_basic_types.h::PVTrackId" ref="a022c1dc5949f6008004878e5ae663de4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef unsigned int <a class="el" href="pv__2way__basic__types_8h.html#a022c1dc5949f6008004878e5ae663de4">PVTrackId</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>PVTrackId uniquely identifies a track for transferring audio/video in a particular direction - receive or transmit. </p>
</div>
</div>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="aa30e8f44267fe77fd99d7923b498cd43"></a><!-- doxytag: member="pv_2way_basic_types.h::PV2WayState" ref="aa30e8f44267fe77fd99d7923b498cd43" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="pv__2way__basic__types_8h.html#aa30e8f44267fe77fd99d7923b498cd43">PV2WayState</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>TPV2WayState Class</p>
<p>An enumeration of the major states of the pv2way engine. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="aa30e8f44267fe77fd99d7923b498cd43a8615468e605ae577a62e21b3e1256f53"></a><!-- doxytag: member="EIdle" ref="aa30e8f44267fe77fd99d7923b498cd43a8615468e605ae577a62e21b3e1256f53" args="" -->EIdle</em> </td><td>
<p>The state immediately after the pv2way instance has been successfully created or instantiated. No resources have been allocated yet. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="aa30e8f44267fe77fd99d7923b498cd43aa32f14040654e4c9579db0cbb187e949"></a><!-- doxytag: member="EInitializing" ref="aa30e8f44267fe77fd99d7923b498cd43aa32f14040654e4c9579db0cbb187e949" args="" -->EInitializing</em> </td><td>
<p>The pv2way is in this state when it is initializing from the EIdle to the ESetup state. The terminal queries the available device capabilities (encode, decode, mux), acquires resources to make a two-way call (codecs, formats, memory etc) and transitions to the ESetup state when it will be ready to accept setup parameters and Connect. If initializing fails, the pv2way relinquishes the resources and reverts to the EIdle state. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="aa30e8f44267fe77fd99d7923b498cd43a130544051d35e496a2e45a9373b3735f"></a><!-- doxytag: member="ESetup" ref="aa30e8f44267fe77fd99d7923b498cd43a130544051d35e496a2e45a9373b3735f" args="" -->ESetup</em> </td><td>
<p>The state where the pv2way instance is in the process of receiving setup parameters from the application, for encoding, multiplexing, capturing and rendering. Each time a new set of parameters is passed in, validation will take place and a status will be returned accordingly. A valid data source and data sink for the communications port are to be added to the terminal in this state before it can be transitioned to the Econnecting state. Media sources and sinks can also be added at this time. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="aa30e8f44267fe77fd99d7923b498cd43a95bb4c75cf55e376d39416f039d497c7"></a><!-- doxytag: member="EConnecting" ref="aa30e8f44267fe77fd99d7923b498cd43a95bb4c75cf55e376d39416f039d497c7" args="" -->EConnecting</em> </td><td>
<p>The state where the pv2way instance has received a call to start connecting. It starts communication with the remote terminal to exchange media capabilities and channel configuration in preparation for the establishment of media channels. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="aa30e8f44267fe77fd99d7923b498cd43a79291ef141073f9bb84726b3beaf3ea2"></a><!-- doxytag: member="EConnected" ref="aa30e8f44267fe77fd99d7923b498cd43a79291ef141073f9bb84726b3beaf3ea2" args="" -->EConnected</em> </td><td>
<p>The state after all control signaling is completed. The terminal is now able to open media tracks for audio and video. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="aa30e8f44267fe77fd99d7923b498cd43a6387b2e5575c38fec46fc118c5725c23"></a><!-- doxytag: member="EDisconnecting" ref="aa30e8f44267fe77fd99d7923b498cd43a6387b2e5575c38fec46fc118c5725c23" args="" -->EDisconnecting</em> </td><td>
<p>The state where the terminal is shutting down all tracks and the multiplex. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="aa30e8f44267fe77fd99d7923b498cd43adee17f7f8f307b3d519e72965e99b7fd"></a><!-- doxytag: member="EResetting" ref="aa30e8f44267fe77fd99d7923b498cd43adee17f7f8f307b3d519e72965e99b7fd" args="" -->EResetting</em> </td><td>
<p>The state where the terminal is releasing all resources and transitioning to the EIdle state. </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a5cb9071bcf8f11ba40a1ae878607005b"></a><!-- doxytag: member="pv_2way_basic_types.h::TPVDirection" ref="a5cb9071bcf8f11ba40a1ae878607005b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="pv__2way__basic__types_8h.html#a5cb9071bcf8f11ba40a1ae878607005b">TPVDirection</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>TPVDirection Enum</p>
<p>TPVDirection emumerates the direction of the track. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a5cb9071bcf8f11ba40a1ae878607005baa6ed63754beade7053040674bc5296bb"></a><!-- doxytag: member="PV_DIRECTION_NONE" ref="a5cb9071bcf8f11ba40a1ae878607005baa6ed63754beade7053040674bc5296bb" args="" -->PV_DIRECTION_NONE</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a5cb9071bcf8f11ba40a1ae878607005ba54d50bc8ec508c1e156ae98e994d1fbd"></a><!-- doxytag: member="INCOMING" ref="a5cb9071bcf8f11ba40a1ae878607005ba54d50bc8ec508c1e156ae98e994d1fbd" args="" -->INCOMING</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a5cb9071bcf8f11ba40a1ae878607005bab7e585d7370b6e932e98c044ba08b139"></a><!-- doxytag: member="OUTGOING" ref="a5cb9071bcf8f11ba40a1ae878607005bab7e585d7370b6e932e98c044ba08b139" args="" -->OUTGOING</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a5cb9071bcf8f11ba40a1ae878607005baaa6aaa3f3edcd29272c4ff8fc7c74cd8"></a><!-- doxytag: member="PV_DIRECTION_BOTH" ref="a5cb9071bcf8f11ba40a1ae878607005baaa6aaa3f3edcd29272c4ff8fc7c74cd8" args="" -->PV_DIRECTION_BOTH</em> </td><td>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a93656b326057b808a92717d7f06141aa"></a><!-- doxytag: member="pv_2way_basic_types.h::TPVLoopbackMode" ref="a93656b326057b808a92717d7f06141aa" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="pv__2way__basic__types_8h.html#a93656b326057b808a92717d7f06141aa">TPVLoopbackMode</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>TPVLoopbackMode Enum</p>
<p>TPVLoopbackMode emumerates the possible loopback options that can be used with the pv2way SDK </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a93656b326057b808a92717d7f06141aaa99aecd0f45fce38bd3b9ac090006ffaf"></a><!-- doxytag: member="PV_LOOPBACK_NONE" ref="a93656b326057b808a92717d7f06141aaa99aecd0f45fce38bd3b9ac090006ffaf" args="" -->PV_LOOPBACK_NONE</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a93656b326057b808a92717d7f06141aaa89c39bec4c237c2b651185842e1a97c3"></a><!-- doxytag: member="PV_LOOPBACK_COMM" ref="a93656b326057b808a92717d7f06141aaa89c39bec4c237c2b651185842e1a97c3" args="" -->PV_LOOPBACK_COMM</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a93656b326057b808a92717d7f06141aaaf315f4338937fb7b4120483a81a05bc8"></a><!-- doxytag: member="PV_LOOPBACK_ENGINE" ref="a93656b326057b808a92717d7f06141aaaf315f4338937fb7b4120483a81a05bc8" args="" -->PV_LOOPBACK_ENGINE</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a93656b326057b808a92717d7f06141aaa9479581358351ac35be54092e2325684"></a><!-- doxytag: member="PV_LOOPBACK_MUX" ref="a93656b326057b808a92717d7f06141aaa9479581358351ac35be54092e2325684" args="" -->PV_LOOPBACK_MUX</em> </td><td>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af4551e1a20a6ab7cfc828dae30f4e918"></a><!-- doxytag: member="pv_2way_basic_types.h::TPVMediaType_t" ref="af4551e1a20a6ab7cfc828dae30f4e918" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="pv__2way__basic__types_8h.html#af4551e1a20a6ab7cfc828dae30f4e918">TPVMediaType_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Enumeration of high level media types supported by the SDK </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="af4551e1a20a6ab7cfc828dae30f4e918ae488036e063704bac904e3587afcf892"></a><!-- doxytag: member="PV_MEDIA_NONE" ref="af4551e1a20a6ab7cfc828dae30f4e918ae488036e063704bac904e3587afcf892" args="" -->PV_MEDIA_NONE</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="af4551e1a20a6ab7cfc828dae30f4e918a851244b1a2173fc72e409fa1b68d272d"></a><!-- doxytag: member="PV_CONTROL" ref="af4551e1a20a6ab7cfc828dae30f4e918a851244b1a2173fc72e409fa1b68d272d" args="" -->PV_CONTROL</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="af4551e1a20a6ab7cfc828dae30f4e918a3e9e91a8689fa9bb3278403f979b7796"></a><!-- doxytag: member="PV_AUDIO" ref="af4551e1a20a6ab7cfc828dae30f4e918a3e9e91a8689fa9bb3278403f979b7796" args="" -->PV_AUDIO</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="af4551e1a20a6ab7cfc828dae30f4e918a972ff568e58584fe1d3324dbe5a4a2bc"></a><!-- doxytag: member="PV_VIDEO" ref="af4551e1a20a6ab7cfc828dae30f4e918a972ff568e58584fe1d3324dbe5a4a2bc" args="" -->PV_VIDEO</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="af4551e1a20a6ab7cfc828dae30f4e918affe36f675ca0fc8493c0ee6299aad0b1"></a><!-- doxytag: member="PV_DATA" ref="af4551e1a20a6ab7cfc828dae30f4e918affe36f675ca0fc8493c0ee6299aad0b1" args="" -->PV_DATA</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="af4551e1a20a6ab7cfc828dae30f4e918aae67c80f9cfb1cc09b652536b2feadbf"></a><!-- doxytag: member="PV_USER_INPUT" ref="af4551e1a20a6ab7cfc828dae30f4e918aae67c80f9cfb1cc09b652536b2feadbf" args="" -->PV_USER_INPUT</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="af4551e1a20a6ab7cfc828dae30f4e918ae0b0a427bcba031f83d5a360186c1c17"></a><!-- doxytag: member="PV_MULTIPLEXED" ref="af4551e1a20a6ab7cfc828dae30f4e918ae0b0a427bcba031f83d5a360186c1c17" args="" -->PV_MULTIPLEXED</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="af4551e1a20a6ab7cfc828dae30f4e918a2414954ce662126133b7e4562324b918"></a><!-- doxytag: member="PV_MEDIA_ALL" ref="af4551e1a20a6ab7cfc828dae30f4e918a2414954ce662126133b7e4562324b918" args="" -->PV_MEDIA_ALL</em> </td><td>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a30d734629f3bf8d2e82f5f82c780cac9"></a><!-- doxytag: member="pv_2way_basic_types.h::TPVTerminalType" ref="a30d734629f3bf8d2e82f5f82c780cac9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="pv__2way__basic__types_8h.html#a30d734629f3bf8d2e82f5f82c780cac9">TPVTerminalType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>TPVTerminalType enum TPVTerminalType enumerates the possible 2-way protocols </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a30d734629f3bf8d2e82f5f82c780cac9a07b34eabb691fd8be64ec9892ef7cfd1"></a><!-- doxytag: member="PV_323" ref="a30d734629f3bf8d2e82f5f82c780cac9a07b34eabb691fd8be64ec9892ef7cfd1" args="" -->PV_323</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a30d734629f3bf8d2e82f5f82c780cac9aa5a38abacef5de5ecc773e8c4d4226b0"></a><!-- doxytag: member="PV_324M" ref="a30d734629f3bf8d2e82f5f82c780cac9aa5a38abacef5de5ecc773e8c4d4226b0" args="" -->PV_324M</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a30d734629f3bf8d2e82f5f82c780cac9a196e7367449d6a722c45bc0fa7b2dae6"></a><!-- doxytag: member="PV_SIP" ref="a30d734629f3bf8d2e82f5f82c780cac9a196e7367449d6a722c45bc0fa7b2dae6" args="" -->PV_SIP</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a30d734629f3bf8d2e82f5f82c780cac9aab88b4fbfd4b605b392ef375418586da"></a><!-- doxytag: member="PV_TERMINAL_TYPE_NONE" ref="a30d734629f3bf8d2e82f5f82c780cac9aab88b4fbfd4b605b392ef375418586da" args="" -->PV_TERMINAL_TYPE_NONE</em> </td><td>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a9a3063089cef7f69c7da40561324af82"></a><!-- doxytag: member="pv_2way_basic_types.h::TPVTIndicationType" ref="a9a3063089cef7f69c7da40561324af82" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="pv__2way__basic__types_8h.html#a9a3063089cef7f69c7da40561324af82">TPVTIndicationType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>TPVTIndicationType enum</p>
<p>Enumeration of unsolicited indications from pv2way. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a9a3063089cef7f69c7da40561324af82afc87862d1c289f94bd0bffeba4b47cd6"></a><!-- doxytag: member="PVT_INDICATION_INCOMING_TRACK" ref="a9a3063089cef7f69c7da40561324af82afc87862d1c289f94bd0bffeba4b47cd6" args="" -->PVT_INDICATION_INCOMING_TRACK</em> </td><td>
<p>Indicates that the peer terminal has established an incoming track. The local buffer specifies the media type associated with the track. The first octet of the local buffer indicates the media type. The second,third and fourth octets are reserved. The four octets from five to eight are to be interpreted as a unique track id. The format type and additional capabilities are indicated using the PV2WayTrackInfoInterface extension interface. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a9a3063089cef7f69c7da40561324af82ae2e4d79d11a2268d62bfe09f2b3c8204"></a><!-- doxytag: member="PVT_INDICATION_OUTGOING_TRACK" ref="a9a3063089cef7f69c7da40561324af82ae2e4d79d11a2268d62bfe09f2b3c8204" args="" -->PVT_INDICATION_OUTGOING_TRACK</em> </td><td>
<p>Indicates that the local terminal has established an outgoing track that is acceptable to the peer. The local buffer specifies the media type associated with the track. The first octet of the local buffer indicates the media type. The second,third and fourth octets are reserved. The four octets from five to eight are to be interpreted as a unique track id. The format type and additional capabilities are indicated using the PV2WayTrackInfoInterface extension interface. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a9a3063089cef7f69c7da40561324af82acd71f161168ce287c7f37810f33ae9a8"></a><!-- doxytag: member="PVT_INDICATION_DISCONNECT" ref="a9a3063089cef7f69c7da40561324af82acd71f161168ce287c7f37810f33ae9a8" args="" -->PVT_INDICATION_DISCONNECT</em> </td><td>
<p>Indicates that 2way engine has ended the current telephony session. The app can now either reset the engine or make a subsequent call. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a9a3063089cef7f69c7da40561324af82a52763ba18f4ceeee24017119c10d381c"></a><!-- doxytag: member="PVT_INDICATION_CLOSING_TRACK" ref="a9a3063089cef7f69c7da40561324af82a52763ba18f4ceeee24017119c10d381c" args="" -->PVT_INDICATION_CLOSING_TRACK</em> </td><td>
<p>Indicates the start of unsolicited closure of an incoming/outgoing track. The PVT_INDICATION_CLOSE_TRACK indication will be sent when the track is completely close. The first octet of the local buffer indicates the direction of the track. The second and third octets indicates the track id. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a9a3063089cef7f69c7da40561324af82a170519fbbe41ee9b6e210961d366452e"></a><!-- doxytag: member="PVT_INDICATION_CLOSE_TRACK" ref="a9a3063089cef7f69c7da40561324af82a170519fbbe41ee9b6e210961d366452e" args="" -->PVT_INDICATION_CLOSE_TRACK</em> </td><td>
<p>Indicates an unsolicited closure of an incoming/outgoing track. Any media sink/source associated with this will be stopped and returned to the application. The first octet of the local buffer indicates the media type of the track. The second octet indicates the direction. The third octet indicates whether there is a replacement for this track available. If true, the application may add data source/sink for this track again. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a9a3063089cef7f69c7da40561324af82a6ed13ef9ff0953b572a20ce66e5886fd"></a><!-- doxytag: member="PVT_INDICATION_PAUSE_TRACK" ref="a9a3063089cef7f69c7da40561324af82a6ed13ef9ff0953b572a20ce66e5886fd" args="" -->PVT_INDICATION_PAUSE_TRACK</em> </td><td>
<p>Indicates that local terminal has paused an incoming track. Any media sink associated with this will be stopped. The first octet of the local buffer indicates the direction of the track. The second and third octets indicates the track id. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a9a3063089cef7f69c7da40561324af82ae375bca99eee589286675372be4f1617"></a><!-- doxytag: member="PVT_INDICATION_RESUME_TRACK" ref="a9a3063089cef7f69c7da40561324af82ae375bca99eee589286675372be4f1617" args="" -->PVT_INDICATION_RESUME_TRACK</em> </td><td>
<p>Indicates that local terminal has resumed an incoming track. Any media sink associated with this will be restarted. The first octet of the local buffer indicates the direction of the track. The second and third octets indicates the track id. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a9a3063089cef7f69c7da40561324af82abbeb972d976d3b5912f34ddbfb120132"></a><!-- doxytag: member="PVT_INDICATION_INTERNAL_ERROR" ref="a9a3063089cef7f69c7da40561324af82abbeb972d976d3b5912f34ddbfb120132" args="" -->PVT_INDICATION_INTERNAL_ERROR</em> </td><td>
<p>Indicates an internal error in the pv2way engine. The derived class provides further information about the actual error. </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Variable Documentation</h2>
<a class="anchor" id="ab004b306f796b1def2656bc579669ead"></a><!-- doxytag: member="pv_2way_basic_types.h::PV2WayDisconnectError" ref="ab004b306f796b1def2656bc579669ead" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="pv__2way__basic__types_8h.html#ab004b306f796b1def2656bc579669ead">PV2WayDisconnectError</a> = <a class="el" href="pv__2way__basic__types_8h.html#a605f81e129aae6058ed3105abab9274e">PV2WayErrorStatusStart</a> - 2</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The peer disconnected without endsession command </p>
</div>
</div>
<a class="anchor" id="a1742b962cedb4c4d644299ad741f9bcd"></a><!-- doxytag: member="pv_2way_basic_types.h::PV2WayDispatchError" ref="a1742b962cedb4c4d644299ad741f9bcd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="pv__2way__basic__types_8h.html#a1742b962cedb4c4d644299ad741f9bcd">PV2WayDispatchError</a> = <a class="el" href="pv__2way__basic__types_8h.html#a605f81e129aae6058ed3105abab9274e">PV2WayErrorStatusStart</a> - 1</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>There was an error dispatching muxed data to the downstream node </p>
</div>
</div>
<a class="anchor" id="a291325bc893ef1b90922b14338dfc93b"></a><!-- doxytag: member="pv_2way_basic_types.h::PV2WayErrorRejected" ref="a291325bc893ef1b90922b14338dfc93b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="pv__2way__basic__types_8h.html#a291325bc893ef1b90922b14338dfc93b">PV2WayErrorRejected</a> = <a class="el" href="pv__2way__basic__types_8h.html#a605f81e129aae6058ed3105abab9274e">PV2WayErrorStatusStart</a> - 5</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The request was rejected by the peer </p>
</div>
</div>
<a class="anchor" id="a605f81e129aae6058ed3105abab9274e"></a><!-- doxytag: member="pv_2way_basic_types.h::PV2WayErrorStatusStart" ref="a605f81e129aae6058ed3105abab9274e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="pv__2way__basic__types_8h.html#a605f81e129aae6058ed3105abab9274e">PV2WayErrorStatusStart</a> = (-10500)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The starting error code for 2way specific errors </p>
</div>
</div>
<a class="anchor" id="a091da477fc63d62845e4ab9822590847"></a><!-- doxytag: member="pv_2way_basic_types.h::PV2WayErrReplaced" ref="a091da477fc63d62845e4ab9822590847" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="pv__2way__basic__types_8h.html#a091da477fc63d62845e4ab9822590847">PV2WayErrReplaced</a> = <a class="el" href="pv__2way__basic__types_8h.html#a605f81e129aae6058ed3105abab9274e">PV2WayErrorStatusStart</a> - 6</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Signals replacement of an existing resource </p>
</div>
</div>
</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.005.1.1 </small>
</small></address>
</body>
</html>
|
