.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "pods::SDL::CD 3pm"
.TH pods::SDL::CD 3pm 2024-01-10 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
SDL::CD \-\- SDL Bindings for structure SDL_CD
.SH CATEGORY
.IX Header "CATEGORY"
Core, CDROM, Structure
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 3
\& use SDL;
\& use SDL::CDROM;
\& use SDL::CD;
\&
\& SDL::init(SDL_INIT_CDROM);
\&
\& my $drives = SDL::CDROM::num_drives;
\& 
\& if( $drives > 0 )
\& {
\&  my $CD = SDL::CD\->new( 0 );
\& 
\&   if($CD)
\&   {
\&        ... 
\&   }
\&  
\& }
.Ve
.SH CONSTANTS
.IX Header "CONSTANTS"
The constants are exported by default. You can avoid this by doing:
.PP
.Vb 1
\& use SDL::CD ();
.Ve
.PP
and access them directly:
.PP
.Vb 1
\& SDL::CD::CD_TRAYEMPTY;
.Ve
.PP
or by choosing the export tags below:
.PP
Export tag: ':status'
.PP
.Vb 5
\& CD_TRAYEMPTY
\& CD_STOPPED
\& CD_PLAYING
\& CD_PAUSED
\& CD_ERROR
.Ve
.PP
Export tag: ':defaults'
.PP
.Vb 2
\& CD_FPS
\& SDL_MAX_TRACKS
.Ve
.SH METHOD
.IX Header "METHOD"
.SS new
.IX Subsection "new"
.Vb 1
\& my $CD = SDL::CD\->new($drive)
.Ve
.PP
Makes a new SDL::CD object. Returns \f(CW\*(C`undef\*(C'\fR if the drive is busy or inaccessible.
.SS status
.IX Subsection "status"
.Vb 1
\& my $status = $CD\->status();
.Ve
.PP
Returns the current status of the CD tray
.PP
Returns on of the following constants:
.IP \(bu 4
CD_TRAYEMPTY
.IP \(bu 4
CD_STOPPED
.IP \(bu 4
CD_PLAYING
.IP \(bu 4
CD_PAUSED
.IP \(bu 4
CD_ERROR
.SS play_tracks
.IX Subsection "play_tracks"
.Vb 1
\& $CD\->play_tracks($start_track, $start_frame, $ntracks, $nframes)
.Ve
.PP
Plays the given SDL::CD starting at track \f(CW$start_track\fR, for \f(CW$ntracks\fR tracks.
.PP
\&\f(CW$start_frame\fR is the frame offset, from the beginning of the \f(CW$start_track\fR, at which to start. \f(CW$nframes\fR is the frame offset, from the 
beginning of the last track ($start_track+$ntracks), at which to end playing.
.PP
\&\fBplay_tracks()\fR should only be called after calling "status" to get information about the CD.
.PP
\&\fBNote: Data tracks are ignored.\fR
.PP
Returns \f(CW0\fR, or \f(CW\-1\fR if there was an error.
.SS play
.IX Subsection "play"
.Vb 1
\& $CD\->play($start, $length);
.Ve
.PP
Plays the given SDL::CD , starting a frame \f(CW$start\fR for \f(CW$length\fR frames.
.PP
Returns \f(CW0\fR on success, \f(CW\-1\fR on error
.SS pause
.IX Subsection "pause"
.Vb 1
\& $CD\->pause();
.Ve
.PP
Pauses play on CD
.PP
Returns \f(CW0\fR on success, or \f(CW\-1\fR on an error.
.SS resume
.IX Subsection "resume"
.Vb 1
\& $CD\->resume();
.Ve
.PP
Returns \f(CW0\fR on success, or \f(CW\-1\fR on an error.
.SS stop
.IX Subsection "stop"
.Vb 1
\& $CD\->stop();
.Ve
.PP
Stops play on the CD.
.PP
Returns \f(CW0\fR on success, or \f(CW\-1\fR on an error.
.SS eject
.IX Subsection "eject"
.Vb 1
\& $CD\->eject();
.Ve
.PP
Ejects the CD.
.PP
Returns \f(CW0\fR on success, or \f(CW\-1\fR on an error.
.SS id
.IX Subsection "id"
.Vb 1
\& $CD\->id();
.Ve
.PP
Private drive identifier
.SS num_tracks
.IX Subsection "num_tracks"
.Vb 1
\& $CD\->num_tracks();
.Ve
.PP
Number of tracks on the CD
.SS cur_track
.IX Subsection "cur_track"
.Vb 1
\& $CD\->cur_track();
.Ve
.PP
Current track on the CD;
.SS track
.IX Subsection "track"
.Vb 1
\& my $track =  $CD\->track($number);
.Ve
.PP
Retrieves track description of track \f(CW$number\fR in CD. See SDL::CDTrack.
.SS FRAMES_TO_MSF
.IX Subsection "FRAMES_TO_MSF"
.Vb 1
\& my ($min, $sec, $fra) = FRAMES_TO_MSF($frames);
.Ve
.PP
Conversion functions from frames to Minute/Second/Frames
.SS MSF_TO_FRAMES
.IX Subsection "MSF_TO_FRAMES"
.Vb 1
\& my $frames = MSF_TO_FRAMES($min, $sec, $fra);
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
SDL::CDROM, SDL::CDTrack
.SH AUTHORS
.IX Header "AUTHORS"
See "AUTHORS" in SDL.