clanSound CD Audio

Classes

class  clan::CDDrive
 CD drive audio interface. More...
 

Construction

 clan::CDDrive::CDDrive ()
 Constructs a null instance. More...
 
virtual clan::CDDrive::~CDDrive ()
 

Attributes

static std::vector< CDDrive > & clan::CDDrive::get_drives ()
 Returns the amount of CD drives available on the system. More...
 
bool clan::CDDrive::is_null () const
 Returns true if this object is invalid. More...
 
void clan::CDDrive::throw_if_null () const
 Throw an exception if this object is invalid. More...
 
std::string clan::CDDrive::get_drive_path ()
 Get the path of the CD drive. More...
 
std::string clan::CDDrive::get_cd_name ()
 Get the name of the CD. More...
 
int clan::CDDrive::get_num_tracks ()
 Get the number of tracks available on the cd. More...
 
bool clan::CDDrive::is_playing ()
 Returns true if the CD drive is playing. More...
 
int clan::CDDrive::get_cur_track ()
 Returns the current track. More...
 
int clan::CDDrive::get_cur_frame ()
 Returns the current frame on the track. More...
 

Operations

bool clan::CDDrive::play_tracks (int track, int end_track=0)
 Play from track 'track' til track 'end_track'. More...
 
bool clan::CDDrive::play_frames (int frame, int end_frame=0)
 Play from frame 'frame' to 'end_frame'. More...
 
bool clan::CDDrive::play_track (int track)
 Play track 'track'. Returns true if successful. More...
 
void clan::CDDrive::stop ()
 Stop playing. More...
 
void clan::CDDrive::pause ()
 Pause the playback. More...
 
void clan::CDDrive::resume ()
 Resume the playback. More...
 

Detailed Description

Function Documentation

clan::CDDrive::CDDrive ( )

Constructs a null instance.

Use get_drives() instead

virtual clan::CDDrive::~CDDrive ( )
virtual
std::string clan::CDDrive::get_cd_name ( )

Get the name of the CD.

int clan::CDDrive::get_cur_frame ( )

Returns the current frame on the track.

int clan::CDDrive::get_cur_track ( )

Returns the current track.

std::string clan::CDDrive::get_drive_path ( )

Get the path of the CD drive.

static std::vector<CDDrive>& clan::CDDrive::get_drives ( )
static

Returns the amount of CD drives available on the system.

int clan::CDDrive::get_num_tracks ( )

Get the number of tracks available on the cd.

bool clan::CDDrive::is_null ( ) const
inline

Returns true if this object is invalid.

bool clan::CDDrive::is_playing ( )

Returns true if the CD drive is playing.

void clan::CDDrive::pause ( )

Pause the playback.

bool clan::CDDrive::play_frames ( int  frame,
int  end_frame = 0 
)

Play from frame 'frame' to 'end_frame'.

Parameters
frameBegin frame.
end_frameEnd frame.
bool clan::CDDrive::play_track ( int  track)

Play track 'track'. Returns true if successful.

bool clan::CDDrive::play_tracks ( int  track,
int  end_track = 0 
)

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

Parameters
trackBegin track.
end_trackEnd track.
void clan::CDDrive::resume ( )

Resume the playback.

void clan::CDDrive::stop ( )

Stop playing.

void clan::CDDrive::throw_if_null ( ) const

Throw an exception if this object is invalid.