Mercurial > sdl-ios-xcode

comparison include/SDL_cdrom.h @ 1668:4da1ee79c9af SDL-1.3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
more tweaking indent options
author Sam Lantinga <slouken@libsdl.org>
date Mon, 29 May 2006 04:04:35 +0000
parents 782fd950bd46
children
comparison
equal deleted inserted replaced
1667:1fddae038bc8 1668:4da1ee79c9af
102 /* CD-audio API functions: */ 102 /* CD-audio API functions: */
103 103
104 /* Returns the number of CD-ROM drives on the system, or -1 if 104 /* Returns the number of CD-ROM drives on the system, or -1 if
105 SDL_Init() has not been called with the SDL_INIT_CDROM flag. 105 SDL_Init() has not been called with the SDL_INIT_CDROM flag.
106 */ 106 */
107 extern DECLSPEC int SDLCALL SDL_CDNumDrives (void); 107 extern DECLSPEC int SDLCALL SDL_CDNumDrives(void);
108 108
109 /* Returns a human-readable, system-dependent identifier for the CD-ROM. 109 /* Returns a human-readable, system-dependent identifier for the CD-ROM.
110 Example: 110 Example:
111 "/dev/cdrom" 111 "/dev/cdrom"
112 "E:" 112 "E:"
113 "/dev/disk/ide/1/master" 113 "/dev/disk/ide/1/master"
114 */ 114 */
115 extern DECLSPEC const char *SDLCALL SDL_CDName (int drive); 115 extern DECLSPEC const char *SDLCALL SDL_CDName(int drive);
116 116
117 /* Opens a CD-ROM drive for access. It returns a drive handle on success, 117 /* Opens a CD-ROM drive for access. It returns a drive handle on success,
118 or NULL if the drive was invalid or busy. This newly opened CD-ROM 118 or NULL if the drive was invalid or busy. This newly opened CD-ROM
119 becomes the default CD used when other CD functions are passed a NULL 119 becomes the default CD used when other CD functions are passed a NULL
120 CD-ROM handle. 120 CD-ROM handle.
121 Drives are numbered starting with 0. Drive 0 is the system default CD-ROM. 121 Drives are numbered starting with 0. Drive 0 is the system default CD-ROM.
122 */ 122 */
123 extern DECLSPEC SDL_CD *SDLCALL SDL_CDOpen (int drive); 123 extern DECLSPEC SDL_CD *SDLCALL SDL_CDOpen(int drive);
124 124
125 /* This function returns the current status of the given drive. 125 /* This function returns the current status of the given drive.
126 If the drive has a CD in it, the table of contents of the CD and current 126 If the drive has a CD in it, the table of contents of the CD and current
127 play position of the CD will be stored in the SDL_CD structure. 127 play position of the CD will be stored in the SDL_CD structure.
128 */ 128 */
129 extern DECLSPEC CDstatus SDLCALL SDL_CDStatus (SDL_CD * cdrom); 129 extern DECLSPEC CDstatus SDLCALL SDL_CDStatus(SDL_CD * cdrom);
130 130
131 /* Play the given CD starting at 'start_track' and 'start_frame' for 'ntracks' 131 /* Play the given CD starting at 'start_track' and 'start_frame' for 'ntracks'
132 tracks and 'nframes' frames. If both 'ntrack' and 'nframe' are 0, play 132 tracks and 'nframes' frames. If both 'ntrack' and 'nframe' are 0, play
133 until the end of the CD. This function will skip data tracks. 133 until the end of the CD. This function will skip data tracks.
134 This function should only be called after calling SDL_CDStatus() to 134 This function should only be called after calling SDL_CDStatus() to
145 if ( CD_INDRIVE(SDL_CDStatus(cdrom)) ) 145 if ( CD_INDRIVE(SDL_CDStatus(cdrom)) )
146 SDL_CDPlayTracks(cdrom, 0, 0, 2, 10); 146 SDL_CDPlayTracks(cdrom, 0, 0, 2, 10);
147 147
148 This function returns 0, or -1 if there was an error. 148 This function returns 0, or -1 if there was an error.
149 */ 149 */
150 extern DECLSPEC int SDLCALL SDL_CDPlayTracks (SDL_CD * cdrom, 150 extern DECLSPEC int SDLCALL SDL_CDPlayTracks(SDL_CD * cdrom,
151 int start_track, 151 int start_track,
152 int start_frame, int ntracks, 152 int start_frame, int ntracks,
153 int nframes); 153 int nframes);
154 154
155 /* Play the given CD starting at 'start' frame for 'length' frames. 155 /* Play the given CD starting at 'start' frame for 'length' frames.
156 It returns 0, or -1 if there was an error. 156 It returns 0, or -1 if there was an error.
157 */ 157 */
158 extern DECLSPEC int SDLCALL SDL_CDPlay (SDL_CD * cdrom, int start, 158 extern DECLSPEC int SDLCALL SDL_CDPlay(SDL_CD * cdrom, int start, int length);
159 int length);
160 159
161 /* Pause play -- returns 0, or -1 on error */ 160 /* Pause play -- returns 0, or -1 on error */
162 extern DECLSPEC int SDLCALL SDL_CDPause (SDL_CD * cdrom); 161 extern DECLSPEC int SDLCALL SDL_CDPause(SDL_CD * cdrom);
163 162
164 /* Resume play -- returns 0, or -1 on error */ 163 /* Resume play -- returns 0, or -1 on error */
165 extern DECLSPEC int SDLCALL SDL_CDResume (SDL_CD * cdrom); 164 extern DECLSPEC int SDLCALL SDL_CDResume(SDL_CD * cdrom);
166 165
167 /* Stop play -- returns 0, or -1 on error */ 166 /* Stop play -- returns 0, or -1 on error */
168 extern DECLSPEC int SDLCALL SDL_CDStop (SDL_CD * cdrom); 167 extern DECLSPEC int SDLCALL SDL_CDStop(SDL_CD * cdrom);
169 168
170 /* Eject CD-ROM -- returns 0, or -1 on error */ 169 /* Eject CD-ROM -- returns 0, or -1 on error */
171 extern DECLSPEC int SDLCALL SDL_CDEject (SDL_CD * cdrom); 170 extern DECLSPEC int SDLCALL SDL_CDEject(SDL_CD * cdrom);
172 171
173 /* Closes the handle for the CD-ROM drive */ 172 /* Closes the handle for the CD-ROM drive */
174 extern DECLSPEC void SDLCALL SDL_CDClose (SDL_CD * cdrom); 173 extern DECLSPEC void SDLCALL SDL_CDClose(SDL_CD * cdrom);
175 174
176 175
177 /* Ends C function definitions when using C++ */ 176 /* Ends C function definitions when using C++ */
178 #ifdef __cplusplus 177 #ifdef __cplusplus
179 /* *INDENT-OFF* */ 178 /* *INDENT-OFF* */