docs/html/sdlcdplaytracks.html

   1 <HTML
   2 ><HEAD
   3 ><TITLE
   4 >SDL_CDPlayTracks</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_CDPlay"
  17 HREF="sdlcdplay.html"><LINK
  18 REL="NEXT"
  19 TITLE="SDL_CDPause"
  20 HREF="sdlcdpause.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="sdlcdplay.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="sdlcdpause.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="SDLCDPLAYTRACKS"
  74 ></A
  75 >SDL_CDPlayTracks</H1
  76 ><DIV
  77 CLASS="REFNAMEDIV"
  78 ><A
  79 NAME="AEN7375"
  80 ></A
  81 ><H2
  82 >Name</H2
  83 >SDL_CDPlayTracks&nbsp;--&nbsp;Play the given CD track(s)</DIV
  84 ><DIV
  85 CLASS="REFSYNOPSISDIV"
  86 ><A
  87 NAME="AEN7378"
  88 ></A
  89 ><H2
  90 >Synopsis</H2
  91 ><DIV
  92 CLASS="FUNCSYNOPSIS"
  93 ><A
  94 NAME="AEN7379"
  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_CDPlayTracks</B
 108 ></CODE
 109 >(SDL_CD *cdrom, int start_track, int start_frame, int ntracks, int nframes));</CODE
 110 ></P
 111 ><P
 112 ></P
 113 ></DIV
 114 ></DIV
 115 ><DIV
 116 CLASS="REFSECT1"
 117 ><A
 118 NAME="AEN7385"
 119 ></A
 120 ><H2
 121 >Description</H2
 122 ><P
 123 ><TT
 124 CLASS="FUNCTION"
 125 >SDL_CDPlayTracks</TT
 126 > plays the given CD starting at track
 127 <TT
 128 CLASS="PARAMETER"
 129 ><I
 130 >start_track</I
 131 ></TT
 132 >, for <TT
 133 CLASS="PARAMETER"
 134 ><I
 135 >ntracks</I
 136 ></TT
 137 > tracks.  </P
 138 ><P
 139 ><TT
 140 CLASS="PARAMETER"
 141 ><I
 142 >start_frame</I
 143 ></TT
 144 > is the frame offset, from the beginning of the <TT
 145 CLASS="PARAMETER"
 146 ><I
 147 >start_track</I
 148 ></TT
 149 >, at which to start. <TT
 150 CLASS="PARAMETER"
 151 ><I
 152 >nframes</I
 153 ></TT
 154 > is the frame offset, from the beginning of the last track (<TT
 155 CLASS="PARAMETER"
 156 ><I
 157 >start_track</I
 158 ></TT
 159 >+<TT
 160 CLASS="PARAMETER"
 161 ><I
 162 >ntracks</I
 163 ></TT
 164 >), at which to end playing.</P
 165 ><P
 166 ><TT
 167 CLASS="FUNCTION"
 168 >SDL_CDPlayTracks</TT
 169 > should only be called after calling
 170 <A
 171 HREF="sdlcdstatus.html"
 172 ><TT
 173 CLASS="FUNCTION"
 174 >SDL_CDStatus</TT
 175 ></A
 176 >
 177 to get track information about the CD.</P
 178 ><DIV
 179 CLASS="NOTE"
 180 ><BLOCKQUOTE
 181 CLASS="NOTE"
 182 ><P
 183 ><B
 184 >Note: </B
 185 >Data tracks are ignored.</P
 186 ></BLOCKQUOTE
 187 ></DIV
 188 ></DIV
 189 ><DIV
 190 CLASS="REFSECT1"
 191 ><A
 192 NAME="AEN7403"
 193 ></A
 194 ><H2
 195 >Return Value</H2
 196 ><P
 197 >Returns <SPAN
 198 CLASS="RETURNVALUE"
 199 >0</SPAN
 200 >, or <SPAN
 201 CLASS="RETURNVALUE"
 202 >-1</SPAN
 203 >
 204 if there was an error.</P
 205 ></DIV
 206 ><DIV
 207 CLASS="REFSECT1"
 208 ><A
 209 NAME="AEN7408"
 210 ></A
 211 ><H2
 212 >Examples</H2
 213 ><P
 214 ><PRE
 215 CLASS="PROGRAMLISTING"
 216 >/* assuming cdrom is a previously opened device */
 217 /* Play the entire CD */
 218 if(CD_INDRIVE(SDL_CDStatus(cdrom)))
 219   SDL_CDPlayTracks(cdrom, 0, 0, 0, 0);
 220
 221 /* Play the first track */
 222 if(CD_INDRIVE(SDL_CDStatus(cdrom)))
 223   SDL_CDPlayTracks(cdrom, 0, 0, 1, 0);
 224
 225 /* Play first 15 seconds of the 2nd track */
 226 if(CD_INDRIVE(SDL_CDStatus(cdrom)))
 227   SDL_CDPlayTracks(cdrom, 1, 0, 0, CD_FPS*15);</PRE
 228 >
 229 &#13;</P
 230 ></DIV
 231 ><DIV
 232 CLASS="REFSECT1"
 233 ><A
 234 NAME="AEN7412"
 235 ></A
 236 ><H2
 237 >See Also</H2
 238 ><P
 239 ><A
 240 HREF="sdlcdplay.html"
 241 ><TT
 242 CLASS="FUNCTION"
 243 >SDL_CDPlay</TT
 244 ></A
 245 >,
 246 <A
 247 HREF="sdlcdstatus.html"
 248 ><TT
 249 CLASS="FUNCTION"
 250 >SDL_CDStatus</TT
 251 ></A
 252 >,
 253 <A
 254 HREF="sdlcd.html"
 255 ><TT
 256 CLASS="FUNCTION"
 257 >SDL_CD</TT
 258 ></A
 259 ></P
 260 ></DIV
 261 ><DIV
 262 CLASS="NAVFOOTER"
 263 ><HR
 264 ALIGN="LEFT"
 265 WIDTH="100%"><TABLE
 266 SUMMARY="Footer navigation table"
 267 WIDTH="100%"
 268 BORDER="0"
 269 CELLPADDING="0"
 270 CELLSPACING="0"
 271 ><TR
 272 ><TD
 273 WIDTH="33%"
 274 ALIGN="left"
 275 VALIGN="top"
 276 ><A
 277 HREF="sdlcdplay.html"
 278 ACCESSKEY="P"
 279 >Prev</A
 280 ></TD
 281 ><TD
 282 WIDTH="34%"
 283 ALIGN="center"
 284 VALIGN="top"
 285 ><A
 286 HREF="index.html"
 287 ACCESSKEY="H"
 288 >Home</A
 289 ></TD
 290 ><TD
 291 WIDTH="33%"
 292 ALIGN="right"
 293 VALIGN="top"
 294 ><A
 295 HREF="sdlcdpause.html"
 296 ACCESSKEY="N"
 297 >Next</A
 298 ></TD
 299 ></TR
 300 ><TR
 301 ><TD
 302 WIDTH="33%"
 303 ALIGN="left"
 304 VALIGN="top"
 305 >SDL_CDPlay</TD
 306 ><TD
 307 WIDTH="34%"
 308 ALIGN="center"
 309 VALIGN="top"
 310 ><A
 311 HREF="cdrom.html"
 312 ACCESSKEY="U"
 313 >Up</A
 314 ></TD
 315 ><TD
 316 WIDTH="33%"
 317 ALIGN="right"
 318 VALIGN="top"
 319 >SDL_CDPause</TD
 320 ></TR
 321 ></TABLE
 322 ></DIV
 323 ></BODY
 324 ></HTML
 325 >