.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "pods::SDL::SMPEG 3pm"
.TH pods::SDL::SMPEG 3pm 2024-01-10 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
SDL::SMPEG \- a SDL perl extension
.SH CATEGORY
.IX Header "CATEGORY"
TODO
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  $video = SDL::SMPEG\->new( \-name => \*(Aqpr0n.mpg\*(Aq );
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\f(CW\*(C`SDL::SMPEG\*(C'\fR adds support for MPEG video to your
SDL Perl application.  SMPEGs are objects bound to
surfaces, whose playback is controlled through the
object's interface.
.SS METHODS
.IX Subsection "METHODS"
.IP \(bu 4
\&\f(CWSDL::SMPEG::error()\fR returns any error messages associated with playback
.IP \(bu 4
\&\f(CWSDL::SMPEG::audio(bool)\fR enables or disables audio playback, (on by default)
.IP \(bu 4
\&\f(CWSDL::SMPEG::video(bool)\fR enables or disable video playback, (on by default)
.IP \(bu 4
\&\f(CWSDL::SMPEG::loop(bool)\fR enables or disable playback looping (off by default)
.IP \(bu 4
\&\f(CWSDL::SMPEG::volume(int)\fR set the volume as per the mixer volume
.IP \(bu 4
\&\f(CWSDL::SMPEG:display(surface)\fR binds the clip to a display surface
.IP \(bu 4
\&\f(CW\*(C`SDL::SMPEG::scale([x,y]|[surface]|int)\*(C'\fR scales the clip by either x,y
factors, scales to the image dimensions, or a single scalar.
.IP \(bu 4
\&\f(CWSDL::SMPEG::play()\fR plays the video clip, call \f(CWSDL::SMPEG::display()\fR before playing
.IP \(bu 4
\&\f(CWSDL::SMPEG::pause()\fR pauses video playback
.IP \(bu 4
\&\f(CWSDL::SMPEG::stop()\fR stops video playback
.IP \(bu 4
\&\f(CWSDL::SMPEG::rewind()\fR resets the clip to the beginning
.IP \(bu 4
\&\f(CWSDL::SMPEG::seek(offset)\fR seeks to a particular byte offset
.IP \(bu 4
\&\f(CWSDL::SMPEG::skip(time)\fR skips to a particular time
.IP \(bu 4
\&\f(CWSDL::SMPEG::region(rect)\fR takes a SDL::Rect and defines the display area
.IP \(bu 4
\&\f(CWSDL::SMPEG::frame(int)\fR renders a specific frame to the screen
.IP \(bu 4
\&\f(CWSDL::SMPEG::info()\fR returns a new \f(CW\*(C`SDL::MPEG\*(C'\fR object reflecting the current status
.IP \(bu 4
\&\f(CWSDL::SMPEG::status()\fR returns either SMPEG_PLAYING or SMPEG_STOPPED or SMPEG_ERROR
.SH AUTHOR
.IX Header "AUTHOR"
David J. Goehrig
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBperl\fR\|(1) \fBSDL::Surface\fR\|(3) \fBSDL::MPEG\fR\|(3)