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

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