1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> 3 <title>CPV2WayInterface class Reference</title> 4 <link href="doxygen.css" rel="stylesheet" type="text/css"> 5 </head><body> 6 <!-- Generated by Doxygen 1.2.18 --> 7 <center> 8 <a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> 9 <hr><h1>CPV2WayInterface Class Reference</h1><code>#include <<a class="el" href="pv__2way__interface_8h-source.html">pv_2way_interface.h</a>></code> 10 <p> 11 <table border=0 cellpadding=0 cellspacing=0> 12 <tr><td></td></tr> 13 <tr><td colspan=2><br><h2>Public Methods</h2></td></tr> 14 <tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classCPV2WayInterface.html#a0">~CPV2WayInterface</a> ()</td></tr> 15 <tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF PVCommandId </td><td valign=bottom><a class="el" href="classCPV2WayInterface.html#a1">GetSDKInfo</a> (PVSDKInfo &aSDKInfo, OsclAny *aContextData=NULL)=0</td></tr> 16 <tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF PVCommandId </td><td valign=bottom><a class="el" href="classCPV2WayInterface.html#a2">GetSDKModuleInfo</a> (PVSDKModuleInfo &aSDKModuleInfo, OsclAny *aContextData=NULL)=0</td></tr> 17 <tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF PVCommandId </td><td valign=bottom><a class="el" href="classCPV2WayInterface.html#a3">Init</a> (<a class="el" href="classPV2WayInitInfo.html">PV2WayInitInfo</a> &aInitInfo, OsclAny *aContextData=NULL)=0</td></tr> 18 <tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF PVCommandId </td><td valign=bottom><a class="el" href="classCPV2WayInterface.html#a4">Reset</a> (OsclAny *aContextData=NULL)=0</td></tr> 19 <tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF PVCommandId </td><td valign=bottom><a class="el" href="classCPV2WayInterface.html#a5">AddDataSource</a> (<a class="el" href="pv__2way__basic__types_8h.html#a8">PVTrackId</a> aTrackId, PVMFNodeInterface &aDataSource, OsclAny *aContextData=NULL)=0</td></tr> 20 <tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF PVCommandId </td><td valign=bottom><a class="el" href="classCPV2WayInterface.html#a6">RemoveDataSource</a> (PVMFNodeInterface &aDataSource, OsclAny *aContextData=NULL)=0</td></tr> 21 <tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF PVCommandId </td><td valign=bottom><a class="el" href="classCPV2WayInterface.html#a7">AddDataSink</a> (<a class="el" href="pv__2way__basic__types_8h.html#a8">PVTrackId</a> aTrackId, PVMFNodeInterface &aDataSink, OsclAny *aContextData=NULL)=0</td></tr> 22 <tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF PVCommandId </td><td valign=bottom><a class="el" href="classCPV2WayInterface.html#a8">RemoveDataSink</a> (PVMFNodeInterface &aDataSink, OsclAny *aContextData=NULL)=0</td></tr> 23 <tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF PVCommandId </td><td valign=bottom><a class="el" href="classCPV2WayInterface.html#a9">Connect</a> (const <a class="el" href="classPV2WayConnectOptions.html">PV2WayConnectOptions</a> &aOptions, PVMFNodeInterface *aCommServer=NULL, OsclAny *aContextData=NULL)=0</td></tr> 24 <tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF PVCommandId </td><td valign=bottom><a class="el" href="classCPV2WayInterface.html#a10">Disconnect</a> (OsclAny *aContextData=NULL)=0</td></tr> 25 <tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF PVCommandId </td><td valign=bottom><a class="el" href="classCPV2WayInterface.html#a11">GetState</a> (<a class="el" href="pv__2way__basic__types_8h.html#a48">PV2WayState</a> &aState, OsclAny *aContextData=NULL)=0</td></tr> 26 <tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF PVCommandId </td><td valign=bottom><a class="el" href="classCPV2WayInterface.html#a12">Pause</a> (<a class="el" href="pv__2way__basic__types_8h.html#a6">PV2WayDirection</a> aDirection, <a class="el" href="pv__2way__basic__types_8h.html#a8">PVTrackId</a> aTrackId, OsclAny *aContextData=NULL)=0</td></tr> 27 <tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF PVCommandId </td><td valign=bottom><a class="el" href="classCPV2WayInterface.html#a13">Resume</a> (<a class="el" href="pv__2way__basic__types_8h.html#a6">PV2WayDirection</a> aDirection, <a class="el" href="pv__2way__basic__types_8h.html#a8">PVTrackId</a> aTrackId, OsclAny *aContextData=NULL)=0</td></tr> 28 <tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF PVCommandId </td><td valign=bottom><a class="el" href="classCPV2WayInterface.html#a14">SetLogAppender</a> (const char *aTag, OsclSharedPtr< PVLoggerAppender > &aAppender, OsclAny *aContextData=NULL)=0</td></tr> 29 <tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF PVCommandId </td><td valign=bottom><a class="el" href="classCPV2WayInterface.html#a15">RemoveLogAppender</a> (const char *aTag, OsclSharedPtr< PVLoggerAppender > &aAppender, OsclAny *aContextData=NULL)=0</td></tr> 30 <tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF PVCommandId </td><td valign=bottom><a class="el" href="classCPV2WayInterface.html#a16">SetLogLevel</a> (const char *aTag, int32 aLevel, bool aSetSubtree=false, OsclAny *aContextData=NULL)=0</td></tr> 31 <tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF PVCommandId </td><td valign=bottom><a class="el" href="classCPV2WayInterface.html#a17">GetLogLevel</a> (const char *aTag, int32 &aLogInfo, OsclAny *aContextData=NULL)=0</td></tr> 32 <tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF PVCommandId </td><td valign=bottom><a class="el" href="classCPV2WayInterface.html#a18">QueryUUID</a> (const PvmfMimeString &aMimeType, Oscl_Vector< PVUuid, BasicAlloc > &aUuids, bool aExactUuidsOnly=false, OsclAny *aContextData=NULL)=0</td></tr> 33 <tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF PVCommandId </td><td valign=bottom><a class="el" href="classCPV2WayInterface.html#a19">QueryInterface</a> (const PVUuid &aUuid, PVInterface *&aInterfacePtr, OsclAny *aContext=NULL)=0</td></tr> 34 <tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF PVCommandId </td><td valign=bottom><a class="el" href="classCPV2WayInterface.html#a20">CancelAllCommands</a> (OsclAny *aContextData=NULL)=0</td></tr> 35 </table> 36 <hr><a name="_details"></a><h2>Detailed Description</h2> 37 CPV2WayInterface Class 38 <p> 39 CPV2WayInterface 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 CPV2WayInterface 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 40 <p> 41 <hr><h2>Constructor & Destructor Documentation</h2> 42 <a name="a0" doxytag="CPV2WayInterface::~CPV2WayInterface"></a><p> 43 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 44 <tr> 45 <td class="md"> 46 <table cellpadding="0" cellspacing="0" border="0"> 47 <tr> 48 <td class="md" nowrap valign="top"> virtual CPV2WayInterface::~CPV2WayInterface </td> 49 <td class="md" valign="top">( </td> 50 <td class="mdname1" valign="top" nowrap> </td> 51 <td class="md" valign="top">) </td> 52 <td class="md" nowrap><code> [inline, virtual]</code></td> 53 </tr> 54 55 </table> 56 </td> 57 </tr> 58 </table> 59 <table cellspacing=5 cellpadding=0 border=0> 60 <tr> 61 <td> 62 63 </td> 64 <td> 65 66 <p> 67 Object destructor function Releases Resources prior to destruction </td> 68 </tr> 69 </table> 70 <hr><h2>Member Function Documentation</h2> 71 <a name="a7" doxytag="CPV2WayInterface::AddDataSink"></a><p> 72 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 73 <tr> 74 <td class="md"> 75 <table cellpadding="0" cellspacing="0" border="0"> 76 <tr> 77 <td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::AddDataSink </td> 78 <td class="md" valign="top">( </td> 79 <td class="md" nowrap valign="top"><a class="el" href="pv__2way__basic__types_8h.html#a8">PVTrackId</a> </td> 80 <td class="mdname" nowrap> <em>aTrackId</em>, </td> 81 </tr> 82 <tr> 83 <td></td> 84 <td></td> 85 <td class="md" nowrap>PVMFNodeInterface & </td> 86 <td class="mdname" nowrap> <em>aDataSink</em>, </td> 87 </tr> 88 <tr> 89 <td></td> 90 <td></td> 91 <td class="md" nowrap>OsclAny * </td> 92 <td class="mdname" nowrap> <em>aContextData</em> = NULL</td> 93 </tr> 94 <tr> 95 <td></td> 96 <td class="md">) </td> 97 <td class="md" colspan="2"><code> [pure virtual]</code></td> 98 </tr> 99 100 </table> 101 </td> 102 </tr> 103 </table> 104 <table cellspacing=5 cellpadding=0 border=0> 105 <tr> 106 <td> 107 108 </td> 109 <td> 110 111 <p> 112 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.<dl compact><dt><b>Parameters: </b></dt><dd> 113 <table border=0 cellspacing=2 cellpadding=0> 114 <tr><td valign=top><em>aTrackId</em> </td><td> 115 Indicates the unique track id to be associated with this sink. </td></tr> 116 <tr><td valign=top><em>aDataSink</em> </td><td> 117 The data sink to be added </td></tr> 118 <tr><td valign=top><em>aContextData</em> </td><td> 119 Optional opaque data that will be passed back to the user with the command response</td></tr> 120 </table> 121 </dl><dl compact><dt><b>Returns: </b></dt><dd> 122 A unique command id for asynchronous completion </dl> </td> 123 </tr> 124 </table> 125 <a name="a5" doxytag="CPV2WayInterface::AddDataSource"></a><p> 126 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 127 <tr> 128 <td class="md"> 129 <table cellpadding="0" cellspacing="0" border="0"> 130 <tr> 131 <td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::AddDataSource </td> 132 <td class="md" valign="top">( </td> 133 <td class="md" nowrap valign="top"><a class="el" href="pv__2way__basic__types_8h.html#a8">PVTrackId</a> </td> 134 <td class="mdname" nowrap> <em>aTrackId</em>, </td> 135 </tr> 136 <tr> 137 <td></td> 138 <td></td> 139 <td class="md" nowrap>PVMFNodeInterface & </td> 140 <td class="mdname" nowrap> <em>aDataSource</em>, </td> 141 </tr> 142 <tr> 143 <td></td> 144 <td></td> 145 <td class="md" nowrap>OsclAny * </td> 146 <td class="mdname" nowrap> <em>aContextData</em> = NULL</td> 147 </tr> 148 <tr> 149 <td></td> 150 <td class="md">) </td> 151 <td class="md" colspan="2"><code> [pure virtual]</code></td> 152 </tr> 153 154 </table> 155 </td> 156 </tr> 157 </table> 158 <table cellspacing=5 cellpadding=0 border=0> 159 <tr> 160 <td> 161 162 </td> 163 <td> 164 165 <p> 166 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.<dl compact><dt><b>Parameters: </b></dt><dd> 167 <table border=0 cellspacing=2 cellpadding=0> 168 <tr><td valign=top><em>aTrackId</em> </td><td> 169 The outgoing track id </td></tr> 170 <tr><td valign=top><em>aDataSource</em> </td><td> 171 Reference to the data source for this track </td></tr> 172 <tr><td valign=top><em>aContextData</em> </td><td> 173 Optional opaque data that will be passed back to the user with the command response @leave 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> 174 </table> 175 </dl><dl compact><dt><b>Returns: </b></dt><dd> 176 A unique command id for asynchronous completion </dl> </td> 177 </tr> 178 </table> 179 <a name="a20" doxytag="CPV2WayInterface::CancelAllCommands"></a><p> 180 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 181 <tr> 182 <td class="md"> 183 <table cellpadding="0" cellspacing="0" border="0"> 184 <tr> 185 <td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::CancelAllCommands </td> 186 <td class="md" valign="top">( </td> 187 <td class="md" nowrap valign="top">OsclAny * </td> 188 <td class="mdname1" valign="top" nowrap> <em>aContextData</em> = NULL </td> 189 <td class="md" valign="top">) </td> 190 <td class="md" nowrap><code> [pure virtual]</code></td> 191 </tr> 192 193 </table> 194 </td> 195 </tr> 196 </table> 197 <table cellspacing=5 cellpadding=0 border=0> 198 <tr> 199 <td> 200 201 </td> 202 <td> 203 204 <p> 205 This API is to allow the user to cancel all pending requests. The current request being processed, if any, will also be aborted. <dl compact><dt><b>Parameters: </b></dt><dd> 206 <table border=0 cellspacing=2 cellpadding=0> 207 <tr><td valign=top><em>aContextData</em> </td><td> 208 Optional opaque data that will be passed back to the user with the command response </td></tr> 209 </table> 210 </dl><dl compact><dt><b>Returns: </b></dt><dd> 211 A unique command id for asynchronous completion </dl> </td> 212 </tr> 213 </table> 214 <a name="a9" doxytag="CPV2WayInterface::Connect"></a><p> 215 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 216 <tr> 217 <td class="md"> 218 <table cellpadding="0" cellspacing="0" border="0"> 219 <tr> 220 <td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::Connect </td> 221 <td class="md" valign="top">( </td> 222 <td class="md" nowrap valign="top">const <a class="el" href="classPV2WayConnectOptions.html">PV2WayConnectOptions</a> & </td> 223 <td class="mdname" nowrap> <em>aOptions</em>, </td> 224 </tr> 225 <tr> 226 <td></td> 227 <td></td> 228 <td class="md" nowrap>PVMFNodeInterface * </td> 229 <td class="mdname" nowrap> <em>aCommServer</em> = NULL, </td> 230 </tr> 231 <tr> 232 <td></td> 233 <td></td> 234 <td class="md" nowrap>OsclAny * </td> 235 <td class="mdname" nowrap> <em>aContextData</em> = NULL</td> 236 </tr> 237 <tr> 238 <td></td> 239 <td class="md">) </td> 240 <td class="md" colspan="2"><code> [pure virtual]</code></td> 241 </tr> 242 243 </table> 244 </td> 245 </tr> 246 </table> 247 <table cellspacing=5 cellpadding=0 border=0> 248 <tr> 249 <td> 250 251 </td> 252 <td> 253 254 <p> 255 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.<dl compact><dt><b>Parameters: </b></dt><dd> 256 <table border=0 cellspacing=2 cellpadding=0> 257 <tr><td valign=top><em>aOptions</em> </td><td> 258 Optional additional information for call setup. </td></tr> 259 <tr><td valign=top><em>aCommServer</em> </td><td> 260 An optional pointer to a comm server to provide comm source and sink end-points. </td></tr> 261 <tr><td valign=top><em>aContextData</em> </td><td> 262 Optional opaque data that will be passed back to the user with the command response</td></tr> 263 </table> 264 </dl><dl compact><dt><b>Returns: </b></dt><dd> 265 A unique command id for asynchronous completion </dl> </td> 266 </tr> 267 </table> 268 <a name="a10" doxytag="CPV2WayInterface::Disconnect"></a><p> 269 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 270 <tr> 271 <td class="md"> 272 <table cellpadding="0" cellspacing="0" border="0"> 273 <tr> 274 <td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::Disconnect </td> 275 <td class="md" valign="top">( </td> 276 <td class="md" nowrap valign="top">OsclAny * </td> 277 <td class="mdname1" valign="top" nowrap> <em>aContextData</em> = NULL </td> 278 <td class="md" valign="top">) </td> 279 <td class="md" nowrap><code> [pure virtual]</code></td> 280 </tr> 281 282 </table> 283 </td> 284 </tr> 285 </table> 286 <table cellspacing=5 cellpadding=0 border=0> 287 <tr> 288 <td> 289 290 </td> 291 <td> 292 293 <p> 294 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. 295 <p> 296 It is a no-op when called in any other state. 297 <p> 298 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. 299 <p> 300 This is an asynchronous request.<dl compact><dt><b>Parameters: </b></dt><dd> 301 <table border=0 cellspacing=2 cellpadding=0> 302 <tr><td valign=top><em>aContextData</em> </td><td> 303 Optional opaque data that will be passed back to the user with the command response</td></tr> 304 </table> 305 </dl><dl compact><dt><b>Returns: </b></dt><dd> 306 A unique command id for asynchronous completion </dl> </td> 307 </tr> 308 </table> 309 <a name="a17" doxytag="CPV2WayInterface::GetLogLevel"></a><p> 310 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 311 <tr> 312 <td class="md"> 313 <table cellpadding="0" cellspacing="0" border="0"> 314 <tr> 315 <td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::GetLogLevel </td> 316 <td class="md" valign="top">( </td> 317 <td class="md" nowrap valign="top">const char * </td> 318 <td class="mdname" nowrap> <em>aTag</em>, </td> 319 </tr> 320 <tr> 321 <td></td> 322 <td></td> 323 <td class="md" nowrap>int32 & </td> 324 <td class="mdname" nowrap> <em>aLogInfo</em>, </td> 325 </tr> 326 <tr> 327 <td></td> 328 <td></td> 329 <td class="md" nowrap>OsclAny * </td> 330 <td class="mdname" nowrap> <em>aContextData</em> = NULL</td> 331 </tr> 332 <tr> 333 <td></td> 334 <td class="md">) </td> 335 <td class="md" colspan="2"><code> [pure virtual]</code></td> 336 </tr> 337 338 </table> 339 </td> 340 </tr> 341 </table> 342 <table cellspacing=5 cellpadding=0 border=0> 343 <tr> 344 <td> 345 346 </td> 347 <td> 348 349 <p> 350 Allows the logging level to be queried for a particular logging tag. A larger log level will result in more messages being logged. 351 <p> 352 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).<dl compact><dt><b>Parameters: </b></dt><dd> 353 <table border=0 cellspacing=2 cellpadding=0> 354 <tr><td valign=top><em>aTag</em> </td><td> 355 Specifies the logger tree tag where the log level should be retrieved. </td></tr> 356 <tr><td valign=top><em>aLogInfo</em> </td><td> 357 an output parameter which will be filled in with the log level information. </td></tr> 358 <tr><td valign=top><em>aContextData</em> </td><td> 359 Optional opaque data that will be passed back to the user with the command response </td></tr> 360 </table> 361 </dl><dl compact><dt><b>Exceptions: </b></dt><dd> 362 <table border=0 cellspacing=2 cellpadding=0> 363 <tr><td valign=top><em>memory_error</em> </td><td> 364 leaves on memory allocation error.</td></tr> 365 </table> 366 </dl><dl compact><dt><b>Returns: </b></dt><dd> 367 A unique command id for asynchronous completion </dl> </td> 368 </tr> 369 </table> 370 <a name="a1" doxytag="CPV2WayInterface::GetSDKInfo"></a><p> 371 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 372 <tr> 373 <td class="md"> 374 <table cellpadding="0" cellspacing="0" border="0"> 375 <tr> 376 <td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::GetSDKInfo </td> 377 <td class="md" valign="top">( </td> 378 <td class="md" nowrap valign="top">PVSDKInfo & </td> 379 <td class="mdname" nowrap> <em>aSDKInfo</em>, </td> 380 </tr> 381 <tr> 382 <td></td> 383 <td></td> 384 <td class="md" nowrap>OsclAny * </td> 385 <td class="mdname" nowrap> <em>aContextData</em> = NULL</td> 386 </tr> 387 <tr> 388 <td></td> 389 <td class="md">) </td> 390 <td class="md" colspan="2"><code> [pure virtual]</code></td> 391 </tr> 392 393 </table> 394 </td> 395 </tr> 396 </table> 397 <table cellspacing=5 cellpadding=0 border=0> 398 <tr> 399 <td> 400 401 </td> 402 <td> 403 404 <p> 405 Returns version information about the SDK<dl compact><dt><b>Parameters: </b></dt><dd> 406 <table border=0 cellspacing=2 cellpadding=0> 407 <tr><td valign=top><em>aSDKInfo</em> </td><td> 408 A reference to a PVSDKInfo structure which contains the product label and date </td></tr> 409 <tr><td valign=top><em>aContextData</em> </td><td> 410 Optional opaque data that will be passed back to the user with the command response @leave This method can leave with one of the following error codes PVMFErrNoMemory if the SDK failed to allocate memory during this operation </td></tr> 411 </table> 412 </dl><dl compact><dt><b>Returns: </b></dt><dd> 413 A unique command id for asynchronous completion </dl> </td> 414 </tr> 415 </table> 416 <a name="a2" doxytag="CPV2WayInterface::GetSDKModuleInfo"></a><p> 417 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 418 <tr> 419 <td class="md"> 420 <table cellpadding="0" cellspacing="0" border="0"> 421 <tr> 422 <td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::GetSDKModuleInfo </td> 423 <td class="md" valign="top">( </td> 424 <td class="md" nowrap valign="top">PVSDKModuleInfo & </td> 425 <td class="mdname" nowrap> <em>aSDKModuleInfo</em>, </td> 426 </tr> 427 <tr> 428 <td></td> 429 <td></td> 430 <td class="md" nowrap>OsclAny * </td> 431 <td class="mdname" nowrap> <em>aContextData</em> = NULL</td> 432 </tr> 433 <tr> 434 <td></td> 435 <td class="md">) </td> 436 <td class="md" colspan="2"><code> [pure virtual]</code></td> 437 </tr> 438 439 </table> 440 </td> 441 </tr> 442 </table> 443 <table cellspacing=5 cellpadding=0 border=0> 444 <tr> 445 <td> 446 447 </td> 448 <td> 449 450 <p> 451 Returns information about all modules currently used by the SDK.<dl compact><dt><b>Parameters: </b></dt><dd> 452 <table border=0 cellspacing=2 cellpadding=0> 453 <tr><td valign=top><em>aSDKModuleInfo</em> </td><td> 454 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> 455 <tr><td valign=top><em>aContextData</em> </td><td> 456 Optional opaque data that will be passed back to the user with the command response @leave This method can leave with one of the following error codes PVMFErrNoMemory if the SDK failed to allocate memory during this operation </td></tr> 457 </table> 458 </dl><dl compact><dt><b>Returns: </b></dt><dd> 459 A unique command id for asynchronous completion </dl> </td> 460 </tr> 461 </table> 462 <a name="a11" doxytag="CPV2WayInterface::GetState"></a><p> 463 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 464 <tr> 465 <td class="md"> 466 <table cellpadding="0" cellspacing="0" border="0"> 467 <tr> 468 <td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::GetState </td> 469 <td class="md" valign="top">( </td> 470 <td class="md" nowrap valign="top"><a class="el" href="pv__2way__basic__types_8h.html#a48">PV2WayState</a> & </td> 471 <td class="mdname" nowrap> <em>aState</em>, </td> 472 </tr> 473 <tr> 474 <td></td> 475 <td></td> 476 <td class="md" nowrap>OsclAny * </td> 477 <td class="mdname" nowrap> <em>aContextData</em> = NULL</td> 478 </tr> 479 <tr> 480 <td></td> 481 <td class="md">) </td> 482 <td class="md" colspan="2"><code> [pure virtual]</code></td> 483 </tr> 484 485 </table> 486 </td> 487 </tr> 488 </table> 489 <table cellspacing=5 cellpadding=0 border=0> 490 <tr> 491 <td> 492 493 </td> 494 <td> 495 496 <p> 497 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.<dl compact><dt><b>Parameters: </b></dt><dd> 498 <table border=0 cellspacing=2 cellpadding=0> 499 <tr><td valign=top><em>aState</em> </td><td> 500 Reflects the state of the PV 2Way engine when the command was received. </td></tr> 501 <tr><td valign=top><em>aContextData</em> </td><td> 502 Optional opaque data that will be passed back to the user with the command response </td></tr> 503 </table> 504 </dl><dl compact><dt><b>Returns: </b></dt><dd> 505 value indicating the current pv2way state </dl> </td> 506 </tr> 507 </table> 508 <a name="a3" doxytag="CPV2WayInterface::Init"></a><p> 509 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 510 <tr> 511 <td class="md"> 512 <table cellpadding="0" cellspacing="0" border="0"> 513 <tr> 514 <td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::Init </td> 515 <td class="md" valign="top">( </td> 516 <td class="md" nowrap valign="top"><a class="el" href="classPV2WayInitInfo.html">PV2WayInitInfo</a> & </td> 517 <td class="mdname" nowrap> <em>aInitInfo</em>, </td> 518 </tr> 519 <tr> 520 <td></td> 521 <td></td> 522 <td class="md" nowrap>OsclAny * </td> 523 <td class="mdname" nowrap> <em>aContextData</em> = NULL</td> 524 </tr> 525 <tr> 526 <td></td> 527 <td class="md">) </td> 528 <td class="md" colspan="2"><code> [pure virtual]</code></td> 529 </tr> 530 531 </table> 532 </td> 533 </tr> 534 </table> 535 <table cellspacing=5 cellpadding=0 border=0> 536 <tr> 537 <td> 538 539 </td> 540 <td> 541 542 <p> 543 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. 544 <p> 545 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.<dl compact><dt><b>Parameters: </b></dt><dd> 546 <table border=0 cellspacing=2 cellpadding=0> 547 <tr><td valign=top><em>aInitInfo</em> </td><td> 548 A reference to a CPV2WayInitInfo structure which contains the capabilities of the applications sinks and sources to handle compressed and uncompressed formats. </td></tr> 549 <tr><td valign=top><em>aContextData</em> </td><td> 550 Optional opaque data that will be passed back to the user with the command response @leave 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> 551 </table> 552 </dl><dl compact><dt><b>Returns: </b></dt><dd> 553 A unique command id for asynchronous completion </dl> </td> 554 </tr> 555 </table> 556 <a name="a12" doxytag="CPV2WayInterface::Pause"></a><p> 557 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 558 <tr> 559 <td class="md"> 560 <table cellpadding="0" cellspacing="0" border="0"> 561 <tr> 562 <td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::Pause </td> 563 <td class="md" valign="top">( </td> 564 <td class="md" nowrap valign="top"><a class="el" href="pv__2way__basic__types_8h.html#a6">PV2WayDirection</a> </td> 565 <td class="mdname" nowrap> <em>aDirection</em>, </td> 566 </tr> 567 <tr> 568 <td></td> 569 <td></td> 570 <td class="md" nowrap><a class="el" href="pv__2way__basic__types_8h.html#a8">PVTrackId</a> </td> 571 <td class="mdname" nowrap> <em>aTrackId</em>, </td> 572 </tr> 573 <tr> 574 <td></td> 575 <td></td> 576 <td class="md" nowrap>OsclAny * </td> 577 <td class="mdname" nowrap> <em>aContextData</em> = NULL</td> 578 </tr> 579 <tr> 580 <td></td> 581 <td class="md">) </td> 582 <td class="md" colspan="2"><code> [pure virtual]</code></td> 583 </tr> 584 585 </table> 586 </td> 587 </tr> 588 </table> 589 <table cellspacing=5 cellpadding=0 border=0> 590 <tr> 591 <td> 592 593 </td> 594 <td> 595 596 <p> 597 For an incoming track this function pauses sending media to the sink (output device) and stops the sink. 598 <p> 599 For outgoing, it pauses the sending of media from the source and stops the source.<dl compact><dt><b>Parameters: </b></dt><dd> 600 <table border=0 cellspacing=2 cellpadding=0> 601 <tr><td valign=top><em>aDirection</em> </td><td> 602 Specifies the direction of the track - incoming or outgoing </td></tr> 603 <tr><td valign=top><em>aTrackId</em> </td><td> 604 Specifies which track is to be paused. </td></tr> 605 <tr><td valign=top><em>aContextData</em> </td><td> 606 Optional opaque data that will be passed back to the user with the command response</td></tr> 607 </table> 608 </dl><dl compact><dt><b>Returns: </b></dt><dd> 609 A unique command id for asynchronous completion </dl> </td> 610 </tr> 611 </table> 612 <a name="a19" doxytag="CPV2WayInterface::QueryInterface"></a><p> 613 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 614 <tr> 615 <td class="md"> 616 <table cellpadding="0" cellspacing="0" border="0"> 617 <tr> 618 <td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::QueryInterface </td> 619 <td class="md" valign="top">( </td> 620 <td class="md" nowrap valign="top">const PVUuid & </td> 621 <td class="mdname" nowrap> <em>aUuid</em>, </td> 622 </tr> 623 <tr> 624 <td></td> 625 <td></td> 626 <td class="md" nowrap>PVInterface *& </td> 627 <td class="mdname" nowrap> <em>aInterfacePtr</em>, </td> 628 </tr> 629 <tr> 630 <td></td> 631 <td></td> 632 <td class="md" nowrap>OsclAny * </td> 633 <td class="mdname" nowrap> <em>aContext</em> = NULL</td> 634 </tr> 635 <tr> 636 <td></td> 637 <td class="md">) </td> 638 <td class="md" colspan="2"><code> [pure virtual]</code></td> 639 </tr> 640 641 </table> 642 </td> 643 </tr> 644 </table> 645 <table cellspacing=5 cellpadding=0 border=0> 646 <tr> 647 <td> 648 649 </td> 650 <td> 651 652 <p> 653 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 <dl compact><dt><b>Parameters: </b></dt><dd> 654 <table border=0 cellspacing=2 cellpadding=0> 655 <tr><td valign=top><em>aUuid</em> </td><td> 656 The UUID of the desired interface </td></tr> 657 <tr><td valign=top><em>aInterfacePtr</em> </td><td> 658 The output pointer to the desired interface </td></tr> 659 </table> 660 </dl><dl compact><dt><b>Exceptions: </b></dt><dd> 661 <table border=0 cellspacing=2 cellpadding=0> 662 <tr><td valign=top><em>not_supported</em> </td><td> 663 leaves if the specified interface id is not supported. </td></tr> 664 </table> 665 </dl> </td> 666 </tr> 667 </table> 668 <a name="a18" doxytag="CPV2WayInterface::QueryUUID"></a><p> 669 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 670 <tr> 671 <td class="md"> 672 <table cellpadding="0" cellspacing="0" border="0"> 673 <tr> 674 <td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::QueryUUID </td> 675 <td class="md" valign="top">( </td> 676 <td class="md" nowrap valign="top">const PvmfMimeString & </td> 677 <td class="mdname" nowrap> <em>aMimeType</em>, </td> 678 </tr> 679 <tr> 680 <td></td> 681 <td></td> 682 <td class="md" nowrap>Oscl_Vector< PVUuid, BasicAlloc > & </td> 683 <td class="mdname" nowrap> <em>aUuids</em>, </td> 684 </tr> 685 <tr> 686 <td></td> 687 <td></td> 688 <td class="md" nowrap>bool </td> 689 <td class="mdname" nowrap> <em>aExactUuidsOnly</em> = false, </td> 690 </tr> 691 <tr> 692 <td></td> 693 <td></td> 694 <td class="md" nowrap>OsclAny * </td> 695 <td class="mdname" nowrap> <em>aContextData</em> = NULL</td> 696 </tr> 697 <tr> 698 <td></td> 699 <td class="md">) </td> 700 <td class="md" colspan="2"><code> [pure virtual]</code></td> 701 </tr> 702 703 </table> 704 </td> 705 </tr> 706 </table> 707 <table cellspacing=5 cellpadding=0 border=0> 708 <tr> 709 <td> 710 711 </td> 712 <td> 713 714 <p> 715 This API is to allow for extensibility of the pv2way interface. It allows a caller to ask for all UUIDs associated with a particular MIME type. If interfaces of the requested MIME type are found within the system, they are added to the UUIDs array. 716 <p> 717 Also added to the UUIDs array will be all interfaces which have the requested MIME type as a base MIME type. This functionality can be turned off.<dl compact><dt><b>Parameters: </b></dt><dd> 718 <table border=0 cellspacing=2 cellpadding=0> 719 <tr><td valign=top><em>aMimeType</em> </td><td> 720 The MIME type of the desired interfaces </td></tr> 721 <tr><td valign=top><em>aUuids</em> </td><td> 722 An array to hold the discovered UUIDs </td></tr> 723 <tr><td valign=top><em>aExactUuidsOnly</em> </td><td> 724 Turns on/off the retrival of UUIDs with aMimeType as a base type </td></tr> 725 <tr><td valign=top><em>aContextData</em> </td><td> 726 Optional opaque data that will be passed back to the user with the command response </td></tr> 727 </table> 728 </dl> </td> 729 </tr> 730 </table> 731 <a name="a8" doxytag="CPV2WayInterface::RemoveDataSink"></a><p> 732 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 733 <tr> 734 <td class="md"> 735 <table cellpadding="0" cellspacing="0" border="0"> 736 <tr> 737 <td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::RemoveDataSink </td> 738 <td class="md" valign="top">( </td> 739 <td class="md" nowrap valign="top">PVMFNodeInterface & </td> 740 <td class="mdname" nowrap> <em>aDataSink</em>, </td> 741 </tr> 742 <tr> 743 <td></td> 744 <td></td> 745 <td class="md" nowrap>OsclAny * </td> 746 <td class="mdname" nowrap> <em>aContextData</em> = NULL</td> 747 </tr> 748 <tr> 749 <td></td> 750 <td class="md">) </td> 751 <td class="md" colspan="2"><code> [pure virtual]</code></td> 752 </tr> 753 754 </table> 755 </td> 756 </tr> 757 </table> 758 <table cellspacing=5 cellpadding=0 border=0> 759 <tr> 760 <td> 761 762 </td> 763 <td> 764 765 <p> 766 This function unbinds a previously added sink.<dl compact><dt><b>Parameters: </b></dt><dd> 767 <table border=0 cellspacing=2 cellpadding=0> 768 <tr><td valign=top><em>aDataSink</em> </td><td> 769 pointer to the media sink node </td></tr> 770 <tr><td valign=top><em>aContextData</em> </td><td> 771 Optional opaque data that will be passed back to the user with the command response</td></tr> 772 </table> 773 </dl><dl compact><dt><b>Returns: </b></dt><dd> 774 A unique command id for asynchronous completion </dl> </td> 775 </tr> 776 </table> 777 <a name="a6" doxytag="CPV2WayInterface::RemoveDataSource"></a><p> 778 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 779 <tr> 780 <td class="md"> 781 <table cellpadding="0" cellspacing="0" border="0"> 782 <tr> 783 <td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::RemoveDataSource </td> 784 <td class="md" valign="top">( </td> 785 <td class="md" nowrap valign="top">PVMFNodeInterface & </td> 786 <td class="mdname" nowrap> <em>aDataSource</em>, </td> 787 </tr> 788 <tr> 789 <td></td> 790 <td></td> 791 <td class="md" nowrap>OsclAny * </td> 792 <td class="mdname" nowrap> <em>aContextData</em> = NULL</td> 793 </tr> 794 <tr> 795 <td></td> 796 <td class="md">) </td> 797 <td class="md" colspan="2"><code> [pure virtual]</code></td> 798 </tr> 799 800 </table> 801 </td> 802 </tr> 803 </table> 804 <table cellspacing=5 cellpadding=0 border=0> 805 <tr> 806 <td> 807 808 </td> 809 <td> 810 811 <p> 812 This function unbinds a previously added source.<dl compact><dt><b>Parameters: </b></dt><dd> 813 <table border=0 cellspacing=2 cellpadding=0> 814 <tr><td valign=top><em>aDataSource</em> </td><td> 815 pointer to the media source node</td></tr> 816 <tr><td valign=top><em>aContextData</em> </td><td> 817 Optional opaque data that will be passed back to the user with the command response </td></tr> 818 </table> 819 </dl><dl compact><dt><b>Returns: </b></dt><dd> 820 A unique command id for asynchronous completion </dl> </td> 821 </tr> 822 </table> 823 <a name="a15" doxytag="CPV2WayInterface::RemoveLogAppender"></a><p> 824 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 825 <tr> 826 <td class="md"> 827 <table cellpadding="0" cellspacing="0" border="0"> 828 <tr> 829 <td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::RemoveLogAppender </td> 830 <td class="md" valign="top">( </td> 831 <td class="md" nowrap valign="top">const char * </td> 832 <td class="mdname" nowrap> <em>aTag</em>, </td> 833 </tr> 834 <tr> 835 <td></td> 836 <td></td> 837 <td class="md" nowrap>OsclSharedPtr< PVLoggerAppender > & </td> 838 <td class="mdname" nowrap> <em>aAppender</em>, </td> 839 </tr> 840 <tr> 841 <td></td> 842 <td></td> 843 <td class="md" nowrap>OsclAny * </td> 844 <td class="mdname" nowrap> <em>aContextData</em> = NULL</td> 845 </tr> 846 <tr> 847 <td></td> 848 <td class="md">) </td> 849 <td class="md" colspan="2"><code> [pure virtual]</code></td> 850 </tr> 851 852 </table> 853 </td> 854 </tr> 855 </table> 856 <table cellspacing=5 cellpadding=0 border=0> 857 <tr> 858 <td> 859 860 </td> 861 <td> 862 863 <p> 864 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.<dl compact><dt><b>Parameters: </b></dt><dd> 865 <table border=0 cellspacing=2 cellpadding=0> 866 <tr><td valign=top><em>aTag</em> </td><td> 867 Specifies the logger tree tag where the appender should be removed. </td></tr> 868 <tr><td valign=top><em>aAppender</em> </td><td> 869 The log appender to remove. Must be a reference to the same object that was set. </td></tr> 870 <tr><td valign=top><em>aContextData</em> </td><td> 871 Optional opaque data that will be passed back to the user with the command response</td></tr> 872 </table> 873 </dl><dl compact><dt><b>Exceptions: </b></dt><dd> 874 <table border=0 cellspacing=2 cellpadding=0> 875 <tr><td valign=top><em>memory_error</em> </td><td> 876 leaves on memory allocation error.</td></tr> 877 </table> 878 </dl><dl compact><dt><b>Returns: </b></dt><dd> 879 A unique command id for asynchronous completion </dl> </td> 880 </tr> 881 </table> 882 <a name="a4" doxytag="CPV2WayInterface::Reset"></a><p> 883 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 884 <tr> 885 <td class="md"> 886 <table cellpadding="0" cellspacing="0" border="0"> 887 <tr> 888 <td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::Reset </td> 889 <td class="md" valign="top">( </td> 890 <td class="md" nowrap valign="top">OsclAny * </td> 891 <td class="mdname1" valign="top" nowrap> <em>aContextData</em> = NULL </td> 892 <td class="md" valign="top">) </td> 893 <td class="md" nowrap><code> [pure virtual]</code></td> 894 </tr> 895 896 </table> 897 </td> 898 </tr> 899 </table> 900 <table cellspacing=5 cellpadding=0 border=0> 901 <tr> 902 <td> 903 904 </td> 905 <td> 906 907 <p> 908 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. 909 <p> 910 It causes the pv2way to transition back to the EIdle state. The terminal remains in the EResetting state during the transition. 911 <p> 912 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.<dl compact><dt><b>Parameters: </b></dt><dd> 913 <table border=0 cellspacing=2 cellpadding=0> 914 <tr><td valign=top><em>aContextData</em> </td><td> 915 Optional opaque data that will be passed back to the user with the command response @leave 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> 916 </table> 917 </dl><dl compact><dt><b>Returns: </b></dt><dd> 918 A unique command id for asynchronous completion </dl> </td> 919 </tr> 920 </table> 921 <a name="a13" doxytag="CPV2WayInterface::Resume"></a><p> 922 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 923 <tr> 924 <td class="md"> 925 <table cellpadding="0" cellspacing="0" border="0"> 926 <tr> 927 <td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::Resume </td> 928 <td class="md" valign="top">( </td> 929 <td class="md" nowrap valign="top"><a class="el" href="pv__2way__basic__types_8h.html#a6">PV2WayDirection</a> </td> 930 <td class="mdname" nowrap> <em>aDirection</em>, </td> 931 </tr> 932 <tr> 933 <td></td> 934 <td></td> 935 <td class="md" nowrap><a class="el" href="pv__2way__basic__types_8h.html#a8">PVTrackId</a> </td> 936 <td class="mdname" nowrap> <em>aTrackId</em>, </td> 937 </tr> 938 <tr> 939 <td></td> 940 <td></td> 941 <td class="md" nowrap>OsclAny * </td> 942 <td class="mdname" nowrap> <em>aContextData</em> = NULL</td> 943 </tr> 944 <tr> 945 <td></td> 946 <td class="md">) </td> 947 <td class="md" colspan="2"><code> [pure virtual]</code></td> 948 </tr> 949 950 </table> 951 </td> 952 </tr> 953 </table> 954 <table cellspacing=5 cellpadding=0 border=0> 955 <tr> 956 <td> 957 958 </td> 959 <td> 960 961 <p> 962 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.<dl compact><dt><b>Parameters: </b></dt><dd> 963 <table border=0 cellspacing=2 cellpadding=0> 964 <tr><td valign=top><em>aDirection</em> </td><td> 965 Specifies the direction of the track - incoming or outgoing </td></tr> 966 <tr><td valign=top><em>aTrackId</em> </td><td> 967 Specifies which track is to be paused. </td></tr> 968 <tr><td valign=top><em>aContextData</em> </td><td> 969 Optional opaque data that will be passed back to the user with the command response</td></tr> 970 </table> 971 </dl><dl compact><dt><b>Returns: </b></dt><dd> 972 A unique command id for asynchronous completion </dl> </td> 973 </tr> 974 </table> 975 <a name="a14" doxytag="CPV2WayInterface::SetLogAppender"></a><p> 976 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 977 <tr> 978 <td class="md"> 979 <table cellpadding="0" cellspacing="0" border="0"> 980 <tr> 981 <td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::SetLogAppender </td> 982 <td class="md" valign="top">( </td> 983 <td class="md" nowrap valign="top">const char * </td> 984 <td class="mdname" nowrap> <em>aTag</em>, </td> 985 </tr> 986 <tr> 987 <td></td> 988 <td></td> 989 <td class="md" nowrap>OsclSharedPtr< PVLoggerAppender > & </td> 990 <td class="mdname" nowrap> <em>aAppender</em>, </td> 991 </tr> 992 <tr> 993 <td></td> 994 <td></td> 995 <td class="md" nowrap>OsclAny * </td> 996 <td class="mdname" nowrap> <em>aContextData</em> = NULL</td> 997 </tr> 998 <tr> 999 <td></td> 1000 <td class="md">) </td> 1001 <td class="md" colspan="2"><code> [pure virtual]</code></td> 1002 </tr> 1003 1004 </table> 1005 </td> 1006 </tr> 1007 </table> 1008 <table cellspacing=5 cellpadding=0 border=0> 1009 <tr> 1010 <td> 1011 1012 </td> 1013 <td> 1014 1015 <p> 1016 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.<dl compact><dt><b>Parameters: </b></dt><dd> 1017 <table border=0 cellspacing=2 cellpadding=0> 1018 <tr><td valign=top><em>aTag</em> </td><td> 1019 Specifies the logger tree tag where the appender should be attached. </td></tr> 1020 <tr><td valign=top><em>aAppender</em> </td><td> 1021 The log appender to attach. </td></tr> 1022 <tr><td valign=top><em>aContextData</em> </td><td> 1023 Optional opaque data that will be passed back to the user with the command response</td></tr> 1024 </table> 1025 </dl><dl compact><dt><b>Exceptions: </b></dt><dd> 1026 <table border=0 cellspacing=2 cellpadding=0> 1027 <tr><td valign=top><em>memory_error</em> </td><td> 1028 leaves on memory allocation error.</td></tr> 1029 </table> 1030 </dl><dl compact><dt><b>Returns: </b></dt><dd> 1031 A unique command id for asynchronous completion </dl> </td> 1032 </tr> 1033 </table> 1034 <a name="a16" doxytag="CPV2WayInterface::SetLogLevel"></a><p> 1035 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 1036 <tr> 1037 <td class="md"> 1038 <table cellpadding="0" cellspacing="0" border="0"> 1039 <tr> 1040 <td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF PVCommandId CPV2WayInterface::SetLogLevel </td> 1041 <td class="md" valign="top">( </td> 1042 <td class="md" nowrap valign="top">const char * </td> 1043 <td class="mdname" nowrap> <em>aTag</em>, </td> 1044 </tr> 1045 <tr> 1046 <td></td> 1047 <td></td> 1048 <td class="md" nowrap>int32 </td> 1049 <td class="mdname" nowrap> <em>aLevel</em>, </td> 1050 </tr> 1051 <tr> 1052 <td></td> 1053 <td></td> 1054 <td class="md" nowrap>bool </td> 1055 <td class="mdname" nowrap> <em>aSetSubtree</em> = false, </td> 1056 </tr> 1057 <tr> 1058 <td></td> 1059 <td></td> 1060 <td class="md" nowrap>OsclAny * </td> 1061 <td class="mdname" nowrap> <em>aContextData</em> = NULL</td> 1062 </tr> 1063 <tr> 1064 <td></td> 1065 <td class="md">) </td> 1066 <td class="md" colspan="2"><code> [pure virtual]</code></td> 1067 </tr> 1068 1069 </table> 1070 </td> 1071 </tr> 1072 </table> 1073 <table cellspacing=5 cellpadding=0 border=0> 1074 <tr> 1075 <td> 1076 1077 </td> 1078 <td> 1079 1080 <p> 1081 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.<dl compact><dt><b>Parameters: </b></dt><dd> 1082 <table border=0 cellspacing=2 cellpadding=0> 1083 <tr><td valign=top><em>aTag</em> </td><td> 1084 Specifies the logger tree tag where the log level should be set. </td></tr> 1085 <tr><td valign=top><em>aLevel</em> </td><td> 1086 Specifies the log level to set. </td></tr> 1087 <tr><td valign=top><em>aSetSubtree</em> </td><td> 1088 Specifies whether the entire subtree with aTag as the root should be reset to the log level. </td></tr> 1089 <tr><td valign=top><em>aContextData</em> </td><td> 1090 Optional opaque data that will be passed back to the user with the command response</td></tr> 1091 </table> 1092 </dl><dl compact><dt><b>Exceptions: </b></dt><dd> 1093 <table border=0 cellspacing=2 cellpadding=0> 1094 <tr><td valign=top><em>memory_error</em> </td><td> 1095 leaves on memory allocation error.</td></tr> 1096 </table> 1097 </dl><dl compact><dt><b>Returns: </b></dt><dd> 1098 A unique command id for asynchronous completion </dl> </td> 1099 </tr> 1100 </table> 1101 <hr>The documentation for this class was generated from the following file:<ul> 1102 <li><a class="el" href="pv__2way__interface_8h-source.html">pv_2way_interface.h</a></ul> 1103 <hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>PV2Way Engine</small> 1104 <address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small> 1105 </small></address> 1106 </body> 1107 </html> 1108
