Fixed the pod path in archive

[sdlgit/SDL_perl.git] / lib / pods / SDL / MPEG.pod

diff --git a/lib/pods/SDL/MPEG.pod b/lib/pods/SDL/MPEG.pod
new file mode 100644 (file)
index 0000000..db2c8c8
--- /dev/null
+++ b/lib/pods/SDL/MPEG.pod
@@ -0,0 +1,71 @@
+=pod
+
+=head1 NAME
+
+SDL::MPEG - a SDL perl extension
+
+=head1 SYNOPSIS
+
+  $info = new SDL::MPEG -from => $mpeg;
+
+=head1 DESCRIPTION
+
+C<SDL::MPEG> provides an interface to quering the status
+of a SMPEG stream.  
+
+=head2 METHODS 
+
+=over 4
+
+=item *
+
+C<SDL::MPEG::has_audio> returns true if it has audio track
+
+=item *
+
+C<SDL::MPEG::has_video> returns true if it has a video track
+
+=item *
+
+C<SDL::MPEG::width> returns the width of the video in pixels
+
+=item *
+
+C<SDL::MPEG::height> returns the height of the video in pixels
+
+=item *
+
+C<SDL::MPEG::size> returns the total size of the clip in bytes
+
+=item *
+
+C<SDL::MPEG::offset> returns the offset into the clip in bytes
+
+=item *
+
+C<SDL::MPEG::frame> returns the offset into the clip in fames 
+
+=item *
+
+C<SDL::MPEG::fps> returns the play rate in frames per second
+
+=item *
+
+C<SDL::MPEG::time> returns the current play time in seconds
+
+=item *
+
+C<SDL::MPEG::length> returns the total play time in seconds
+
+=back
+
+=head1 AUTHOR
+
+David J. Goehrig
+
+=head1 SEE ALSO
+
+perl(1) SDL::Video(3)
+
+=cut
+