view docs/man3/SDL_CDPlayTracks.3 @ 4011:f5794774970d SDL-1.2

Reverted mousewheel support in 1.2, since it breaks binary compatibility.
author Sam Lantinga <slouken@libsdl.org>
date Fri, 06 Jul 2007 13:39:03 +0000
parents e5bc29de3f0a
children 546f7c1eb755
line wrap: on
line source

.TH "SDL_CDPlayTracks" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference" 
.SH "NAME"
SDL_CDPlayTracks\- Play the given CD track(s)
.SH "SYNOPSIS"
.PP
\fB#include "SDL\&.h"
.sp
\fBint \fBSDL_CDPlayTracks\fP\fR(\fBSDL_CD *cdrom, int start_track, int start_frame, int ntracks, int nframes)\fR);
.SH "DESCRIPTION"
.PP
\fBSDL_CDPlayTracks\fP plays the given CD starting at track \fBstart_track\fR, for \fBntracks\fR tracks\&. 
.PP
\fBstart_frame\fR is the frame offset, from the beginning of the \fBstart_track\fR, at which to start\&. \fBnframes\fR is the frame offset, from the beginning of the last track (\fBstart_track\fR+\fBntracks\fR), at which to end playing\&.
.PP
\fBSDL_CDPlayTracks\fP should only be called after calling \fI\fBSDL_CDStatus\fP\fR to get track information about the CD\&.
.PP
.RS
\fBNote:  
.PP
Data tracks are ignored\&.
.RE
.SH "RETURN VALUE"
.PP
Returns \fB0\fR, or \fB-1\fR if there was an error\&.
.SH "EXAMPLES"
.PP
.PP
.nf
\f(CW/* assuming cdrom is a previously opened device */
/* Play the entire CD */
if(CD_INDRIVE(SDL_CDStatus(cdrom)))
  SDL_CDPlayTracks(cdrom, 0, 0, 0, 0);

/* Play the first track */
if(CD_INDRIVE(SDL_CDStatus(cdrom)))
  SDL_CDPlayTracks(cdrom, 0, 0, 1, 0);

/* Play first 15 seconds of the 2nd track */
if(CD_INDRIVE(SDL_CDStatus(cdrom)))
  SDL_CDPlayTracks(cdrom, 1, 0, 0, CD_FPS*15);\fR
.fi
.PP
 
.SH "SEE ALSO"
.PP
\fI\fBSDL_CDPlay\fP\fR, \fI\fBSDL_CDStatus\fP\fR, \fI\fBSDL_CD\fP\fR
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58