Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

KAudioPlayer Class Reference

#include <kaudioplayer.h>

List of all members.

Public Slots

void play ()

Public Methods

 KAudioPlayer (const QString &filename, QObject *parent=0, const char *name=0)
 ~KAudioPlayer ()

Static Public Methods

void play (const QString &filename)


Detailed Description

This class provides one-shot-and-forget audio playing. You will never know if what you wanted to play really got played.

It doesn't require linking any special libraries, as it operates over DCOP. In the current implementation, it only indirectly communicates with the aRts soundserver, using knotify as DCOP -> MCOP bridge.

Due to that fact, if you need "fast" response times, more control or feedback, use the MCOP interfaces rather than this.

An example of using this class is:

   KAudioPlayer::play("/var/share/foo.wav");
 

If you want to use signals & slots, you can do something like:

   KAudioPlayer player("/var/share/foo.wav");
   connect(&button, SIGNAL(clicked()), &player, SLOT(play()));
 

Definition at line 55 of file kaudioplayer.h.


Constructor & Destructor Documentation

KAudioPlayer::KAudioPlayer const QString &    filename,
QObject *    parent = 0,
const char *    name = 0
 

Constructor.

Parameters:
filename  Absolute path to the filename of the sound file to play
parent  A parent QObject for this KAudioPlayer
name  An internal name for this KAudioPlayer

KAudioPlayer::~KAudioPlayer  
 

Destructor.


Member Function Documentation

void KAudioPlayer::play   [slot]
 

Play function as slot.

Plays the soundfile given to the constructor.

void KAudioPlayer::play const QString &    filename [static]
 

Static play function.

Parameters:
filename  Absolute path to the filename of the sound file to play. if not absolute, goes off KDEDIR/share/sounds/ (preferred)


The documentation for this class was generated from the following file:
Generated on Wed Aug 13 23:30:06 2003 for kdelibs by doxygen1.2.18