moved constants for cd/cdrom/cdtrack
[sdlgit/SDL-Site.git] / pages / SDL-CDTrack.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="#CONSTANTS">CONSTANTS</a></li>
9 <li><a href="#METHOD">METHOD</a>
10 <ul><li><a href="#id">id</a></li>
11 <li><a href="#type">type</a></li>
12 <li><a href="#length">length</a></li>
13 <li><a href="#offset">offset </a></li>
14 </ul>
15 </li>
16 <li><a href="#SEE_ALSO">SEE ALSO</a>
17 </li>
18 </ul><hr />
19 <!-- INDEX END -->
20
21 <h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
22 <div id="NAME_CONTENT">
23 <p>SDL::CDTrack -- SDL Bindings for structure SDL_CDTrack</p>
24
25 </div>
26 <h1 id="CATEGORY">CATEGORY</h1><p><a href="#TOP" class="toplink">Top</a></p>
27 <div id="CATEGORY_CONTENT">
28 <p>Core, CDROM, Structure</p>
29
30 </div>
31 <h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>
32 <div id="SYNOPSIS_CONTENT">
33 <pre> use SDL ':init';
34  use SDL::CDROM;
35  use SDL::CD ':status';
36  use SDL::CDTrack;
37
38  SDL::init( SDL_INIT_CDROM );
39
40  my $drives = SDL::CDROM::num_drives(); 
41
42  if( $drives &gt; 0 )
43  {
44      my $CD = SDL::CD-&gt;new(0); #first drive's CD
45
46      if($CD)
47      {
48          if( $CD-&gt;status != CD_TRAYEMPTY )
49          {
50              my $track = SDL::CD-&gt;track(0);
51          }
52      }
53  }
54
55 </pre>
56
57 </div>
58 <h1 id="CONSTANTS">CONSTANTS</h1><p><a href="#TOP" class="toplink">Top</a></p>
59 <div id="CONSTANTS_CONTENT">
60 <p>The constants are not exported by default. You can export them into your namespace by doing:</p>
61 <pre> use SDL::CDTrack ':all';
62
63 </pre>
64 <p>or access them directly:</p>
65 <pre> SDL::CDTrack::SDL_AUDIO_TRACK;
66
67 </pre>
68 <p>or by choosing the export tags below:</p>
69 <p>Export tag: ':type'</p>
70 <pre> SDL_AUDIO_TRACK
71  SDL_DATA_TRACK
72
73 </pre>
74
75 </div>
76 <h1 id="METHOD">METHOD</h1><p><a href="#TOP" class="toplink">Top</a></p>
77 <div id="METHOD_CONTENT">
78
79 </div>
80 <h2 id="id">id</h2>
81 <div id="id_CONTENT">
82 <pre> $track-&gt;id() # 0-99 
83
84 </pre>
85 <p>Track number</p>
86
87 </div>
88 <h2 id="type">type</h2>
89 <div id="type_CONTENT">
90 <pre> $track-&gt;type() # SDL_AUDIO_TRACK or SDL_DATA_TRACK 
91
92 </pre>
93 <p>Type of track</p>
94
95 </div>
96 <h2 id="length">length</h2>
97 <div id="length_CONTENT">
98 <pre> $track-&gt;length() 
99
100 </pre>
101 <p>Length, in frames, of this track </p>
102
103 </div>
104 <h2 id="offset">offset </h2>
105 <div id="offset_CONTENT">
106 <pre> $track-&gt;offset()
107
108 </pre>
109 <p>Frame offset to the beginning of this track </p>
110
111 </div>
112 <h1 id="SEE_ALSO">SEE ALSO</h1><p><a href="#TOP" class="toplink">Top</a></p>
113 <div id="SEE_ALSO_CONTENT">
114 <p><a href="SDL-CDROM.html">SDL::CDROM</a>, <a href="SDL-CD.html">SDL::CD</a></p>
115
116 </div>
117 </div>