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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
|
/*
* Ekiga -- A VoIP and Video-Conferencing application
* Copyright (C) 2000-2009 Damien Sandras <dsandras@seconix.com>
* 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. This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
*
* Ekiga is licensed under the GPL license and as a special exception, you
* have permission to link or otherwise combine this program with the
* programs OPAL, OpenH323 and PWLIB, and distribute the combination, without
* applying the requirements of the GNU GPL to the OPAL, OpenH323 and PWLIB
* programs, as long as you do follow the requirements of the GNU GPL for all
* the rest of the software thus combined.
*/
/*
* call.h - description
* ------------------------------------------
* begin : written in 2007 by Damien Sandras
* copyright : (c) 2007 by Damien Sandras
* description : declaration of the interface of a call handled by
* the Ekiga::CallManager.
*
*/
#ifndef __CALL_H__
#define __CALL_H__
#include <boost/signals.hpp>
#include <boost/bind.hpp>
#include <string>
#include <boost/smart_ptr.hpp>
namespace Ekiga
{
/**
* @addtogroup calls
* @{
*/
/*
* Everything is handled asynchronously and signaled through the
* Ekiga::CallManager
*/
class Call
{
public:
Call ()
{
}
virtual ~Call () { };
enum StreamType { Audio, Video };
/*
* Call Management
*/
/** Hangup the call
*/
virtual void hangup () = 0;
/** Answer an incoming call
*/
virtual void answer () = 0;
/** Transfer the call to the specified uri
* @param uri is the uri where to transfer the call
*/
virtual void transfer (std::string uri) = 0;
/** Put the call on hold or retrieve it
*/
virtual void toggle_hold () = 0;
/** Toggle the stream transmission (if any)
* @param the stream type
*/
virtual void toggle_stream_pause (StreamType type) = 0;
/** Send the given DTMF
* @param dtmf is the dtmf to send (one char)
*/
virtual void send_dtmf (const char dtmf) = 0;
/** Reject an incoming call after the given delay
* @param delay the delay after which reject the call
*/
virtual void set_reject_delay (unsigned delay) = 0;
/*
* Call Information
*/
/** Return the call id
* @return: the call id
*/
virtual const std::string get_id () const = 0;
/** Return the local party name
* @return: the local party name
*/
virtual const std::string get_local_party_name () const = 0;
/** Return the remote party name
* @return: the remote party name
*/
virtual const std::string get_remote_party_name () const = 0;
/** Return the remote application
* @return: the remote application
*/
virtual const std::string get_remote_application () const = 0;
/** Return the remote callback uri
* @return: the remote uri
*/
virtual const std::string get_remote_uri () const = 0;
/** Return the call duration
* @return the current call duration
*/
virtual const std::string get_duration () const = 0;
/** Return the call start date and time
* @return the current call start date and time
*/
virtual time_t get_start_time () const = 0;
/** Return information about call type
* @return true if it is an outgoing call
*/
virtual bool is_outgoing () const = 0;
/** Return the received audio bandwidth
* @return the received audio bandwidth in kbytes/s
*/
virtual double get_received_audio_bandwidth () const = 0;
/** Return the transmitted audio bandwidth
* @return the transmitted audio bandwidth in kbytes/s
*/
virtual double get_transmitted_audio_bandwidth () const = 0;
/** Return the received video bandwidth
* @return the received video bandwidth in kbytes/s
*/
virtual double get_received_video_bandwidth () const = 0;
/** Return the transmitted video bandwidth
* @return the transmitted video bandwidth in kbytes/s
*/
virtual double get_transmitted_video_bandwidth () const = 0;
/** Return the jitter size
* @return the jitter size in ms
*/
virtual unsigned get_jitter_size () const = 0;
/** Return the lost packets information
* @return the lost packets percentage
*/
virtual double get_lost_packets () const = 0;
/** Return the late packets information
* @return the late packets percentage
*/
virtual double get_late_packets () const = 0;
/** Return the out of order packets information
* @return the out of order packets percentage
*/
virtual double get_out_of_order_packets () const = 0;
/*
* Signals
*/
/* Signal emitted when the call is established
*/
boost::signal0<void> established;
/* Signal emitted when an established call is cleared
* @param: a string describing why the call was cleared
*/
boost::signal1<void, std::string> cleared;
/* Signal emitted when the call is missed, ie cleared
* without having been established
*/
boost::signal0<void> missed;
/* Signal emitted when the call is forwarded
*/
boost::signal0<void> forwarded;
/* Signal emitted when the call is held
*/
boost::signal0<void> held;
/* Signal emitted when the call is retrieved
*/
boost::signal0<void> retrieved;
/* Signal emitted when the call is being setup
*/
boost::signal0<void> setup;
/* Signal emitted when the remote party is ringing
*/
boost::signal0<void> ringing;
/* Signal emitted when a stream is opened
* @param the stream name
* @param the stream type
* @param transmission or reception
*/
boost::signal3<void, std::string, StreamType, bool> stream_opened;
/* Signal emitted when a stream is closed
* @param the stream name
* @param the stream type
* @param transmission or reception
*/
boost::signal3<void, std::string, StreamType, bool> stream_closed;
/* Signal emitted when a transmitted stream is paused
* @param the stream name
* @param the stream type
* @param transmission or reception
*/
boost::signal2<void, std::string, StreamType> stream_paused;
/* Signal emitted when a transmitted stream is resumed
* @param the stream name
* @param the stream type
* @param transmission or reception
*/
boost::signal2<void, std::string, StreamType> stream_resumed;
/** This signal is emitted when the Call is removed.
*/
boost::signal0<void> removed;
};
/**
* @}
*/
};
#endif
|
