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