summaryrefslogtreecommitdiffstats
path: root/kdecore/kaudioplayer.h
diff options
context:
space:
mode:
authortoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
committertoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
commitce4a32fe52ef09d8f5ff1dd22c001110902b60a2 (patch)
tree5ac38a06f3dde268dc7927dc155896926aaf7012 /kdecore/kaudioplayer.h
downloadtdelibs-ce4a32fe52ef09d8f5ff1dd22c001110902b60a2.tar.gz
tdelibs-ce4a32fe52ef09d8f5ff1dd22c001110902b60a2.zip
Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.
BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdelibs@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'kdecore/kaudioplayer.h')
-rw-r--r--kdecore/kaudioplayer.h93
1 files changed, 93 insertions, 0 deletions
diff --git a/kdecore/kaudioplayer.h b/kdecore/kaudioplayer.h
new file mode 100644
index 000000000..bf77aeb59
--- /dev/null
+++ b/kdecore/kaudioplayer.h
@@ -0,0 +1,93 @@
+ /*
+
+ Copyright (C) 2000 Stefan Westerfeld
+ stefan@space.twc.de
+
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Library General Public
+ License as published by the Free Software Foundation; either
+ version 2 of the License, or (at your option) any later version.
+
+ This library is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ Library General Public License for more details.
+
+ You should have received a copy of the GNU Library General Public License
+ along with this library; see the file COPYING.LIB. If not, write to
+ the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
+
+ */
+
+#ifndef __KAUDIOPLAYER_H__
+#define __KAUDIOPLAYER_H__
+
+#include <qobject.h>
+#include "kdelibs_export.h"
+
+class KAudioPlayerPrivate;
+/**
+ * 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:
+ *
+ * \code
+ * KAudioPlayer::play("/var/share/foo.wav");
+ * \endcode
+ *
+ * If you want to use signals & slots, you can do something like:
+ *
+ * \code
+ * KAudioPlayer player("/var/share/foo.wav");
+ * connect(&button, SIGNAL(clicked()), &player, SLOT(play()));
+ * \endcode
+ *
+ */
+//REVISED: hausmann
+class KDECORE_EXPORT KAudioPlayer : public QObject {
+Q_OBJECT
+public:
+ /**
+ * Constructor.
+ *
+ * @param filename Absolute path to the filename of the sound file to play
+ * @param parent A parent QObject for this KAudioPlayer
+ * @param name An internal name for this KAudioPlayer
+ */
+ KAudioPlayer( const QString& filename,
+ QObject* parent = 0, const char* name = 0 );
+
+ /**
+ * Destructor.
+ */
+ ~KAudioPlayer();
+
+ /**
+ * Static play function.
+ *
+ * @param filename Absolute path to the filename of the sound file to play.
+ * if not absolute, goes off KDEDIR/share/sounds/ (preferred)
+ */
+ static void play(const QString &filename);
+
+public slots:
+ /**
+ * Play function as slot.
+ *
+ * Plays the soundfile given to the constructor.
+ */
+ void play();
+private:
+ KAudioPlayerPrivate *d;
+};
+
+#endif // __KAUDIOPLAYER_H__