/lib/pods/SDL/MPEG.pod

http://github.com/PerlGameDev/SDL · Unknown · 76 lines · 38 code · 38 blank · 0 comment · 0 complexity · 0310d96872778f017a440d8b9256942e MD5 · raw file

  1. =pod
  2. =head1 NAME
  3. SDL::MPEG - a SDL perl extension
  4. =head1 CATEGORY
  5. TODO
  6. =head1 SYNOPSIS
  7. $info = SDL::MPEG->new( -from => $mpeg );
  8. =head1 DESCRIPTION
  9. C<SDL::MPEG> provides an interface to querying the status
  10. of a SMPEG stream.
  11. =head2 METHODS
  12. =over 4
  13. =item *
  14. C<SDL::MPEG::has_audio> returns true if it has audio track
  15. =item *
  16. C<SDL::MPEG::has_video> returns true if it has a video track
  17. =item *
  18. C<SDL::MPEG::width> returns the width of the video in pixels
  19. =item *
  20. C<SDL::MPEG::height> returns the height of the video in pixels
  21. =item *
  22. C<SDL::MPEG::size> returns the total size of the clip in bytes
  23. =item *
  24. C<SDL::MPEG::offset> returns the offset into the clip in bytes
  25. =item *
  26. C<SDL::MPEG::frame> returns the offset into the clip in frames
  27. =item *
  28. C<SDL::MPEG::fps> returns the play rate in frames per second
  29. =item *
  30. C<SDL::MPEG::time> returns the current play time in seconds
  31. =item *
  32. C<SDL::MPEG::length> returns the total play time in seconds
  33. =back
  34. =head1 AUTHOR
  35. David J. Goehrig
  36. =head1 SEE ALSO
  37. perl(1) SDL::Video(3)
  38. =cut