CL_CDDrive Class Reference
[clanSound CD Audio]

CD drive audio interface. More...

#include <cd_drive.h>

List of all members.

Attributes

CL_String8 get_drive_path ()
 Get the path of the CD drive.
CL_String8 get_cd_name ()
 Get the name of the CD.
int get_num_tracks ()
 Get the number of tracks available on the cd.
bool is_playing ()
 Returns true if the CD drive is playing.
int get_cur_track ()
 Returns the current track.
int get_cur_frame ()
 Returns the current frame on the track.
static std::vector< CL_CDDrive > & get_drives ()
 Returns the amount of CD drives available on the system.

Public Member Functions

Construction
 CL_CDDrive ()
 Constructs a CD drive object.
 CL_CDDrive (const CL_CDDrive &copy)
 Constructs a CDDrive.
virtual ~CL_CDDrive ()
Operations
bool play_tracks (int track, int end_track=0)
 Play from track 'track' til track 'end_track'.
bool play_frames (int frame, int end_frame=0)
 Play from frame 'frame' to 'end_frame'.
bool play_track (int track)
 Play track 'track'. Returns true if successful.
void stop ()
 Stop playing.
void pause ()
 Pause the playback.
void resume ()
 Resume the playback.


Detailed Description

CD drive audio interface.

Use this class to control the CDROM drive in your computer.


Constructor & Destructor Documentation

CL_CDDrive::CL_CDDrive  ) 
 

Constructs a CD drive object.

CL_CDDrive::CL_CDDrive const CL_CDDrive copy  ) 
 

Constructs a CDDrive.

Parameters:
copy = CDDrive

virtual CL_CDDrive::~CL_CDDrive  )  [virtual]
 


Member Function Documentation

CL_String8 CL_CDDrive::get_cd_name  ) 
 

Get the name of the CD.

int CL_CDDrive::get_cur_frame  ) 
 

Returns the current frame on the track.

int CL_CDDrive::get_cur_track  ) 
 

Returns the current track.

CL_String8 CL_CDDrive::get_drive_path  ) 
 

Get the path of the CD drive.

static std::vector<CL_CDDrive>& CL_CDDrive::get_drives  )  [static]
 

Returns the amount of CD drives available on the system.

int CL_CDDrive::get_num_tracks  ) 
 

Get the number of tracks available on the cd.

bool CL_CDDrive::is_playing  ) 
 

Returns true if the CD drive is playing.

void CL_CDDrive::pause  ) 
 

Pause the playback.

bool CL_CDDrive::play_frames int  frame,
int  end_frame = 0
 

Play from frame 'frame' to 'end_frame'.

Parameters:
frame Begin frame.
end_frame End frame.

bool CL_CDDrive::play_track int  track  ) 
 

Play track 'track'. Returns true if successful.

bool CL_CDDrive::play_tracks int  track,
int  end_track = 0
 

Play from track 'track' til track 'end_track'.

Parameters:
track Begin track.
end_track End track.

void CL_CDDrive::resume  ) 
 

Resume the playback.

void CL_CDDrive::stop  ) 
 

Stop playing.


The documentation for this class was generated from the following file:
Generated on Thu Dec 3 02:39:35 2009 for ClanLib by  doxygen 1.4.6