|
|
// -*-C++-*- /* This file is part of the KDE libraries Copyright (C) 1997 Christian Esken (esken@kde.org) 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ #ifndef KAUDIO_H #define KAUDIO_H "$Id: kaudio.h,v 1.16 1999/12/13 18:20:24 kulow Exp $" #include <string> #include <qobject.h> #include <qtimer.h> /** * The KAudio class is a very easy means to playback digital audio * data. A standard procedure looks like this example: * * // Class definition * class DemoClient : public KTMainWindow * { * Q_OBJECT * * public: * DemoClient(); * KAudio KAServer; * * public slots: * void playOK(); * // [...] * } * * // Program * // ************* Initialization ****************************** * DemoClient *myClient = new DemoClient(); * if (myClient->KAServer.serverStatus()) { * cerr << "Failed contacting audio server\n"; * exit (1); * } * * * // ************* If you want to recieve Qt signals *********** * KAServer.setSignals(true); * QObject::connect(&KAServer, SIGNAL(playFinished()), this, SLOT(playOK())); * * * // ************* Playback ************************************ * KAServer.play("/my/sounds/is/here.wav"); * * See democlient.cpp in the kdebase sources for a full program * showing more possibilities of the KAudio class */ class KAudio : public QObject { Q_OBJECT public: /** * Create an Audio player */ KAudio(); /** * Destroy the Audio player again */ ~KAudio(); /** * Play the Wav last set via setFilename(filename) or play(filename) */ bool play(); /** * Set filename as current media name and play it */ bool play(const char *filename); /** * Set filename as current media name and play it */ bool play(QString& filename); /** * Set the "current" Filename. This file can be played later with ::play() */ bool setFilename(const char *filename); /** * Set the "current" Filename. This file can be played later with ::play() */ bool setFilename(QString& filename); /** * If true is given, every play call is synced directly. */ void setAutosync(bool autosync); /** If you want to recieve a Qt signal when your media is finished, you must * call setSignals(true) before you play your media. */ void setSignals(bool sigs=true); /** * Stop current media */ bool stop(); /** Sync media. This effectively blocks the calling process until the * media is played fully */ void sync(); /** Query Server status. 0 means OK. You MUST check server status after * creating a KAudio object. */ int serverStatus(); signals: /** * Signal gets emitted after current media has been finished. * This signal only gets emitted, if setSignals(true) was called before. * Do not forget to include this signal in your own derived class if you * want signals. */ void playFinished(); private: bool ServerContacted; bool autosync; std::string wavName; long execID, clientID; QTimer *finishTimer; int sockFD; }; /** * @libdoc Interface to the KDE sound system * * This library provides an interface to the KDE sound system, allowing * applications to play sounds in various formats. The API is * encapsulated in the @ref KAudio class. */ #endif
Generated by: dfaure@faure on Sun Mar 26 14:25:21 2000, using kdoc 2.0a35. |