@@ -1228,12 +1228,15 @@ uint32_t dc_init_webxdc_integration (dc_context_t* context, uint32_t c
1228
1228
* who will get informed by an #DC_EVENT_INCOMING_CALL event and rings.
1229
1229
*
1230
1230
* Possible actions during ringing:
1231
+ * - caller cancels the call using dc_end_call(), callee receives #DC_EVENT_CALL_ENDED.
1231
1232
* - callee accepts using dc_accept_incoming_call(), caller receives #DC_EVENT_OUTGOING_CALL_ACCEPTED,
1232
1233
* callee's devices receive #DC_EVENT_INCOMING_CALL_ACCEPTED, call starts
1233
1234
* - callee rejects using dc_end_call(), caller receives #DC_EVENT_CALL_ENDED,
1234
- * callee's other devices receive #DC_EVENT_CALL_ENDED, done.
1235
- * - caller cancels the call using dc_end_call(), callee receives #DC_EVENT_CALL_ENDED, done.
1236
- * - after 1 minute without action, caller and callee receive #DC_EVENT_CALL_ENDED
1235
+ * callee's other devices receive #DC_EVENT_CALL_ENDED.
1236
+ * - callee is already in a call. in this case,
1237
+ * UI may decide to show a notification instead of ringing.
1238
+ * otherwise, this is same as timeout.
1239
+ * - timeout: after 1 minute without action, caller and callee receive #DC_EVENT_CALL_ENDED
1237
1240
* to prevent endless ringing of callee
1238
1241
* in case caller got offline without being able to send cancellation message.
1239
1242
*
@@ -1246,6 +1249,9 @@ uint32_t dc_init_webxdc_integration (dc_context_t* context, uint32_t c
1246
1249
* In the UI, the sorted chatlist is used as an overview about calls as well as messages.
1247
1250
* To place a call with a contact that has no chat yet, use dc_create_chat_by_contact_id() first.
1248
1251
*
1252
+ * UI will usually allow only one call at the same time,
1253
+ * this has to be tracked by UI across profile, the core does not track this.
1254
+ *
1249
1255
* @memberof dc_context_t
1250
1256
* @param context The context object.
1251
1257
* @param chat_id The chat to place a call for.
@@ -6650,14 +6656,20 @@ void dc_event_unref(dc_event_t* event);
6650
6656
6651
6657
/**
6652
6658
* Incoming call.
6653
- * UI will usually start ringing.
6659
+ * UI will usually start ringing,
6660
+ * or show a notification if there is already a call in some profile.
6661
+ *
6662
+ * Together with this event,
6663
+ * an info-message is added to the corresponding chat.
6664
+ * The info-message, however, is _not_ additionally notified using #DC_EVENT_INCOMING_MSG,
6665
+ * if needed, this has to be done by the UI explicitly.
6654
6666
*
6655
6667
* If user takes action, dc_accept_incoming_call() or dc_end_call() should be called.
6656
6668
*
6657
6669
* Otherwise, ringing should end on #DC_EVENT_CALL_ENDED
6658
6670
* or #DC_EVENT_INCOMING_CALL_ACCEPTED
6659
6671
*
6660
- * @param data1 (int) msg_id
6672
+ * @param data1 (int) msg_id ID of the info-message referring to the call,
6661
6673
*/
6662
6674
#define DC_EVENT_INCOMING_CALL 2550
6663
6675
0 commit comments