home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / SLAX 6.0.8 / slax-6.0.8.iso / slax / base / 006-devel.lzm / usr / include / arts / kaudiomanagerplay.h < prev    next >
Encoding:
C/C++ Source or Header  |  2005-10-10  |  2.1 KB  |  85 lines
  1. /*  This file is part of the KDE project
  2.     Copyright (C) 2003 Matthias Kretz <kretz@kde.org>
  3.  
  4.     This library is free software; you can redistribute it and/or
  5.     modify it under the terms of the GNU Library General Public
  6.     License version 2 as published by the Free Software Foundation.
  7.  
  8.     This library is distributed in the hope that it will be useful,
  9.     but WITHOUT ANY WARRANTY; without even the implied warranty of
  10.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11.     Library General Public License for more details.
  12.  
  13.     You should have received a copy of the GNU Library General Public License
  14.     along with this library; see the file COPYING.LIB.  If not, write to
  15.     the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  16.     Boston, MA 02110-1301, USA.
  17.  
  18. */
  19.  
  20. #ifndef KAUDIOMANAGERPLAY_H
  21. #define KAUDIOMANAGERPLAY_H
  22.  
  23. #include <artsflow.h>
  24. #include <qstring.h>
  25. #include <kdelibs_export.h>
  26.  
  27. class KArtsServer;
  28. class QString;
  29.  
  30. /**
  31.  * KDE Wrapper for Arts::Synth_AMAN_PLAY. Use this class to create an entry in
  32.  * the AudioManager - that's the list you see when opening the AudioManager view
  33.  * in artscontrol.
  34.  *
  35.  * @author Matthias Kretz <kretz@kde.org>
  36.  * @since 3.2
  37.  */
  38. class KDE_ARTS_EXPORT KAudioManagerPlay
  39. {
  40.     public:
  41.         KAudioManagerPlay( KArtsServer * server, const QString & title = QString::null );
  42.         ~KAudioManagerPlay();
  43.  
  44.         /**
  45.          * Returns the internal Arts::Synth_AMAN_PLAY
  46.          */
  47.         Arts::Synth_AMAN_PLAY amanPlay();
  48.  
  49.         /**
  50.          * return true if this == 0 or amanPlay().isNull()
  51.          *
  52.          * in essence, ((KDE::PlayObject*)0)->isNull() will not
  53.          * crash
  54.          **/
  55.         bool isNull() const;
  56.  
  57.         /**
  58.          * Set the name of the output in the AudioManager
  59.          */
  60.         void setTitle( const QString & title );
  61.  
  62.         /**
  63.          * returns the name of the output as it appears in the AudioManager
  64.          */
  65.         QString title();
  66.  
  67.         void setAutoRestoreID( const QString & autoRestoreID );
  68.         QString autoRestoreID();
  69.  
  70.         void start();
  71.         void stop();
  72.  
  73.     private:
  74.         struct PrivateData {
  75.             Arts::Synth_AMAN_PLAY amanPlay;
  76.             bool started;
  77.         };
  78.         PrivateData* d;
  79. };
  80.  
  81.  
  82. #endif // KAUDIOMANAGERPLAY_H
  83.  
  84. // vim: sw=4 ts=4
  85.