CL_CDDrive Class Reference
[clanSound CD Audio]

CD drive audio interface. More...

#include <cd_drive.h>

List of all members.

Public Member Functions

Construction

 CL_CDDrive ()
 Constructs a null instance.
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.

Attributes



bool is_null () const
 Returns true if this object is invalid.
void throw_if_null () const
 Throw an exception if this object is invalid.
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.

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 null instance.

Use get_drives() instead

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_null (  )  const [inline]

Returns true if this object is invalid.

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.

void CL_CDDrive::throw_if_null (  )  const

Throw an exception if this object is invalid.


The documentation for this class was generated from the following file: