summaryrefslogtreecommitdiffstats
path: root/arts/kde/kaudiomanagerplay.h
blob: 6bf332130ea7eceed035a6aceb6cef67a892c738 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
/*  This file is part of the KDE project
    Copyright (C) 2003 Matthias Kretz <kretz@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 version 2 as published by the Free Software Foundation.

    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 KAUDIOMANAGERPLAY_H
#define KAUDIOMANAGERPLAY_H

#include <artsflow.h>
#include <qstring.h>
#include <kdelibs_export.h>

class KArtsServer;
class QString;

/**
 * KDE Wrapper for Arts::Synth_AMAN_PLAY. Use this class to create an entry in
 * the AudioManager - that's the list you see when opening the AudioManager view
 * in artscontrol.
 *
 * @author Matthias Kretz <kretz@kde.org>
 * @since 3.2
 */
class KDE_ARTS_EXPORT KAudioManagerPlay
{
	public:
		KAudioManagerPlay( KArtsServer * server, const QString & title = QString::null );
		~KAudioManagerPlay();

		/**
		 * Returns the internal Arts::Synth_AMAN_PLAY
		 */
		Arts::Synth_AMAN_PLAY amanPlay();

		/**
		 * return true if this == 0 or amanPlay().isNull()
		 *
		 * in essence, ((KDE::PlayObject*)0)->isNull() will not
		 * crash
		 **/
		bool isNull() const;

		/**
		 * Set the name of the output in the AudioManager
		 */
		void setTitle( const QString & title );

		/**
		 * returns the name of the output as it appears in the AudioManager
		 */
		QString title();

		void setAutoRestoreID( const QString & autoRestoreID );
		QString autoRestoreID();

		void start();
		void stop();

	private:
		struct PrivateData {
			Arts::Synth_AMAN_PLAY amanPlay;
			bool started;
		};
		PrivateData* d;
};


#endif // KAUDIOMANAGERPLAY_H

// vim: sw=4 ts=4