pages/SDL-SMPEG.html-inc

   1 <div class="pod">
   2 <!-- INDEX START -->
   3 <h3 id="TOP">Index</h3>
   4
   5 <ul><li><a href="#NAME">NAME</a></li>
   6 <li><a href="#SYNOPSIS">SYNOPSIS</a></li>
   7 <li><a href="#DESCRIPTION">DESCRIPTION</a>
   8 <ul><li><a href="#METHODS">METHODS </a></li>
   9 </ul>
  10 </li>
  11 <li><a href="#AUTHOR">AUTHOR</a></li>
  12 <li><a href="#SEE_ALSO">SEE ALSO</a>
  13 </li>
  14 </ul><hr />
  15 <!-- INDEX END -->
  16
  17
  18
  19
  20
  21 <h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
  22 <div id="NAME_CONTENT">
  23 <p>SDL::SMPEG - a SDL perl extension</p>
  24
  25 </div>
  26 <h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>
  27 <div id="SYNOPSIS_CONTENT">
  28 <pre>  $video = SDL::SMPEG-&gt;new( -name =&gt; 'pr0n.mpg' );
  29
  30 </pre>
  31
  32 </div>
  33 <h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p>
  34 <div id="DESCRIPTION_CONTENT">
  35 <p><code>SDL::SMPEG</code> adds support for MPEG video to your
  36 SDL Perl application.  SMPEGs are objects bound to
  37 surfaces, whose playback is controled through the
  38 object's interface.</p>
  39
  40 </div>
  41 <h2 id="METHODS">METHODS </h2>
  42 <div id="METHODS_CONTENT">
  43
  44
  45
  46
  47 <ul>
  48                 <li><code>SDL::SMPEG::error()</code> returns any error messages associated with playback        </li>
  49                 <li><code>SDL::SMPEG::audio(bool)</code> enables or disables audio playback, (on by default)    </li>
  50                 <li><code>SDL::SMPEG::video(bool)</code> enables or disable video playback, (on by default)     </li>
  51                 <li><code>SDL::SMPEG::loop(bool)</code> enables or disable playback looping (off by default)    </li>
  52                 <li><code>SDL::SMPEG::volume(int)</code> set the volume as per the mixer volume </li>
  53                 <li><code>SDL::SMPEG:display(surface)</code> binds the clip to a display surface        </li>
  54                 <li><code>SDL::SMPEG::scale([x,y]|[surface]|int)</code> scales the clip by either x,y
  55 factors, scales to the image dimensions, or a single scalar.    </li>
  56                 <li><code>SDL::SMPEG::play()</code> plays the video clip, call <code>SDL::SMPEG::display()</code> before playing        </li>
  57                 <li><code>SDL::SMPEG::pause()</code> pauses video playback      </li>
  58                 <li><code>SDL::SMPEG::stop()</code> stops video playback        </li>
  59                 <li><code>SDL::SMPEG::rewind()</code> resets the clip to the beginning  </li>
  60                 <li><code>SDL::SMPEG::seek(offset)</code> seeks to a particular byte offset     </li>
  61                 <li><code>SDL::SMPEG::skip(time)</code> skips to a particular time      </li>
  62                 <li><code>SDL::SMPEG::region(rect)</code> takes a SDL::Rect and defines the display area        </li>
  63                 <li><code>SDL::SMPEG::frame(int)</code> renders a specific frame to the screen  </li>
  64                 <li><code>SDL::SMPEG::info()</code> returns a new <code>SDL::MPEG</code> object reflecting the current status   </li>
  65                 <li><code>SDL::SMPEG::status()</code> returns either SMPEG_PLAYING or SMPEG_STOPPED or SMPEG_ERROR</li>
  66 </ul>
  67
  68
  69 </div>
  70 <h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p>
  71 <div id="AUTHOR_CONTENT">
  72 <p>David J. Goehrig</p>
  73
  74 </div>
  75 <h1 id="SEE_ALSO">SEE ALSO</h1><p><a href="#TOP" class="toplink">Top</a></p>
  76 <div id="SEE_ALSO_CONTENT">
  77 <p>perl(1) SDL::Surface(3) SDL::MPEG(3)</p>
  78
  79 </div>
  80 </div>