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
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
|
<!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: CPV2WayInterface 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 Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Data 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 Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>CPV2WayInterface Class Reference</h1><!-- doxytag: class="CPV2WayInterface" -->
<p><code>#include <<a class="el" href="pv__2way__interface_8h_source.html">pv_2way_interface.h</a>></code></p>
<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">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPV2WayInterface.html#a527bb1e253aff5c6fd77992be4dee838">~CPV2WayInterface</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual OSCL_IMPORT_REF PVCommandId </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPV2WayInterface.html#ac1f1b38a3d57f4f431bf0abd3739b388">GetSDKInfo</a> (PVSDKInfo &aSDKInfo, OsclAny *aContextData=NULL)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual OSCL_IMPORT_REF PVCommandId </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPV2WayInterface.html#a6b7de3d51dc52508fabc10dc90087e15">GetSDKModuleInfo</a> (PVSDKModuleInfo &aSDKModuleInfo, OsclAny *aContextData=NULL)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual OSCL_IMPORT_REF PVCommandId </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPV2WayInterface.html#a3f925c1944bb84a32b92f797b33a700b">Init</a> (<a class="el" href="classPV2WayInitInfo.html">PV2WayInitInfo</a> &aInitInfo, OsclAny *aContextData=NULL)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual OSCL_IMPORT_REF PVCommandId </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPV2WayInterface.html#a9667ab6f87d960e3291a750441d7e2b3">Reset</a> (OsclAny *aContextData=NULL)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual OSCL_IMPORT_REF PVCommandId </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPV2WayInterface.html#a76e71b906b59d40eb82099a12fafc6e7">AddDataSource</a> (<a class="el" href="pv__2way__basic__types_8h.html#a022c1dc5949f6008004878e5ae663de4">PVTrackId</a> aTrackId, PVMFNodeInterface &aDataSource, OsclAny *aContextData=NULL)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual OSCL_IMPORT_REF PVCommandId </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPV2WayInterface.html#ab0328af85d59d6b26504f62990146f02">RemoveDataSource</a> (PVMFNodeInterface &aDataSource, OsclAny *aContextData=NULL)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual OSCL_IMPORT_REF PVCommandId </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPV2WayInterface.html#a06a813ed7b1989246f8cd77e60cf742b">AddDataSink</a> (<a class="el" href="pv__2way__basic__types_8h.html#a022c1dc5949f6008004878e5ae663de4">PVTrackId</a> aTrackId, PVMFNodeInterface &aDataSink, OsclAny *aContextData=NULL)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual OSCL_IMPORT_REF PVCommandId </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPV2WayInterface.html#a961f8ebbd4f25e7559c0f31880227502">RemoveDataSink</a> (PVMFNodeInterface &aDataSink, OsclAny *aContextData=NULL)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual OSCL_IMPORT_REF PVCommandId </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPV2WayInterface.html#a59cff4eff03845aa93df8691124e9385">Connect</a> (const <a class="el" href="classPV2WayConnectOptions.html">PV2WayConnectOptions</a> &aOptions, PVMFNodeInterface *aCommServer=NULL, OsclAny *aContextData=NULL)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual OSCL_IMPORT_REF PVCommandId </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPV2WayInterface.html#a13a93403242eab4763835d66c6bc3ef2">Disconnect</a> (OsclAny *aContextData=NULL)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual OSCL_IMPORT_REF PVCommandId </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPV2WayInterface.html#a791dd03ed115b0037c52e1ca2e375cf1">GetState</a> (<a class="el" href="pv__2way__basic__types_8h.html#aa30e8f44267fe77fd99d7923b498cd43">PV2WayState</a> &aState, OsclAny *aContextData=NULL)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual OSCL_IMPORT_REF PVCommandId </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPV2WayInterface.html#a5f41a487dcabd61ef7ad3cc3468f049e">Pause</a> (<a class="el" href="pv__2way__basic__types_8h.html#ac317ca49ff6a168a50adbda432171232">PV2WayDirection</a> aDirection, <a class="el" href="pv__2way__basic__types_8h.html#a022c1dc5949f6008004878e5ae663de4">PVTrackId</a> aTrackId, OsclAny *aContextData=NULL)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual OSCL_IMPORT_REF PVCommandId </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPV2WayInterface.html#a1f7e2359a8a3678930e02a45566f7c9e">Resume</a> (<a class="el" href="pv__2way__basic__types_8h.html#ac317ca49ff6a168a50adbda432171232">PV2WayDirection</a> aDirection, <a class="el" href="pv__2way__basic__types_8h.html#a022c1dc5949f6008004878e5ae663de4">PVTrackId</a> aTrackId, OsclAny *aContextData=NULL)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual OSCL_IMPORT_REF PVCommandId </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPV2WayInterface.html#aa53f5eba3cce928a716d7d12e82cc590">SetLogAppender</a> (const char *aTag, OsclSharedPtr< PVLoggerAppender > &aAppender, OsclAny *aContextData=NULL)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual OSCL_IMPORT_REF PVCommandId </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPV2WayInterface.html#ad13f6c374394badf181cb235dfb888b0">RemoveLogAppender</a> (const char *aTag, OsclSharedPtr< PVLoggerAppender > &aAppender, OsclAny *aContextData=NULL)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual OSCL_IMPORT_REF PVCommandId </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPV2WayInterface.html#a6c2e1d10d98af47bbaaeb6a82fecb6a8">SetLogLevel</a> (const char *aTag, int32 aLevel, bool aSetSubtree=false, OsclAny *aContextData=NULL)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual OSCL_IMPORT_REF PVCommandId </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPV2WayInterface.html#a2d330ea36479d66184753d3d418593b6">GetLogLevel</a> (const char *aTag, int32 &aLogInfo, OsclAny *aContextData=NULL)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual OSCL_IMPORT_REF PVCommandId </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPV2WayInterface.html#a37537c1aba8cc700d6f3267617a05286">QueryInterface</a> (const PVUuid &aUuid, PVInterface *&aInterfacePtr, OsclAny *aContext=NULL)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual OSCL_IMPORT_REF PVCommandId </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPV2WayInterface.html#a2438d83d8d96c7354f06458e5b608984">CancelAllCommands</a> (OsclAny *aContextData=NULL)=0</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="classCPV2WayInterface.html">CPV2WayInterface</a> Class</p>
<p><a class="el" href="classCPV2WayInterface.html">CPV2WayInterface</a> is the interface to the pv2way SDK, which allows initialization, control, and termination of a two-way (3g-324m, SIP) terminal. The application is expected to contain and maintain a pointer to the <a class="el" href="classCPV2WayInterface.html">CPV2WayInterface</a> instance at all times that a call is active. The CPV2WayFactory factory class is to be used to create and delete instances of this class </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a527bb1e253aff5c6fd77992be4dee838"></a><!-- doxytag: member="CPV2WayInterface::~CPV2WayInterface" ref="a527bb1e253aff5c6fd77992be4dee838" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual CPV2WayInterface::~CPV2WayInterface </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Object destructor function Releases Resources prior to destruction </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a06a813ed7b1989246f8cd77e60cf742b"></a><!-- doxytag: member="CPV2WayInterface::AddDataSink" ref="a06a813ed7b1989246f8cd77e60cf742b" args="(PVTrackId aTrackId, PVMFNodeInterface &aDataSink, OsclAny *aContextData=NULL)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::AddDataSink </td>
<td>(</td>
<td class="paramtype"><a class="el" href="pv__2way__basic__types_8h.html#a022c1dc5949f6008004878e5ae663de4">PVTrackId</a> </td>
<td class="paramname"> <em>aTrackId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">PVMFNodeInterface & </td>
<td class="paramname"> <em>aDataSink</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">OsclAny * </td>
<td class="paramname"> <em>aContextData</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function allows the user to specify the media sink for an incoming track. AddDataSinkL can be called only for established incoming tracks identified by a unique track id. Incoming tracks are initiated by the peer and their establishment is indicated using the PVT_INDICATION_INCOMING_TRACK notification which provides the media type and a unique track id. The format type is indicated using the PV2WayTrackInfoInterface extension interface in the PVAsyncInformationalEvent. Data sinks could be of the following types: a)raw media sinks like video display sinks for RGB and YUV formats, audio rendering sinks for PCM. b)sources of compressed data like file, combined decode and render devices.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aTrackId</em> </td><td>Indicates the unique track id to be associated with this sink. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aDataSink</em> </td><td>The data sink to be added </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aContextData</em> </td><td>Optional opaque data that will be passed back to the user with the command response</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A unique command id for asynchronous completion </dd></dl>
</div>
</div>
<a class="anchor" id="a76e71b906b59d40eb82099a12fafc6e7"></a><!-- doxytag: member="CPV2WayInterface::AddDataSource" ref="a76e71b906b59d40eb82099a12fafc6e7" args="(PVTrackId aTrackId, PVMFNodeInterface &aDataSource, OsclAny *aContextData=NULL)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::AddDataSource </td>
<td>(</td>
<td class="paramtype"><a class="el" href="pv__2way__basic__types_8h.html#a022c1dc5949f6008004878e5ae663de4">PVTrackId</a> </td>
<td class="paramname"> <em>aTrackId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">PVMFNodeInterface & </td>
<td class="paramname"> <em>aDataSource</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">OsclAny * </td>
<td class="paramname"> <em>aContextData</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function allows the user to specify the media source for an outgoing track. Sources should be added after the PVT_INDICATION_OUTGOING_TRACK is received which specifies the format type and the unique track id. The format type is indicated using the PV2WayTrackInfoInterface extension interface in the PVAsyncInformationalEvent. Data sources could be of the following types: a)raw media sources like camera, microphone etc. b)sources of compressed data like file, combined capture and encode devices.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aTrackId</em> </td><td>The outgoing track id </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aDataSource</em> </td><td>Reference to the data source for this track </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aContextData</em> </td><td>Optional opaque data that will be passed back to the user with the command response This method can leave with one of the following error codes PVMFErrNotSupported if the format of the sources/sinks is incomtible with what the SDK can handle KPVErrInvalidState if invoked in the incorrect state 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>A unique command id for asynchronous completion </dd></dl>
</div>
</div>
<a class="anchor" id="a2438d83d8d96c7354f06458e5b608984"></a><!-- doxytag: member="CPV2WayInterface::CancelAllCommands" ref="a2438d83d8d96c7354f06458e5b608984" args="(OsclAny *aContextData=NULL)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::CancelAllCommands </td>
<td>(</td>
<td class="paramtype">OsclAny * </td>
<td class="paramname"> <em>aContextData</em> = <code>NULL</code></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This API is to allow the user to cancel all pending requests. The current request being processed, if any, will also be aborted. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aContextData</em> </td><td>Optional opaque data that will be passed back to the user with the command response </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A unique command id for asynchronous completion </dd></dl>
</div>
</div>
<a class="anchor" id="a59cff4eff03845aa93df8691124e9385"></a><!-- doxytag: member="CPV2WayInterface::Connect" ref="a59cff4eff03845aa93df8691124e9385" args="(const PV2WayConnectOptions &aOptions, PVMFNodeInterface *aCommServer=NULL, OsclAny *aContextData=NULL)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::Connect </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classPV2WayConnectOptions.html">PV2WayConnectOptions</a> & </td>
<td class="paramname"> <em>aOptions</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">PVMFNodeInterface * </td>
<td class="paramname"> <em>aCommServer</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">OsclAny * </td>
<td class="paramname"> <em>aContextData</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function can be invoked only in the ESetup state. The terminal starts connecting with the remote terminal based on the specified options and capabilities. Incoming tracks may be opened before ConnectL completes and will be indicated via the PVT_INDICATION_INCOMING_TRACK event.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aOptions</em> </td><td>Optional additional information for call setup. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aCommServer</em> </td><td>An optional pointer to a comm server to provide comm source and sink end-points. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aContextData</em> </td><td>Optional opaque data that will be passed back to the user with the command response</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A unique command id for asynchronous completion </dd></dl>
</div>
</div>
<a class="anchor" id="a13a93403242eab4763835d66c6bc3ef2"></a><!-- doxytag: member="CPV2WayInterface::Disconnect" ref="a13a93403242eab4763835d66c6bc3ef2" args="(OsclAny *aContextData=NULL)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::Disconnect </td>
<td>(</td>
<td class="paramtype">OsclAny * </td>
<td class="paramname"> <em>aContextData</em> = <code>NULL</code></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The Disconnect call is valid only when invoked in the EConnecting, and EConnected states. It causes the terminal to transition to the EDisconnecting state. All the media tracks both incoming and outgoing will be closed on invoking Disconnect. On completion, the terminal goes to the ESetup state. The statistics of the previous call shall still be available until Connect is invoked again.</p>
<p>It is a no-op when called in any other state.</p>
<p>The post disconnect option specifies what this terminal wishes to do after the data call is terminated, whether it wants to disconnect the line or continue the call as a voice only call.</p>
<p>This is an asynchronous request.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aContextData</em> </td><td>Optional opaque data that will be passed back to the user with the command response</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A unique command id for asynchronous completion </dd></dl>
</div>
</div>
<a class="anchor" id="a2d330ea36479d66184753d3d418593b6"></a><!-- doxytag: member="CPV2WayInterface::GetLogLevel" ref="a2d330ea36479d66184753d3d418593b6" args="(const char *aTag, int32 &aLogInfo, OsclAny *aContextData=NULL)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::GetLogLevel </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>aTag</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32 & </td>
<td class="paramname"> <em>aLogInfo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">OsclAny * </td>
<td class="paramname"> <em>aContextData</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Allows the logging level to be queried for a particular logging tag. A larger log level will result in more messages being logged.</p>
<p>In the asynchronous response, this should return the log level along with an indication of where the level was inherited (i.e., the ancestor tag).</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aTag</em> </td><td>Specifies the logger tree tag where the log level should be retrieved. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aLogInfo</em> </td><td>an output parameter which will be filled in with the log level information. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aContextData</em> </td><td>Optional opaque data that will be passed back to the user with the command response </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>memory_error</em> </td><td>leaves on memory allocation error.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A unique command id for asynchronous completion </dd></dl>
</div>
</div>
<a class="anchor" id="ac1f1b38a3d57f4f431bf0abd3739b388"></a><!-- doxytag: member="CPV2WayInterface::GetSDKInfo" ref="ac1f1b38a3d57f4f431bf0abd3739b388" args="(PVSDKInfo &aSDKInfo, OsclAny *aContextData=NULL)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::GetSDKInfo </td>
<td>(</td>
<td class="paramtype">PVSDKInfo & </td>
<td class="paramname"> <em>aSDKInfo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">OsclAny * </td>
<td class="paramname"> <em>aContextData</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns version information about the SDK</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aSDKInfo</em> </td><td>A reference to a PVSDKInfo structure which contains the product label and date </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aContextData</em> </td><td>Optional opaque data that will be passed back to the user with the command response This method can leave with one of the following error codes PVMFErrNoMemory if the SDK failed to allocate memory during this operation </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A unique command id for asynchronous completion </dd></dl>
</div>
</div>
<a class="anchor" id="a6b7de3d51dc52508fabc10dc90087e15"></a><!-- doxytag: member="CPV2WayInterface::GetSDKModuleInfo" ref="a6b7de3d51dc52508fabc10dc90087e15" args="(PVSDKModuleInfo &aSDKModuleInfo, OsclAny *aContextData=NULL)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::GetSDKModuleInfo </td>
<td>(</td>
<td class="paramtype">PVSDKModuleInfo & </td>
<td class="paramname"> <em>aSDKModuleInfo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">OsclAny * </td>
<td class="paramname"> <em>aContextData</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns information about all modules currently used by the SDK.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aSDKModuleInfo</em> </td><td>A reference to a PVSDKModuleInfo structure which contains the number of modules currently used by pv2way SDK and the PV UID and description string for each module. The PV UID and description string for modules will be returned in one string buffer allocated by the client. If the string buffer is not large enough to hold the all the module's information, the information will be written up to the length of the buffer and truncated. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aContextData</em> </td><td>Optional opaque data that will be passed back to the user with the command response This method can leave with one of the following error codes PVMFErrNoMemory if the SDK failed to allocate memory during this operation </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A unique command id for asynchronous completion </dd></dl>
</div>
</div>
<a class="anchor" id="a791dd03ed115b0037c52e1ca2e375cf1"></a><!-- doxytag: member="CPV2WayInterface::GetState" ref="a791dd03ed115b0037c52e1ca2e375cf1" args="(PV2WayState &aState, OsclAny *aContextData=NULL)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::GetState </td>
<td>(</td>
<td class="paramtype"><a class="el" href="pv__2way__basic__types_8h.html#aa30e8f44267fe77fd99d7923b498cd43">PV2WayState</a> & </td>
<td class="paramname"> <em>aState</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">OsclAny * </td>
<td class="paramname"> <em>aContextData</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function returns the current state of the pv2way. Application may use this info for updating display or determine if the pv2way is ready for the next request.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aState</em> </td><td>Reflects the state of the PV 2Way engine when the command was received. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aContextData</em> </td><td>Optional opaque data that will be passed back to the user with the command response </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>value indicating the current pv2way state </dd></dl>
</div>
</div>
<a class="anchor" id="a3f925c1944bb84a32b92f797b33a700b"></a><!-- doxytag: member="CPV2WayInterface::Init" ref="a3f925c1944bb84a32b92f797b33a700b" args="(PV2WayInitInfo &aInitInfo, OsclAny *aContextData=NULL)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::Init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPV2WayInitInfo.html">PV2WayInitInfo</a> & </td>
<td class="paramname"> <em>aInitInfo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">OsclAny * </td>
<td class="paramname"> <em>aContextData</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function is valid only in the EIdle state. It is a no-op when invoked in any other state. It causes the pv2way to transition to the ESetup state. The terminal remains in the EInitializing state during the transition.</p>
<p>While initializing, the pv2way tries to allocate system resources needed for a two-way call. If it fails for some reason, and the pv2way reverts to the EIdle state. All the resources are de-allocated.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aInitInfo</em> </td><td>A reference to a CPV2WayInitInfo structure which contains the capabilities of the applications sinks and sources to handle compressed and uncompressed formats. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aContextData</em> </td><td>Optional opaque data that will be passed back to the user with the command response This method can leave with one of the following error codes PVMFErrArgument if more tx and rx codecs are set than engine can handle, or the mandatory codecs are not in the list. PVMFErrNotSupported if the format of the sources/sinks is incomtible with what the SDK can handle PVMFErrInvalidState if invoked in the incorrect state PVMFErrNoMemory if the SDK failed to allocate memory during this operation </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A unique command id for asynchronous completion </dd></dl>
</div>
</div>
<a class="anchor" id="a5f41a487dcabd61ef7ad3cc3468f049e"></a><!-- doxytag: member="CPV2WayInterface::Pause" ref="a5f41a487dcabd61ef7ad3cc3468f049e" args="(PV2WayDirection aDirection, PVTrackId aTrackId, OsclAny *aContextData=NULL)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::Pause </td>
<td>(</td>
<td class="paramtype"><a class="el" href="pv__2way__basic__types_8h.html#ac317ca49ff6a168a50adbda432171232">PV2WayDirection</a> </td>
<td class="paramname"> <em>aDirection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pv__2way__basic__types_8h.html#a022c1dc5949f6008004878e5ae663de4">PVTrackId</a> </td>
<td class="paramname"> <em>aTrackId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">OsclAny * </td>
<td class="paramname"> <em>aContextData</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>For an incoming track this function pauses sending media to the sink (output device) and stops the sink.</p>
<p>For outgoing, it pauses the sending of media from the source and stops the source.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aDirection</em> </td><td>Specifies the direction of the track - incoming or outgoing </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aTrackId</em> </td><td>Specifies which track is to be paused. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aContextData</em> </td><td>Optional opaque data that will be passed back to the user with the command response</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A unique command id for asynchronous completion </dd></dl>
</div>
</div>
<a class="anchor" id="a37537c1aba8cc700d6f3267617a05286"></a><!-- doxytag: member="CPV2WayInterface::QueryInterface" ref="a37537c1aba8cc700d6f3267617a05286" args="(const PVUuid &aUuid, PVInterface *&aInterfacePtr, OsclAny *aContext=NULL)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::QueryInterface </td>
<td>(</td>
<td class="paramtype">const PVUuid & </td>
<td class="paramname"> <em>aUuid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">PVInterface *& </td>
<td class="paramname"> <em>aInterfacePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">OsclAny * </td>
<td class="paramname"> <em>aContext</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This API is to allow for extensibility of the pv2way interface. It allows a caller to ask for an instance of a particular interface object to be returned. The mechanism is analogous to the COM IUnknown method. The interfaces are identified with an interface ID that is a UUID as in DCE and a pointer to the interface object is returned if it is supported. Otherwise the returned pointer is NULL. TBD: Define the UIID, InterfacePtr structures </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aUuid</em> </td><td>The UUID of the desired interface </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aInterfacePtr</em> </td><td>The output pointer to the desired interface </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>not_supported</em> </td><td>leaves if the specified interface id is not supported. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a961f8ebbd4f25e7559c0f31880227502"></a><!-- doxytag: member="CPV2WayInterface::RemoveDataSink" ref="a961f8ebbd4f25e7559c0f31880227502" args="(PVMFNodeInterface &aDataSink, OsclAny *aContextData=NULL)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::RemoveDataSink </td>
<td>(</td>
<td class="paramtype">PVMFNodeInterface & </td>
<td class="paramname"> <em>aDataSink</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">OsclAny * </td>
<td class="paramname"> <em>aContextData</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function unbinds a previously added sink.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aDataSink</em> </td><td>pointer to the media sink node </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aContextData</em> </td><td>Optional opaque data that will be passed back to the user with the command response</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A unique command id for asynchronous completion </dd></dl>
</div>
</div>
<a class="anchor" id="ab0328af85d59d6b26504f62990146f02"></a><!-- doxytag: member="CPV2WayInterface::RemoveDataSource" ref="ab0328af85d59d6b26504f62990146f02" args="(PVMFNodeInterface &aDataSource, OsclAny *aContextData=NULL)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::RemoveDataSource </td>
<td>(</td>
<td class="paramtype">PVMFNodeInterface & </td>
<td class="paramname"> <em>aDataSource</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">OsclAny * </td>
<td class="paramname"> <em>aContextData</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function unbinds a previously added source.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aDataSource</em> </td><td>pointer to the media source node</td></tr>
<tr><td valign="top"></td><td valign="top"><em>aContextData</em> </td><td>Optional opaque data that will be passed back to the user with the command response </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A unique command id for asynchronous completion </dd></dl>
</div>
</div>
<a class="anchor" id="ad13f6c374394badf181cb235dfb888b0"></a><!-- doxytag: member="CPV2WayInterface::RemoveLogAppender" ref="ad13f6c374394badf181cb235dfb888b0" args="(const char *aTag, OsclSharedPtr< PVLoggerAppender > &aAppender, OsclAny *aContextData=NULL)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::RemoveLogAppender </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>aTag</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">OsclSharedPtr< PVLoggerAppender > & </td>
<td class="paramname"> <em>aAppender</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">OsclAny * </td>
<td class="paramname"> <em>aContextData</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Allows a logging appender to be removed from the logger tree at the point specified by the input tag. The input tag cannot be NULL.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aTag</em> </td><td>Specifies the logger tree tag where the appender should be removed. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aAppender</em> </td><td>The log appender to remove. Must be a reference to the same object that was set. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aContextData</em> </td><td>Optional opaque data that will be passed back to the user with the command response</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>memory_error</em> </td><td>leaves on memory allocation error.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A unique command id for asynchronous completion </dd></dl>
</div>
</div>
<a class="anchor" id="a9667ab6f87d960e3291a750441d7e2b3"></a><!-- doxytag: member="CPV2WayInterface::Reset" ref="a9667ab6f87d960e3291a750441d7e2b3" args="(OsclAny *aContextData=NULL)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::Reset </td>
<td>(</td>
<td class="paramtype">OsclAny * </td>
<td class="paramname"> <em>aContextData</em> = <code>NULL</code></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function is valid only in the ESetup and EInitializing state. It is a no-op when invoked in the EIdle state and returns PVMFErrInvalidState if invoked in any other state.</p>
<p>It causes the pv2way to transition back to the EIdle state. The terminal remains in the EResetting state during the transition.</p>
<p>While resetting, the pv2way de-allocates all resources resources that had been previously allocated. When it completes, ResetComplete is called and the pv2way reverts to the EIdle state.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aContextData</em> </td><td>Optional opaque data that will be passed back to the user with the command response This method can leave with one of the following error codes PVMFErrInvalidState if invoked in the incorrect state PVMFErrNoMemory if the SDK failed to allocate memory during this operation </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A unique command id for asynchronous completion </dd></dl>
</div>
</div>
<a class="anchor" id="a1f7e2359a8a3678930e02a45566f7c9e"></a><!-- doxytag: member="CPV2WayInterface::Resume" ref="a1f7e2359a8a3678930e02a45566f7c9e" args="(PV2WayDirection aDirection, PVTrackId aTrackId, OsclAny *aContextData=NULL)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::Resume </td>
<td>(</td>
<td class="paramtype"><a class="el" href="pv__2way__basic__types_8h.html#ac317ca49ff6a168a50adbda432171232">PV2WayDirection</a> </td>
<td class="paramname"> <em>aDirection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="pv__2way__basic__types_8h.html#a022c1dc5949f6008004878e5ae663de4">PVTrackId</a> </td>
<td class="paramname"> <em>aTrackId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">OsclAny * </td>
<td class="paramname"> <em>aContextData</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Resume a previously paused incoming or outgoing track. For incoming, this function starts resumes playing out the media to the appropriate sink based on the current settings. For outgoing it resumes encoding and sending media from the source.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aDirection</em> </td><td>Specifies the direction of the track - incoming or outgoing </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aTrackId</em> </td><td>Specifies which track is to be paused. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aContextData</em> </td><td>Optional opaque data that will be passed back to the user with the command response</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A unique command id for asynchronous completion </dd></dl>
</div>
</div>
<a class="anchor" id="aa53f5eba3cce928a716d7d12e82cc590"></a><!-- doxytag: member="CPV2WayInterface::SetLogAppender" ref="aa53f5eba3cce928a716d7d12e82cc590" args="(const char *aTag, OsclSharedPtr< PVLoggerAppender > &aAppender, OsclAny *aContextData=NULL)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::SetLogAppender </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>aTag</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">OsclSharedPtr< PVLoggerAppender > & </td>
<td class="paramname"> <em>aAppender</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">OsclAny * </td>
<td class="paramname"> <em>aContextData</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Allows a logging appender to be attached at some point in the logger tag tree. The location in the tag tree is specified by the input tag string. A single appender can be attached multiple times in the tree, but it may result in duplicate copies of log messages if the appender is not attached in disjoint portions of the tree. A logging appender is responsible for actually writing the log message to its final location (e.g., memory, file, network, etc). This API can be called anytime after creation of the terminal.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aTag</em> </td><td>Specifies the logger tree tag where the appender should be attached. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aAppender</em> </td><td>The log appender to attach. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aContextData</em> </td><td>Optional opaque data that will be passed back to the user with the command response</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>memory_error</em> </td><td>leaves on memory allocation error.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A unique command id for asynchronous completion </dd></dl>
</div>
</div>
<a class="anchor" id="a6c2e1d10d98af47bbaaeb6a82fecb6a8"></a><!-- doxytag: member="CPV2WayInterface::SetLogLevel" ref="a6c2e1d10d98af47bbaaeb6a82fecb6a8" args="(const char *aTag, int32 aLevel, bool aSetSubtree=false, OsclAny *aContextData=NULL)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::SetLogLevel </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>aTag</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32 </td>
<td class="paramname"> <em>aLevel</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>aSetSubtree</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">OsclAny * </td>
<td class="paramname"> <em>aContextData</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Allows the logging level to be set for the logging node specified by the tag. A larger log level will result in more messages being logged. A message will only be logged if its level is LESS THAN or equal to the current log level. The set_subtree flag will allow an entire subtree, with the specified tag as the root, to be reset to the specified value.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aTag</em> </td><td>Specifies the logger tree tag where the log level should be set. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aLevel</em> </td><td>Specifies the log level to set. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aSetSubtree</em> </td><td>Specifies whether the entire subtree with aTag as the root should be reset to the log level. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aContextData</em> </td><td>Optional opaque data that will be passed back to the user with the command response</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>memory_error</em> </td><td>leaves on memory allocation error.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A unique command id for asynchronous completion </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="pv__2way__interface_8h_source.html">pv_2way_interface.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>
|
