Applied Magnet's Patch

[sdlgit/SDL_perl.git] / lib / docs / Cdrom.pod

diff --git a/lib/docs/Cdrom.pod b/lib/docs/Cdrom.pod
new file mode 100644 (file)
index 0000000..e6582bc
--- /dev/null
+++ b/lib/docs/Cdrom.pod
@@ -0,0 +1,96 @@
+=pod
+
+
+
+=head1 NAME
+
+SDL::Cdrom - a SDL perl extension for managing CD-ROM drives
+
+=head1 SYNOPSIS
+
+       use SDL::Cdrom;
+       $cdrom = SDL::Cdrom->new(0);
+       $cdrom->play();
+
+=head1 EXPORTS
+
+=over 4
+
+=item *
+
+C<cd_num_drives>.
+
+=back
+
+=head1 DESCRIPTION
+
+Create a new SDL::Cdrom object. The passed $id is the number of the drive,
+whereas 0 is the first drive etc.
+       
+       use SDL::Cdrom;
+       my $drive => SDL::Cdrom->new($id);
+
+=head1 METHODS
+
+=head2 cd_num_drives()
+
+Returns the number of CD-ROM drives present.
+
+=head2 name()
+
+Returns the system dependent name of the CD-ROM device.
+
+=head2 status()
+
+Return the status of the drive.
+
+=head2 play()
+
+Play a track.
+
+=head2 pause()
+
+Pause the playing.
+
+=head2 resume()
+
+Resume the playing.
+
+=head2 stop()
+
+Stop the playing.
+
+=head2 eject()
+
+Eject the medium in the drive.
+
+=head2 id()
+
+Return the ID of the drive.
+
+=head2 num_tracks()
+
+Return the number of tracks on the medium.
+
+=head2 track()
+
+Returns the track description
+
+=head2 current()
+
+Return the current played track number.
+
+=head2 current_frame()
+
+Return the current frame.
+
+=head1 AUTHORS
+
+David J. Goehrig
+Documentation by Tels <http://bloodgate.com/>.
+
+=head1 SEE ALSO
+
+L<perl> L<SDL::Mixer> L<SDL::App>.
+
+=cut