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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
|
/*
This file is part of libkabc.
Copyright (c) 2002 Tobias Koenig <tokoe@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., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef KABC_SOUND_H
#define KABC_SOUND_H
#include <tqcstring.h>
#include <tqstring.h>
#include <kdelibs_export.h>
namespace KABC {
/** @short Class that holds a Sound clip for a contact.
*
* The sound can be played doing something like this:
*
* \code
* KTempFile tmp;
* if(sound.isIntern()) {
* tmp.file()->tqwriteBlock( sound.data() );
* tmp.close();
* KAudioPlayer::play( tmp.name() );
* } else if(!sound.url().isEmpty()) {
* TQString tmpFile;
* if(!KIO::NetAccess::download(KURL(themeURL.url()), tmpFile, NULL))
* {
* KMessageBox::error(0L,
* KIO::NetAccess::lastErrorString(),
* i18n("Failed to download sound file"),
* KMessageBox::Notify
* );
* return;
* }
* KAudioPlayer::play( tmpFile );
* }
* \endcode
*
* Unfortunetly KAudioPlayer::play is ASync, so to delete the temporary file, the best you can really do is set a timer.
*
*/
class KABC_EXPORT Sound
{
friend KABC_EXPORT TQDataStream &operator<<( TQDataStream &, const Sound & );
friend KABC_EXPORT TQDataStream &operator>>( TQDataStream &, Sound & );
public:
/**
* Consturctor. Creates an empty object.
*/
Sound();
/**
* Consturctor.
*
* @param url A URL that describes the position of the sound file.
*/
Sound( const TQString &url );
/**
* Consturctor.
*
* @param data The raw data of the sound.
*/
Sound( const TQByteArray &data );
/**
* Destructor.
*/
~Sound();
bool operator==( const Sound & ) const;
bool operator!=( const Sound & ) const;
/**
* Sets a URL for the location of the sound file. When using this
* function, isIntern() will return 'false' until you use
* setData().
*
* @param url The location URL of the sound file.
*/
void setUrl( const TQString &url );
/**
* Test if this sound file has been set.
* Just does: !isIntern() && url.isEmpty()
* @since 3.4
*/
bool isEmpty() const;
/**
* Sets the raw data of the sound. When using this function,
* isIntern() will return 'true' until you use setUrl().
*
* @param data The raw data of the sound.
*/
void setData( const TQByteArray &data );
/**
* Returns whether the sound is described by a URL (extern) or
* by the raw data (intern).
* When this method returns 'true' you can use data() to
* get the raw data. Otherwise you can request the URL of this
* sound by url() and load the raw data from that location.
*/
bool isIntern() const;
/**
* Returns the location URL of this sound.
*/
TQString url() const;
/**
* Returns the raw data of this sound.
*/
TQByteArray data() const;
/**
* Returns string representation of the sound.
*/
TQString asString() const;
private:
TQString mUrl;
TQByteArray mData;
int mIntern;
};
KABC_EXPORT TQDataStream &operator<<( TQDataStream &, const Sound & );
KABC_EXPORT TQDataStream &operator>>( TQDataStream &, Sound & );
}
#endif
|
