Commit | Line | Data |
896b04ee |
1 | =pod |
2 | |
3 | |
4 | =head1 NAME |
5 | |
6 | SDL::SMPEG - a SDL perl extension |
7 | |
8 | =head1 SYNOPSIS |
9 | |
10 | $video = new SDL::SMPEG ( -name => 'pr0n.mpg' ); |
11 | |
12 | =head1 DESCRIPTION |
13 | |
14 | C<SDL::SMPEG> adds support for MPEG video to your |
15 | SDL Perl application. SMPEGs are objects bound to |
16 | surfaces, whose playback is controled through the |
17 | object's interface. |
18 | |
19 | =head2 METHODS |
20 | |
21 | |
22 | =over 4 |
23 | |
24 | =item * |
25 | |
26 | C<SDL::SMPEG::error()> returns any error messages associated with playback |
27 | |
28 | =item * |
29 | |
30 | C<SDL::SMPEG::audio(bool)> enables or disables audio playback, (on by default) |
31 | |
32 | =item * |
33 | |
34 | C<SDL::SMPEG::video(bool)> enables or disable video playback, (on by default) |
35 | |
36 | =item * |
37 | |
38 | C<SDL::SMPEG::loop(bool)> enables or disable playback looping (off by default) |
39 | |
40 | =item * |
41 | |
42 | C<SDL::SMPEG::volume(int)> set the volume as per the mixer volume |
43 | |
44 | =item * |
45 | |
46 | C<SDL::SMPEG:display(surface)> binds the clip to a display surface |
47 | |
48 | =item * |
49 | |
50 | C<SDL::SMPEG::scale([x,y]|[surface]|int)> scales the clip by either x,y |
51 | factors, scales to the image dimensions, or a single scalar. |
52 | |
53 | =item * |
54 | |
55 | C<SDL::SMPEG::play()> plays the video clip, call C<SDL::SMPEG::display()> before playing |
56 | |
57 | =item * |
58 | |
59 | C<SDL::SMPEG::pause()> pauses video playback |
60 | |
61 | =item * |
62 | |
63 | C<SDL::SMPEG::stop()> stops video playback |
64 | |
65 | =item * |
66 | |
67 | C<SDL::SMPEG::rewind()> resets the clip to the beginning |
68 | |
69 | =item * |
70 | |
71 | C<SDL::SMPEG::seek(offset)> seeks to a particular byte offset |
72 | |
73 | =item * |
74 | |
75 | C<SDL::SMPEG::skip(time)> skips to a particular time |
76 | |
77 | =item * |
78 | |
79 | C<SDL::SMPEG::region(rect)> takes a SDL::Rect and defines the display area |
80 | |
81 | =item * |
82 | |
83 | C<SDL::SMPEG::frame(int)> renders a specific frame to the screen |
84 | |
85 | =item * |
86 | |
87 | C<SDL::SMPEG::info()> returns a new C<SDL::MPEG> object reflecting the current status |
88 | |
89 | =item * |
90 | |
91 | C<SDL::SMPEG::status()> returns either SMPEG_PLAYING or SMPEG_STOPPED or SMPEG_ERROR |
92 | |
93 | =back |
94 | |
95 | =head1 AUTHOR |
96 | |
97 | David J. Goehrig |
98 | |
99 | =head1 SEE ALSO |
100 | |
101 | perl(1) SDL::Surface(3) SDL::MPEG(3) |
102 | |
103 | =cut |
104 | |