moved constants for cd/cdrom/cdtrack
[sdlgit/SDL-Site.git] / pages / SDL-CDROM.html-inc
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="#CATEGORY">CATEGORY</a></li>
7 <li><a href="#SYNOPSIS">SYNOPSIS</a></li>
8 <li><a href="#METHODS">METHODS</a>
9 <ul><li><a href="#num_drives">num_drives</a></li>
10 <li><a href="#name">name</a></li>
11 </ul>
12 </li>
13 <li><a href="#See_Also">See Also</a>
14 </li>
15 </ul><hr />
16 <!-- INDEX END -->
17
18 <h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
19 <div id="NAME_CONTENT">
20 <p>SDL::CDROM -- SDL Bindings for the CDROM device</p>
21
22 </div>
23 <h1 id="CATEGORY">CATEGORY</h1><p><a href="#TOP" class="toplink">Top</a></p>
24 <div id="CATEGORY_CONTENT">
25 <p>Core, CDROM</p>
26
27 </div>
28 <h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>
29 <div id="SYNOPSIS_CONTENT">
30 <pre> use SDL ':init';
31  use SDL::CDROM;
32
33  SDL::init(SDL_INIT_CDROM);
34
35  print SDL::CDROM::num_drives();
36
37  print SDL::CDROM::name(0);
38
39  SDL::quit();
40
41 </pre>
42
43 </div>
44 <h1 id="METHODS">METHODS</h1><p><a href="#TOP" class="toplink">Top</a></p>
45 <div id="METHODS_CONTENT">
46
47 </div>
48 <h2 id="num_drives">num_drives</h2>
49 <div id="num_drives_CONTENT">
50 <pre> my $drives = SDL::CDROM::num_drives(); 
51
52 </pre>
53 <p>Returns number of drives available on the system</p>
54
55 </div>
56 <h2 id="name">name</h2>
57 <div id="name_CONTENT">
58 <pre> my $drive_name = SDL::CDROM::name($drive_num);
59
60 </pre>
61 <p>Returns human readable name for CDROM device</p>
62 <p>Examples:</p>
63 <ul>
64                 <li>'/dev/cdrom'        </li>
65                 <li>'E:'        </li>
66                 <li>'/dev/disk/ide/1/master'  </li>
67 </ul>
68
69
70 </div>
71 <h1 id="See_Also">See Also</h1><p><a href="#TOP" class="toplink">Top</a></p>
72 <div id="See_Also_CONTENT">
73 <p><a href="SDL-CD.html">SDL::CD</a>, <a href="SDL-CDTrack.html">SDL::CDTrack</a></p>
74
75 </div>
76 </div>