← Back to branch summary

~ubuntu-branches/ubuntu/wily/sflphone/wily

« back to all changes in this revision

Viewing changes to daemon/src/dbus/callmanager-introspec.xml

  • Committer: Package Import Robot
  • Author(s): Mark Purcell
  • Date: 2014-01-28 18:23:36 UTC
  • mfrom: (1.1.11)
  • mto: This revision was merged to the branch mainline in revision 24.
  • Revision ID: package-import@ubuntu.com-20140128182336-3xenud1kbnwmf3mz
http://bugs.debian.org/735846
http://bugs.debian.org/727164
http://bugs.debian.org/718178
http://bugs.debian.org/736583
http://bugs.debian.org/722040
http://bugs.debian.org/736746
* New upstream release 
  - Fixes "New Upstream Release" (Closes: #735846)
  - Fixes "Ringtone does not stop" (Closes: #727164)
  - Fixes "[sflphone-kde] crash on startup" (Closes: #718178)
  - Fixes "sflphone GUI crashes when call is hung up" (Closes: #736583)
* Build-Depends: ensure GnuTLS 2.6
  - libucommon-dev (>= 6.0.7-1.1), libccrtp-dev (>= 2.0.6-3)
  - Fixes "FTBFS Build-Depends libgnutls{26,28}-dev" (Closes: #722040)
* Fix "boost 1.49 is going away" unversioned Build-Depends: (Closes: #736746)
* Add Build-Depends: libsndfile-dev, nepomuk-core-dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
daemon/src/dbus/callmanager-introspec.xml
1
 
<?xml version="1.0" encoding="UTF-8" ?>
2
 
 
3
 
<node name="/callmanager-introspec" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
4
 
    <interface name="org.sflphone.SFLphone.CallManager">
5
 
 
6
 
        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
7
 
            <p>The CallManager interface is used to manage call and conference related actions.</p>
8
 
            <p>Since SFLphone-daemon supports multiple incoming/outgoing calls, any actions involving a specific call must address the method by the means of a unique callID.
9
 
            SFLphone-clients is responsible for generating the callID on outgoing calls. Conversely, SFLphone-daemon will generate a unique callID for incoming calls.</p>
10
 
        </tp:docstring>
11
 
        <method name="placeCall" tp:name-for-bindings="placeCall">
12
 
            <tp:docstring>
13
 
              <p>This is the main method in order to place a new call. The call is registered with the daemon using this method.</p>
14
 
            </tp:docstring>
15
 
            <arg type="s" name="accountID" direction="in">
16
 
              <tp:docstring>
17
 
                The ID of the account with which you want to make a call. If the call is to be placed without any account by means of a SIP URI (i.e. sip:num@server), the "IP2IP_PROFILE" is passed as the accountID. For more details on accounts see the configuration manager interface.
18
 
              </tp:docstring>
19
 
            </arg>
20
 
            <arg type="s" name="callID" direction="in">
21
 
              <tp:docstring>
22
 
                The callID is a unique identifier that must be randomly generated on the client's side. Any subsequent actions refering to this call must use this callID.
23
 
              </tp:docstring>
24
 
            </arg>
25
 
            <arg type="s" name="to" direction="in">
26
 
              <tp:docstring>
27
 
                If bound to a VoIP account, then the argument is the phone number. In case of calls involving "IP2IP_PROFILE", a complete SIP URI must be specified.
28
 
              </tp:docstring>
29
 
            </arg>
30
 
            <arg type="b" name="callSucceeded" direction="out"/>
31
 
        </method>
32
 
 
33
 
        <method name="refuse" tp:name-for-bindings="refuse">
34
 
            <tp:docstring>
35
 
              Refuse an incoming call.
36
 
            </tp:docstring>
37
 
            <arg type="s" name="callID" direction="in">
38
 
              <tp:docstring>
39
 
                The callID.
40
 
              </tp:docstring>
41
 
            </arg>
42
 
            <arg type="b" name="refuseSucceeded" direction="out"/>
43
 
 
44
 
        </method>
45
 
 
46
 
        <method name="accept" tp:name-for-bindings="accept">
47
 
            <tp:docstring>
48
 
              Answer an incoming call. Automatically puts the current call on HOLD.
49
 
            </tp:docstring>
50
 
            <arg type="s" name="callID" direction="in">
51
 
              <tp:docstring>
52
 
                The callID.
53
 
              </tp:docstring>
54
 
            </arg>
55
 
            <arg type="b" name="acceptSucceeded" direction="out"/>
56
 
        </method>
57
 
 
58
 
        <method name="hangUp" tp:name-for-bindings="hangUp">
59
 
            <tp:docstring>
60
 
              Hangup a call in state "CURRENT" or "HOLD".
61
 
            </tp:docstring>
62
 
            <arg type="s" name="callID" direction="in">
63
 
              <tp:docstring>
64
 
                The callID.
65
 
              </tp:docstring>
66
 
            </arg>
67
 
            <arg type="b" name="hangupSucceeded" direction="out"/>
68
 
        </method>
69
 
 
70
 
        <method name="hangUpConference" tp:name-for-bindings="hangUpConference">
71
 
            <tp:added version="0.9.7"/>
72
 
            <tp:docstring>
73
 
              Hangup a conference, and every call participating to the conference.
74
 
            </tp:docstring>
75
 
            <arg type="s" name="confID" direction="in">
76
 
              <tp:docstring>
77
 
                The unique conference ID.
78
 
              </tp:docstring>
79
 
            </arg>
80
 
            <arg type="b" name="hangupSucceeded" direction="out"/>
81
 
        </method>
82
 
 
83
 
        <method name="hold" tp:name-for-bindings="hold">
84
 
            <tp:docstring>
85
 
              Place a call on hold.
86
 
            </tp:docstring>
87
 
            <arg type="s" name="callID" direction="in">
88
 
              <tp:docstring>
89
 
                The callID.
90
 
              </tp:docstring>
91
 
            </arg>
92
 
            <arg type="b" name="holdSucceeded" direction="out"/>
93
 
        </method>
94
 
 
95
 
        <method name="unhold" tp:name-for-bindings="unhold">
96
 
            <tp:docstring>
97
 
              Take a call off hold, and place this call in state CURRENT.
98
 
            </tp:docstring>
99
 
            <arg type="s" name="callID" direction="in">
100
 
              <tp:docstring>
101
 
                The callID.
102
 
              </tp:docstring>
103
 
            </arg>
104
 
            <arg type="b" name="unHoldSucceeded" direction="out"/>
105
 
        </method>
106
 
 
107
 
        <method name="transfer" tp:name-for-bindings="transfer">
108
 
            <tp:docstring>
109
 
              Transfer a call to the given phone number.
110
 
            </tp:docstring>
111
 
            <arg type="s" name="callID" direction="in">
112
 
              <tp:docstring>
113
 
                The callID.
114
 
              </tp:docstring>
115
 
            </arg>
116
 
            <arg type="s" name="to" direction="in">
117
 
              <tp:docstring>
118
 
                The phone number to which the call will be transferred.
119
 
              </tp:docstring>
120
 
            </arg>
121
 
            <arg type="b" name="transferSucceeded" direction="out"/>
122
 
        </method>
123
 
 
124
 
        <method name="attendedTransfer" tp:name-for-bindings="attendedTransfer">
125
 
            <tp:docstring>
126
 
              Perform an attended transfer on two calls.
127
 
            </tp:docstring>
128
 
            <arg type="s" name="transferID" direction="in">
129
 
              <tp:docstring>
130
 
                The callID of the call to be transfered.
131
 
              </tp:docstring>
132
 
            </arg>
133
 
            <arg type="s" name="targetID" direction="in">
134
 
              <tp:docstring>
135
 
                The callID of the target call.
136
 
              </tp:docstring>
137
 
            </arg>
138
 
            <arg type="b" name="transferSucceeded" direction="out"/>
139
 
        </method>
140
 
 
141
 
        <method name="playDTMF" tp:name-for-bindings="playDTMF">
142
 
            <tp:docstring>
143
 
              Dual-Tone multi-frequency. Tell the core to play dialtones. A SIP INFO message is sent to notify the server.
144
 
            </tp:docstring>
145
 
            <arg type="s" name="key" direction="in">
146
 
              <tp:docstring>
147
 
                Unicode character for pressed key.
148
 
              </tp:docstring>
149
 
            </arg>
150
 
        </method>
151
 
 
152
 
        <method name="startTone" tp:name-for-bindings="startTone">
153
 
            <tp:docstring>
154
 
              Start audio stream and play tone.
155
 
            </tp:docstring>
156
 
            <arg type="i" name="start" direction="in"/>
157
 
            <arg type="i" name="type" direction="in"/>
158
 
        </method>
159
 
 
160
 
        <method name="setVolume" tp:name-for-bindings="setVolume">
161
 
            <tp:docstring>
162
 
              <p>Sets the volume using a linear scale [0,100].</p>
163
 
              <tp:rationale>Pulseaudio has its own mechanism to modify application volume. This method is enabled only if the ALSA API is used.</tp:rationale>
164
 
            </tp:docstring>
165
 
            <arg type="s" name="device" direction="in">
166
 
              <tp:docstring>
167
 
                The device: mic or speaker
168
 
              </tp:docstring>
169
 
            </arg>
170
 
            <arg type="d" name="value" direction="in">
171
 
              <tp:docstring>
172
 
                The volume value (between 0 and 100)
173
 
              </tp:docstring>
174
 
            </arg>
175
 
        </method>
176
 
 
177
 
        <method name="getVolume" tp:name-for-bindings="getVolume">
178
 
            <tp:docstring>
179
 
              <p>Return the volume value of the given device on a linear scale [0,100].</p>
180
 
              <tp:rationale>Only enabled if the ALSA API is used, Pulseaudio has its own mechanism to modify application volume.</tp:rationale>
181
 
            </tp:docstring>
182
 
            <arg type="s" name="device" direction="in">
183
 
              <tp:docstring>
184
 
                The device: mic or speaker
185
 
              </tp:docstring>
186
 
            </arg>
187
 
            <arg type="d" name="value" direction="out">
188
 
              <tp:docstring>
189
 
                The volume value (between 0 and 100)
190
 
              </tp:docstring>
191
 
            </arg>
192
 
        </method>
193
 
 
194
 
        <method name="joinParticipant" tp:name-for-bindings="joinParticipant">
195
 
            <tp:added version="0.9.7"/>
196
 
            <tp:docstring>
197
 
              <p>Join two participants together to create a 3-way conference including the current client.</p>
198
 
              <tp:rationale>The signal <tp:member-ref>conferenceCreated</tp:member-ref> is emitted on success.</tp:rationale>
199
 
            </tp:docstring>
200
 
            <arg type="s" name="sel_callID" direction="in"/>
201
 
            <arg type="s" name="drag_callID" direction="in"/>
202
 
            <arg type="b" name="joinSucceeded" direction="out"/>
203
 
        </method>
204
 
 
205
 
        <method name="createConfFromParticipantList" tp:name-for-bindings="createConfFromParticipantList">
206
 
            <tp:added version="0.9.14"/>
207
 
            <tp:docstring>
208
 
                <p>Create a conference from a list of participants</p>
209
 
            <tp:rationale>The signal <tp:member-ref>conferenceCreated</tp:member-ref> is emitted on success.</tp:rationale>
210
 
            </tp:docstring>
211
 
            <arg type="as" name="participants" direction="in"/>
212
 
        </method>
213
 
 
214
 
        <method name="addParticipant" tp:name-for-bindings="addParticipant">
215
 
            <tp:added version="0.9.7"/>
216
 
            <tp:docstring>
217
 
              <p>Join a new particiant to an existing conference.</p>
218
 
              <tp:rationale>The signal <tp:member-ref>conferenceChanged</tp:member-ref> is emitted on success.</tp:rationale>
219
 
            </tp:docstring>
220
 
            <arg type="s" name="callID" direction="in">
221
 
              <tp:docstring>
222
 
                The ID of the call to add to the conference
223
 
              </tp:docstring>
224
 
            </arg>
225
 
            <arg type="s" name="confID" direction="in">
226
 
              <tp:docstring>
227
 
                An existing conference ID
228
 
              </tp:docstring>
229
 
            </arg>
230
 
            <arg type="b" name="addSucceeded" direction="out"/>
231
 
        </method>
232
 
 
233
 
        <method name="addMainParticipant" tp:name-for-bindings="addMainParticipant">
234
 
            <tp:added version="0.9.7"/>
235
 
            <tp:docstring>
236
 
              <p>As the core can handle multiple calls and conferences, it may happen that the client's user leaves a conference to answer an incoming call or to start new calls. This method is used to reintroduce SFLphone-client's user into the conference.</p>
237
 
              <p>Its put the current call on HOLD or detaches SFLphone-client's user from the another conference.</p>
238
 
            </tp:docstring>
239
 
            <arg type="s" name="confID" direction="in">
240
 
              <tp:docstring>
241
 
                An existing conference ID
242
 
              </tp:docstring>
243
 
            </arg>
244
 
            <arg type="b" name="addSucceeded" direction="out"/>
245
 
        </method>
246
 
 
247
 
        <method name="detachParticipant" tp:name-for-bindings="detachParticipant">
248
 
            <tp:added version="0.9.7"/>
249
 
            <tp:docstring>
250
 
              Detach the given call from the conference. If only one participant is left, the conference is deleted and the signal <tp:member-ref>conferenceRemoved</tp:member-ref> is emited.
251
 
            </tp:docstring>
252
 
            <arg type="s" name="callID" direction="in">
253
 
              <tp:docstring>
254
 
                The call ID
255
 
              </tp:docstring>
256
 
            </arg>
257
 
            <arg type="b" name="detachSucceeded" direction="out"/>
258
 
        </method>
259
 
 
260
 
        <method name="joinConference" tp:name-for-bindings="joinConference">
261
 
            <tp:added version="0.9.7"/>
262
 
            <tp:docstring>
263
 
                Join two conferences together.
264
 
            </tp:docstring>
265
 
            <arg type="s" name="sel_confID" direction="in"/>
266
 
            <arg type="s" name="drag_confID" direction="in"/>
267
 
            <arg type="b" name="joinSucceeded" direction="out"/>
268
 
        </method>
269
 
 
270
 
        <method name="getConferenceDetails" tp:name-for-bindings="getConferenceDetails">
271
 
            <tp:added version="0.9.7"/>
272
 
            <tp:docstring>
273
 
              Returns a hashtable containing conference details.
274
 
            </tp:docstring>
275
 
            <arg type="s" name="callID" direction="in">
276
 
              <tp:docstring>
277
 
                The conference ID
278
 
              </tp:docstring>
279
 
            </arg>
280
 
            <annotation name="com.trolltech.QtDBus.QtTypeName.Out0" value="MapStringString"/>
281
 
            <arg type="a{ss}" name="infos" direction="out">
282
 
              <tp:docstring>
283
 
                A map containing the ID of the conferences
284
 
                and their states:
285
 
                <ul>
286
 
                  <li>ACTIVE_ATTACHED</li>
287
 
                  <li>ACTIVE_DETACHED</li>
288
 
                  <li>HOLD</li>
289
 
                </ul>
290
 
              </tp:docstring>
291
 
            </arg>
292
 
        </method>
293
 
 
294
 
        <method name="getConferenceList" tp:name-for-bindings="getConferenceList">
295
 
            <tp:added version="0.9.7"/>
296
 
            <tp:docstring>
297
 
              Returns a list containing all active
298
 
              conferences.
299
 
              <tp:rationale>To update client status, one should
300
 
              use <tp:member-ref>getParticipantList</tp:member-ref>
301
 
              with provided conference IDs.</tp:rationale>
302
 
            </tp:docstring>
303
 
            <arg type="as" name="list" direction="out">
304
 
              <tp:docstring>
305
 
                The list of conferences.
306
 
              </tp:docstring>
307
 
            </arg>
308
 
        </method>
309
 
 
310
 
        <method name="getConferenceId" tp:name-for-bindings="getConferenceId">
311
 
            <tp:added version="1.1.0"/>
312
 
            <tp:docstring>
313
 
                If thsi call participate to a conference, return the conference id.
314
 
                Return an empty string elsewhere.
315
 
            </tp:docstring>
316
 
            <arg type="s" name="callID" direction="in">
317
 
              <tp:docstring>
318
 
                The call id.
319
 
              </tp:docstring>
320
 
            </arg>
321
 
            <arg type="s" name="confID" direction="out">
322
 
              <tp:docstring>
323
 
                A string containing the conference ID, or an empty string.
324
 
              </tp:docstring>
325
 
            </arg>
326
 
        </method>
327
 
 
328
 
        <method name="setRecording" tp:name-for-bindings="setRecording">
329
 
            <tp:docstring>
330
 
              Start recording a call.
331
 
            </tp:docstring>
332
 
            <arg type="s" name="callID" direction="in">
333
 
              <tp:docstring>
334
 
                The ID of the call to record.
335
 
              </tp:docstring>
336
 
            </arg>
337
 
        </method>
338
 
 
339
 
        <method name="getIsRecording" tp:name-for-bindings="getIsRecording">
340
 
            <tp:docstring>
341
 
              Tells whether or not a call is being recorded.
342
 
            </tp:docstring>
343
 
            <arg type="s" name="callID" direction="in">
344
 
              <tp:docstring>
345
 
                The call ID.
346
 
              </tp:docstring>
347
 
            </arg>
348
 
            <arg type="b" name="isRecording" direction="out">
349
 
              <tp:docstring>
350
 
                Returns true is the call is being recorded. False otherwise.
351
 
              </tp:docstring>
352
 
            </arg>
353
 
        </method>
354
 
 
355
 
        <method name="recordPlaybackSeek" tp:name-for-bindings="recordPlaybackSeek">
356
 
            <tp:docstring>
357
 
              <p>Sets the playback position using a linear scale [0,100].</p>
358
 
            </tp:docstring>
359
 
            <arg type="d" name="value" direction="in"/>
360
 
        </method>
361
 
 
362
 
        <signal name="recordPlaybackFilepath" tp:name-for-bindings="recordPlaybackFilepath">
363
 
            <tp:docstring>
364
 
              Once after starting recording for the first time, this signal is emited to
365
 
              provide the recorded file path to client application.
366
 
            </tp:docstring>
367
 
            <arg type="s" name="callID" />
368
 
            <arg type="s" name="filepath"/>
369
 
        </signal>
370
 
 
371
 
        <signal name="recordPlaybackStopped" tp:name-for-bindings="recordPlaybackStopped">
372
 
            <tp:docstring/>
373
 
            <arg type="s" name="filepath" />
374
 
        </signal>
375
 
 
376
 
        <signal name="updatePlaybackScale" tp:name-for-bindings="updatePlaybackScale">
377
 
            <tp:docstring/>
378
 
            <arg type="i" name="position" />
379
 
            <arg type="i" name="size" />
380
 
        </signal>
381
 
 
382
 
        <method name="getCallDetails" tp:name-for-bindings="getCallDetails">
383
 
            <tp:docstring>
384
 
              Get all the details about a specific call.
385
 
            </tp:docstring>
386
 
            <arg type="s" name="callID" direction="in">
387
 
              <tp:docstring>
388
 
                The call ID.
389
 
              </tp:docstring>
390
 
            </arg>
391
 
            <annotation name="com.trolltech.QtDBus.QtTypeName.Out0" value="MapStringString"/>
392
 
            <arg type="a{ss}" name="infos" direction="out" tp:type="String_String_Map">
393
 
              <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
394
 
                <p>A map containing the call details: </p>
395
 
                <ul>
396
 
                  <li>ACCOUNTID</li>
397
 
                  <li>PEER_NUMBER</li>
398
 
                  <li>PEER_NAME</li>
399
 
                  <li>DISPLAY_NAME</li>
400
 
                  <li>CALL_STATE</li>
401
 
                  <li>CALL_TYPE</li>
402
 
                  <li>CONF_ID</li>
403
 
                </ul>
404
 
              </tp:docstring>
405
 
            </arg>
406
 
        </method>
407
 
 
408
 
        <method name="getCallList" tp:name-for-bindings="getCallList">
409
 
            <tp:docstring>
410
 
              Get the list of active calls.
411
 
              <tp:rationale>To get the call details, iterate on the return value and call <tp:member-ref>getCallDetails</tp:member-ref> method.</tp:rationale>
412
 
            </tp:docstring>
413
 
            <arg type="as" name="list" direction="out">
414
 
              <tp:docstring>
415
 
                A list of call IDs.
416
 
              </tp:docstring>
417
 
            </arg>
418
 
        </method>
419
 
 
420
 
        <method name="getCurrentAudioCodecName" tp:name-for-bindings="getCurrentAudioCodecName">
421
 
            <arg type="s" name="callID" direction="in"/>
422
 
            <arg type="s" name="codecName" direction="out"/>
423
 
        </method>
424
 
 
425
 
        <method name="sendTextMessage" tp:name-for-bindings="sendTextMessage">
426
 
            <tp:docstring>
427
 
                Send a text message to the specified call
428
 
            </tp:docstring>
429
 
            <arg type="s" name="callID" direction="in"/>
430
 
            <arg type="s" name="message" direction="in"/>
431
 
        </method>
432
 
 
433
 
        <signal name="newCallCreated" tp:name-for-bindings="newCallCreated">
434
 
            <tp:docstring>
435
 
              <p>Notify that a call has been created.</p>
436
 
              <p>The callID generated by the daemon must be stored by the clients in order to address other actions for
437
 
                this call. This signal is emitted when call haves been created by the daemon itself.</p>
438
 
              <tp:rationale>The client must subscribe to this signal to handle calls created by other clients</tp:rationale>
439
 
            </tp:docstring>
440
 
            <arg type="s" name="accountID">
441
 
              <tp:docstring>
442
 
                The account ID of the call. Clients must notify the right account when receiving this signal.
443
 
              </tp:docstring>
444
 
            </arg>
445
 
            <arg type="s" name="callID">
446
 
              <tp:docstring>
447
 
                A new call ID.
448
 
              </tp:docstring>
449
 
            </arg>
450
 
            <arg type="s" name="to">
451
 
              <tp:docstring>
452
 
               The SIP URI this call is trying to reach.
453
 
              </tp:docstring>
454
 
            </arg>
455
 
        </signal>
456
 
 
457
 
        <signal name="incomingCall" tp:name-for-bindings="incomingCall">
458
 
            <tp:docstring>
459
 
              <p>Notify an incoming call.</p>
460
 
              <p>The callID generated by the daemon must be stored by the clients in order to address other action for
461
 
                this call. This signal is emitted when we receive a call from a remote peer</p>
462
 
              <tp:rationale>The client must subscribe to this signal to handle incoming calls.</tp:rationale>
463
 
            </tp:docstring>
464
 
            <arg type="s" name="accountID">
465
 
              <tp:docstring>
466
 
                The account ID of the callee. Clients must notify the right account when receiving this signal.
467
 
              </tp:docstring>
468
 
            </arg>
469
 
            <arg type="s" name="callID">
470
 
              <tp:docstring>
471
 
                A new call ID.
472
 
              </tp:docstring>
473
 
            </arg>
474
 
            <arg type="s" name="from">
475
 
              <tp:docstring>
476
 
                The caller phone number.
477
 
              </tp:docstring>
478
 
            </arg>
479
 
        </signal>
480
 
 
481
 
        <signal name="incomingMessage" tp:name-for-bindings="incomingMessage">
482
 
            <tp:docstring>
483
 
                Notify clients that a new text message has been received.
484
 
            </tp:docstring>
485
 
            <arg type="s" name="callID" />
486
 
            <arg type="s" name="from" />
487
 
            <arg type="s" name="message" />
488
 
        </signal>
489
 
 
490
 
        <signal name="callStateChanged" tp:name-for-bindings="callStateChanged">
491
 
            <tp:docstring>
492
 
              <p>Notify of a change in a call state.</p>
493
 
              <p>The client must subscribe to this signal.</p>
494
 
            </tp:docstring>
495
 
            <arg type="s" name="callID">
496
 
              <tp:docstring>
497
 
                The call ID.
498
 
              </tp:docstring>
499
 
            </arg>
500
 
            <arg type="s" name="state" >
501
 
              <tp:docstring>
502
 
                The acceptable states are:
503
 
                <ul>
504
 
                  <li>INCOMING: Initial state of incoming calls</li>
505
 
                  <li>RINGING: Initial state of received outgoing call</li>
506
 
                  <li>CURRENT: The normal active state of an answered call</li>
507
 
                  <li>HUNGUP: Notify that the call has been hungup by peer</li>
508
 
                  <li>BUSY</li>
509
 
                  <li>FAILURE: Error when processing a call</li>
510
 
                  <li>HOLD</li>
511
 
                  <li>UNHOLD</li>
512
 
                </ul>
513
 
              </tp:docstring>
514
 
            </arg>
515
 
        </signal>
516
 
 
517
 
        <signal name="conferenceChanged" tp:name-for-bindings="conferenceChanged">
518
 
            <tp:added version="0.9.7"/>
519
 
            <tp:docstring>
520
 
              Notify of a change in the conferences state
521
 
            </tp:docstring>
522
 
            <arg type="s" name="confID">
523
 
              <tp:docstring>
524
 
                The conference ID.
525
 
              </tp:docstring>
526
 
            </arg>
527
 
            <arg type="s" name="state">
528
 
              <tp:docstring>
529
 
                The acceptable states are:
530
 
                <ul>
531
 
                  <li>ACTIVE_ATTACHED: SFLphone user is
532
 
                  participating to this conference</li>
533
 
                  <li>ACTIVE_DETACHED: This situation can
534
 
                  occur if a call is received while
535
 
                  SFLphone user is participating to a
536
 
                  conference. In this case, one can leave
537
 
                  the conference by answering the
538
 
                  call. Other participants may continue
539
 
                  conferencing normally.</li>
540
 
                  <li>HOLD: Each call in this conference
541
 
                  is on state HOLD</li>
542
 
                </ul>
543
 
              </tp:docstring>
544
 
            </arg>
545
 
        </signal>
546
 
 
547
 
        <method name="getParticipantList" tp:name-for-bindings="getParticipantList">
548
 
            <tp:added version="0.9.7"/>
549
 
            <tp:docstring>
550
 
              Get the call IDs of every participant to a given conference. The client should keep and update the list of participants.
551
 
            </tp:docstring>
552
 
            <arg type="s" name="confID" direction="in">
553
 
              <tp:docstring>
554
 
                The conference ID.
555
 
              </tp:docstring>
556
 
            </arg>
557
 
            <arg type="as" name="list" direction="out">
558
 
              <tp:docstring>
559
 
                The list of the call IDs.
560
 
              </tp:docstring>
561
 
            </arg>
562
 
        </method>
563
 
 
564
 
        <signal name="conferenceCreated" tp:name-for-bindings="conferenceCreated">
565
 
            <tp:added version="0.9.7"/>
566
 
            <tp:docstring>
567
 
              Emited when a new conference is created. SFLphone-client is reponsible for storing the confID and call <tp:member-ref>getParticipantList</tp:member-ref> to update the display.
568
 
            </tp:docstring>
569
 
            <arg type="s" name="confID">
570
 
              <tp:docstring>
571
 
                A new conference ID.
572
 
              </tp:docstring>
573
 
            </arg>
574
 
        </signal>
575
 
 
576
 
        <signal name="conferenceRemoved" tp:name-for-bindings="conferenceRemoved">
577
 
            <tp:added version="0.9.7"/>
578
 
            <tp:docstring>
579
 
              Emited when a new conference is remove. SFLphone-client should have kept a list of current participant in order to display modification.
580
 
            </tp:docstring>
581
 
            <arg type="s" name="confID">
582
 
              <tp:docstring>
583
 
                The conference ID.
584
 
              </tp:docstring>
585
 
            </arg>
586
 
        </signal>
587
 
 
588
 
        <method name="holdConference" tp:name-for-bindings="holdConference">
589
 
            <tp:added version="0.9.7"/>
590
 
            <tp:docstring>
591
 
              Hold every call which is participating in this conference.
592
 
            </tp:docstring>
593
 
            <arg type="s" name="confID" direction="in">
594
 
              <tp:docstring>
595
 
                The conference ID.
596
 
              </tp:docstring>
597
 
            </arg>
598
 
            <arg type="b" name="holdSucceeded" direction="out"/>
599
 
        </method>
600
 
 
601
 
        <method name="unholdConference" tp:name-for-bindings="unholdConference">
602
 
            <tp:added version="0.9.7"/>
603
 
            <tp:docstring>
604
 
              Hold off every call participating in this conference.
605
 
            </tp:docstring>
606
 
            <arg type="s" name="confID" direction="in">
607
 
              <tp:docstring>
608
 
                The conference ID.
609
 
              </tp:docstring>
610
 
            </arg>
611
 
            <arg type="b" name="unholdSucceeded" direction="out"/>
612
 
        </method>
613
 
 
614
 
        <method name="startRecordedFilePlayback" tp:name-for-bindings="startRecordedFilePlayback">
615
 
            <tp:added version="0.9.14"/>
616
 
            <arg type="s" name="filepath" direction="in"/>
617
 
            <arg type="b" name="result" direction="out"/>
618
 
        </method>
619
 
 
620
 
        <method name="stopRecordedFilePlayback" tp:name-for-bindings="stopRecordedFilePlayback">
621
 
            <tp:added version="0.9.14"/>
622
 
            <tp:docstring/>
623
 
            <arg type="s" name="filepath" direction="in"/>
624
 
        </method>
625
 
 
626
 
        <signal name="sipCallStateChanged" tp:name-for-bindings="sipCallStateChanged">
627
 
            <tp:docstring>
628
 
              <p>Call state changed, SFLphone received a notification
629
 
                from registrar concerning this call.</p>
630
 
            </tp:docstring>
631
 
            <arg type="s" name="callID"  />
632
 
              <tp:docstring>
633
 
                The call ID
634
 
              </tp:docstring>
635
 
            <arg type="s" name="state"  />
636
 
              <tp:docstring>
637
 
                Description string
638
 
              </tp:docstring>
639
 
            <arg type="i" name="code"  />
640
 
              <tp:docstring>
641
 
                The SIP or IAX2 message code
642
 
              </tp:docstring>
643
 
        </signal>
644
 
 
645
 
        <signal name="registrationStateChanged" tp:name-for-bindings="registrationStateChanged">
646
 
            <tp:docstring>
647
 
                <p>Account state changed, SFLphone received a notification
648
 
                from registrar.</p>
649
 
            </tp:docstring>
650
 
            <arg type="s" name="accountID" >
651
 
              <tp:docstring>
652
 
                The account ID
653
 
              </tp:docstring>
654
 
            </arg>
655
 
            <arg type="s" name="state">
656
 
              <tp:docstring>
657
 
                Description string
658
 
              </tp:docstring>
659
 
            </arg>
660
 
            <arg type="i" name="code">
661
 
              <tp:docstring>
662
 
                The SIP or IAX2 message code
663
 
              </tp:docstring>
664
 
            </arg>
665
 
        </signal>
666
 
 
667
 
        <signal name="voiceMailNotify" tp:name-for-bindings="voiceMailNotify">
668
 
            <tp:docstring>
669
 
              Notify the clients of the voicemail number for a specific account, if applicable.
670
 
            </tp:docstring>
671
 
            <arg type="s" name="accountID">
672
 
              <tp:docstring>
673
 
                The account ID.
674
 
              </tp:docstring>
675
 
            </arg>
676
 
            <arg type="i" name="count">
677
 
              <tp:docstring>
678
 
                The number of waiting messages.
679
 
              </tp:docstring>
680
 
            </arg>
681
 
        </signal>
682
 
 
683
 
        <signal name="volumeChanged" tp:name-for-bindings="volumeChanged">
684
 
                <tp:docstring>
685
 
              <p>Notify clients of a volume level change.</p>
686
 
              <p>This signal occurs only if ALSA is enabled since Pulseaudio streams are managed externally. </p>
687
 
            </tp:docstring>
688
 
            <arg type="s" name="device">
689
 
              <tp:docstring>
690
 
                The device: mic or speaker
691
 
              </tp:docstring>
692
 
            </arg>
693
 
            <arg type="d" name="value">
694
 
              <tp:docstring>
695
 
                The new volume value
696
 
              </tp:docstring>
697
 
            </arg>
698
 
        </signal>
699
 
 
700
 
        <signal name="transferSucceeded" tp:name-for-bindings="transferSucceeded">
701
 
            <tp:docstring>
702
 
              <p>Transfer has been successfully
703
 
              processed. Client should remove transfered
704
 
              call from call list as it is no longer
705
 
              accessible in SFLphone-daemon.</p>
706
 
            </tp:docstring>
707
 
        </signal>
708
 
 
709
 
        <signal name="transferFailed" tp:name-for-bindings="transferFailed">
710
 
            <tp:docstring>
711
 
              <p>Transfer operation failed. Corresponding
712
 
              call is no longer accessible in
713
 
              SFLphone-daemon.</p>
714
 
            </tp:docstring>
715
 
        </signal>
716
 
 
717
 
        <signal name="secureSdesOn" tp:name-for-bindings="secureSdesOn">
718
 
            <tp:added version="0.9.7"/>
719
 
            <tp:docstring>
720
 
              <p>Signal sent on SDES session success. Media transmission is encripted
721
 
              for this call only. It does not apply for a conference.</p>
722
 
              <p>A conference can be considered to be secured if and only if each
723
 
              participant is secured.</p>
724
 
            </tp:docstring>
725
 
            <arg type="s" name="callID"/>
726
 
        </signal>
727
 
 
728
 
        <signal name="secureSdesOff" tp:name-for-bindings="secureSdesOff">
729
 
            <tp:added version="0.9.7"/>
730
 
            <tp:docstring>
731
 
              <p>Sinal sent to notify that SDES session failed.</p>
732
 
              <p>Media transmission is not encrypted.</p>
733
 
            </tp:docstring>
734
 
            <arg type="s" name="callID" />
735
 
        </signal>
736
 
 
737
 
        <!-- ZRTP Methods and Signals -->
738
 
        <signal name="secureZrtpOn" tp:name-for-bindings="secureZrtpOn">
739
 
            <tp:added version="0.9.7"/>
740
 
            <arg type="s" name="callID"  />
741
 
            <arg type="s" name="cipher"  />
742
 
        </signal>
743
 
 
744
 
        <signal name="secureZrtpOff" tp:name-for-bindings="secureZrtpOff">
745
 
            <tp:added version="0.9.7"/>
746
 
            <arg type="s" name="callID" />
747
 
        </signal>
748
 
 
749
 
        <signal name="confirmGoClear" tp:name-for-bindings="confirmGoClear">
750
 
            <tp:added version="0.9.7"/>
751
 
            <arg type="s" name="callID" />
752
 
        </signal>
753
 
 
754
 
        <signal name="zrtpNegotiationFailed" tp:name-for-bindings="zrtpNegotiationFailed">
755
 
            <tp:added version="0.9.7"/>
756
 
            <arg type="s" name="callID" />
757
 
            <arg type="s" name="reason"  />
758
 
            <arg type="s" name="severity" />
759
 
        </signal>
760
 
 
761
 
        <signal name="zrtpNotSuppOther" tp:name-for-bindings="zrtpNotSuppOther">
762
 
            <tp:added version="0.9.7"/>
763
 
            <arg type="s" name="callID" />
764
 
        </signal>
765
 
 
766
 
        <signal name="showSAS" tp:name-for-bindings="showSAS">
767
 
            <tp:added version="0.9.7"/>
768
 
            <tp:added version="0.9.7"/>
769
 
            <arg type="s" name="callID" />
770
 
            <arg type="s" name="sas"  />
771
 
            <arg type="b" name="verified"/>
772
 
        </signal>
773
 
 
774
 
        <method name="setSASVerified" tp:name-for-bindings="setSASVerified">
775
 
            <tp:added version="0.9.7"/>
776
 
            <arg type="s" name="callID" direction="in"/>
777
 
        </method>
778
 
 
779
 
        <method name="resetSASVerified" tp:name-for-bindings="resetSASVerified">
780
 
            <tp:added version="0.9.7"/>
781
 
            <arg type="s" name="callID" direction="in"/>
782
 
        </method>
783
 
 
784
 
        <method name="setConfirmGoClear" tp:name-for-bindings="setConfirmGoClear">
785
 
            <tp:added version="0.9.7"/>
786
 
            <arg type="s" name="callID" direction="in"/>
787
 
        </method>
788
 
 
789
 
        <method name="requestGoClear" tp:name-for-bindings="requestGoClear">
790
 
            <tp:added version="0.9.7"/>
791
 
            <arg type="s" name="callID" direction="in"/>
792
 
        </method>
793
 
 
794
 
        <method name="acceptEnrollment" tp:name-for-bindings="acceptEnrollment">
795
 
            <tp:added version="0.9.7"/>
796
 
            <arg type="s" name="callID" direction="in"/>
797
 
            <arg type="b" name="accepted" direction="in"/>
798
 
        </method>
799
 
 
800
 
    </interface>
801
 
</node>