blob: 9d47085c3cdfcaf93943dddd83860e5eb3481591 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>pvauthorengineinterface.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.18 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="annotated.html">Data Structures</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Data Fields</a> &nbsp; <a class="qindex" href="globals.html">Globals</a> &nbsp; </center>
<hr><h1>pvauthorengineinterface.h File Reference</h1><code>#include "oscl_base.h"</code><br>
<code>#include "oscl_string.h"</code><br>
<code>#include "<a class="el" href="pv__engine__types_8h-source.html">pv_engine_types.h</a>"</code><br>
<p>
<a href="pvauthorengineinterface_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Data Structures</h2></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classPVAuthorEngineInterface.html">PVAuthorEngineInterface</a></td></tr>
<tr><td colspan=2><br><h2>Enumerations</h2></td></tr>
<tr><td nowrap align=right valign=top>enum &nbsp;</td><td valign=bottom><a class="el" href="pvauthorengineinterface_8h.html#a8">PVAEState</a> { <br>
&nbsp;&nbsp;<a class="el" href="pvauthorengineinterface_8h.html#a8a0">PVAE_STATE_IDLE</a> = 0,
<a class="el" href="pvauthorengineinterface_8h.html#a8a1">PVAE_STATE_OPENED</a>,
<a class="el" href="pvauthorengineinterface_8h.html#a8a2">PVAE_STATE_INITIALIZED</a>,
<a class="el" href="pvauthorengineinterface_8h.html#a8a3">PVAE_STATE_RECORDING</a>,
<br>
&nbsp;&nbsp;<a class="el" href="pvauthorengineinterface_8h.html#a8a4">PVAE_STATE_PAUSED</a>,
<a class="el" href="pvauthorengineinterface_8h.html#a8a5">PVAE_STATE_ERROR</a>
<br>
}</td></tr>
<tr><td nowrap align=right valign=top>enum &nbsp;</td><td valign=bottom><a class="el" href="pvauthorengineinterface_8h.html#a9">PVAEErrorEvent</a> { <a class="el" href="pvauthorengineinterface_8h.html#a9a6">PVAE_ENCODE_ERROR</a>
}</td></tr>
<tr><td nowrap align=right valign=top>enum &nbsp;</td><td valign=bottom><a class="el" href="pvauthorengineinterface_8h.html#a10">PVAEInfoEvent</a> { <a class="el" href="pvauthorengineinterface_8h.html#a10a7">PVAE_OUTPUT_PROGRESS</a>
}</td></tr>
</table>
<hr><h2>Enumeration Type Documentation</h2>
<a name="a9" doxytag="pvauthorengineinterface.h::PVAEErrorEvent"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> enum PVAEErrorEvent
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Enumeration of errors from pvAuthor Engine. <dl compact><dt><b>Enumeration values: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a name="a9a6" doxytag="PVAE_ENCODE_ERROR"></a><em>PVAE_ENCODE_ERROR</em></em>&nbsp;</td><td>
</td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a10" doxytag="pvauthorengineinterface.h::PVAEInfoEvent"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> enum PVAEInfoEvent
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Enumeration of informational events from pvAuthor Engine. <dl compact><dt><b>Enumeration values: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a name="a10a7" doxytag="PVAE_OUTPUT_PROGRESS"></a><em>PVAE_OUTPUT_PROGRESS</em></em>&nbsp;</td><td>
</td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a8" doxytag="pvauthorengineinterface.h::PVAEState"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> enum PVAEState
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
An enumeration of the major states of the pvAuthor Engine. <dl compact><dt><b>Enumeration values: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a name="a8a0" doxytag="PVAE_STATE_IDLE"></a><em>PVAE_STATE_IDLE</em></em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a name="a8a1" doxytag="PVAE_STATE_OPENED"></a><em>PVAE_STATE_OPENED</em></em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a name="a8a2" doxytag="PVAE_STATE_INITIALIZED"></a><em>PVAE_STATE_INITIALIZED</em></em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a name="a8a3" doxytag="PVAE_STATE_RECORDING"></a><em>PVAE_STATE_RECORDING</em></em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a name="a8a4" doxytag="PVAE_STATE_PAUSED"></a><em>PVAE_STATE_PAUSED</em></em>&nbsp;</td><td>
</td></tr>
<tr><td valign=top><em><a name="a8a5" doxytag="PVAE_STATE_ERROR"></a><em>PVAE_STATE_ERROR</em></em>&nbsp;</td><td>
</td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>PV Author Engine</small>
<address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small>
</small></address>
</body>
</html>