@@ -1216,21 +1216,21 @@ uint32_t dc_init_webxdc_integration (dc_context_t* context, uint32_t c
1216
1216
1217
1217
/**
1218
1218
* Start an outgoing call.
1219
- * This sends a message with all relevant information to the callee,
1219
+ * This sends a message of type #DC_MSG_CALL with all relevant information to the callee,
1220
1220
* who will get informed by an #DC_EVENT_INCOMING_CALL event and rings.
1221
1221
*
1222
1222
* Possible actions during ringing:
1223
1223
*
1224
1224
* - caller cancels the call using dc_end_call():
1225
- * callee receives #DC_EVENT_CALL_ENDED
1225
+ * callee receives #DC_EVENT_CALL_ENDED and has a "Missed Call"
1226
1226
*
1227
1227
* - callee accepts using dc_accept_incoming_call():
1228
1228
* caller receives #DC_EVENT_OUTGOING_CALL_ACCEPTED.
1229
1229
* callee's devices receive #DC_EVENT_INCOMING_CALL_ACCEPTED, call starts
1230
1230
*
1231
- * - callee rejects using dc_end_call():
1232
- * caller receives #DC_EVENT_CALL_ENDED after 1 minute timeout .
1233
- * callee's other devices receive #DC_EVENT_CALL_ENDED
1231
+ * - callee declines using dc_end_call():
1232
+ * caller receives #DC_EVENT_CALL_ENDED and has a "Declinced Call" .
1233
+ * callee's other devices receive #DC_EVENT_CALL_ENDED and have a "Cancelled Call",
1234
1234
*
1235
1235
* - callee is already in a call:
1236
1236
* in this case, UI may decide to show a notification instead of ringing.
@@ -1240,7 +1240,9 @@ uint32_t dc_init_webxdc_integration (dc_context_t* context, uint32_t c
1240
1240
* after 1 minute without action,
1241
1241
* caller and callee receive #DC_EVENT_CALL_ENDED
1242
1242
* to prevent endless ringing of callee
1243
- * in case caller got offline without being able to send cancellation message
1243
+ * in case caller got offline without being able to send cancellation message.
1244
+ * for caller, this is a "Cancelled Call";
1245
+ * for callee, this is a "Missed Call"
1244
1246
*
1245
1247
* Actions during the call:
1246
1248
*
@@ -1276,13 +1278,15 @@ uint32_t dc_place_outgoing_call (dc_context_t* context, uint32_t ch
1276
1278
* All affected devices will receive
1277
1279
* either #DC_EVENT_OUTGOING_CALL_ACCEPTED or #DC_EVENT_INCOMING_CALL_ACCEPTED.
1278
1280
*
1281
+ * If the call is already accepted or ended, nothing happens.
1282
+ *
1279
1283
* @memberof dc_context_t
1280
1284
* @param context The context object.
1281
1285
* @param msg_id The ID of the call to accept.
1282
1286
* This is the ID reported by #DC_EVENT_INCOMING_CALL
1283
1287
* and equals to the ID of the corresponding info message.
1284
1288
* @param accept_call_info any data that other devices receive
1285
- * in #DC_EVENT_OUTGOING_CALL_ACCEPTED or #DC_EVENT_INCOMING_CALL_ACCEPTED .
1289
+ * in #DC_EVENT_OUTGOING_CALL_ACCEPTED.
1286
1290
* @return 1=success, 0=error
1287
1291
*/
1288
1292
int dc_accept_incoming_call (dc_context_t * context , uint32_t msg_id , const char * accept_call_info );
@@ -1291,17 +1295,13 @@ uint32_t dc_place_outgoing_call (dc_context_t* context, uint32_t ch
1291
1295
/**
1292
1296
* End incoming or outgoing call.
1293
1297
*
1294
- * From the view of the caller, a "cancellation",
1295
- * from the view of callee, a "rejection ".
1298
+ * For unaccepted calls ended by the caller, this is a "cancellation".
1299
+ * Unaccepted calls ended by the callee are a "decline ".
1296
1300
* If the call was accepted, this is a "hangup".
1297
1301
*
1298
- * For accepted calls,
1299
- * all participant devices get informed about the ended call via #DC_EVENT_CALL_ENDED.
1300
- * For not accepted calls, only the caller will inform the callee.
1302
+ * All participant devices get informed about the ended call via #DC_EVENT_CALL_ENDED.
1301
1303
*
1302
- * If the callee rejects, the caller will get a timeout or give up at some point -
1303
- * same as for all other reasons the call cannot be established: Device not in reach, device muted, connectivity etc.
1304
- * This is to protect privacy of the callee, avoiding to check if callee is online.
1304
+ * If the call is already ended, nothing happens.
1305
1305
*
1306
1306
* @memberof dc_context_t
1307
1307
* @param context The context object.
@@ -6724,29 +6724,27 @@ void dc_event_unref(dc_event_t* event);
6724
6724
* or show a notification if there is already a call in some profile.
6725
6725
*
6726
6726
* Together with this event,
6727
- * an info-message is added to the corresponding chat.
6728
- * The info-message, however, is _not_ additionally notified using #DC_EVENT_INCOMING_MSG,
6729
- * if needed, this has to be done by the UI explicitly.
6727
+ * a message of type #DC_MSG_CALL is added to the corresponding chat;
6728
+ * this message is announced and updated by the usual even as #DC_EVENT_MSGS_CHANGED.
6730
6729
*
6731
6730
* If user takes action, dc_accept_incoming_call() or dc_end_call() should be called.
6732
6731
*
6733
6732
* Otherwise, ringing should end on #DC_EVENT_CALL_ENDED
6734
6733
* or #DC_EVENT_INCOMING_CALL_ACCEPTED
6735
6734
*
6736
- * @param data1 (int) msg_id ID of the info- message referring to the call.
6735
+ * @param data1 (int) msg_id ID of the message referring to the call.
6737
6736
* @param data2 (char*) place_call_info, text passed to dc_place_outgoing_call()
6738
6737
*/
6739
6738
#define DC_EVENT_INCOMING_CALL 2550
6740
6739
6741
6740
/**
6742
- * The callee accepted an incoming call on another device using dc_accept_incoming_call().
6741
+ * The callee accepted an incoming call on this or another device using dc_accept_incoming_call().
6743
6742
* The caller gets the event #DC_EVENT_OUTGOING_CALL_ACCEPTED at the same time.
6744
6743
*
6745
6744
* The event is sent unconditionally when the corresponding message is received.
6746
6745
* UI should only take action in case call UI was opened before, otherwise the event should be ignored.
6747
6746
*
6748
- * @param data1 (int) msg_id ID of the info-message referring to the call
6749
- * @param data2 (char*) accept_call_info, text passed to dc_place_outgoing_call()
6747
+ * @param data1 (int) msg_id ID of the message referring to the call
6750
6748
*/
6751
6749
#define DC_EVENT_INCOMING_CALL_ACCEPTED 2560
6752
6750
@@ -6756,7 +6754,7 @@ void dc_event_unref(dc_event_t* event);
6756
6754
* The event is sent unconditionally when the corresponding message is received.
6757
6755
* UI should only take action in case call UI was opened before, otherwise the event should be ignored.
6758
6756
*
6759
- * @param data1 (int) msg_id ID of the info- message referring to the call
6757
+ * @param data1 (int) msg_id ID of the message referring to the call
6760
6758
* @param data2 (char*) accept_call_info, text passed to dc_accept_incoming_call()
6761
6759
*/
6762
6760
#define DC_EVENT_OUTGOING_CALL_ACCEPTED 2570
@@ -6768,7 +6766,7 @@ void dc_event_unref(dc_event_t* event);
6768
6766
* The event is sent unconditionally when the corresponding message is received.
6769
6767
* UI should only take action in case call UI was opened before, otherwise the event should be ignored.
6770
6768
*
6771
- * @param data1 (int) msg_id ID of the info- message referring to the call
6769
+ * @param data1 (int) msg_id ID of the message referring to the call
6772
6770
*/
6773
6771
#define DC_EVENT_CALL_ENDED 2580
6774
6772
0 commit comments