lib/docs/MPEG.pod

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