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>PVAuthorEngineInterface 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>PVAuthorEngineInterface Class Reference</h1><code>#include <<a class="el" href="pvauthorengineinterface_8h-source.html">pvauthorengineinterface.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="classPVAuthorEngineInterface.html#a0">~PVAuthorEngineInterface</a> ()</td></tr> 15 <tr><td nowrap align=right valign=top>virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> </td><td valign=bottom><a class="el" href="classPVAuthorEngineInterface.html#a1">SetLogAppender</a> (const char *aTag, PVLoggerAppender &aAppender, const OsclAny *aContextData=NULL)=0</td></tr> 16 <tr><td nowrap align=right valign=top>virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> </td><td valign=bottom><a class="el" href="classPVAuthorEngineInterface.html#a2">RemoveLogAppender</a> (const char *aTag, PVLoggerAppender &aAppender, const OsclAny *aContextData=NULL)=0</td></tr> 17 <tr><td nowrap align=right valign=top>virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> </td><td valign=bottom><a class="el" href="classPVAuthorEngineInterface.html#a3">SetLogLevel</a> (const char *aTag, int32 aLevel, bool aSetSubtree=false, const OsclAny *aContextData=NULL)=0</td></tr> 18 <tr><td nowrap align=right valign=top>virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> </td><td valign=bottom><a class="el" href="classPVAuthorEngineInterface.html#a4">GetLogLevel</a> (const char *aTag, <a class="el" href="pv__engine__types_8h.html#a4">PVLogLevelInfo</a> &aLogInfo, const OsclAny *aContextData=NULL)=0</td></tr> 19 <tr><td nowrap align=right valign=top>virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> </td><td valign=bottom><a class="el" href="classPVAuthorEngineInterface.html#a5">Open</a> (const OsclAny *aContextData=NULL)=0</td></tr> 20 <tr><td nowrap align=right valign=top>virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> </td><td valign=bottom><a class="el" href="classPVAuthorEngineInterface.html#a6">Close</a> (const OsclAny *aContextData=NULL)=0</td></tr> 21 <tr><td nowrap align=right valign=top>virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> </td><td valign=bottom><a class="el" href="classPVAuthorEngineInterface.html#a7">AddDataSource</a> (const PVMFNodeInterface &aDataSource, const OsclAny *aContextData=NULL)=0</td></tr> 22 <tr><td nowrap align=right valign=top>virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> </td><td valign=bottom><a class="el" href="classPVAuthorEngineInterface.html#a8">RemoveDataSource</a> (const PVMFNodeInterface &aDataSource, const OsclAny *aContextData=NULL)=0</td></tr> 23 <tr><td nowrap align=right valign=top>virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> </td><td valign=bottom><a class="el" href="classPVAuthorEngineInterface.html#a9">SelectComposer</a> (const PvmfMimeString &aComposerType, PVInterface *&aConfigInterface, const OsclAny *aContextData=NULL)=0</td></tr> 24 <tr><td nowrap align=right valign=top>virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> </td><td valign=bottom><a class="el" href="classPVAuthorEngineInterface.html#a10">SelectComposer</a> (const PVUuid &aComposerUuid, PVInterface *&aConfigInterface, const OsclAny *aContextData=NULL)=0</td></tr> 25 <tr><td nowrap align=right valign=top>virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> </td><td valign=bottom><a class="el" href="classPVAuthorEngineInterface.html#a11">AddMediaTrack</a> (const PVMFNodeInterface &aDataSource, const PvmfMimeString &aEncoderType, const OsclAny *aComposer, PVInterface *&aConfigInterface, const OsclAny *aContextData=NULL)=0</td></tr> 26 <tr><td nowrap align=right valign=top>virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> </td><td valign=bottom><a class="el" href="classPVAuthorEngineInterface.html#a12">AddMediaTrack</a> (const PVMFNodeInterface &aDataSource, const PVUuid &aEncoderUuid, const OsclAny *aComposer, PVInterface *&aConfigInterface, const OsclAny *aContextData=NULL)=0</td></tr> 27 <tr><td nowrap align=right valign=top>virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> </td><td valign=bottom><a class="el" href="classPVAuthorEngineInterface.html#a13">AddDataSink</a> (const PVMFNodeInterface &aDataSink, const OsclAny *aComposer, const OsclAny *aContextData=NULL)=0</td></tr> 28 <tr><td nowrap align=right valign=top>virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> </td><td valign=bottom><a class="el" href="classPVAuthorEngineInterface.html#a14">RemoveDataSink</a> (const PVMFNodeInterface &aDataSink, const OsclAny *aContextData=NULL)=0</td></tr> 29 <tr><td nowrap align=right valign=top>virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> </td><td valign=bottom><a class="el" href="classPVAuthorEngineInterface.html#a15">Init</a> (const OsclAny *aContextData=NULL)=0</td></tr> 30 <tr><td nowrap align=right valign=top>virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> </td><td valign=bottom><a class="el" href="classPVAuthorEngineInterface.html#a16">Reset</a> (const OsclAny *aContextData=NULL)=0</td></tr> 31 <tr><td nowrap align=right valign=top>virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> </td><td valign=bottom><a class="el" href="classPVAuthorEngineInterface.html#a17">Start</a> (const OsclAny *aContextData=NULL)=0</td></tr> 32 <tr><td nowrap align=right valign=top>virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> </td><td valign=bottom><a class="el" href="classPVAuthorEngineInterface.html#a18">Pause</a> (const OsclAny *aContextData=NULL)=0</td></tr> 33 <tr><td nowrap align=right valign=top>virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> </td><td valign=bottom><a class="el" href="classPVAuthorEngineInterface.html#a19">Resume</a> (const OsclAny *aContextData=NULL)=0</td></tr> 34 <tr><td nowrap align=right valign=top>virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> </td><td valign=bottom><a class="el" href="classPVAuthorEngineInterface.html#a20">Stop</a> (const OsclAny *aContextData=NULL)=0</td></tr> 35 <tr><td nowrap align=right valign=top>virtual <a class="el" href="pvauthorengineinterface_8h.html#a8">PVAEState</a> </td><td valign=bottom><a class="el" href="classPVAuthorEngineInterface.html#a21">GetPVAuthorState</a> ()=0</td></tr> 36 <tr><td nowrap align=right valign=top>virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> </td><td valign=bottom><a class="el" href="classPVAuthorEngineInterface.html#a22">QueryUUID</a> (const PvmfMimeString &aMimeType, Oscl_Vector< PVUuid, OsclMemAllocator > &aUuids, bool aExactUuidsOnly=false, const OsclAny *aContextData=NULL)=0</td></tr> 37 <tr><td nowrap align=right valign=top>virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> </td><td valign=bottom><a class="el" href="classPVAuthorEngineInterface.html#a23">QueryInterface</a> (const PVUuid &aUuid, PVInterface *&aInterfacePtr, const OsclAny *aContextData=NULL)=0</td></tr> 38 <tr><td nowrap align=right valign=top>virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> </td><td valign=bottom><a class="el" href="classPVAuthorEngineInterface.html#a24">GetSDKModuleInfo</a> (<a class="el" href="pv__engine__types_8h.html#a6">PVSDKModuleInfo</a> &aSDKModuleInfo, const OsclAny *aContextData=NULL)=0</td></tr> 39 <tr><td nowrap align=right valign=top>virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> </td><td valign=bottom><a class="el" href="classPVAuthorEngineInterface.html#a25">CancelAllCommands</a> (const OsclAny *aContextData=NULL)=0</td></tr> 40 <tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr> 41 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF void </td><td valign=bottom><a class="el" href="classPVAuthorEngineInterface.html#d0">GetSDKInfo</a> (<a class="el" href="structPVSDKInfo.html">PVSDKInfo</a> &aSDKInfo)</td></tr> 42 </table> 43 <hr><a name="_details"></a><h2>Detailed Description</h2> 44 PVAuthorEngineInterface 45 <p> 46 <hr><h2>Constructor & Destructor Documentation</h2> 47 <a name="a0" doxytag="PVAuthorEngineInterface::~PVAuthorEngineInterface"></a><p> 48 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 49 <tr> 50 <td class="md"> 51 <table cellpadding="0" cellspacing="0" border="0"> 52 <tr> 53 <td class="md" nowrap valign="top"> virtual PVAuthorEngineInterface::~PVAuthorEngineInterface </td> 54 <td class="md" valign="top">( </td> 55 <td class="mdname1" valign="top" nowrap> </td> 56 <td class="md" valign="top">) </td> 57 <td class="md" nowrap><code> [inline, virtual]</code></td> 58 </tr> 59 60 </table> 61 </td> 62 </tr> 63 </table> 64 <table cellspacing=5 cellpadding=0 border=0> 65 <tr> 66 <td> 67 68 </td> 69 <td> 70 71 <p> 72 Destructor. </td> 73 </tr> 74 </table> 75 <hr><h2>Member Function Documentation</h2> 76 <a name="a13" doxytag="PVAuthorEngineInterface::AddDataSink"></a><p> 77 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 78 <tr> 79 <td class="md"> 80 <table cellpadding="0" cellspacing="0" border="0"> 81 <tr> 82 <td class="md" nowrap valign="top"> virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> PVAuthorEngineInterface::AddDataSink </td> 83 <td class="md" valign="top">( </td> 84 <td class="md" nowrap valign="top">const PVMFNodeInterface & </td> 85 <td class="mdname" nowrap> <em>aDataSink</em>, </td> 86 </tr> 87 <tr> 88 <td></td> 89 <td></td> 90 <td class="md" nowrap>const OsclAny * </td> 91 <td class="mdname" nowrap> <em>aComposer</em>, </td> 92 </tr> 93 <tr> 94 <td></td> 95 <td></td> 96 <td class="md" nowrap>const OsclAny * </td> 97 <td class="mdname" nowrap> <em>aContextData</em> = NULL</td> 98 </tr> 99 <tr> 100 <td></td> 101 <td class="md">) </td> 102 <td class="md" colspan="2"><code> [pure virtual]</code></td> 103 </tr> 104 105 </table> 106 </td> 107 </tr> 108 </table> 109 <table cellspacing=5 cellpadding=0 border=0> 110 <tr> 111 <td> 112 113 </td> 114 <td> 115 116 <p> 117 Adds a media sink where output data from the specified composer will be written to. Currently this API does not cause any action as it is not relevant. 118 <p> 119 This command is valid only when pvAuthor Engine is in PVAE_STATE_OPENED state. The referenced composer must be previously selected. 120 <p> 121 This command does not change the pvAuthor Engine engine state.<dl compact><dt><b>Parameters: </b></dt><dd> 122 <table border=0 cellspacing=2 cellpadding=0> 123 <tr><td valign=top><em>aDataSink</em> </td><td> 124 Reference to the data sink to be used </td></tr> 125 <tr><td valign=top><em>aComposer</em> </td><td> 126 Opaque data identifying the composer to which the data sink will connect to. </td></tr> 127 <tr><td valign=top><em>aContextData</em> </td><td> 128 Optional opaque data to be passed back to user with the command response </td></tr> 129 </table> 130 </dl><dl compact><dt><b>Returns: </b></dt><dd> 131 A unique command id for asynchronous completion </dl> </td> 132 </tr> 133 </table> 134 <a name="a7" doxytag="PVAuthorEngineInterface::AddDataSource"></a><p> 135 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 136 <tr> 137 <td class="md"> 138 <table cellpadding="0" cellspacing="0" border="0"> 139 <tr> 140 <td class="md" nowrap valign="top"> virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> PVAuthorEngineInterface::AddDataSource </td> 141 <td class="md" valign="top">( </td> 142 <td class="md" nowrap valign="top">const PVMFNodeInterface & </td> 143 <td class="mdname" nowrap> <em>aDataSource</em>, </td> 144 </tr> 145 <tr> 146 <td></td> 147 <td></td> 148 <td class="md" nowrap>const OsclAny * </td> 149 <td class="mdname" nowrap> <em>aContextData</em> = NULL</td> 150 </tr> 151 <tr> 152 <td></td> 153 <td class="md">) </td> 154 <td class="md" colspan="2"><code> [pure virtual]</code></td> 155 </tr> 156 157 </table> 158 </td> 159 </tr> 160 </table> 161 <table cellspacing=5 cellpadding=0 border=0> 162 <tr> 163 <td> 164 165 </td> 166 <td> 167 168 <p> 169 Adds a media source to be used as input to an authoring session. 170 <p> 171 This command is valid only when pvAuthor Engine is in PVAE_STATE_OPENED state. This command does not change the pvAuthor Engine engine state.<dl compact><dt><b>Parameters: </b></dt><dd> 172 <table border=0 cellspacing=2 cellpadding=0> 173 <tr><td valign=top><em>aDataSource</em> </td><td> 174 Reference to the data source </td></tr> 175 <tr><td valign=top><em>aContextData</em> </td><td> 176 Optional opaque data to be passed back to user with the command response </td></tr> 177 </table> 178 </dl><dl compact><dt><b>Returns: </b></dt><dd> 179 Unique command ID to identify this command in command response </dl> </td> 180 </tr> 181 </table> 182 <a name="a12" doxytag="PVAuthorEngineInterface::AddMediaTrack"></a><p> 183 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 184 <tr> 185 <td class="md"> 186 <table cellpadding="0" cellspacing="0" border="0"> 187 <tr> 188 <td class="md" nowrap valign="top"> virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> PVAuthorEngineInterface::AddMediaTrack </td> 189 <td class="md" valign="top">( </td> 190 <td class="md" nowrap valign="top">const PVMFNodeInterface & </td> 191 <td class="mdname" nowrap> <em>aDataSource</em>, </td> 192 </tr> 193 <tr> 194 <td></td> 195 <td></td> 196 <td class="md" nowrap>const PVUuid & </td> 197 <td class="mdname" nowrap> <em>aEncoderUuid</em>, </td> 198 </tr> 199 <tr> 200 <td></td> 201 <td></td> 202 <td class="md" nowrap>const OsclAny * </td> 203 <td class="mdname" nowrap> <em>aComposer</em>, </td> 204 </tr> 205 <tr> 206 <td></td> 207 <td></td> 208 <td class="md" nowrap>PVInterface *& </td> 209 <td class="mdname" nowrap> <em>aConfigInterface</em>, </td> 210 </tr> 211 <tr> 212 <td></td> 213 <td></td> 214 <td class="md" nowrap>const OsclAny * </td> 215 <td class="mdname" nowrap> <em>aContextData</em> = NULL</td> 216 </tr> 217 <tr> 218 <td></td> 219 <td class="md">) </td> 220 <td class="md" colspan="2"><code> [pure virtual]</code></td> 221 </tr> 222 223 </table> 224 </td> 225 </tr> 226 </table> 227 <table cellspacing=5 cellpadding=0 border=0> 228 <tr> 229 <td> 230 231 </td> 232 <td> 233 234 <p> 235 Add a media track to the specified composer. 236 <p> 237 The source data of this media track will come from the specified data source. pvAuthor engine will encoder of the specified Uuid to encode the source data. A media track will be added to the specified composer, and encoded data will be written to the composer during the authoring session. 238 <p> 239 A configuration object for the selected composer will be saved to the PVInterface pointer provided in aConfigInterface parameter. User should call queryInterface to query for the configuration interfaces supported by the encoder. Before calling <a class="el" href="classPVAuthorEngineInterface.html#a16">Reset()</a>, user must call removeRef on the PVInterface object to remove its reference to the object. 240 <p> 241 This command is valid only when pvAuthor Engine is in PVAE_STATE_OPENED state. The referenced data source and composer must be already added before this method is called. This command does not change the pvAuthor Engine engine state.<dl compact><dt><b>Parameters: </b></dt><dd> 242 <table border=0 cellspacing=2 cellpadding=0> 243 <tr><td valign=top><em>aDataSource</em> </td><td> 244 Data source node to provide input data </td></tr> 245 <tr><td valign=top><em>aEncoderUuid</em> </td><td> 246 Uuid of encoder to encode the source data </td></tr> 247 <tr><td valign=top><em>aComposer</em> </td><td> 248 Opaque data to identify the composer in which a media track will be added. </td></tr> 249 <tr><td valign=top><em>aConfigInterface</em> </td><td> 250 Pointer to configuration object for the selected encoder will be saved to this parameter upon completion of this call </td></tr> 251 <tr><td valign=top><em>aContextData</em> </td><td> 252 Optional opaque data to be passed back to user with the command response </td></tr> 253 </table> 254 </dl><dl compact><dt><b>Returns: </b></dt><dd> 255 A unique command id for asynchronous completion </dl> </td> 256 </tr> 257 </table> 258 <a name="a11" doxytag="PVAuthorEngineInterface::AddMediaTrack"></a><p> 259 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 260 <tr> 261 <td class="md"> 262 <table cellpadding="0" cellspacing="0" border="0"> 263 <tr> 264 <td class="md" nowrap valign="top"> virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> PVAuthorEngineInterface::AddMediaTrack </td> 265 <td class="md" valign="top">( </td> 266 <td class="md" nowrap valign="top">const PVMFNodeInterface & </td> 267 <td class="mdname" nowrap> <em>aDataSource</em>, </td> 268 </tr> 269 <tr> 270 <td></td> 271 <td></td> 272 <td class="md" nowrap>const PvmfMimeString & </td> 273 <td class="mdname" nowrap> <em>aEncoderType</em>, </td> 274 </tr> 275 <tr> 276 <td></td> 277 <td></td> 278 <td class="md" nowrap>const OsclAny * </td> 279 <td class="mdname" nowrap> <em>aComposer</em>, </td> 280 </tr> 281 <tr> 282 <td></td> 283 <td></td> 284 <td class="md" nowrap>PVInterface *& </td> 285 <td class="mdname" nowrap> <em>aConfigInterface</em>, </td> 286 </tr> 287 <tr> 288 <td></td> 289 <td></td> 290 <td class="md" nowrap>const OsclAny * </td> 291 <td class="mdname" nowrap> <em>aContextData</em> = NULL</td> 292 </tr> 293 <tr> 294 <td></td> 295 <td class="md">) </td> 296 <td class="md" colspan="2"><code> [pure virtual]</code></td> 297 </tr> 298 299 </table> 300 </td> 301 </tr> 302 </table> 303 <table cellspacing=5 cellpadding=0 border=0> 304 <tr> 305 <td> 306 307 </td> 308 <td> 309 310 <p> 311 Add a media track to the specified composer. 312 <p> 313 The source data of this media track will come from the specified data source. pvAuthor engine will select the most suitable available encoder of the specified type. A media track will be added to the specified composer, and encoded data will be written to the composer during the authoring session. 314 <p> 315 A configuration object for the selected composer will be saved to the PVInterface pointer provided in aConfigInterface parameter. User should call queryInterface to query for the configuration interfaces supported by the encoder. Before calling <a class="el" href="classPVAuthorEngineInterface.html#a16">Reset()</a>, user must call removeRef on the PVInterface object to remove its reference to the object. 316 <p> 317 This command is valid only when pvAuthor Engine is in PVAE_STATE_OPENED state. The referenced data source and composer must be already added before this method is called. This command does not change the pvAuthor Engine engine state.<dl compact><dt><b>Parameters: </b></dt><dd> 318 <table border=0 cellspacing=2 cellpadding=0> 319 <tr><td valign=top><em>aDataSource</em> </td><td> 320 Data source node to provide input data </td></tr> 321 <tr><td valign=top><em>aEncoderType</em> </td><td> 322 MIME type of encoder to encode the source data </td></tr> 323 <tr><td valign=top><em>aComposer</em> </td><td> 324 Opaque data to identify the composer in which a media track will be added. </td></tr> 325 <tr><td valign=top><em>aConfigInterface</em> </td><td> 326 Pointer to configuration object for the selected encoder will be saved to this parameter upon completion of this call </td></tr> 327 <tr><td valign=top><em>aContextData</em> </td><td> 328 Optional opaque data to be passed back to user with the command response </td></tr> 329 </table> 330 </dl><dl compact><dt><b>Returns: </b></dt><dd> 331 A unique command id for asynchronous completion </dl> </td> 332 </tr> 333 </table> 334 <a name="a25" doxytag="PVAuthorEngineInterface::CancelAllCommands"></a><p> 335 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 336 <tr> 337 <td class="md"> 338 <table cellpadding="0" cellspacing="0" border="0"> 339 <tr> 340 <td class="md" nowrap valign="top"> virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> PVAuthorEngineInterface::CancelAllCommands </td> 341 <td class="md" valign="top">( </td> 342 <td class="md" nowrap valign="top">const OsclAny * </td> 343 <td class="mdname1" valign="top" nowrap> <em>aContextData</em> = NULL </td> 344 <td class="md" valign="top">) </td> 345 <td class="md" nowrap><code> [pure virtual]</code></td> 346 </tr> 347 348 </table> 349 </td> 350 </tr> 351 </table> 352 <table cellspacing=5 cellpadding=0 border=0> 353 <tr> 354 <td> 355 356 </td> 357 <td> 358 359 <p> 360 Cancel all pending requests. The current request being processed, if any, will also be aborted. PVAE_CMD_CANCEL_ALL_COMMANDS will be passed to the command observer on completion. Currently this API is NOT SUPPORTED.<dl compact><dt><b>Parameters: </b></dt><dd> 361 <table border=0 cellspacing=2 cellpadding=0> 362 <tr><td valign=top><em>aContextData</em> </td><td> 363 Optional opaque data that will be passed back to the user with the command response </td></tr> 364 </table> 365 </dl><dl compact><dt><b>Returns: </b></dt><dd> 366 A unique command id for asynchronous completion </dl> </td> 367 </tr> 368 </table> 369 <a name="a6" doxytag="PVAuthorEngineInterface::Close"></a><p> 370 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 371 <tr> 372 <td class="md"> 373 <table cellpadding="0" cellspacing="0" border="0"> 374 <tr> 375 <td class="md" nowrap valign="top"> virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> PVAuthorEngineInterface::Close </td> 376 <td class="md" valign="top">( </td> 377 <td class="md" nowrap valign="top">const OsclAny * </td> 378 <td class="mdname1" valign="top" nowrap> <em>aContextData</em> = NULL </td> 379 <td class="md" valign="top">) </td> 380 <td class="md" nowrap><code> [pure virtual]</code></td> 381 </tr> 382 383 </table> 384 </td> 385 </tr> 386 </table> 387 <table cellspacing=5 cellpadding=0 border=0> 388 <tr> 389 <td> 390 391 </td> 392 <td> 393 394 <p> 395 Closes an authoring session. 396 <p> 397 All resources added and allocated to the authoring session will be released. 398 <p> 399 This command is valid only when pvAuthor engine is in PVAE_STATE_OPENED state and Upon completion of this command, pvAuthor Engine will be in PVAE_STATE_IDLE state.<dl compact><dt><b>Parameters: </b></dt><dd> 400 <table border=0 cellspacing=2 cellpadding=0> 401 <tr><td valign=top><em>aContextData</em> </td><td> 402 Optional opaque data to be passed back to user with the command response </td></tr> 403 </table> 404 </dl><dl compact><dt><b>Returns: </b></dt><dd> 405 Unique command ID to identify this command in command response </dl> </td> 406 </tr> 407 </table> 408 <a name="a4" doxytag="PVAuthorEngineInterface::GetLogLevel"></a><p> 409 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 410 <tr> 411 <td class="md"> 412 <table cellpadding="0" cellspacing="0" border="0"> 413 <tr> 414 <td class="md" nowrap valign="top"> virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> PVAuthorEngineInterface::GetLogLevel </td> 415 <td class="md" valign="top">( </td> 416 <td class="md" nowrap valign="top">const char * </td> 417 <td class="mdname" nowrap> <em>aTag</em>, </td> 418 </tr> 419 <tr> 420 <td></td> 421 <td></td> 422 <td class="md" nowrap><a class="el" href="pv__engine__types_8h.html#a4">PVLogLevelInfo</a> & </td> 423 <td class="mdname" nowrap> <em>aLogInfo</em>, </td> 424 </tr> 425 <tr> 426 <td></td> 427 <td></td> 428 <td class="md" nowrap>const OsclAny * </td> 429 <td class="mdname" nowrap> <em>aContextData</em> = NULL</td> 430 </tr> 431 <tr> 432 <td></td> 433 <td class="md">) </td> 434 <td class="md" colspan="2"><code> [pure virtual]</code></td> 435 </tr> 436 437 </table> 438 </td> 439 </tr> 440 </table> 441 <table cellspacing=5 cellpadding=0 border=0> 442 <tr> 443 <td> 444 445 </td> 446 <td> 447 448 <p> 449 Allows the logging level to be queried for a particular logging tag. A larger log level will result in more messages being logged. 450 <p> 451 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). Currently this API is NOT SUPPORTED.<dl compact><dt><b>Parameters: </b></dt><dd> 452 <table border=0 cellspacing=2 cellpadding=0> 453 <tr><td valign=top><em>aTag</em> </td><td> 454 Specifies the logger tree tag where the log level should be retrieved. </td></tr> 455 <tr><td valign=top><em>aLogInfo</em> </td><td> 456 An output parameter which will be filled in with the log level information. </td></tr> 457 <tr><td valign=top><em>aContextData</em> </td><td> 458 Optional opaque data that will be passed back to the user with the command response </td></tr> 459 </table> 460 </dl><dl compact><dt><b>Exceptions: </b></dt><dd> 461 <table border=0 cellspacing=2 cellpadding=0> 462 <tr><td valign=top><em>memory_error</em> </td><td> 463 leaves on memory allocation error.</td></tr> 464 </table> 465 </dl><dl compact><dt><b>Returns: </b></dt><dd> 466 A unique command id for asynchronous completion </dl> </td> 467 </tr> 468 </table> 469 <a name="a21" doxytag="PVAuthorEngineInterface::GetPVAuthorState"></a><p> 470 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 471 <tr> 472 <td class="md"> 473 <table cellpadding="0" cellspacing="0" border="0"> 474 <tr> 475 <td class="md" nowrap valign="top"> virtual <a class="el" href="pvauthorengineinterface_8h.html#a8">PVAEState</a> PVAuthorEngineInterface::GetPVAuthorState </td> 476 <td class="md" valign="top">( </td> 477 <td class="mdname1" valign="top" nowrap> </td> 478 <td class="md" valign="top">) </td> 479 <td class="md" nowrap><code> [pure virtual]</code></td> 480 </tr> 481 482 </table> 483 </td> 484 </tr> 485 </table> 486 <table cellspacing=5 cellpadding=0 border=0> 487 <tr> 488 <td> 489 490 </td> 491 <td> 492 493 <p> 494 This function returns the current state of the pvAuthor Engine. Application may use this info for updating display or determine if the pvAuthor Engine is ready for the next command.<dl compact><dt><b>Parameters: </b></dt><dd> 495 <table border=0 cellspacing=2 cellpadding=0> 496 <tr><td valign=top><em>aState</em> </td><td> 497 Output parameter to hold state information </td></tr> 498 <tr><td valign=top><em>aContextData</em> </td><td> 499 Optional opaque data to be passed back to user with the command response </td></tr> 500 </table> 501 </dl><dl compact><dt><b>Returns: </b></dt><dd> 502 A unique command id for synchronous completion </dl> </td> 503 </tr> 504 </table> 505 <a name="d0" doxytag="PVAuthorEngineInterface::GetSDKInfo"></a><p> 506 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 507 <tr> 508 <td class="md"> 509 <table cellpadding="0" cellspacing="0" border="0"> 510 <tr> 511 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF void PVAuthorEngineInterface::GetSDKInfo </td> 512 <td class="md" valign="top">( </td> 513 <td class="md" nowrap valign="top"><a class="el" href="structPVSDKInfo.html">PVSDKInfo</a> & </td> 514 <td class="mdname1" valign="top" nowrap> <em>aSDKInfo</em> </td> 515 <td class="md" valign="top">) </td> 516 <td class="md" nowrap><code> [static]</code></td> 517 </tr> 518 519 </table> 520 </td> 521 </tr> 522 </table> 523 <table cellspacing=5 cellpadding=0 border=0> 524 <tr> 525 <td> 526 527 </td> 528 <td> 529 530 <p> 531 Returns SDK version information about author engine.<dl compact><dt><b>Parameters: </b></dt><dd> 532 <table border=0 cellspacing=2 cellpadding=0> 533 <tr><td valign=top><em>aSDKInfo</em> </td><td> 534 A reference to a <a class="el" href="structPVSDKInfo.html">PVSDKInfo</a> structure which contains product name, supported hardware platform, supported software platform, version, part number, and PV UUID. These fields will contain info .for the currently instantiated pvPlayer engine when this function returns success. </td></tr> 535 </table> 536 </dl> </td> 537 </tr> 538 </table> 539 <a name="a24" doxytag="PVAuthorEngineInterface::GetSDKModuleInfo"></a><p> 540 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 541 <tr> 542 <td class="md"> 543 <table cellpadding="0" cellspacing="0" border="0"> 544 <tr> 545 <td class="md" nowrap valign="top"> virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> PVAuthorEngineInterface::GetSDKModuleInfo </td> 546 <td class="md" valign="top">( </td> 547 <td class="md" nowrap valign="top"><a class="el" href="pv__engine__types_8h.html#a6">PVSDKModuleInfo</a> & </td> 548 <td class="mdname" nowrap> <em>aSDKModuleInfo</em>, </td> 549 </tr> 550 <tr> 551 <td></td> 552 <td></td> 553 <td class="md" nowrap>const OsclAny * </td> 554 <td class="mdname" nowrap> <em>aContextData</em> = NULL</td> 555 </tr> 556 <tr> 557 <td></td> 558 <td class="md">) </td> 559 <td class="md" colspan="2"><code> [pure virtual]</code></td> 560 </tr> 561 562 </table> 563 </td> 564 </tr> 565 </table> 566 <table cellspacing=5 cellpadding=0 border=0> 567 <tr> 568 <td> 569 570 </td> 571 <td> 572 573 <p> 574 Returns information about all modules currently used by the SDK. Currently this API is NOT SUPPORTED.<dl compact><dt><b>Parameters: </b></dt><dd> 575 <table border=0 cellspacing=2 cellpadding=0> 576 <tr><td valign=top><em>aSDKModuleInfo</em> </td><td> 577 A reference to a PVSDKModuleInfo structure which contains the number of modules currently used by pvAuthor Engine 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> 578 <tr><td valign=top><em>aContextData</em> </td><td> 579 Optional opaque data that will be passed back to the user with the command response </td></tr> 580 </table> 581 </dl><dl compact><dt><b>Returns: </b></dt><dd> 582 A unique command id for asynchronous completion </dl> </td> 583 </tr> 584 </table> 585 <a name="a15" doxytag="PVAuthorEngineInterface::Init"></a><p> 586 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 587 <tr> 588 <td class="md"> 589 <table cellpadding="0" cellspacing="0" border="0"> 590 <tr> 591 <td class="md" nowrap valign="top"> virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> PVAuthorEngineInterface::Init </td> 592 <td class="md" valign="top">( </td> 593 <td class="md" nowrap valign="top">const OsclAny * </td> 594 <td class="mdname1" valign="top" nowrap> <em>aContextData</em> = NULL </td> 595 <td class="md" valign="top">) </td> 596 <td class="md" nowrap><code> [pure virtual]</code></td> 597 </tr> 598 599 </table> 600 </td> 601 </tr> 602 </table> 603 <table cellspacing=5 cellpadding=0 border=0> 604 <tr> 605 <td> 606 607 </td> 608 <td> 609 610 <p> 611 Initialize an authoring session. 612 <p> 613 Upon calling this method, no more data sources and sinks can be added to the session. Also, all configuration settings will be locked and cannot be modified until the session is reset by calling <a class="el" href="classPVAuthorEngineInterface.html#a16">Reset()</a>. Resources for the session will allocated and initialized to the configuration settings specified. This command is valid only when pvAuthor Engine is in PVAE_STATE_OPENED state. 614 <p> 615 Upon completion of this command, pvAuthor Engine will be in PVAE_STATE_INITIALIZED state, and the authoring session is ready to start.<dl compact><dt><b>Parameters: </b></dt><dd> 616 <table border=0 cellspacing=2 cellpadding=0> 617 <tr><td valign=top><em>aContextData</em> </td><td> 618 Optional opaque data to be passed back to user with the command response </td></tr> 619 </table> 620 </dl><dl compact><dt><b>Returns: </b></dt><dd> 621 A unique command id for asynchronous completion </dl> </td> 622 </tr> 623 </table> 624 <a name="a5" doxytag="PVAuthorEngineInterface::Open"></a><p> 625 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 626 <tr> 627 <td class="md"> 628 <table cellpadding="0" cellspacing="0" border="0"> 629 <tr> 630 <td class="md" nowrap valign="top"> virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> PVAuthorEngineInterface::Open </td> 631 <td class="md" valign="top">( </td> 632 <td class="md" nowrap valign="top">const OsclAny * </td> 633 <td class="mdname1" valign="top" nowrap> <em>aContextData</em> = NULL </td> 634 <td class="md" valign="top">) </td> 635 <td class="md" nowrap><code> [pure virtual]</code></td> 636 </tr> 637 638 </table> 639 </td> 640 </tr> 641 </table> 642 <table cellspacing=5 cellpadding=0 border=0> 643 <tr> 644 <td> 645 646 </td> 647 <td> 648 649 <p> 650 Opens an authoring session. 651 <p> 652 This command is valid only when pvAuthor engine is in PVAE_STATE_IDLE state. Upon completion of this method, pvAuthor engine will be in PVAE_STATE_OPENED state.<dl compact><dt><b>Parameters: </b></dt><dd> 653 <table border=0 cellspacing=2 cellpadding=0> 654 <tr><td valign=top><em>aContextData</em> </td><td> 655 Optional opaque data to be passed back to user with the command response </td></tr> 656 </table> 657 </dl><dl compact><dt><b>Returns: </b></dt><dd> 658 Unique command ID to identify this command in command response </dl> </td> 659 </tr> 660 </table> 661 <a name="a18" doxytag="PVAuthorEngineInterface::Pause"></a><p> 662 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 663 <tr> 664 <td class="md"> 665 <table cellpadding="0" cellspacing="0" border="0"> 666 <tr> 667 <td class="md" nowrap valign="top"> virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> PVAuthorEngineInterface::Pause </td> 668 <td class="md" valign="top">( </td> 669 <td class="md" nowrap valign="top">const OsclAny * </td> 670 <td class="mdname1" valign="top" nowrap> <em>aContextData</em> = NULL </td> 671 <td class="md" valign="top">) </td> 672 <td class="md" nowrap><code> [pure virtual]</code></td> 673 </tr> 674 675 </table> 676 </td> 677 </tr> 678 </table> 679 <table cellspacing=5 cellpadding=0 border=0> 680 <tr> 681 <td> 682 683 </td> 684 <td> 685 686 <p> 687 Pause the authoring session. 688 <p> 689 The authoring session will be paused and no encoded output data will be sent to the data sink. This function is valid only in the PVAE_STATE_RECORDING state. 690 <p> 691 Upon completion of this command, pvAuthor Engine will be in PVAE_STATE_PAUSED state.<dl compact><dt><b>Parameters: </b></dt><dd> 692 <table border=0 cellspacing=2 cellpadding=0> 693 <tr><td valign=top><em>aContextData</em> </td><td> 694 Optional opaque data to be passed back to user with the command response </td></tr> 695 </table> 696 </dl><dl compact><dt><b>Returns: </b></dt><dd> 697 A unique command id for asynchronous completion </dl> </td> 698 </tr> 699 </table> 700 <a name="a23" doxytag="PVAuthorEngineInterface::QueryInterface"></a><p> 701 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 702 <tr> 703 <td class="md"> 704 <table cellpadding="0" cellspacing="0" border="0"> 705 <tr> 706 <td class="md" nowrap valign="top"> virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> PVAuthorEngineInterface::QueryInterface </td> 707 <td class="md" valign="top">( </td> 708 <td class="md" nowrap valign="top">const PVUuid & </td> 709 <td class="mdname" nowrap> <em>aUuid</em>, </td> 710 </tr> 711 <tr> 712 <td></td> 713 <td></td> 714 <td class="md" nowrap>PVInterface *& </td> 715 <td class="mdname" nowrap> <em>aInterfacePtr</em>, </td> 716 </tr> 717 <tr> 718 <td></td> 719 <td></td> 720 <td class="md" nowrap>const OsclAny * </td> 721 <td class="mdname" nowrap> <em>aContextData</em> = NULL</td> 722 </tr> 723 <tr> 724 <td></td> 725 <td class="md">) </td> 726 <td class="md" colspan="2"><code> [pure virtual]</code></td> 727 </tr> 728 729 </table> 730 </td> 731 </tr> 732 </table> 733 <table cellspacing=5 cellpadding=0 border=0> 734 <tr> 735 <td> 736 737 </td> 738 <td> 739 740 <p> 741 This API is to allow for extensibility of the pvAuthor engine 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> 742 <table border=0 cellspacing=2 cellpadding=0> 743 <tr><td valign=top><em>aUuid</em> </td><td> 744 The UUID of the desired interface </td></tr> 745 <tr><td valign=top><em>aInterfacePtr</em> </td><td> 746 The output pointer to the desired interface </td></tr> 747 <tr><td valign=top><em>aContextData</em> </td><td> 748 Optional opaque data to be passed back to user with the command response </td></tr> 749 </table> 750 </dl><dl compact><dt><b>Returns: </b></dt><dd> 751 A unique command id for asynchronous completion </dl> </td> 752 </tr> 753 </table> 754 <a name="a22" doxytag="PVAuthorEngineInterface::QueryUUID"></a><p> 755 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 756 <tr> 757 <td class="md"> 758 <table cellpadding="0" cellspacing="0" border="0"> 759 <tr> 760 <td class="md" nowrap valign="top"> virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> PVAuthorEngineInterface::QueryUUID </td> 761 <td class="md" valign="top">( </td> 762 <td class="md" nowrap valign="top">const PvmfMimeString & </td> 763 <td class="mdname" nowrap> <em>aMimeType</em>, </td> 764 </tr> 765 <tr> 766 <td></td> 767 <td></td> 768 <td class="md" nowrap>Oscl_Vector< PVUuid, OsclMemAllocator > & </td> 769 <td class="mdname" nowrap> <em>aUuids</em>, </td> 770 </tr> 771 <tr> 772 <td></td> 773 <td></td> 774 <td class="md" nowrap>bool </td> 775 <td class="mdname" nowrap> <em>aExactUuidsOnly</em> = false, </td> 776 </tr> 777 <tr> 778 <td></td> 779 <td></td> 780 <td class="md" nowrap>const OsclAny * </td> 781 <td class="mdname" nowrap> <em>aContextData</em> = NULL</td> 782 </tr> 783 <tr> 784 <td></td> 785 <td class="md">) </td> 786 <td class="md" colspan="2"><code> [pure virtual]</code></td> 787 </tr> 788 789 </table> 790 </td> 791 </tr> 792 </table> 793 <table cellspacing=5 cellpadding=0 border=0> 794 <tr> 795 <td> 796 797 </td> 798 <td> 799 800 <p> 801 Discover the UUIDs of interfaces associated with the specified MIME type and node 802 <p> 803 This API is to allow for extensibility of the pvAuthor Engine interface. User can query for all UUIDs associated with a particular MIME type. The UUIDs will be added to the aUuids vector provided by the user. Currently this API is NOT SUPPORTED.<dl compact><dt><b>Parameters: </b></dt><dd> 804 <table border=0 cellspacing=2 cellpadding=0> 805 <tr><td valign=top><em>aMimeType</em> </td><td> 806 The MIME type of the desired interfaces </td></tr> 807 <tr><td valign=top><em>aUuids</em> </td><td> 808 A vector to hold the discovered UUIDs </td></tr> 809 <tr><td valign=top><em>aExactUuidsOnly</em> </td><td> 810 Turns on/off the retrival of UUIDs with aMimeType as a base type </td></tr> 811 <tr><td valign=top><em>aContextData</em> </td><td> 812 Optional opaque data to be passed back to user with the command response </td></tr> 813 </table> 814 </dl><dl compact><dt><b>Returns: </b></dt><dd> 815 A unique command id for asynchronous completion </dl> </td> 816 </tr> 817 </table> 818 <a name="a14" doxytag="PVAuthorEngineInterface::RemoveDataSink"></a><p> 819 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 820 <tr> 821 <td class="md"> 822 <table cellpadding="0" cellspacing="0" border="0"> 823 <tr> 824 <td class="md" nowrap valign="top"> virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> PVAuthorEngineInterface::RemoveDataSink </td> 825 <td class="md" valign="top">( </td> 826 <td class="md" nowrap valign="top">const PVMFNodeInterface & </td> 827 <td class="mdname" nowrap> <em>aDataSink</em>, </td> 828 </tr> 829 <tr> 830 <td></td> 831 <td></td> 832 <td class="md" nowrap>const OsclAny * </td> 833 <td class="mdname" nowrap> <em>aContextData</em> = NULL</td> 834 </tr> 835 <tr> 836 <td></td> 837 <td class="md">) </td> 838 <td class="md" colspan="2"><code> [pure virtual]</code></td> 839 </tr> 840 841 </table> 842 </td> 843 </tr> 844 </table> 845 <table cellspacing=5 cellpadding=0 border=0> 846 <tr> 847 <td> 848 849 </td> 850 <td> 851 852 <p> 853 Removes a previously added data sink. Currently this API does not cause any action as it is not relevant. 854 <p> 855 This command is valid only when pvAuthor Engine is in PVAE_STATE_OPENED state. This command does not change the pvAuthor Engine engine state.<dl compact><dt><b>Parameters: </b></dt><dd> 856 <table border=0 cellspacing=2 cellpadding=0> 857 <tr><td valign=top><em>aDataSink</em> </td><td> 858 Reference to the data sink to be removed </td></tr> 859 <tr><td valign=top><em>aContextData</em> </td><td> 860 Optional opaque data to be passed back to user with the command response </td></tr> 861 </table> 862 </dl><dl compact><dt><b>Returns: </b></dt><dd> 863 A unique command id for asynchronous completion </dl> </td> 864 </tr> 865 </table> 866 <a name="a8" doxytag="PVAuthorEngineInterface::RemoveDataSource"></a><p> 867 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 868 <tr> 869 <td class="md"> 870 <table cellpadding="0" cellspacing="0" border="0"> 871 <tr> 872 <td class="md" nowrap valign="top"> virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> PVAuthorEngineInterface::RemoveDataSource </td> 873 <td class="md" valign="top">( </td> 874 <td class="md" nowrap valign="top">const PVMFNodeInterface & </td> 875 <td class="mdname" nowrap> <em>aDataSource</em>, </td> 876 </tr> 877 <tr> 878 <td></td> 879 <td></td> 880 <td class="md" nowrap>const OsclAny * </td> 881 <td class="mdname" nowrap> <em>aContextData</em> = NULL</td> 882 </tr> 883 <tr> 884 <td></td> 885 <td class="md">) </td> 886 <td class="md" colspan="2"><code> [pure virtual]</code></td> 887 </tr> 888 889 </table> 890 </td> 891 </tr> 892 </table> 893 <table cellspacing=5 cellpadding=0 border=0> 894 <tr> 895 <td> 896 897 </td> 898 <td> 899 900 <p> 901 Unbinds a previously added data source. 902 <p> 903 This command is valid only when pvAuthor Engine is in PVAE_STATE_OPENED state. This command does not change the pvAuthor Engine engine state.<dl compact><dt><b>Parameters: </b></dt><dd> 904 <table border=0 cellspacing=2 cellpadding=0> 905 <tr><td valign=top><em>aDataSource</em> </td><td> 906 Reference to the data source to be removed </td></tr> 907 <tr><td valign=top><em>aContextData</em> </td><td> 908 Optional opaque data to be passed back to user with the command response </td></tr> 909 </table> 910 </dl><dl compact><dt><b>Returns: </b></dt><dd> 911 A unique command id for asynchronous completion </dl> </td> 912 </tr> 913 </table> 914 <a name="a2" doxytag="PVAuthorEngineInterface::RemoveLogAppender"></a><p> 915 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 916 <tr> 917 <td class="md"> 918 <table cellpadding="0" cellspacing="0" border="0"> 919 <tr> 920 <td class="md" nowrap valign="top"> virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> PVAuthorEngineInterface::RemoveLogAppender </td> 921 <td class="md" valign="top">( </td> 922 <td class="md" nowrap valign="top">const char * </td> 923 <td class="mdname" nowrap> <em>aTag</em>, </td> 924 </tr> 925 <tr> 926 <td></td> 927 <td></td> 928 <td class="md" nowrap>PVLoggerAppender & </td> 929 <td class="mdname" nowrap> <em>aAppender</em>, </td> 930 </tr> 931 <tr> 932 <td></td> 933 <td></td> 934 <td class="md" nowrap>const OsclAny * </td> 935 <td class="mdname" nowrap> <em>aContextData</em> = NULL</td> 936 </tr> 937 <tr> 938 <td></td> 939 <td class="md">) </td> 940 <td class="md" colspan="2"><code> [pure virtual]</code></td> 941 </tr> 942 943 </table> 944 </td> 945 </tr> 946 </table> 947 <table cellspacing=5 cellpadding=0 border=0> 948 <tr> 949 <td> 950 951 </td> 952 <td> 953 954 <p> 955 Allows a logging appender to be removed from the logger tree at the point specified by the input tag. If the input tag is NULL then the appender will be removed from locations in the tree. Currently this API is NOT SUPPORTED.<dl compact><dt><b>Parameters: </b></dt><dd> 956 <table border=0 cellspacing=2 cellpadding=0> 957 <tr><td valign=top><em>aTag</em> </td><td> 958 Specifies the logger tree tag where the appender should be removed. Can be NULL to remove at all locations. </td></tr> 959 <tr><td valign=top><em>aAppender</em> </td><td> 960 The log appender to remove. </td></tr> 961 <tr><td valign=top><em>aContextData</em> </td><td> 962 Optional opaque data that will be passed back to the user with the command response</td></tr> 963 </table> 964 </dl><dl compact><dt><b>Exceptions: </b></dt><dd> 965 <table border=0 cellspacing=2 cellpadding=0> 966 <tr><td valign=top><em>memory_error</em> </td><td> 967 leaves on memory allocation error.</td></tr> 968 </table> 969 </dl><dl compact><dt><b>Returns: </b></dt><dd> 970 A unique command id for asynchronous completion </dl> </td> 971 </tr> 972 </table> 973 <a name="a16" doxytag="PVAuthorEngineInterface::Reset"></a><p> 974 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 975 <tr> 976 <td class="md"> 977 <table cellpadding="0" cellspacing="0" border="0"> 978 <tr> 979 <td class="md" nowrap valign="top"> virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> PVAuthorEngineInterface::Reset </td> 980 <td class="md" valign="top">( </td> 981 <td class="md" nowrap valign="top">const OsclAny * </td> 982 <td class="mdname1" valign="top" nowrap> <em>aContextData</em> = NULL </td> 983 <td class="md" valign="top">) </td> 984 <td class="md" nowrap><code> [pure virtual]</code></td> 985 </tr> 986 987 </table> 988 </td> 989 </tr> 990 </table> 991 <table cellspacing=5 cellpadding=0 border=0> 992 <tr> 993 <td> 994 995 </td> 996 <td> 997 998 <p> 999 Reset an initialized authoring session. 1000 <p> 1001 The authoring session will be stopped and all composers and encoders selected for the session will be removed. All data sources and sinks will be reset but will continue to be available for authoring the next output clip. 1002 <p> 1003 User must call removeRef() to remove its reference to any PVInterface objects received from <a class="el" href="classPVAuthorEngineInterface.html#a9">SelectComposer()</a> or <a class="el" href="classPVAuthorEngineInterface.html#a11">AddMediaTrack()</a> or <a class="el" href="classPVAuthorEngineInterface.html#a23">QueryInterface()</a> APIs before calling this method. This method would fail otherwise. 1004 <p> 1005 This method can be called from ANY state but PVAE_STATE_IDLE. Upon completion of this command, pvAuthor Engine will be in PVAE_STATE_OPENED state.<dl compact><dt><b>Parameters: </b></dt><dd> 1006 <table border=0 cellspacing=2 cellpadding=0> 1007 <tr><td valign=top><em>aContextData</em> </td><td> 1008 Optional opaque data to be passed back to user with the command response </td></tr> 1009 </table> 1010 </dl><dl compact><dt><b>Returns: </b></dt><dd> 1011 A unique command id for asynchronous completion </dl> </td> 1012 </tr> 1013 </table> 1014 <a name="a19" doxytag="PVAuthorEngineInterface::Resume"></a><p> 1015 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 1016 <tr> 1017 <td class="md"> 1018 <table cellpadding="0" cellspacing="0" border="0"> 1019 <tr> 1020 <td class="md" nowrap valign="top"> virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> PVAuthorEngineInterface::Resume </td> 1021 <td class="md" valign="top">( </td> 1022 <td class="md" nowrap valign="top">const OsclAny * </td> 1023 <td class="mdname1" valign="top" nowrap> <em>aContextData</em> = NULL </td> 1024 <td class="md" valign="top">) </td> 1025 <td class="md" nowrap><code> [pure virtual]</code></td> 1026 </tr> 1027 1028 </table> 1029 </td> 1030 </tr> 1031 </table> 1032 <table cellspacing=5 cellpadding=0 border=0> 1033 <tr> 1034 <td> 1035 1036 </td> 1037 <td> 1038 1039 <p> 1040 Resume a paused authoring session. 1041 <p> 1042 The authoring session will be resumed and pvAuthor Engine will resume sending encoded output data to the data sinks. This function is valid only in the PVAE_STATE_PAUSED state. 1043 <p> 1044 Upon completion of this command, pvAuthor Engine will be in PVAE_STATE_RECORDING state.<dl compact><dt><b>Parameters: </b></dt><dd> 1045 <table border=0 cellspacing=2 cellpadding=0> 1046 <tr><td valign=top><em>aContextData</em> </td><td> 1047 Optional opaque data to be passed back to user with the command response </td></tr> 1048 </table> 1049 </dl><dl compact><dt><b>Returns: </b></dt><dd> 1050 A unique command id for asynchronous completion </dl> </td> 1051 </tr> 1052 </table> 1053 <a name="a10" doxytag="PVAuthorEngineInterface::SelectComposer"></a><p> 1054 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 1055 <tr> 1056 <td class="md"> 1057 <table cellpadding="0" cellspacing="0" border="0"> 1058 <tr> 1059 <td class="md" nowrap valign="top"> virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> PVAuthorEngineInterface::SelectComposer </td> 1060 <td class="md" valign="top">( </td> 1061 <td class="md" nowrap valign="top">const PVUuid & </td> 1062 <td class="mdname" nowrap> <em>aComposerUuid</em>, </td> 1063 </tr> 1064 <tr> 1065 <td></td> 1066 <td></td> 1067 <td class="md" nowrap>PVInterface *& </td> 1068 <td class="mdname" nowrap> <em>aConfigInterface</em>, </td> 1069 </tr> 1070 <tr> 1071 <td></td> 1072 <td></td> 1073 <td class="md" nowrap>const OsclAny * </td> 1074 <td class="mdname" nowrap> <em>aContextData</em> = NULL</td> 1075 </tr> 1076 <tr> 1077 <td></td> 1078 <td class="md">) </td> 1079 <td class="md" colspan="2"><code> [pure virtual]</code></td> 1080 </tr> 1081 1082 </table> 1083 </td> 1084 </tr> 1085 </table> 1086 <table cellspacing=5 cellpadding=0 border=0> 1087 <tr> 1088 <td> 1089 1090 </td> 1091 <td> 1092 1093 <p> 1094 Selects an output composer by specifying its Uuid. 1095 <p> 1096 pvAuthor engine the composer of the specified Uuid in the authoring session. This command is valid only when pvAuthor Engine is in PVAE_STATE_OPENED state. This command does not change the pvAuthor Engine state. 1097 <p> 1098 Upon completion of this command, opaque data to indentify the selected composer is provided in the callback. The user needs to use this opaque data to identify the composer when calling <a class="el" href="classPVAuthorEngineInterface.html#a11">AddMediaTrack()</a>, <a class="el" href="classPVAuthorEngineInterface.html#a13">AddDataSink()</a>. A configuration interface for the selected composer will be saved to the PVInterface pointer provided in aConfigInterface parameter. User should call queryInterface to query for the configuration interfaces supported by the composer. When configuration is complete or before calling <a class="el" href="classPVAuthorEngineInterface.html#a16">Reset()</a>, user must call removeRef on the PVInterface object to remove its reference to the object.<dl compact><dt><b>Parameters: </b></dt><dd> 1099 <table border=0 cellspacing=2 cellpadding=0> 1100 <tr><td valign=top><em>aComposerUuid</em> </td><td> 1101 Uuid of output composer to be used </td></tr> 1102 <tr><td valign=top><em>aConfigInterface</em> </td><td> 1103 Pointer to configuration object for the selected composer will be saved to this parameter upon completion of this call </td></tr> 1104 <tr><td valign=top><em>aContextData</em> </td><td> 1105 Optional opaque data to be passed back to user with the command response </td></tr> 1106 </table> 1107 </dl><dl compact><dt><b>Returns: </b></dt><dd> 1108 A unique command id for asynchronous completion </dl> </td> 1109 </tr> 1110 </table> 1111 <a name="a9" doxytag="PVAuthorEngineInterface::SelectComposer"></a><p> 1112 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 1113 <tr> 1114 <td class="md"> 1115 <table cellpadding="0" cellspacing="0" border="0"> 1116 <tr> 1117 <td class="md" nowrap valign="top"> virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> PVAuthorEngineInterface::SelectComposer </td> 1118 <td class="md" valign="top">( </td> 1119 <td class="md" nowrap valign="top">const PvmfMimeString & </td> 1120 <td class="mdname" nowrap> <em>aComposerType</em>, </td> 1121 </tr> 1122 <tr> 1123 <td></td> 1124 <td></td> 1125 <td class="md" nowrap>PVInterface *& </td> 1126 <td class="mdname" nowrap> <em>aConfigInterface</em>, </td> 1127 </tr> 1128 <tr> 1129 <td></td> 1130 <td></td> 1131 <td class="md" nowrap>const OsclAny * </td> 1132 <td class="mdname" nowrap> <em>aContextData</em> = NULL</td> 1133 </tr> 1134 <tr> 1135 <td></td> 1136 <td class="md">) </td> 1137 <td class="md" colspan="2"><code> [pure virtual]</code></td> 1138 </tr> 1139 1140 </table> 1141 </td> 1142 </tr> 1143 </table> 1144 <table cellspacing=5 cellpadding=0 border=0> 1145 <tr> 1146 <td> 1147 1148 </td> 1149 <td> 1150 1151 <p> 1152 Selects an output composer by specifying its MIME type. 1153 <p> 1154 pvAuthor engine will use the most suitable output composer of the specified MIME type available in the authoring session. This command is valid only when pvAuthor Engine is in PVAE_STATE_OPENED state. This command does not change the pvAuthor Engine state. 1155 <p> 1156 Upon completion of this command, opaque data to indentify the selected composer is provided in the callback. The user needs to use this opaque data to identify the composer when calling <a class="el" href="classPVAuthorEngineInterface.html#a11">AddMediaTrack()</a>, <a class="el" href="classPVAuthorEngineInterface.html#a13">AddDataSink()</a>. A configuration interface for the selected composer will be saved to the PVInterface pointer provided in aConfigInterface parameter. User should call queryInterface to query for the configuration interfaces supported by the composer. When configuration is complete or before calling <a class="el" href="classPVAuthorEngineInterface.html#a16">Reset()</a>, user must call removeRef on the PVInterface object to remove its reference to the object.<dl compact><dt><b>Parameters: </b></dt><dd> 1157 <table border=0 cellspacing=2 cellpadding=0> 1158 <tr><td valign=top><em>aComposerType</em> </td><td> 1159 MIME type of output composer to be used </td></tr> 1160 <tr><td valign=top><em>aConfigInterface</em> </td><td> 1161 Pointer to configuration object for the selected composer will be saved to this parameter upon completion of this call </td></tr> 1162 <tr><td valign=top><em>aContextData</em> </td><td> 1163 Optional opaque data to be passed back to user with the command response </td></tr> 1164 </table> 1165 </dl><dl compact><dt><b>Returns: </b></dt><dd> 1166 A unique command id for asynchronous completion </dl> </td> 1167 </tr> 1168 </table> 1169 <a name="a1" doxytag="PVAuthorEngineInterface::SetLogAppender"></a><p> 1170 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 1171 <tr> 1172 <td class="md"> 1173 <table cellpadding="0" cellspacing="0" border="0"> 1174 <tr> 1175 <td class="md" nowrap valign="top"> virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> PVAuthorEngineInterface::SetLogAppender </td> 1176 <td class="md" valign="top">( </td> 1177 <td class="md" nowrap valign="top">const char * </td> 1178 <td class="mdname" nowrap> <em>aTag</em>, </td> 1179 </tr> 1180 <tr> 1181 <td></td> 1182 <td></td> 1183 <td class="md" nowrap>PVLoggerAppender & </td> 1184 <td class="mdname" nowrap> <em>aAppender</em>, </td> 1185 </tr> 1186 <tr> 1187 <td></td> 1188 <td></td> 1189 <td class="md" nowrap>const OsclAny * </td> 1190 <td class="mdname" nowrap> <em>aContextData</em> = NULL</td> 1191 </tr> 1192 <tr> 1193 <td></td> 1194 <td class="md">) </td> 1195 <td class="md" colspan="2"><code> [pure virtual]</code></td> 1196 </tr> 1197 1198 </table> 1199 </td> 1200 </tr> 1201 </table> 1202 <table cellspacing=5 cellpadding=0 border=0> 1203 <tr> 1204 <td> 1205 1206 </td> 1207 <td> 1208 1209 <p> 1210 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). Currently this API is NOT SUPPORTED.<dl compact><dt><b>Parameters: </b></dt><dd> 1211 <table border=0 cellspacing=2 cellpadding=0> 1212 <tr><td valign=top><em>aTag</em> </td><td> 1213 Specifies the logger tree tag where the appender should be attached. </td></tr> 1214 <tr><td valign=top><em>aAppender</em> </td><td> 1215 The log appender to attach. </td></tr> 1216 <tr><td valign=top><em>aContextData</em> </td><td> 1217 Optional opaque data that will be passed back to the user with the command response</td></tr> 1218 </table> 1219 </dl><dl compact><dt><b>Exceptions: </b></dt><dd> 1220 <table border=0 cellspacing=2 cellpadding=0> 1221 <tr><td valign=top><em>memory_error</em> </td><td> 1222 leaves on memory allocation error.</td></tr> 1223 </table> 1224 </dl><dl compact><dt><b>Returns: </b></dt><dd> 1225 A unique command id for asynchronous completion </dl> </td> 1226 </tr> 1227 </table> 1228 <a name="a3" doxytag="PVAuthorEngineInterface::SetLogLevel"></a><p> 1229 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 1230 <tr> 1231 <td class="md"> 1232 <table cellpadding="0" cellspacing="0" border="0"> 1233 <tr> 1234 <td class="md" nowrap valign="top"> virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> PVAuthorEngineInterface::SetLogLevel </td> 1235 <td class="md" valign="top">( </td> 1236 <td class="md" nowrap valign="top">const char * </td> 1237 <td class="mdname" nowrap> <em>aTag</em>, </td> 1238 </tr> 1239 <tr> 1240 <td></td> 1241 <td></td> 1242 <td class="md" nowrap>int32 </td> 1243 <td class="mdname" nowrap> <em>aLevel</em>, </td> 1244 </tr> 1245 <tr> 1246 <td></td> 1247 <td></td> 1248 <td class="md" nowrap>bool </td> 1249 <td class="mdname" nowrap> <em>aSetSubtree</em> = false, </td> 1250 </tr> 1251 <tr> 1252 <td></td> 1253 <td></td> 1254 <td class="md" nowrap>const OsclAny * </td> 1255 <td class="mdname" nowrap> <em>aContextData</em> = NULL</td> 1256 </tr> 1257 <tr> 1258 <td></td> 1259 <td class="md">) </td> 1260 <td class="md" colspan="2"><code> [pure virtual]</code></td> 1261 </tr> 1262 1263 </table> 1264 </td> 1265 </tr> 1266 </table> 1267 <table cellspacing=5 cellpadding=0 border=0> 1268 <tr> 1269 <td> 1270 1271 </td> 1272 <td> 1273 1274 <p> 1275 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. Currently this API is NOT SUPPORTED.<dl compact><dt><b>Parameters: </b></dt><dd> 1276 <table border=0 cellspacing=2 cellpadding=0> 1277 <tr><td valign=top><em>aTag</em> </td><td> 1278 Specifies the logger tree tag where the log level should be set. </td></tr> 1279 <tr><td valign=top><em>aLevel</em> </td><td> 1280 Specifies the log level to set. </td></tr> 1281 <tr><td valign=top><em>aSetSubtree</em> </td><td> 1282 Specifies whether the entire subtree with aTag as the root should be reset to the log level. </td></tr> 1283 <tr><td valign=top><em>aContextData</em> </td><td> 1284 Optional opaque data that will be passed back to the user with the command response</td></tr> 1285 </table> 1286 </dl><dl compact><dt><b>Exceptions: </b></dt><dd> 1287 <table border=0 cellspacing=2 cellpadding=0> 1288 <tr><td valign=top><em>memory_error</em> </td><td> 1289 leaves on memory allocation error.</td></tr> 1290 </table> 1291 </dl><dl compact><dt><b>Returns: </b></dt><dd> 1292 A unique command id for asynchronous completion </dl> </td> 1293 </tr> 1294 </table> 1295 <a name="a17" doxytag="PVAuthorEngineInterface::Start"></a><p> 1296 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 1297 <tr> 1298 <td class="md"> 1299 <table cellpadding="0" cellspacing="0" border="0"> 1300 <tr> 1301 <td class="md" nowrap valign="top"> virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> PVAuthorEngineInterface::Start </td> 1302 <td class="md" valign="top">( </td> 1303 <td class="md" nowrap valign="top">const OsclAny * </td> 1304 <td class="mdname1" valign="top" nowrap> <em>aContextData</em> = NULL </td> 1305 <td class="md" valign="top">) </td> 1306 <td class="md" nowrap><code> [pure virtual]</code></td> 1307 </tr> 1308 1309 </table> 1310 </td> 1311 </tr> 1312 </table> 1313 <table cellspacing=5 cellpadding=0 border=0> 1314 <tr> 1315 <td> 1316 1317 </td> 1318 <td> 1319 1320 <p> 1321 Start the authoring session. 1322 <p> 1323 pvAuthor Engine will begin to receive source data, encode them to the specified format and quality, and send the output data to the specified data sinks. This function is valid only in the PVAE_STATE_INITIALIZED state. 1324 <p> 1325 Upon completion of this command, pvAuthor Engine will be in PVAE_STATE_RECORDING state.<dl compact><dt><b>Parameters: </b></dt><dd> 1326 <table border=0 cellspacing=2 cellpadding=0> 1327 <tr><td valign=top><em>aContextData</em> </td><td> 1328 Optional opaque data to be passed back to user with the command response </td></tr> 1329 </table> 1330 </dl><dl compact><dt><b>Returns: </b></dt><dd> 1331 A unique command id for asynchronous completion </dl> </td> 1332 </tr> 1333 </table> 1334 <a name="a20" doxytag="PVAuthorEngineInterface::Stop"></a><p> 1335 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 1336 <tr> 1337 <td class="md"> 1338 <table cellpadding="0" cellspacing="0" border="0"> 1339 <tr> 1340 <td class="md" nowrap valign="top"> virtual <a class="el" href="pv__engine__types_8h.html#a0">PVCommandId</a> PVAuthorEngineInterface::Stop </td> 1341 <td class="md" valign="top">( </td> 1342 <td class="md" nowrap valign="top">const OsclAny * </td> 1343 <td class="mdname1" valign="top" nowrap> <em>aContextData</em> = NULL </td> 1344 <td class="md" valign="top">) </td> 1345 <td class="md" nowrap><code> [pure virtual]</code></td> 1346 </tr> 1347 1348 </table> 1349 </td> 1350 </tr> 1351 </table> 1352 <table cellspacing=5 cellpadding=0 border=0> 1353 <tr> 1354 <td> 1355 1356 </td> 1357 <td> 1358 1359 <p> 1360 Stops an authoring session. 1361 <p> 1362 The authoring session will be stopped and pvAuthor Engine will stop receiving source data from the data sources, and no further encoded data will be sent to the data sinks. This function is valid only in the PVAE_STATE_RECORDING and PVAE_STATE_PAUSED states. 1363 <p> 1364 Upon completion of this command, pvAuthor Engine will be in PVAE_STATE_INITIALIZED state.<dl compact><dt><b>Parameters: </b></dt><dd> 1365 <table border=0 cellspacing=2 cellpadding=0> 1366 <tr><td valign=top><em>aContextData</em> </td><td> 1367 Optional opaque data to be passed back to user with the command response </td></tr> 1368 </table> 1369 </dl><dl compact><dt><b>Returns: </b></dt><dd> 1370 A unique command id for asynchronous completion </dl> </td> 1371 </tr> 1372 </table> 1373 <hr>The documentation for this class was generated from the following file:<ul> 1374 <li><a class="el" href="pvauthorengineinterface_8h-source.html">pvauthorengineinterface.h</a></ul> 1375 <hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>PV Author Engine</small> 1376 <address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small> 1377 </small></address> 1378 </body> 1379 </html> 1380
