cx.ring.Ring.CallManager.xml 33 KB

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