lib/docs/MPEG.pm

   1 =pod
   2
   3
   4 =head1 NAME
   5
   6 SDL::MPEG - a SDL perl extension
   7
   8 =head1 SYNOPSIS
   9
  10   $info = new SDL::MPEG -from => $mpeg;
  11
  12 =head1 DESCRIPTION
  13
  14 C<SDL::MPEG> provides an interface to quering the status
  15 of a SMPEG stream.
  16
  17 =head2 METHODS
  18
  19 =over 4
  20
  21 =item *
  22
  23 C<SDL::MPEG::has_audio> returns true if it has audio track
  24
  25 =item *
  26
  27 C<SDL::MPEG::has_video> returns true if it has a video track
  28
  29 =item *
  30
  31 C<SDL::MPEG::width> returns the width of the video in pixels
  32
  33 =item *
  34
  35 C<SDL::MPEG::height> returns the height of the video in pixels
  36
  37 =item *
  38
  39 C<SDL::MPEG::size> returns the total size of the clip in bytes
  40
  41 =item *
  42
  43 C<SDL::MPEG::offset> returns the offset into the clip in bytes
  44
  45 =item *
  46
  47 C<SDL::MPEG::frame> returns the offset into the clip in fames
  48
  49 =item *
  50
  51 C<SDL::MPEG::fps> returns the play rate in frames per second
  52
  53 =item *
  54
  55 C<SDL::MPEG::time> returns the current play time in seconds
  56
  57 =item *
  58
  59 C<SDL::MPEG::length> returns the total play time in seconds
  60
  61 =back
  62
  63 =head1 AUTHOR
  64
  65 David J. Goehrig
  66
  67 =head1 SEE ALSO
  68
  69 perl(1) SDL::Video(3)
  70
  71 =cut
  72