Mercurial > sdl-ios-xcode
annotate docs/man3/SDL_CDPlayTracks.3 @ 2848:8a3aa505ecba
Comment cleanup.
| author | Ryan C. Gordon <icculus@icculus.org> |
|---|---|
| date | Sun, 07 Dec 2008 07:16:40 +0000 |
| parents | 546f7c1eb755 |
| children | 1238da4a7112 |
| rev | line source |
|---|---|
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
1 .TH "SDL_CDPlayTracks" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference" |
| 0 | 2 .SH "NAME" |
|
2283
546f7c1eb755
Merged revision 3472 from SDL 1.2, fixing bug #493
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
3 SDL_CDPlayTracks \- Play the given CD track(s) |
| 0 | 4 .SH "SYNOPSIS" |
| 5 .PP | |
| 6 \fB#include "SDL\&.h" | |
| 7 .sp | |
| 8 \fBint \fBSDL_CDPlayTracks\fP\fR(\fBSDL_CD *cdrom, int start_track, int start_frame, int ntracks, int nframes)\fR); | |
| 9 .SH "DESCRIPTION" | |
| 10 .PP | |
| 11 \fBSDL_CDPlayTracks\fP plays the given CD starting at track \fBstart_track\fR, for \fBntracks\fR tracks\&. | |
| 12 .PP | |
| 13 \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\&. | |
| 14 .PP | |
| 15 \fBSDL_CDPlayTracks\fP should only be called after calling \fI\fBSDL_CDStatus\fP\fR to get track information about the CD\&. | |
| 16 .PP | |
| 17 .RS | |
| 18 \fBNote: | |
| 19 .PP | |
| 20 Data tracks are ignored\&. | |
| 21 .RE | |
| 22 .SH "RETURN VALUE" | |
| 23 .PP | |
| 24 Returns \fB0\fR, or \fB-1\fR if there was an error\&. | |
| 25 .SH "EXAMPLES" | |
| 26 .PP | |
| 27 .PP | |
| 28 .nf | |
| 29 \f(CW/* assuming cdrom is a previously opened device */ | |
| 30 /* Play the entire CD */ | |
| 31 if(CD_INDRIVE(SDL_CDStatus(cdrom))) | |
| 32 SDL_CDPlayTracks(cdrom, 0, 0, 0, 0); | |
| 33 | |
| 34 /* Play the first track */ | |
| 35 if(CD_INDRIVE(SDL_CDStatus(cdrom))) | |
| 36 SDL_CDPlayTracks(cdrom, 0, 0, 1, 0); | |
| 37 | |
| 38 /* Play first 15 seconds of the 2nd track */ | |
| 39 if(CD_INDRIVE(SDL_CDStatus(cdrom))) | |
| 40 SDL_CDPlayTracks(cdrom, 1, 0, 0, CD_FPS*15);\fR | |
| 41 .fi | |
| 42 .PP | |
| 43 | |
| 44 .SH "SEE ALSO" | |
| 45 .PP | |
| 46 \fI\fBSDL_CDPlay\fP\fR, \fI\fBSDL_CDStatus\fP\fR, \fI\fBSDL_CD\fP\fR | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
47 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58 |