doc/pvauthor_html/pvauthorengineinterface_8h.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>pvauthor_engine: pvauthorengineinterface.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>pvauthorengineinterface.h File Reference</h1><code>#include &quot;oscl_base.h&quot;</code><br/>
<code>#include &quot;oscl_string.h&quot;</code><br/>
<code>#include &quot;<a class="el" href="pv__engine__types_8h_source.html">pv_engine_types.h</a>&quot;</code><br/>

<p><a href="pvauthorengineinterface_8h_source.html">Go to the source code of this file.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPVAuthorEngineInterface.html">PVAuthorEngineInterface</a></td></tr>
<tr><td colspan="2"><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="pvauthorengineinterface_8h.html#a26d016a81d853ae9bcc76750700942a3">PVAEState</a> { <br/>
&nbsp;&nbsp;<a class="el" href="pvauthorengineinterface_8h.html#a26d016a81d853ae9bcc76750700942a3a8e77a162d926f72d6f45fc265816e043">PVAE_STATE_IDLE</a> =  0, 
<a class="el" href="pvauthorengineinterface_8h.html#a26d016a81d853ae9bcc76750700942a3ad7071add477ac2fd856bb70f17221280">PVAE_STATE_OPENED</a>, 
<a class="el" href="pvauthorengineinterface_8h.html#a26d016a81d853ae9bcc76750700942a3a08133758dc629ca307b77e1c0ca02137">PVAE_STATE_INITIALIZED</a>, 
<a class="el" href="pvauthorengineinterface_8h.html#a26d016a81d853ae9bcc76750700942a3ab81874ecd6c45924b65c9c888248cfbc">PVAE_STATE_RECORDING</a>, 
<br/>
&nbsp;&nbsp;<a class="el" href="pvauthorengineinterface_8h.html#a26d016a81d853ae9bcc76750700942a3ad41102214aee85cd25daed94c8653ada">PVAE_STATE_PAUSED</a>, 
<a class="el" href="pvauthorengineinterface_8h.html#a26d016a81d853ae9bcc76750700942a3a24d3e2043af495ed4177775612f3121b">PVAE_STATE_ERROR</a>
<br/>
 }</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="pvauthorengineinterface_8h.html#ada5f35f5c036e471936c6d66e2b3f244">PVAEErrorEvent</a> { <a class="el" href="pvauthorengineinterface_8h.html#ada5f35f5c036e471936c6d66e2b3f244a563c6d35a005e13f2d5b779d6795bc2b">PVAE_ENCODE_ERROR</a>
 }</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="pvauthorengineinterface_8h.html#a3184107df8025c4a10157024aefd7b09">PVAEInfoEvent</a> { <a class="el" href="pvauthorengineinterface_8h.html#a3184107df8025c4a10157024aefd7b09abef8d2ebf1bb7959274f5b4419c5ef61">PVAE_OUTPUT_PROGRESS</a>
 }</td></tr>
</table>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="ada5f35f5c036e471936c6d66e2b3f244"></a><!-- doxytag: member="pvauthorengineinterface.h::PVAEErrorEvent" ref="ada5f35f5c036e471936c6d66e2b3f244" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="pvauthorengineinterface_8h.html#ada5f35f5c036e471936c6d66e2b3f244">PVAEErrorEvent</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Enumeration of errors from pvAuthor Engine. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ada5f35f5c036e471936c6d66e2b3f244a563c6d35a005e13f2d5b779d6795bc2b"></a><!-- doxytag: member="PVAE_ENCODE_ERROR" ref="ada5f35f5c036e471936c6d66e2b3f244a563c6d35a005e13f2d5b779d6795bc2b" args="" -->PVAE_ENCODE_ERROR</em>&nbsp;</td><td>
</td></tr>
</table>
</dd>
</dl>

</div>
</div>
<a class="anchor" id="a3184107df8025c4a10157024aefd7b09"></a><!-- doxytag: member="pvauthorengineinterface.h::PVAEInfoEvent" ref="a3184107df8025c4a10157024aefd7b09" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="pvauthorengineinterface_8h.html#a3184107df8025c4a10157024aefd7b09">PVAEInfoEvent</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Enumeration of informational events from pvAuthor Engine. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a3184107df8025c4a10157024aefd7b09abef8d2ebf1bb7959274f5b4419c5ef61"></a><!-- doxytag: member="PVAE_OUTPUT_PROGRESS" ref="a3184107df8025c4a10157024aefd7b09abef8d2ebf1bb7959274f5b4419c5ef61" args="" -->PVAE_OUTPUT_PROGRESS</em>&nbsp;</td><td>
</td></tr>
</table>
</dd>
</dl>

</div>
</div>
<a class="anchor" id="a26d016a81d853ae9bcc76750700942a3"></a><!-- doxytag: member="pvauthorengineinterface.h::PVAEState" ref="a26d016a81d853ae9bcc76750700942a3" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="pvauthorengineinterface_8h.html#a26d016a81d853ae9bcc76750700942a3">PVAEState</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>An enumeration of the major states of the pvAuthor Engine. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a26d016a81d853ae9bcc76750700942a3a8e77a162d926f72d6f45fc265816e043"></a><!-- doxytag: member="PVAE_STATE_IDLE" ref="a26d016a81d853ae9bcc76750700942a3a8e77a162d926f72d6f45fc265816e043" args="" -->PVAE_STATE_IDLE</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a26d016a81d853ae9bcc76750700942a3ad7071add477ac2fd856bb70f17221280"></a><!-- doxytag: member="PVAE_STATE_OPENED" ref="a26d016a81d853ae9bcc76750700942a3ad7071add477ac2fd856bb70f17221280" args="" -->PVAE_STATE_OPENED</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a26d016a81d853ae9bcc76750700942a3a08133758dc629ca307b77e1c0ca02137"></a><!-- doxytag: member="PVAE_STATE_INITIALIZED" ref="a26d016a81d853ae9bcc76750700942a3a08133758dc629ca307b77e1c0ca02137" args="" -->PVAE_STATE_INITIALIZED</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a26d016a81d853ae9bcc76750700942a3ab81874ecd6c45924b65c9c888248cfbc"></a><!-- doxytag: member="PVAE_STATE_RECORDING" ref="a26d016a81d853ae9bcc76750700942a3ab81874ecd6c45924b65c9c888248cfbc" args="" -->PVAE_STATE_RECORDING</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a26d016a81d853ae9bcc76750700942a3ad41102214aee85cd25daed94c8653ada"></a><!-- doxytag: member="PVAE_STATE_PAUSED" ref="a26d016a81d853ae9bcc76750700942a3ad41102214aee85cd25daed94c8653ada" args="" -->PVAE_STATE_PAUSED</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a26d016a81d853ae9bcc76750700942a3a24d3e2043af495ed4177775612f3121b"></a><!-- doxytag: member="PVAE_STATE_ERROR" ref="a26d016a81d853ae9bcc76750700942a3a24d3e2043af495ed4177775612f3121b" args="" -->PVAE_STATE_ERROR</em>&nbsp;</td><td>
</td></tr>
</table>
</dd>
</dl>

</div>
</div>
</div>
<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>PV Author Engine</small>
<address style="align: left;"><small>Posting Version: CORE_9.004.1.1 </small>
</small></address>
</body>
</html>