Commit | Line | Data |
162a0989 |
1 | <div class="pod"> |
2 | <!-- INDEX START --> |
3 | <h3 id="TOP">Index</h3> |
4 | |
5 | <ul><li><a href="#NAME">NAME</a></li> |
6 | <li><a href="#SYNOPSIS">SYNOPSIS</a></li> |
7 | <li><a href="#EXPORTS">EXPORTS</a></li> |
8 | <li><a href="#DESCRIPTION">DESCRIPTION</a></li> |
9 | <li><a href="#METHODS">METHODS</a> |
10 | <ul><li><a href="#cd_num_drives">cd_num_drives()</a></li> |
11 | <li><a href="#name_cd">name(cd)</a></li> |
12 | <li><a href="#status_cd">status(cd)</a></li> |
13 | <li><a href="#play_cd_start_length_fs_fl">play(cd,start,length,fs,fl) </a></li> |
14 | <li><a href="#pause_cd">pause(cd)</a></li> |
15 | <li><a href="#resume_cd">resume(cd)</a></li> |
16 | <li><a href="#stop_cd">stop(cd)</a></li> |
17 | <li><a href="#eject_cd">eject(cd)</a></li> |
18 | <li><a href="#id_cd">id(cd)</a></li> |
19 | <li><a href="#num_tracks_cd">num_tracks(cd)</a></li> |
20 | <li><a href="#track_cd_number">track(cd,number)</a></li> |
21 | <li><a href="#current_cd">current(cd)</a></li> |
22 | <li><a href="#current_frame_cd">current_frame(cd)</a></li> |
23 | </ul> |
24 | </li> |
25 | <li><a href="#AUTHORS">AUTHORS</a></li> |
26 | <li><a href="#SEE_ALSO">SEE ALSO</a> |
27 | </li> |
28 | </ul><hr /> |
29 | <!-- INDEX END --> |
30 | |
31 | <h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p> |
32 | <div id="NAME_CONTENT"> |
33 | <p>SDL::Cdrom - a SDL perl extension for managing CD-ROM drives</p> |
34 | |
35 | </div> |
36 | <h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
37 | <div id="SYNOPSIS_CONTENT"> |
38 | <pre> use SDL::Cdrom; |
39 | $cdrom = SDL::Cdrom->new(0); |
40 | $cdrom->play(); |
41 | |
42 | </pre> |
43 | |
44 | </div> |
45 | <h1 id="EXPORTS">EXPORTS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
46 | <div id="EXPORTS_CONTENT"> |
47 | <ul> |
48 | <li><code>cd_num_drives</code>.</li> |
49 | </ul> |
50 | |
51 | |
52 | </div> |
53 | <h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p> |
54 | <div id="DESCRIPTION_CONTENT"> |
55 | <p>Create a new SDL::Cdrom object. The passed $id is the number of the drive, |
56 | whereas 0 is the first drive etc.</p> |
57 | <pre> use SDL::Cdrom; |
58 | my $drive => SDL::Cdrom->new($id); |
59 | |
60 | </pre> |
61 | |
62 | </div> |
63 | <h1 id="METHODS">METHODS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
64 | <div id="METHODS_CONTENT"> |
65 | |
66 | </div> |
67 | <h2 id="cd_num_drives">cd_num_drives()</h2> |
68 | <div id="cd_num_drives_CONTENT"> |
69 | <p>Returns the number of CD-ROM drives present.</p> |
70 | |
71 | </div> |
72 | <h2 id="name_cd">name(cd)</h2> |
73 | <div id="name_cd_CONTENT"> |
74 | <p>Returns the system dependent name of the CD-ROM device. |
75 | It takes a SDL::Cdrom as first parameter.</p> |
76 | |
77 | </div> |
78 | <h2 id="status_cd">status(cd)</h2> |
79 | <div id="status_cd_CONTENT"> |
80 | <p>Return the status of the drive. |
81 | It takes a SDL::Cdrom as first parameter.</p> |
82 | |
83 | </div> |
84 | <h2 id="play_cd_start_length_fs_fl">play(cd,start,length,fs,fl) </h2> |
85 | <div id="play_cd_start_length_fs_fl_CONTENT"> |
86 | <p>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. |
cbc85b7f |
87 | It returns 1 on succés 0 on error.</p> |
162a0989 |
88 | |
89 | </div> |
90 | <h2 id="pause_cd">pause(cd)</h2> |
91 | <div id="pause_cd_CONTENT"> |
92 | <p>Pause the playing of the SDL::Cdrom given as first parameter. |
cbc85b7f |
93 | It returns 1 on succés 0 on error.</p> |
162a0989 |
94 | |
95 | </div> |
96 | <h2 id="resume_cd">resume(cd)</h2> |
97 | <div id="resume_cd_CONTENT"> |
98 | <p>Resume the playing of the SDL::Cdrom given as first parameter. |
cbc85b7f |
99 | It returns 1 on succés 0 on error.</p> |
162a0989 |
100 | |
101 | </div> |
102 | <h2 id="stop_cd">stop(cd)</h2> |
103 | <div id="stop_cd_CONTENT"> |
104 | <p>Stop the playing of the SDL::Cdrom given as first parameter. |
cbc85b7f |
105 | It returns 1 on succés 0 on error.</p> |
162a0989 |
106 | |
107 | </div> |
108 | <h2 id="eject_cd">eject(cd)</h2> |
109 | <div id="eject_cd_CONTENT"> |
110 | <p>Eject the medium in the SDL::Cdrom given as first parameter. |
cbc85b7f |
111 | It returns 1 on succés 0 on error.</p> |
162a0989 |
112 | |
113 | </div> |
114 | <h2 id="id_cd">id(cd)</h2> |
115 | <div id="id_cd_CONTENT"> |
116 | <p>Return the ID of the drive given as first parameter.</p> |
117 | |
118 | </div> |
119 | <h2 id="num_tracks_cd">num_tracks(cd)</h2> |
120 | <div id="num_tracks_cd_CONTENT"> |
121 | <p>Return the number of tracks on the SDL::Cdrom given as first parameter.</p> |
122 | |
123 | </div> |
124 | <h2 id="track_cd_number">track(cd,number)</h2> |
125 | <div id="track_cd_number_CONTENT"> |
126 | <p>Returns the track description of the track given as second parameter. |
127 | the first parameter is a SDL:Cdrom.</p> |
128 | |
129 | </div> |
130 | <h2 id="current_cd">current(cd)</h2> |
131 | <div id="current_cd_CONTENT"> |
132 | <p>Return the current played track number given as first parameter.</p> |
133 | |
134 | </div> |
135 | <h2 id="current_frame_cd">current_frame(cd)</h2> |
136 | <div id="current_frame_cd_CONTENT"> |
137 | <p>Return the current frame given as first parameter.</p> |
138 | |
139 | </div> |
140 | <h1 id="AUTHORS">AUTHORS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
141 | <div id="AUTHORS_CONTENT"> |
142 | <p>David J. Goehrig |
143 | Documentation by Tels <http://bloodgate.com/>.</p> |
144 | |
145 | </div> |
146 | <h1 id="SEE_ALSO">SEE ALSO</h1><p><a href="#TOP" class="toplink">Top</a></p> |
147 | <div id="SEE_ALSO_CONTENT"> |
148 | <p><cite>perl</cite> <cite>SDL::Mixer</cite> <cite>SDL::App</cite>.</p> |
149 | |
150 | </div> |
151 | </div> |