~ubuntu-branches/ubuntu/gutsy/pygame/gutsy

« back to all changes in this revision

Viewing changes to docs/ref/pygame_cdrom.html

  • Committer: Bazaar Package Importer
  • Author(s): Ed Boraas
  • Date: 2002-02-20 06:39:24 UTC
  • Revision ID: james.westby@ubuntu.com-20020220063924-amlzj7tqkeods4eq
Tags: upstream-1.4
ImportĀ upstreamĀ versionĀ 1.4

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<html>
 
2
<title>pygame.cdrom</title>
 
3
<body bgcolor=#aaeebb text=#000000 link=#331111 vlink=#331111>
 
4
 
 
5
 
 
6
<table cellspacing=3 width=100%><tr><td bgcolor=#00000>
 
7
<table width=100%><tr><td bgcolor=c2fc20 align=center>
 
8
    <a href=http://www.pygame.org>
 
9
    <img src=../pygame_tiny.gif border=0 width=200 height=60></a><br>
 
10
    <b>pygame&nbsp;&nbsp;&nbsp;documentation</b>
 
11
</td><td bgcolor=6aee28 align=center valign=top width=100%>
 
12
 
 
13
        ||&nbsp;
 
14
        <a href=http://www.pygame.org>Home</a> &nbsp;||&nbsp;
 
15
        <a href=../index.html>Help Contents</a> &nbsp;||
 
16
        <br>&nbsp;<br>
 
17
 
 
18
|| <a href=pygame.html>pygame</a> || 
 
19
<a href=pygame_cdrom.html>cdrom</a> || 
 
20
<a href=pygame_constants.html>constants</a> || 
 
21
<a href=pygame_display.html>display</a> || 
 
22
<a href=pygame_draw.html>draw</a> || 
 
23
<a href=pygame_event.html>event</a> ||<br>
 
24
|| <a href=pygame_font.html>font</a> || 
 
25
<a href=pygame_image.html>image</a> || 
 
26
<a href=pygame_joystick.html>joystick</a> || 
 
27
<a href=pygame_key.html>key</a> || 
 
28
<a href=pygame_mixer.html>mixer</a> || 
 
29
<a href=pygame_mixer_music.html>mixer_music</a> ||<br>
 
30
|| <a href=pygame_mouse.html>mouse</a> || 
 
31
<a href=pygame_movie.html>movie</a> || 
 
32
<a href=pygame_surfarray.html>surfarray</a> || 
 
33
<a href=pygame_time.html>time</a> || 
 
34
<a href=pygame_transform.html>transform</a> ||<br>
 
35
&nbsp;<br>|| <a href=CD.html>CD</a> || 
 
36
<a href=Channel.html>Channel</a> || 
 
37
<a href=Clock.html>Clock</a> || 
 
38
<a href=Font.html>Font</a> || 
 
39
<a href=Joystick.html>Joystick</a> || 
 
40
<a href=Movie.html>Movie</a> ||<br>
 
41
|| <a href=Rect.html>Rect</a> || 
 
42
<a href=Sound.html>Sound</a> || 
 
43
<a href=Surface.html>Surface</a> ||<br>
 
44
&nbsp;<br>|| <a href=pygame_cursors.html>cursors</a> || 
 
45
<a href=pygame_sprite.html>sprite</a> || 
 
46
<a href=pygame_version.html>version</a> ||<br>
 
47
 
 
48
 
 
49
</td></tr></table></td></tr></table>
 
50
<br>
 
51
<h2 align=center>pygame.cdrom</h2>
 
52
The cdrom module provides a few functions to initialize
 
53
the CDROM subsystem and to manage the CD objects. The CD
 
54
objects are created with the <a href=#CD>pygame.cdrom.CD()</a> function.
 
55
This function needs a cdrom device number to work on. All
 
56
cdrom drives on the system are enumerated for use as a CD
 
57
object. To access most of the CD functions, you'll need to
 
58
<a href=pygame.html#init>init()</a> the CD. (note that the cdrom module will already
 
59
be initialized). When multiple CD objects are created for the
 
60
same CDROM device, the state and values for those CD objects
 
61
will be shared.
 
62
<br>&nbsp;<br>
 
63
You can call the <a href=CD.html#get_name>CD.get_name()</a> and <a href=CD.html#get_id>CD.get_id()</a> functions
 
64
without initializing the CD object.
 
65
<br>&nbsp;<br>
 
66
Be sure to understand there is a difference between the cdrom module
 
67
and the CD objects.
 
68
 
 
69
<hr>
 
70
 
 
71
<table>
 
72
<tr><td><a href=#CD>CD</a></td><td> -
 
73
create new CD object</td></tr>
 
74
 
 
75
 
 
76
<tr><td><a href=#get_count>get_count</a></td><td> -
 
77
query number of cdroms on system</td></tr>
 
78
 
 
79
 
 
80
<tr><td><a href=#get_init>get_init</a></td><td> -
 
81
query init of cdrom module</td></tr>
 
82
 
 
83
 
 
84
<tr><td><a href=#init>init</a></td><td> -
 
85
initialize the cdrom subsystem</td></tr>
 
86
 
 
87
 
 
88
<tr><td><a href=#quit>quit</a></td><td> -
 
89
uninitialize the cdrom subsystem</td></tr>
 
90
 
 
91
 
 
92
</table>
 
93
 
 
94
<hr>
 
95
 
 
96
<a name=CD><font size=+2><b>CD
 
97
</b></font><br><font size=+1><tt>
 
98
pygame.cdrom.CD(id) -> CD
 
99
</tt></font><ul>
 
100
Creates a new CD object for the given CDROM id. The given id
 
101
must be less than the value from <a href=#get_count>pygame.cdrom.get_count()</a>.
 
102
</ul><br>&nbsp;<br>
 
103
 
 
104
<a name=get_count><font size=+2><b>get_count
 
105
</b></font><br><font size=+1><tt>
 
106
pygame.cdrom.get_count() -> int
 
107
</tt></font><ul>
 
108
Returns the number of CDROM drives available on
 
109
the system.
 
110
</ul><br>&nbsp;<br>
 
111
 
 
112
<a name=get_init><font size=+2><b>get_init
 
113
</b></font><br><font size=+1><tt>
 
114
pygame.cdrom.get_init() -> bool
 
115
</tt></font><ul>
 
116
Returns true of the cdrom module is initialized
 
117
</ul><br>&nbsp;<br>
 
118
 
 
119
<a name=init><font size=+2><b>init
 
120
</b></font><br><font size=+1><tt>
 
121
pygame.cdrom.init() -> None
 
122
</tt></font><ul>
 
123
Initialize the CDROM module manually
 
124
</ul><br>&nbsp;<br>
 
125
 
 
126
<a name=quit><font size=+2><b>quit
 
127
</b></font><br><font size=+1><tt>
 
128
pygame.cdrom.quit() -> None
 
129
</tt></font><ul>
 
130
Uninitialize the CDROM module manually
 
131
</ul><br>&nbsp;<br>
 
132
 
 
133
 
 
134
<hr>
 
135
</body></html>