1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 6.5.0.0 for Windows">
7<META http-equiv="Content-Style-Type" content="text/css">
8<LINK rel="stylesheet" type="text/css" href="../../CSS/revolution.css">
9<title>THPPlayerGetState</title>
10</head>
11
12<body>
13
14<h1>THPPlayerGetState</h1>
15
16<h2>Syntax</h2>
17<dl><dd><pre class="construction">
18#include &quot;THPPlayer.h&quot;
19
20s32 THPPlayerGetState(void);
21</pre></dd></dl>
22
23<h2>Arguments</h2>
24<p>None.</p>
25
26<h2>Return Values</h2>
27<p>Returns the current player status.</p>
28
29<TABLE class="arguments" border="1" >
30  <tbody>
31    <tr ALIGN="center">
32<td bgcolor="#CCCCCC">Status</td>
33<td bgcolor="#CCCCCC" width=50>Value</td>
34<td bgcolor="#CCCCCC">Description</td>
35    </tr>
36    <tr>
37<th>THP_PLAYER_STOP</th>
38      <td align="center">0</td>
39<td>The player is paused.</td>
40    </tr>
41    <tr>
42<th>THP_PLAYER_PREPARE</th>
43      <td align="center">1</td>
44<td>Finished movie playback preparation.</td>
45    </tr>
46    <tr>
47<th>THP_PLAYER_PLAY</th>
48      <td align="center">2</td>
49<td>Movie is being played.</td>
50    </tr>
51    <tr>
52<th>THP_PLAYER_PLAYED</th>
53      <td align="center">3</td>
54<td>Played movie to the end. <br>(Indicates that playback reached the end, when using one-shot playback.)</td>
55    </tr>
56    <tr>
57<th>THP_PLAYER_PAUSE</th>
58      <td align="center">4</td>
59<td>Movie is being paused.</td>
60    </tr>
61    <tr>
62<th>THP_PLAYER_ERROR</th>
63      <td align="center">5</td>
64<td>An error occurred.</td>
65    </tr>
66  </tbody>
67</table>
68
69<H2>Description</H2>
70<p>The <code>THPPlayerGetState</code> function gets the current player status.</p>
71
72<p>If the ERROR status is received, please call the <a href="THPPlayerStop.html"><code>THPPlayerStop</code></a> and <a href="THPPlayerClose.html"><code>THPPlayerClose</code></a> functions to end playback of the THP movie data.</p>
73
74<H2>See Also</H2>
75<P class="reference">
76<a href="THPPlayerStop.html">THPPlayerStop</a>,
77<a href="THPPlayerClose.html">THPPlayerClose</a>
78</P>
79
80<H2>Revision History</H2>
81<P>
822006/03/01 Initial version.<br>
83</P>
84
85<hr><p>CONFIDENTIAL</p></body>
86</html>
87