Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 3295

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!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>Crystal Space 1.2.1: iMovieRecorder Struct Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
 <tr height="59">
  <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
  <td class="head"><h2>Public API Reference</h2></td>
 </tr>
 <tr height="11">
  <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
 </tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</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="pages.html"><span>Related&nbsp;Pages</span></a></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="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul>
</div>
<h1>iMovieRecorder Struct Reference</h1><!-- doxytag: class="iMovieRecorder" --><!-- doxytag: inherits="iBase" -->Using this interface you can communicate with the MovieRecorder plugin.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="movierecorder_8h-source.html">ivaria/movierecorder.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for iMovieRecorder:</div>
<div class="dynsection">
<p><center><img src="structiMovieRecorder__inherit__graph.png" border="0" usemap="#iMovieRecorder__inherit__map" alt="Inheritance graph"></center>
<map name="iMovieRecorder__inherit__map">
<area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="37,7,93,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="structiMovieRecorder-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">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiMovieRecorder.html#41ab94d67f113b95ff73846324768895">IsPaused</a> (void) const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Is the recording paused?  <a href="#41ab94d67f113b95ff73846324768895"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiMovieRecorder.html#4feec5d077c0da9e3aaa5f7628f1a285">IsRecording</a> (void) const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Are we recording?  <a href="#4feec5d077c0da9e3aaa5f7628f1a285"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiMovieRecorder.html#cff97abca33b50e2f32e97fdfc2f024f">Pause</a> (void)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Pause an in-progress recording.  <a href="#cff97abca33b50e2f32e97fdfc2f024f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiMovieRecorder.html#8f9780f1cd6efbc2dc60b8833483c9e7">Start</a> (void)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Start recording using the settings in the configuration system.  <a href="#8f9780f1cd6efbc2dc60b8833483c9e7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiMovieRecorder.html#2a07e9cf7924010f4c444beab60fbbe1">Stop</a> (void)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stop recording if a recording is in progress.  <a href="#2a07e9cf7924010f4c444beab60fbbe1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiMovieRecorder.html#89ef895396758d3b997010459a1b686f">UnPause</a> (void)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Resume an in-progress recording.  <a href="#89ef895396758d3b997010459a1b686f"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Using this interface you can communicate with the MovieRecorder plugin. 
<p>
This allows changing or disabling the hotkey bindings, changing the video parameters, and programmatically starting and stopping the recorder. <dl class="remark" compact><dt><b>Remarks:</b></dt><dd>The plugin is GPL, not LGPL. </dd></dl>

<p>Definition at line <a class="el" href="movierecorder_8h-source.html#l00039">39</a> of file <a class="el" href="movierecorder_8h-source.html">movierecorder.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="41ab94d67f113b95ff73846324768895"></a><!-- doxytag: member="iMovieRecorder::IsPaused" ref="41ab94d67f113b95ff73846324768895" args="(void) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool iMovieRecorder::IsPaused           </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Is the recording paused? 
<p>

</div>
</div><p>
<a class="anchor" name="4feec5d077c0da9e3aaa5f7628f1a285"></a><!-- doxytag: member="iMovieRecorder::IsRecording" ref="4feec5d077c0da9e3aaa5f7628f1a285" args="(void) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool iMovieRecorder::IsRecording           </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Are we recording? 
<p>

</div>
</div><p>
<a class="anchor" name="cff97abca33b50e2f32e97fdfc2f024f"></a><!-- doxytag: member="iMovieRecorder::Pause" ref="cff97abca33b50e2f32e97fdfc2f024f" args="(void)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iMovieRecorder::Pause           </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Pause an in-progress recording. 
<p>

</div>
</div><p>
<a class="anchor" name="8f9780f1cd6efbc2dc60b8833483c9e7"></a><!-- doxytag: member="iMovieRecorder::Start" ref="8f9780f1cd6efbc2dc60b8833483c9e7" args="(void)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iMovieRecorder::Start           </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Start recording using the settings in the configuration system. 
<p>

</div>
</div><p>
<a class="anchor" name="2a07e9cf7924010f4c444beab60fbbe1"></a><!-- doxytag: member="iMovieRecorder::Stop" ref="2a07e9cf7924010f4c444beab60fbbe1" args="(void)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iMovieRecorder::Stop           </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Stop recording if a recording is in progress. 
<p>

</div>
</div><p>
<a class="anchor" name="89ef895396758d3b997010459a1b686f"></a><!-- doxytag: member="iMovieRecorder::UnPause" ref="89ef895396758d3b997010459a1b686f" args="(void)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iMovieRecorder::UnPause           </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Resume an in-progress recording. 
<p>

</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>ivaria/<a class="el" href="movierecorder_8h-source.html">movierecorder.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by 
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 
</small></address> </div></body> </html>