.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "pods::SDL::CD 3pm"
.TH pods::SDL::CD 3pm "2020-11-09" "perl v5.32.0" "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, \s-1CDROM,\s0 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 \s-1SDL::CD\s0 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 \s-1CD\s0 tray
.PP
Returns on of the following constants:
.IP "\(bu" 4
\&\s-1CD_TRAYEMPTY\s0
.IP "\(bu" 4
\&\s-1CD_STOPPED\s0
.IP "\(bu" 4
\&\s-1CD_PLAYING\s0
.IP "\(bu" 4
\&\s-1CD_PAUSED\s0
.IP "\(bu" 4
\&\s-1CD_ERROR\s0
.SS "play_tracks"
.IX Subsection "play_tracks"
.Vb 1
\& $CD\->play_tracks($start_track, $start_frame, $ntracks, $nframes)
.Ve
.PP
Plays the given \s-1SDL::CD\s0 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 \*(L"status\*(R" to get information about the \s-1CD.\s0
.PP
\&\fBNote: Data tracks are ignored.\fR
.PP
Returns \f(CW0\fR, or \f(CW\*(C`\-1\*(C'\fR if there was an error.
.SS "play"
.IX Subsection "play"
.Vb 1
\& $CD\->play($start, $length);
.Ve
.PP
Plays the given \s-1SDL::CD ,\s0 starting a frame \f(CW$start\fR for \f(CW$length\fR frames.
.PP
Returns \f(CW0\fR on success, \f(CW\*(C`\-1\*(C'\fR on error
.SS "pause"
.IX Subsection "pause"
.Vb 1
\& $CD\->pause();
.Ve
.PP
Pauses play on \s-1CD\s0
.PP
Returns \f(CW0\fR on success, or \f(CW\*(C`\-1\*(C'\fR on an error.
.SS "resume"
.IX Subsection "resume"
.Vb 1
\& $CD\->resume();
.Ve
.PP
Returns \f(CW0\fR on success, or \f(CW\*(C`\-1\*(C'\fR on an error.
.SS "stop"
.IX Subsection "stop"
.Vb 1
\& $CD\->stop();
.Ve
.PP
Stops play on the \s-1CD.\s0
.PP
Returns \f(CW0\fR on success, or \f(CW\*(C`\-1\*(C'\fR on an error.
.SS "eject"
.IX Subsection "eject"
.Vb 1
\& $CD\->eject();
.Ve
.PP
Ejects the \s-1CD.\s0
.PP
Returns \f(CW0\fR on success, or \f(CW\*(C`\-1\*(C'\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 \s-1CD\s0
.SS "cur_track"
.IX Subsection "cur_track"
.Vb 1
\& $CD\->cur_track();
.Ve
.PP
Current track on the \s-1CD\s0;
.SS "track"
.IX Subsection "track"
.Vb 1
\& my $track =  $CD\->track($number);
.Ve
.PP
Retrieves track description of track \f(CW$number\fR in \s-1CD.\s0 See SDL::CDTrack.
.SS "\s-1FRAMES_TO_MSF\s0"
.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 "\s-1MSF_TO_FRAMES\s0"
.IX Subsection "MSF_TO_FRAMES"
.Vb 1
\& my $frames = MSF_TO_FRAMES($min, $sec, $fra);
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1SDL::CDROM\s0, SDL::CDTrack
.SH "AUTHORS"
.IX Header "AUTHORS"
See \*(L"\s-1AUTHORS\*(R"\s0 in \s-1SDL\s0.