/usr/share/dbus-1/interfaces/cx.ring.Ring.CallManager.xml is in ring-daemon 20180228.1.503da2b~ds1-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 | <?xml version="1.0" encoding="UTF-8" ?>
<node name="/cx.ring.Ring.CallManager" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<interface name="cx.ring.Ring.CallManager">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>The CallManager interface is used to manage call and conference related actions.</p>
<p>Since Ring-daemon supports multiple incoming/outgoing calls, any actions involving a specific call must address the method by the means of a unique callID.
Ring-daemon will generate a unique callID for outgoing and incoming calls.</p>
</tp:docstring>
<method name="placeCall" tp:name-for-bindings="placeCall">
<tp:docstring>
<p>This is the main method in order to place a new call. The call is registered with the daemon using this method.</p>
</tp:docstring>
<arg type="s" name="accountID" direction="in">
<tp:docstring>
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.
</tp:docstring>
</arg>
<arg type="s" name="to" direction="in">
<tp:docstring>
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.
</tp:docstring>
</arg>
<arg type="s" name="callID" direction="out"/>
</method>
<method name="placeCallWithDetails" tp:name-for-bindings="placeCallWithDetails">
<tp:added version="4.1.0"/>
<tp:docstring>
<p>This is a method in order to place a new call. This version allows to pass some call details. The call is registered with the daemon using this method.</p>
</tp:docstring>
<arg type="s" name="accountID" direction="in">
<tp:docstring>
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.
</tp:docstring>
</arg>
<arg type="s" name="to" direction="in">
<tp:docstring>
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.
</tp:docstring>
</arg>
<annotation name="org.qtproject.QtDBus.QtTypeName.In2" value="MapStringString"/>
<arg type="a{ss}" name="VolatileCallDetails" direction="in">
<tp:docstring>
TBD.
</tp:docstring>
</arg>
<arg type="s" name="callID" direction="out"/>
</method>
<method name="refuse" tp:name-for-bindings="refuse">
<tp:docstring>
Refuse an incoming call.
</tp:docstring>
<arg type="s" name="callID" direction="in">
<tp:docstring>
The callID.
</tp:docstring>
</arg>
<arg type="b" name="refuseSucceeded" direction="out"/>
</method>
<signal name="SmartInfo" tp:name-for-bindings="SmartInfo">
<tp:docstring>
Once enabled using the startSmartInfo method, this signal is emitted every refreshTimeMS
</tp:docstring>
<annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="MapStringString"/>
<arg type="a{ss}" name="info" direction="out" />
</signal>
<method name="accept" tp:name-for-bindings="accept">
<tp:docstring>
Answer an incoming call. Automatically puts the current call on HOLD.
</tp:docstring>
<arg type="s" name="callID" direction="in">
<tp:docstring>
The callID.
</tp:docstring>
</arg>
<arg type="b" name="acceptSucceeded" direction="out"/>
</method>
<method name="hangUp" tp:name-for-bindings="hangUp">
<tp:docstring>
Hangup a call in state "CURRENT" or "HOLD".
</tp:docstring>
<arg type="s" name="callID" direction="in">
<tp:docstring>
The callID.
</tp:docstring>
</arg>
<arg type="b" name="hangupSucceeded" direction="out"/>
</method>
<method name="hangUpConference" tp:name-for-bindings="hangUpConference">
<tp:added version="0.9.7"/>
<tp:docstring>
Hangup a conference, and every call participating to the conference.
</tp:docstring>
<arg type="s" name="confID" direction="in">
<tp:docstring>
The unique conference ID.
</tp:docstring>
</arg>
<arg type="b" name="hangupSucceeded" direction="out"/>
</method>
<method name="hold" tp:name-for-bindings="hold">
<tp:docstring>
Place a call on hold.
</tp:docstring>
<arg type="s" name="callID" direction="in">
<tp:docstring>
The callID.
</tp:docstring>
</arg>
<arg type="b" name="holdSucceeded" direction="out"/>
</method>
<method name="unhold" tp:name-for-bindings="unhold">
<tp:docstring>
Take a call off hold, and place this call in state CURRENT.
</tp:docstring>
<arg type="s" name="callID" direction="in">
<tp:docstring>
The callID.
</tp:docstring>
</arg>
<arg type="b" name="unHoldSucceeded" direction="out"/>
</method>
<method name="muteLocalMedia" tp:name-for-bindings="muteLocalMedia">
<arg type="s" name="callid" direction="in">
<tp:docstring>
The callid to mute
</tp:docstring>
</arg>
<arg type="s" name="mediaType" direction="in">
<tp:docstring>
The type of media (AUDIO or VIDEO)
</tp:docstring>
</arg>
<arg type="b" name="mute" direction="in">
<tp:docstring>
True to mute audio capture, false to unmute.
</tp:docstring>
</arg>
<arg type="b" name="res" direction="out">
<tp:docstring>
True if mute succeed. False otherwise
</tp:docstring>
</arg>
</method>
<method name="transfer" tp:name-for-bindings="transfer">
<tp:docstring>
Transfer a call to the given phone number.
</tp:docstring>
<arg type="s" name="callID" direction="in">
<tp:docstring>
The callID.
</tp:docstring>
</arg>
<arg type="s" name="to" direction="in">
<tp:docstring>
The phone number to which the call will be transferred.
</tp:docstring>
</arg>
<arg type="b" name="transferSucceeded" direction="out"/>
</method>
<method name="attendedTransfer" tp:name-for-bindings="attendedTransfer">
<tp:docstring>
Perform an attended transfer on two calls.
</tp:docstring>
<arg type="s" name="transferID" direction="in">
<tp:docstring>
The callID of the call to be transfered.
</tp:docstring>
</arg>
<arg type="s" name="targetID" direction="in">
<tp:docstring>
The callID of the target call.
</tp:docstring>
</arg>
<arg type="b" name="transferSucceeded" direction="out"/>
</method>
<method name="playDTMF" tp:name-for-bindings="playDTMF">
<tp:docstring>
Dual-Tone multi-frequency. Tell the core to play dialtones. A SIP INFO message is sent to notify the server.
</tp:docstring>
<arg type="s" name="key" direction="in">
<tp:docstring>
Unicode character for pressed key.
</tp:docstring>
</arg>
</method>
<method name="startTone" tp:name-for-bindings="startTone">
<tp:docstring>
Start audio stream and play tone.
</tp:docstring>
<arg type="i" name="start" direction="in"/>
<arg type="i" name="type" direction="in"/>
</method>
<method name="joinParticipant" tp:name-for-bindings="joinParticipant">
<tp:added version="0.9.7"/>
<tp:docstring>
<p>Join two participants together to create a 3-way conference including the current client.</p>
<tp:rationale>The signal <tp:member-ref>conferenceCreated</tp:member-ref> is emitted on success.</tp:rationale>
</tp:docstring>
<arg type="s" name="sel_callID" direction="in"/>
<arg type="s" name="drag_callID" direction="in"/>
<arg type="b" name="joinSucceeded" direction="out"/>
</method>
<method name="createConfFromParticipantList" tp:name-for-bindings="createConfFromParticipantList">
<tp:added version="0.9.14"/>
<tp:docstring>
<p>Create a conference from a list of participants</p>
<tp:rationale>The signal <tp:member-ref>conferenceCreated</tp:member-ref> is emitted on success.</tp:rationale>
</tp:docstring>
<arg type="as" name="participants" direction="in"/>
</method>
<method name="isConferenceParticipant" tp:name-for-bindings="isConferenceParticipant">
<arg type="s" name="callID" direction="in"/>
<arg type="b" name="isParticipant" direction="out"/>
</method>
<method name="addParticipant" tp:name-for-bindings="addParticipant">
<tp:added version="0.9.7"/>
<tp:docstring>
<p>Join a new particiant to an existing conference.</p>
<tp:rationale>The signal <tp:member-ref>conferenceChanged</tp:member-ref> is emitted on success.</tp:rationale>
</tp:docstring>
<arg type="s" name="callID" direction="in">
<tp:docstring>
The ID of the call to add to the conference
</tp:docstring>
</arg>
<arg type="s" name="confID" direction="in">
<tp:docstring>
An existing conference ID
</tp:docstring>
</arg>
<arg type="b" name="addSucceeded" direction="out"/>
</method>
<method name="addMainParticipant" tp:name-for-bindings="addMainParticipant">
<tp:added version="0.9.7"/>
<tp:docstring>
<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 Ring-client's user into the conference.</p>
<p>Its put the current call on HOLD or detaches Ring-client's user from the another conference.</p>
</tp:docstring>
<arg type="s" name="confID" direction="in">
<tp:docstring>
An existing conference ID
</tp:docstring>
</arg>
<arg type="b" name="addSucceeded" direction="out"/>
</method>
<method name="detachLocalParticipant" tp:name-for-bindings="detachLocalParticipant">
<tp:added version="3.0.0"/>
<tp:docstring>
Detach local participant from the conference.
Remote participants are placed in hold.
The signal <tp:member-ref>conferenceChanged</tp:member-ref> is emited.
</tp:docstring>
<arg type="b" name="detachSucceeded" direction="out"/>
</method>
<method name="detachParticipant" tp:name-for-bindings="detachParticipant">
<tp:added version="0.9.7"/>
<tp:docstring>
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.
</tp:docstring>
<arg type="s" name="callID" direction="in">
<tp:docstring>
The call ID
</tp:docstring>
</arg>
<arg type="b" name="detachSucceeded" direction="out"/>
</method>
<method name="joinConference" tp:name-for-bindings="joinConference">
<tp:added version="0.9.7"/>
<tp:docstring>
Join two conferences together.
</tp:docstring>
<arg type="s" name="sel_confID" direction="in"/>
<arg type="s" name="drag_confID" direction="in"/>
<arg type="b" name="joinSucceeded" direction="out"/>
</method>
<method name="getConferenceDetails" tp:name-for-bindings="getConferenceDetails">
<tp:added version="0.9.7"/>
<tp:docstring>
Returns a hashtable containing conference details.
</tp:docstring>
<arg type="s" name="callID" direction="in">
<tp:docstring>
The conference ID
</tp:docstring>
</arg>
<annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="MapStringString"/>
<arg type="a{ss}" name="infos" direction="out">
<tp:docstring>
A map containing the ID of the conferences
and their states:
<ul>
<li>ACTIVE_ATTACHED</li>
<li>ACTIVE_DETACHED</li>
<li>HOLD</li>
</ul>
</tp:docstring>
</arg>
</method>
<method name="getConferenceList" tp:name-for-bindings="getConferenceList">
<tp:added version="0.9.7"/>
<tp:docstring>
Returns a list containing all active
conferences.
<tp:rationale>To update client status, one should
use <tp:member-ref>getParticipantList</tp:member-ref>
with provided conference IDs.</tp:rationale>
</tp:docstring>
<arg type="as" name="list" direction="out">
<tp:docstring>
The list of conferences.
</tp:docstring>
</arg>
</method>
<method name="getConferenceId" tp:name-for-bindings="getConferenceId">
<tp:added version="1.1.0"/>
<tp:docstring>
If thsi call participate to a conference, return the conference id.
Return an empty string elsewhere.
</tp:docstring>
<arg type="s" name="callID" direction="in">
<tp:docstring>
The call id.
</tp:docstring>
</arg>
<arg type="s" name="confID" direction="out">
<tp:docstring>
A string containing the conference ID, or an empty string.
</tp:docstring>
</arg>
</method>
<method name="toggleRecording" tp:name-for-bindings="toggleRecording">
<tp:docstring>
Toggle recording for a call.
</tp:docstring>
<arg type="s" name="callID" direction="in">
<tp:docstring>
The ID of the call to start/stop recording.
</tp:docstring>
</arg>
<arg type="b" name="isRecording" direction="out">
<tp:docstring>
Returns true is the call is being recorded. False otherwise.
</tp:docstring>
</arg>
</method>
<method name="startSmartInfo" tp:name-for-bindings="startSmartInfo">
<tp:docstring>
Start sending the signal smartInfo
</tp:docstring>
<arg type="u" name="refreshTimeMs" direction="in">
<tp:docstring>
Set the sending time (in milliseconds) of the signal.
</tp:docstring>
</arg>
</method>
<method name="stopSmartInfo" tp:name-for-bindings="stopSmartInfo">
<tp:docstring>
Stop sending the signal smartInfo
</tp:docstring>
</method>
<method name="getIsRecording" tp:name-for-bindings="getIsRecording">
<tp:docstring>
Tells whether or not a call is being recorded.
</tp:docstring>
<arg type="s" name="callID" direction="in">
<tp:docstring>
The call ID.
</tp:docstring>
</arg>
<arg type="b" name="isRecording" direction="out">
<tp:docstring>
Returns true is the call is being recorded. False otherwise.
</tp:docstring>
</arg>
</method>
<method name="recordPlaybackSeek" tp:name-for-bindings="recordPlaybackSeek">
<tp:docstring>
<p>Sets the playback position using a linear scale [0,100].</p>
</tp:docstring>
<arg type="d" name="value" direction="in"/>
</method>
<signal name="recordPlaybackFilepath" tp:name-for-bindings="recordPlaybackFilepath">
<tp:docstring>
Once after starting recording for the first time, this signal is emited to
provide the recorded file path to client application.
</tp:docstring>
<arg type="s" name="callID" />
<arg type="s" name="filepath"/>
</signal>
<signal name="recordPlaybackStopped" tp:name-for-bindings="recordPlaybackStopped">
<tp:docstring/>
<arg type="s" name="filepath" />
</signal>
<signal name="updatePlaybackScale" tp:name-for-bindings="updatePlaybackScale">
<tp:docstring/>
<arg type="s" name="filepath" />
<arg type="i" name="position" />
<arg type="i" name="size" />
</signal>
<method name="getCallDetails" tp:name-for-bindings="getCallDetails">
<tp:docstring>
Get all the details about a specific call.
</tp:docstring>
<arg type="s" name="callID" direction="in">
<tp:docstring>
The call ID.
</tp:docstring>
</arg>
<annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="MapStringString"/>
<arg type="a{ss}" name="infos" direction="out" tp:type="String_String_Map">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>A map containing the call details: </p>
<ul>
<li>ACCOUNTID</li>
<li>PEER_NUMBER</li>
<li>PEER_NAME</li>
<li>DISPLAY_NAME</li>
<li>CALL_STATE</li>
<li>CALL_TYPE</li>
<li>CONF_ID</li>
</ul>
</tp:docstring>
</arg>
</method>
<method name="getCallList" tp:name-for-bindings="getCallList">
<tp:docstring>
Get the list of active calls.
<tp:rationale>To get the call details, iterate on the return value and call <tp:member-ref>getCallDetails</tp:member-ref> method.</tp:rationale>
</tp:docstring>
<arg type="as" name="list" direction="out">
<tp:docstring>
A list of call IDs.
</tp:docstring>
</arg>
</method>
<method name="switchInput" tp:name-for-bindings="switchInput">
<tp:docstring>
Switch input for the specified call
</tp:docstring>
<arg type="s" name="callID" direction="in"/>
<arg type="s" name="input" direction="in"/>
</method>
<method name="sendTextMessage" tp:name-for-bindings="sendTextMessage">
<tp:docstring>
Send a text message to the specified call
</tp:docstring>
<arg type="s" name="callID" direction="in"/>
<annotation name="org.qtproject.QtDBus.QtTypeName.In1" value="MapStringString"/>
<arg type="a{ss}" name="payloads" direction="in"/>
<arg type="b" name="isMixed" direction="in"/>
</method>
<signal name="newCallCreated" tp:name-for-bindings="newCallCreated">
<tp:docstring>
<p>Notify that a call has been created.</p>
<p>The callID generated by the daemon must be stored by the clients in order to address other actions for
this call. This signal is emitted when call haves been created by the daemon itself.</p>
<tp:rationale>The client must subscribe to this signal to handle calls created by other clients</tp:rationale>
</tp:docstring>
<arg type="s" name="accountID">
<tp:docstring>
The account ID of the call. Clients must notify the right account when receiving this signal.
</tp:docstring>
</arg>
<arg type="s" name="callID">
<tp:docstring>
A new call ID.
</tp:docstring>
</arg>
<arg type="s" name="to">
<tp:docstring>
The SIP URI this call is trying to reach.
</tp:docstring>
</arg>
</signal>
<signal name="incomingCall" tp:name-for-bindings="incomingCall">
<tp:docstring>
<p>Notify an incoming call.</p>
<p>The callID generated by the daemon must be stored by the clients in order to address other action for
this call. This signal is emitted when we receive a call from a remote peer</p>
<tp:rationale>The client must subscribe to this signal to handle incoming calls.</tp:rationale>
</tp:docstring>
<arg type="s" name="accountID">
<tp:docstring>
The account ID of the callee. Clients must notify the right account when receiving this signal.
</tp:docstring>
</arg>
<arg type="s" name="callID">
<tp:docstring>
A new call ID.
</tp:docstring>
</arg>
<arg type="s" name="from">
<tp:docstring>
The caller phone number.
</tp:docstring>
</arg>
</signal>
<signal name="incomingMessage" tp:name-for-bindings="incomingMessage">
<tp:docstring>
Notify clients that new messages have been received. The key is
the mime type and the value the mime payload.
</tp:docstring>
<arg type="s" name="callID" />
<arg type="s" name="from" />
<annotation name="org.qtproject.QtDBus.QtTypeName.In2" value="MapStringString"/>
<arg type="a{ss}" name="messages" />
</signal>
<signal name="callStateChanged" tp:name-for-bindings="callStateChanged">
<tp:docstring>
<p>Notify of a change in a call state.</p>
<p>The client must subscribe to this signal.</p>
</tp:docstring>
<arg type="s" name="callID">
<tp:docstring>
The call ID.
</tp:docstring>
</arg>
<arg type="s" name="state" >
<tp:docstring>
The acceptable states are:
<ul>
<li>INCOMING: Initial state of incoming calls</li>
<li>CONNECTING: Peer found, contacting him</li>
<li>RINGING: Initial state of received outgoing call</li>
<li>CURRENT: The normal active state of an answered call</li>
<li>HUNGUP: Notify that the call has been hungup by peer</li>
<li>BUSY</li>
<li>FAILURE: Error when processing a call</li>
<li>HOLD</li>
<li>UNHOLD</li>
</ul>
</tp:docstring>
</arg>
<arg type="i" name="code">
<tp:docstring>
The optional account-type specific message code. 0 if not set.
</tp:docstring>
<tp:added version="2.0.0" />
</arg>
</signal>
<signal name="conferenceChanged" tp:name-for-bindings="conferenceChanged">
<tp:added version="0.9.7"/>
<tp:docstring>
Notify of a change in the conferences state
</tp:docstring>
<arg type="s" name="confID">
<tp:docstring>
The conference ID.
</tp:docstring>
</arg>
<arg type="s" name="state">
<tp:docstring>
The acceptable states are:
<ul>
<li>ACTIVE_ATTACHED: Ring user is
participating to this conference</li>
<li>ACTIVE_DETACHED: This situation can
occur if a call is received while
Ring user is participating to a
conference. In this case, one can leave
the conference by answering the
call. Other participants may continue
conferencing normally.</li>
<li>HOLD: Each call in this conference
is on state HOLD</li>
</ul>
</tp:docstring>
</arg>
</signal>
<method name="getDisplayNames" tp:name-for-bindings="getDisplayNames">
<tp:added version="1.3.0"/>
<tp:docstring>
Get the display name of every participant in a given conference, or their number as a fallback.
</tp:docstring>
<arg type="s" name="confID" direction="in">
<tp:docstring>
The conference ID.
</tp:docstring>
</arg>
<arg type="as" name="list" direction="out">
<tp:docstring>
The list of the display names.
</tp:docstring>
</arg>
</method>
<method name="getParticipantList" tp:name-for-bindings="getParticipantList">
<tp:added version="0.9.7"/>
<tp:docstring>
Get the call IDs of every participant to a given conference. The client should keep and update the list of participants.
</tp:docstring>
<arg type="s" name="confID" direction="in">
<tp:docstring>
The conference ID.
</tp:docstring>
</arg>
<arg type="as" name="list" direction="out">
<tp:docstring>
The list of the call IDs.
</tp:docstring>
</arg>
</method>
<signal name="conferenceCreated" tp:name-for-bindings="conferenceCreated">
<tp:added version="0.9.7"/>
<tp:docstring>
Emited when a new conference is created. Ring-client is reponsible for storing the confID and call <tp:member-ref>getParticipantList</tp:member-ref> to update the display.
</tp:docstring>
<arg type="s" name="confID">
<tp:docstring>
A new conference ID.
</tp:docstring>
</arg>
</signal>
<signal name="conferenceRemoved" tp:name-for-bindings="conferenceRemoved">
<tp:added version="0.9.7"/>
<tp:docstring>
Emited when a new conference is remove. Ring-client should have kept a list of current participant in order to display modification.
</tp:docstring>
<arg type="s" name="confID">
<tp:docstring>
The conference ID.
</tp:docstring>
</arg>
</signal>
<method name="holdConference" tp:name-for-bindings="holdConference">
<tp:added version="0.9.7"/>
<tp:docstring>
Hold every call which is participating in this conference.
</tp:docstring>
<arg type="s" name="confID" direction="in">
<tp:docstring>
The conference ID.
</tp:docstring>
</arg>
<arg type="b" name="holdSucceeded" direction="out"/>
</method>
<method name="unholdConference" tp:name-for-bindings="unholdConference">
<tp:added version="0.9.7"/>
<tp:docstring>
Hold off every call participating in this conference.
</tp:docstring>
<arg type="s" name="confID" direction="in">
<tp:docstring>
The conference ID.
</tp:docstring>
</arg>
<arg type="b" name="unholdSucceeded" direction="out"/>
</method>
<method name="startRecordedFilePlayback" tp:name-for-bindings="startRecordedFilePlayback">
<tp:added version="0.9.14"/>
<arg type="s" name="filepath" direction="in"/>
<arg type="b" name="result" direction="out"/>
</method>
<method name="stopRecordedFilePlayback" tp:name-for-bindings="stopRecordedFilePlayback">
<tp:added version="0.9.14"/>
<tp:docstring/>
</method>
<signal name="voiceMailNotify" tp:name-for-bindings="voiceMailNotify">
<tp:docstring>
Notify the clients of the voicemail number for a specific account, if applicable.
</tp:docstring>
<arg type="s" name="accountID">
<tp:docstring>
The account ID.
</tp:docstring>
</arg>
<arg type="i" name="count">
<tp:docstring>
The number of waiting messages.
</tp:docstring>
</arg>
</signal>
<signal name="transferSucceeded" tp:name-for-bindings="transferSucceeded">
<tp:docstring>
<p>Transfer has been successfully
processed. Client should remove transfered
call from call list as it is no longer
accessible in Ring-daemon (dring).</p>
</tp:docstring>
</signal>
<signal name="transferFailed" tp:name-for-bindings="transferFailed">
<tp:docstring>
<p>Transfer operation failed. Corresponding
call is no longer accessible in
Ring-daemon (dring).</p>
</tp:docstring>
</signal>
<signal name="secureSdesOn" tp:name-for-bindings="secureSdesOn">
<tp:added version="0.9.7"/>
<tp:docstring>
<p>Signal sent on SDES session success. Media transmission is encripted
for this call only. It does not apply for a conference.</p>
<p>A conference can be considered to be secured if and only if each
participant is secured.</p>
</tp:docstring>
<arg type="s" name="callID"/>
</signal>
<signal name="secureSdesOff" tp:name-for-bindings="secureSdesOff">
<tp:added version="0.9.7"/>
<tp:docstring>
<p>Sinal sent to notify that SDES session failed.</p>
<p>Media transmission is not encrypted.</p>
</tp:docstring>
<arg type="s" name="callID" />
</signal>
<signal name="recordingStateChanged" tp:name-for-bindings="recordingStateChange">
<tp:added version="1.3.0"/>
<arg type="s" name="callID" />
<arg type="b" name="recordingState"/>
</signal>
<signal name="onRtcpReportReceived" tp:name-for-bindings="onRtcpReportReceived">
<tp:added version="1.3.0"/>
<tp:docstring>
<p>Signal sent adter a RTCP report has been received and computed.</p>
</tp:docstring>
<arg type="s" name="callID" />
<annotation name="org.qtproject.QtDBus.QtTypeName.In1" value="MapStringInt"/>
<arg type="a{si}" name="report" direction="out" tp:type="String_Integer_Map">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>A map containing RTCP stats: </p>
<ul>
<li>PACKET_LOSS</li>
<li>CUMULATIVE_LOSS</li>
<li>ROUND_TRIP_DELAY</li>
<li>LATENCY</li>
</ul>
</tp:docstring>
</arg>
</signal>
<signal name="peerHold" tp:name-for-bindings="peerHold">
<tp:added version="2.0.0"/>
<arg type="s" name="callID" />
<arg type="b" name="peerHolding" />
</signal>
<signal name="audioMuted" tp:name-for-bindings="audioMuted">
<tp:added version="2.1.0"/>
<arg type="s" name="callID" />
<arg type="b" name="audioMuted" />
</signal>
<signal name="videoMuted" tp:name-for-bindings="videoMuted">
<tp:added version="2.1.0"/>
<arg type="s" name="callID" />
<arg type="b" name="videoMuted" />
</signal>
</interface>
</node>
|