Commit | Line | Data |
b82df135 |
1 | <div class="pod"> |
2 | <!-- INDEX START --> |
3 | <h3 id="TOP">Index</h3> |
4 | |
5 | <ul><li><a href="#NAME">NAME</a></li> |
37af21e0 |
6 | <li><a href="#CATEGORY">CATEGORY</a></li> |
7 | <li><a href="#SYNOPSIS">SYNOPSIS</a></li> |
8 | <li><a href="#METHOD">METHOD</a> |
9 | <ul><li><a href="#new_drive">new( $drive )</a></li> |
10 | <li><a href="#status">status</a> |
11 | <ul><li><a href="#returns">returns</a></li> |
12 | </ul> |
13 | </li> |
14 | <li><a href="#play_tracks">play_tracks</a> |
15 | <ul><li><a href="#Returns">Returns</a></li> |
16 | </ul> |
17 | </li> |
18 | <li><a href="#play">play</a> |
19 | <ul><li><a href="#Returns-2">Returns</a></li> |
20 | </ul> |
21 | </li> |
22 | <li><a href="#pause">pause </a> |
23 | <ul><li><a href="#Returns-3">Returns</a></li> |
24 | </ul> |
25 | </li> |
26 | <li><a href="#resume">resume</a> |
27 | <ul><li><a href="#Returns-4">Returns</a></li> |
28 | </ul> |
29 | </li> |
30 | <li><a href="#stop">stop</a> |
31 | <ul><li><a href="#Returns-5">Returns</a></li> |
32 | </ul> |
33 | </li> |
34 | <li><a href="#eject">eject</a> |
35 | <ul><li><a href="#Returns-6">Returns</a></li> |
36 | </ul> |
37 | </li> |
38 | <li><a href="#id">id</a></li> |
39 | <li><a href="#num_tracks">num_tracks</a></li> |
40 | <li><a href="#cur_track">cur_track </a></li> |
41 | <li><a href="#track">track</a></li> |
42 | </ul> |
43 | </li> |
44 | <li><a href="#SEE_ALSO">SEE ALSO</a> |
b82df135 |
45 | </li> |
46 | </ul><hr /> |
47 | <!-- INDEX END --> |
48 | |
49 | <h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p> |
50 | <div id="NAME_CONTENT"> |
51 | <p>SDL::CD -- SDL Bindings for structure SDL_CD</p> |
52 | |
53 | </div> |
54 | <h1 id="CATEGORY">CATEGORY</h1><p><a href="#TOP" class="toplink">Top</a></p> |
55 | <div id="CATEGORY_CONTENT"> |
37af21e0 |
56 | <p>Core, CDROM, Structure</p> |
57 | |
58 | </div> |
59 | <h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
60 | <div id="SYNOPSIS_CONTENT"> |
61 | <pre> use SDL; |
62 | use SDL::CDROM; |
63 | use SDL::CD; |
64 | |
65 | SDL::init(SDL_INIT_CDROM); |
66 | |
67 | my $drives = SDL::CDROM::num_drives; |
68 | |
69 | if( $drives > 0 ) |
70 | { |
71 | my $CD = SDL::CD->new( 0 ); |
72 | |
73 | if($CD != NULL) |
74 | { |
75 | ... |
76 | } |
77 | |
78 | } |
79 | |
80 | SDL::quit(); |
81 | |
82 | </pre> |
83 | |
84 | </div> |
85 | <h1 id="METHOD">METHOD</h1><p><a href="#TOP" class="toplink">Top</a></p> |
86 | <div id="METHOD_CONTENT"> |
87 | |
88 | </div> |
89 | <h2 id="new_drive">new( $drive )</h2> |
90 | <div id="new_drive_CONTENT"> |
91 | <pre> my $CD = SDL::CD->new( $drive ) |
92 | |
93 | </pre> |
94 | <p>Makes a new SDL::CD object. Returns NULL if the drive is busy or inaccessible. </p> |
95 | |
96 | </div> |
97 | <h2 id="status">status</h2> |
98 | <div id="status_CONTENT"> |
99 | <pre> my $status = $CD->status(); |
100 | |
101 | </pre> |
102 | <p>Returns the current status of the CD tray </p> |
103 | |
104 | </div> |
105 | <h3 id="returns">returns</h3> |
106 | <div id="returns_CONTENT"> |
107 | <dl> |
108 | <dt>CD_TRAYEMPTY</dt> |
109 | <dt>CD_STOPPED</dt> |
110 | <dt>CD_PLAYING</dt> |
111 | <dt>CD_PAUSED</dt> |
112 | <dt>CD_ERROR = -1 </dt> |
113 | </dl> |
114 | |
115 | |
116 | |
117 | |
118 | |
119 | </div> |
120 | <h2 id="play_tracks">play_tracks</h2> |
121 | <div id="play_tracks_CONTENT"> |
122 | <pre> $CD->play_tracks($start_track, $start_frame, $ntracks, $nframes) |
123 | |
124 | </pre> |
125 | <p>Plays the given SDL::CD starting at track $start_track, for $ntracks tracks. </p> |
126 | <p>$start_frame is the frame offset, from the beginning of the $start_track, at which to start. $nframes is the frame offset, from the beginning of the last track ($start_track+$ntracks), at which to end playing.</p> |
127 | <p>play_tracks() should only be called after calling SDL_CDStatus to get track information about the CD use $CD->status().</p> |
128 | <p><strong>Note: Data tracks are ignored.</strong></p> |
129 | |
130 | </div> |
131 | <h3 id="Returns">Returns</h3> |
132 | <div id="Returns_CONTENT"> |
133 | <p>0, or -1 if there was an error. </p> |
134 | |
135 | </div> |
136 | <h2 id="play">play</h2> |
137 | <div id="play_CONTENT"> |
138 | <pre> $CD->play($start, $length ); |
139 | |
140 | </pre> |
141 | <p>Plays the given SDL::CD , starting a frame $start for $length frames. </p> |
142 | |
143 | </div> |
144 | <h3 id="Returns-2">Returns</h3> |
145 | <div id="Returns_CONTENT-2"> |
146 | <p>0 on success, -1 on error</p> |
147 | |
148 | </div> |
149 | <h2 id="pause">pause </h2> |
150 | <div id="pause_CONTENT"> |
151 | <pre> $CD->pause(); |
152 | |
153 | </pre> |
154 | <p>Pauses play on CD</p> |
155 | |
156 | </div> |
157 | <h3 id="Returns-3">Returns</h3> |
158 | <div id="Returns_CONTENT-3"> |
159 | <p>Returns 0 on success, or -1 on an error. </p> |
160 | |
161 | </div> |
162 | <h2 id="resume">resume</h2> |
163 | <div id="resume_CONTENT"> |
164 | <pre> $CD->resume(); |
165 | |
166 | </pre> |
167 | |
168 | </div> |
169 | <h3 id="Returns-4">Returns</h3> |
170 | <div id="Returns_CONTENT-4"> |
171 | <p>Returns 0 on success, or -1 on an error. </p> |
172 | |
173 | </div> |
174 | <h2 id="stop">stop</h2> |
175 | <div id="stop_CONTENT"> |
176 | <pre> $CD->stop(); |
177 | |
178 | </pre> |
179 | <p>Stops play on the CD. </p> |
180 | |
181 | </div> |
182 | <h3 id="Returns-5">Returns</h3> |
183 | <div id="Returns_CONTENT-5"> |
184 | <p>Returns 0 on success, or -1 on an error. </p> |
185 | |
186 | </div> |
187 | <h2 id="eject">eject</h2> |
188 | <div id="eject_CONTENT"> |
189 | <pre> $CD->eject(); |
190 | |
191 | </pre> |
192 | <p>Ejects the CD.</p> |
193 | |
194 | </div> |
195 | <h3 id="Returns-6">Returns</h3> |
196 | <div id="Returns_CONTENT-6"> |
197 | <p>Returns 0 on success, or -1 on an error. </p> |
198 | |
199 | </div> |
200 | <h2 id="id">id</h2> |
201 | <div id="id_CONTENT"> |
202 | <pre> $CD->id(); |
203 | |
204 | </pre> |
205 | <p>Private drive identifier</p> |
206 | |
207 | </div> |
208 | <h2 id="num_tracks">num_tracks</h2> |
209 | <div id="num_tracks_CONTENT"> |
210 | <pre> $CD->num_tracks(); |
211 | |
212 | </pre> |
213 | <p>Number of tracks on the CD</p> |
214 | |
215 | </div> |
216 | <h2 id="cur_track">cur_track </h2> |
217 | <div id="cur_track_CONTENT"> |
218 | <pre> $CD->cur_track(); |
219 | |
220 | </pre> |
221 | <p>Current track on the CD;</p> |
222 | |
223 | </div> |
224 | <h2 id="track">track</h2> |
225 | <div id="track_CONTENT"> |
226 | <pre> my $track = $CD->track($number); |
227 | |
228 | </pre> |
46beffd8 |
229 | <p>Retrives track description of track $number in CD. See <a href="/SDL-CDTrack.html">SDL::CDTrack</a>.</p> |
37af21e0 |
230 | |
231 | |
232 | |
233 | |
234 | |
235 | </div> |
236 | <h1 id="SEE_ALSO">SEE ALSO</h1><p><a href="#TOP" class="toplink">Top</a></p> |
237 | <div id="SEE_ALSO_CONTENT"> |
46beffd8 |
238 | <p><a href="/SDL-CDROM.html">SDL::CDROM</a>, <a href="/SDL-CDTrack.html">SDL::CDTrack</a></p> |
b82df135 |
239 | |
240 | </div> |
241 | </div> |