<HTML>
	<HEAD>
    	<TITLE>Adobe ExtendScript Toolkit</TITLE>
		<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
		<LINK HREF="adobe.css" REL="stylesheet" TYPE="text/css">
        <LINK HREF="tabs.css" REL="stylesheet" TYPE="text/css">
 	</HEAD>
	<BODY> 
    <div class="header"><a href="http://www.adobe.com"><img src="adobelogo.jpg" alt="http://www.adobe.com"></a>&nbsp;<b>ExtendScript ToolKit</b></div>
<!-- Generated by Doxygen 1.5.5 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li class="current"><a href="classes.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    <li>
      <form action="search.php" method="get">
        <table cellspacing="0" cellpadding="0" border="0">
          <tr>
            <td><label>&nbsp;<u>S</u>earch&nbsp;for&nbsp;</label></td>
            <td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
          </tr>
        </table>
      </form>
    </li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>UsingFlashPlayer Class Reference</h1><!-- doxytag: class="UsingFlashPlayer" -->
<h4>Usage</h4>
	
  <ol>
  <li>Run the snippet in the ExtendScript Toolkit (see Readme.txt).
  <li>You should see a dialog window showing a Flash movie.
   <li> Press the 'Stop' button to stop the movie
   <li> Press the 'Start' button to continue the movie
  </ol>
 
 <h4>Description</h4>
 
 <p>Creates a dialog window that plays a Flash movie.

 <p>The dialog contains ScriptUI components, including control buttons and a FlashPlayer element.<br />

 <p>Loads the Flash movie, an SWF file, into the FlashPlayer component using control's loadMovie() function.
 The 'file' parameter must be a valid ExtendScript File object that references any type of Flash file. 

 <p>Start and stop buttons in the palette control playback using the FlashPlayer control's
 stopMovie() and 'playMovie() methods. Stop pauses the move, and Start restarts it
 from the point at which it paused.
 
 <p>See the JavaScript Tools Guide for details of when you can call the stopMovie() and playMove() functions.<br />
<p>
<a href="classUsingFlashPlayer-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUsingFlashPlayer.html#726980a99643a7e7f24d30da36bb92c1">UsingFlashPlayer</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">Boolean&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUsingFlashPlayer.html#9969f1776a8744d7fe5115b6bcaf24d1">run</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Functional part of this snippet.  <a href="#9969f1776a8744d7fe5115b6bcaf24d1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">Boolean&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUsingFlashPlayer.html#6bf66b861f97b45365cf7e754be4c996">canRun</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Determines whether snippet can be run given current context.  <a href="#6bf66b861f97b45365cf7e754be4c996"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">File&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUsingFlashPlayer.html#4d7181f2592da6c1d8601fcea59ed7d2">flashFile</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The Flash movie to load into the dialog window.  <a href="#4d7181f2592da6c1d8601fcea59ed7d2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">String&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUsingFlashPlayer.html#9787033a17c37caee1bf3e6680500c46">requiredContext</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The context in which this snippet can run.  <a href="#9787033a17c37caee1bf3e6680500c46"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUsingFlashPlayer.html#0d830f3b4896fae4072441d0c80b5371">paletteRef</a></td></tr>

</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="726980a99643a7e7f24d30da36bb92c1"></a><!-- doxytag: member="UsingFlashPlayer::UsingFlashPlayer" ref="726980a99643a7e7f24d30da36bb92c1" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void UsingFlashPlayer::UsingFlashPlayer           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="9969f1776a8744d7fe5115b6bcaf24d1"></a><!-- doxytag: member="UsingFlashPlayer::run" ref="9969f1776a8744d7fe5115b6bcaf24d1" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Boolean UsingFlashPlayer::run           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Functional part of this snippet. 
<p>
Creates a dialog window and adds the ScriptUI components to it. Creates event handlers for the buttons that control the playback. <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the snippet ran as expected, false otherwise </dd></dl>

</div>
</div><p>
<a class="anchor" name="6bf66b861f97b45365cf7e754be4c996"></a><!-- doxytag: member="UsingFlashPlayer::canRun" ref="6bf66b861f97b45365cf7e754be4c996" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Boolean UsingFlashPlayer::canRun           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Determines whether snippet can be run given current context. 
<p>
The snippet fails if these preconditions are not met: <ul>
<li>
The SWF file must exist in the file system. </li>
</ul>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True is this snippet can run, false otherwise </dd></dl>

</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="4d7181f2592da6c1d8601fcea59ed7d2"></a><!-- doxytag: member="UsingFlashPlayer::flashFile" ref="4d7181f2592da6c1d8601fcea59ed7d2" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">File <a class="el" href="classUsingFlashPlayer.html#4d7181f2592da6c1d8601fcea59ed7d2">UsingFlashPlayer::flashFile</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The Flash movie to load into the dialog window. 
<p>

</div>
</div><p>
<a class="anchor" name="9787033a17c37caee1bf3e6680500c46"></a><!-- doxytag: member="UsingFlashPlayer::requiredContext" ref="9787033a17c37caee1bf3e6680500c46" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">String <a class="el" href="classUsingFlashPlayer.html#9787033a17c37caee1bf3e6680500c46">UsingFlashPlayer::requiredContext</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The context in which this snippet can run. 
<p>

</div>
</div><p>
<a class="anchor" name="0d830f3b4896fae4072441d0c80b5371"></a><!-- doxytag: member="UsingFlashPlayer::paletteRef" ref="0d830f3b4896fae4072441d0c80b5371" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="classUsingFlashPlayer.html#0d830f3b4896fae4072441d0c80b5371">UsingFlashPlayer::paletteRef</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="UsingFlashPlayer_8jsx.html">UsingFlashPlayer.jsx</a></ul>
</div>
<p><img src="1ptrans.gif" /><p>
<p><img src="1ptrans.gif"  /></p>
<p><img src="asn.gif" width="114" height="45" border="0" alt="Adobe Solutions Network">Copyright&#169; 2008 Adobe Systems Incorporated. All rights reserved.</p>
<p>
    	<a href="http://www.adobe.com/misc/copyright.html">Terms of Use</a>&nbsp;
        <a href="http://www.adobe.com/misc/privacy.html">Online Privacy Policy</a>&nbsp;
        <a href="http://access.adobe.com">Adobe and accessibility</a>&nbsp;
        <a href="http://www.adobe.com/aboutadobe/antipiracy/main.html">Avoid software piracy</a>&nbsp;
        <a href="http://www.adobe.com/misc/agreement.html">Permissions and Trademarks</a>
</p>
</body>
</html>
