[79d1f6]: libkwave / Connect.h Maximize Restore History

Download this file

Connect.h    58 lines (49 with data), 2.4 kB

 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
/*************************************************************************
Connect.h - function for connecting Kwave streaming objects
-------------------
begin : Sat Oct 27 2007
copyright : (C) 2007 by Thomas Eschenbacher
email : Thomas.Eschenbacher@gmx.de
***************************************************************************/
/***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#ifndef _CONNECT_H_
#define _CONNECT_H_
#include "config.h"
#include <kdemacros.h>
class QString;
namespace Kwave {
class StreamObject;
/**
* Connect an output of a Kwave::SampleSource to the input
* of a Kwave::SampleSink. The following combinations of
* single-track and multi-track sources/sinks are allowed.:
* \li single -> single (1:1)
* \li single -> multi (1:N)
* \li multi -> multi (N:N)
*
* @param source a Kwave::SampleSource that produces data
* @param output name of the output, must be formed with the
* Qt macro \c SIGNAL(...) \c out of
* a Qt style signal.
* @param sink a Kwave::SampleSink that can receive data
* @param input name of the inputm must be formed with the
* Qt macro \c SLOT(...) \c out of a Qt style
* (public) slot .
* @return true if successful or false if either
* \li an invalid combination of single/multi track
* source/sink has been passed
* \li a source or sink's track is NULL (missing)
* \li input or output name is zero-length
*/
bool connect(Kwave::StreamObject &source, const QString &output,
Kwave::StreamObject &sink, const QString &input)
KDE_EXPORT;
}
#endif /* _CONNECT_H_ */