dwww Home | Manual pages | Find package

SDL_CDStatus(3)                SDL API Reference               SDL_CDStatus(3)

NAME
       SDL_CDStatus - Returns the current status of the given drive.

SYNOPSIS
       #include "SDL.h"

       CDstatus  SDL_CDStatus(SDL_CD  *cdrom); /* Given a status, returns true
       if  there's  a  disk  in  the  drive  */   #define   CD_INDRIVE(status)
       ((int)status > 0)

DESCRIPTION
       This  function returns the current status of the given drive. Status is
       described like so:

       typedef enum {
         CD_TRAYEMPTY,
         CD_STOPPED,
         CD_PLAYING,
         CD_PAUSED,
         CD_ERROR = -1
       } CDstatus;

       If the drive has a CD in it, the table of contents of the CD  and  cur-
       rent play position of the CD will be stored in the SDL_CD structure.

       The  macro  CD_INDRIVE  is provided for convenience, and given a status
       returns true if there's a disk in the drive.

              Note:

              SDL_CDStatus also updates the SDL_CD structure passed to it.

EXAMPLE
       int playTrack(int track)
       {
         int playing = 0;

         if ( CD_INDRIVE(SDL_CDStatus(cdrom)) ) {
         /* clamp to the actual number of tracks on the CD */
           if (track >= cdrom->numtracks) {
             track = cdrom->numtracks-1;
           }

           if ( SDL_CDPlayTracks(cdrom, track, 0, 1, 0) == 0 ) {
             playing = 1;
           }
         }
         return playing;
       }

SEE ALSO
       SDL_CD

SDL                         Tue 11 Sep 2001, 22:58             SDL_CDStatus(3)

Generated by dwww version 1.15 on Sat Jun 22 00:53:12 CEST 2024.