.TH "KAudioPlayer" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdecore Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KAudioPlayer \- This class provides one-shot-and-forget audio playing.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kaudioplayer.h>\fP
.PP
Inherits \fBQObject\fP.
.PP
.SS "Public Slots"

.in +1c
.ti -1c
.RI "void \fBplay\fP ()"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKAudioPlayer\fP (const \fBQString\fP &filename, \fBQObject\fP *\fBparent\fP=0, const char *\fBname\fP=0)"
.br
.ti -1c
.RI "\fB~KAudioPlayer\fP ()"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static void \fBplay\fP (const \fBQString\fP &filename)"
.br
.in -1c
.SH "Detailed Description"
.PP 
This class provides one-shot-and-forget audio playing. 

You will never know if what you wanted to play really got played.
.PP
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.
.PP
Due to that fact, if you need 'fast' response times, more control or feedback, use the MCOP interfaces rather than this.
.PP
An example of using this class is:
.PP
.PP
.nf
   KAudioPlayer::play('/var/share/foo.wav');
.fi
.PP
.PP
If you want to use signals & slots, you can do something like:
.PP
.PP
.nf
   KAudioPlayer player('/var/share/foo.wav');
   connect(&button, SIGNAL(clicked()), &player, SLOT(play()));
.fi
.PP
 
.PP
Definition at line 56 of file kaudioplayer.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KAudioPlayer::KAudioPlayer (const \fBQString\fP & filename, \fBQObject\fP * parent = \fC0\fP, const char * name = \fC0\fP)"
.PP
Constructor. 
.PP
\fBParameters:\fP
.RS 4
\fIfilename\fP Absolute path to the filename of the sound file to play 
.br
\fIparent\fP A parent \fBQObject\fP for this KAudioPlayer 
.br
\fIname\fP An internal name for this KAudioPlayer
.RE
.PP

.PP
Definition at line 33 of file kaudioplayer.cpp.
.SS "KAudioPlayer::~\fBKAudioPlayer\fP ()"
.PP
Destructor. 
.PP

.PP
Definition at line 39 of file kaudioplayer.cpp.
.SH "Member Function Documentation"
.PP 
.SS "void KAudioPlayer::play (const \fBQString\fP & filename)\fC [static]\fP"
.PP
Static play function. 
.PP
\fBParameters:\fP
.RS 4
\fIfilename\fP Absolute path to the filename of the sound file to play. if not absolute, goes off KDEDIR/share/sounds/ (preferred)
.RE
.PP

.PP
Definition at line 44 of file kaudioplayer.cpp.
.SS "void KAudioPlayer::play ()\fC [slot]\fP"
.PP
Play function as slot. 
.PP
Plays the soundfile given to the constructor.
.PP
Definition at line 50 of file kaudioplayer.cpp.
.PP
References KNotifyClient::userEvent().

.SH "Author"
.PP 
Generated automatically by Doxygen for kdecore Library from the source code.
