SDL 1.2.13
[crawl:crawl-sdl.git] / docs / html / sdlcdplay.html
1 <HTML
2 ><HEAD
3 ><TITLE
4 >SDL_CDPlay</TITLE
5 ><META
6 NAME="GENERATOR"
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
8 "><LINK
9 REL="HOME"
10 TITLE="SDL Library Documentation"
11 HREF="index.html"><LINK
12 REL="UP"
13 TITLE="CD-ROM"
14 HREF="cdrom.html"><LINK
15 REL="PREVIOUS"
16 TITLE="SDL_CDStatus"
17 HREF="sdlcdstatus.html"><LINK
18 REL="NEXT"
19 TITLE="SDL_CDPlayTracks"
20 HREF="sdlcdplaytracks.html"></HEAD
21 ><BODY
22 CLASS="REFENTRY"
23 BGCOLOR="#FFF8DC"
24 TEXT="#000000"
25 LINK="#0000ee"
26 VLINK="#551a8b"
27 ALINK="#ff0000"
28 ><DIV
29 CLASS="NAVHEADER"
30 ><TABLE
31 SUMMARY="Header navigation table"
32 WIDTH="100%"
33 BORDER="0"
34 CELLPADDING="0"
35 CELLSPACING="0"
36 ><TR
37 ><TH
38 COLSPAN="3"
39 ALIGN="center"
40 >SDL Library Documentation</TH
41 ></TR
42 ><TR
43 ><TD
44 WIDTH="10%"
45 ALIGN="left"
46 VALIGN="bottom"
47 ><A
48 HREF="sdlcdstatus.html"
49 ACCESSKEY="P"
50 >Prev</A
51 ></TD
52 ><TD
53 WIDTH="80%"
54 ALIGN="center"
55 VALIGN="bottom"
56 ></TD
57 ><TD
58 WIDTH="10%"
59 ALIGN="right"
60 VALIGN="bottom"
61 ><A
62 HREF="sdlcdplaytracks.html"
63 ACCESSKEY="N"
64 >Next</A
65 ></TD
66 ></TR
67 ></TABLE
68 ><HR
69 ALIGN="LEFT"
70 WIDTH="100%"></DIV
71 ><H1
72 ><A
73 NAME="SDLCDPLAY"
74 ></A
75 >SDL_CDPlay</H1
76 ><DIV
77 CLASS="REFNAMEDIV"
78 ><A
79 NAME="AEN7343"
80 ></A
81 ><H2
82 >Name</H2
83 >SDL_CDPlay&nbsp;--&nbsp;Play a CD</DIV
84 ><DIV
85 CLASS="REFSYNOPSISDIV"
86 ><A
87 NAME="AEN7346"
88 ></A
89 ><H2
90 >Synopsis</H2
91 ><DIV
92 CLASS="FUNCSYNOPSIS"
93 ><A
94 NAME="AEN7347"
95 ></A
96 ><P
97 ></P
98 ><PRE
99 CLASS="FUNCSYNOPSISINFO"
100 >#include "SDL.h"</PRE
101 ><P
102 ><CODE
103 ><CODE
104 CLASS="FUNCDEF"
105 >int <B
106 CLASS="FSFUNC"
107 >SDL_CDPlay</B
108 ></CODE
109 >(SDL_CD *cdrom, int start, int length);</CODE
110 ></P
111 ><P
112 ></P
113 ></DIV
114 ></DIV
115 ><DIV
116 CLASS="REFSECT1"
117 ><A
118 NAME="AEN7353"
119 ></A
120 ><H2
121 >Description</H2
122 ><P
123 >Plays the given <TT
124 CLASS="PARAMETER"
125 ><I
126 >cdrom</I
127 ></TT
128 >, starting a frame <TT
129 CLASS="PARAMETER"
130 ><I
131 >start</I
132 ></TT
133 > for <TT
134 CLASS="PARAMETER"
135 ><I
136 >length</I
137 ></TT
138 > frames.</P
139 ></DIV
140 ><DIV
141 CLASS="REFSECT1"
142 ><A
143 NAME="AEN7359"
144 ></A
145 ><H2
146 >Return Values</H2
147 ><P
148 >Returns <SPAN
149 CLASS="RETURNVALUE"
150 >0</SPAN
151 > on success, or <SPAN
152 CLASS="RETURNVALUE"
153 >-1</SPAN
154 > on an error.</P
155 ></DIV
156 ><DIV
157 CLASS="REFSECT1"
158 ><A
159 NAME="AEN7364"
160 ></A
161 ><H2
162 >See Also</H2
163 ><P
164 ><A
165 HREF="sdlcdplaytracks.html"
166 ><TT
167 CLASS="FUNCTION"
168 >SDL_CDPlayTracks</TT
169 ></A
170 >,
171 <A
172 HREF="sdlcdstop.html"
173 ><TT
174 CLASS="FUNCTION"
175 >SDL_CDStop</TT
176 ></A
177 ></P
178 ></DIV
179 ><DIV
180 CLASS="NAVFOOTER"
181 ><HR
182 ALIGN="LEFT"
183 WIDTH="100%"><TABLE
184 SUMMARY="Footer navigation table"
185 WIDTH="100%"
186 BORDER="0"
187 CELLPADDING="0"
188 CELLSPACING="0"
189 ><TR
190 ><TD
191 WIDTH="33%"
192 ALIGN="left"
193 VALIGN="top"
194 ><A
195 HREF="sdlcdstatus.html"
196 ACCESSKEY="P"
197 >Prev</A
198 ></TD
199 ><TD
200 WIDTH="34%"
201 ALIGN="center"
202 VALIGN="top"
203 ><A
204 HREF="index.html"
205 ACCESSKEY="H"
206 >Home</A
207 ></TD
208 ><TD
209 WIDTH="33%"
210 ALIGN="right"
211 VALIGN="top"
212 ><A
213 HREF="sdlcdplaytracks.html"
214 ACCESSKEY="N"
215 >Next</A
216 ></TD
217 ></TR
218 ><TR
219 ><TD
220 WIDTH="33%"
221 ALIGN="left"
222 VALIGN="top"
223 >SDL_CDStatus</TD
224 ><TD
225 WIDTH="34%"
226 ALIGN="center"
227 VALIGN="top"
228 ><A
229 HREF="cdrom.html"
230 ACCESSKEY="U"
231 >Up</A
232 ></TD
233 ><TD
234 WIDTH="33%"
235 ALIGN="right"
236 VALIGN="top"
237 >SDL_CDPlayTracks</TD
238 ></TR
239 ></TABLE
240 ></DIV
241 ></BODY
242 ></HTML
243 >