lib/pods/SDL/Cdrom.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SDL::Cdrom - a SDL perl extension for managing CD-ROM drives
   6
   7 =head1 SYNOPSIS
   8
   9         use SDL::Cdrom;
  10         $cdrom = SDL::Cdrom->new(0);
  11         $cdrom->play();
  12
  13 =head1 EXPORTS
  14
  15 =over 4
  16
  17 =item *
  18
  19 C<cd_num_drives>.
  20
  21 =back
  22
  23 =head1 DESCRIPTION
  24
  25 Create a new SDL::Cdrom object. The passed $id is the number of the drive,
  26 whereas 0 is the first drive etc.
  27
  28         use SDL::Cdrom;
  29         my $drive => SDL::Cdrom->new($id);
  30
  31 =head1 METHODS
  32
  33 =head2 cd_num_drives()
  34
  35 Returns the number of CD-ROM drives present.
  36
  37 =head2 name(cd)
  38
  39 Returns the system dependent name of the CD-ROM device.
  40 It takes a SDL::Cdrom as first parameter.
  41
  42 =head2 status(cd)
  43
  44 Return the status of the drive.
  45 It takes a SDL::Cdrom as first parameter.
  46
  47 =head2 play(cd,start,length,fs,fl)
  48
  49 Play a track from the SDL::Cdrom given as first parameter, second parameter is the frame to start, the third is the lenght to play.
  50 It returns 1 on succés 0 on error.
  51
  52 =head2 pause(cd)
  53
  54 Pause the playing of the SDL::Cdrom given as first parameter.
  55 It returns 1 on succés 0 on error.
  56
  57 =head2 resume(cd)
  58
  59 Resume the playing of the SDL::Cdrom given as first parameter.
  60 It returns 1 on succés 0 on error.
  61
  62 =head2 stop(cd)
  63
  64 Stop the playing of the SDL::Cdrom given as first parameter.
  65 It returns 1 on succés 0 on error.
  66
  67 =head2 eject(cd)
  68
  69 Eject the medium in the SDL::Cdrom given as first parameter.
  70 It returns 1 on succés 0 on error.
  71
  72 =head2 id(cd)
  73
  74 Return the ID of the drive given as first parameter.
  75
  76 =head2 num_tracks(cd)
  77
  78 Return the number of tracks on the SDL::Cdrom given as first parameter.
  79
  80 =head2 track(cd,number)
  81
  82 Returns the track description of the track given as second parameter.
  83 the first parameter is a SDL:Cdrom.
  84
  85 =head2 current(cd)
  86
  87 Return the current played track number given as first parameter.
  88
  89 =head2 current_frame(cd)
  90
  91 Return the current frame given as first parameter.
  92
  93 =head1 AUTHORS
  94
  95 David J. Goehrig
  96 Documentation by Tels <http://bloodgate.com/>.
  97
  98 =head1 SEE ALSO
  99
 100 L<perl> L<SDL::Mixer> L<SDL::App>.
 101
 102 =cut