Changeset 4929 for pjproject/trunk/pjsip/include/pjsua-lib/pjsua.h

Timestamp:

Sep 24, 2014 8:26:33 AM (9 years ago)

Author:

nanang

Message:

Close #1793: Avoid call setting flags PJSUA_CALL_UNHOLD, PJSUA_CALL_UPDATE_CONTACT, and PJSUA_CALL_NO_SDP_OFFER to be sticky or reused in the next calls of pjsua_call_reinvite/update().

File:

• pjproject/trunk/pjsip/include/pjsua-lib/pjsua.h (modified) (8 diffs)

pjproject/trunk/pjsip/include/pjsua-lib/pjsua.h

@@ -613 +613 @@
      * Bitmask of #pjsua_call_flag constants.
      *
-     * Default: 0
+     * Default: PJSUA_CALL_INCLUDE_DISABLED_MEDIA
      */
     unsigned         flag;
@@ -620 +620 @@
      * This flag controls what methods to request keyframe are allowed on
      * the call. Value is bitmask of #pjsua_vid_req_keyframe_method.
+     *
+     * Default: PJSUA_VID_REQ_KEYFRAME_SIP_INFO
      */
     unsigned         req_keyframe_method;
@@ -4086 +4088 @@
     /**
      * When the call is being put on hold, specify this flag to unhold it.
-     * This flag is only valid for #pjsua_call_reinvite(). Note: for
-     * compatibility reason, this flag must have value of 1 because
-     * previously the unhold option is specified as boolean value.
+     * This flag is only valid for #pjsua_call_reinvite() and
+     * #pjsua_call_update(). Note: for compatibility reason, this flag must
+     * have value of 1 because previously the unhold option is specified as
+     * boolean value.
      */
     PJSUA_CALL_UNHOLD = 1,
@@ -4106 +4109 @@
      * Include SDP "m=" line with port set to zero for each disabled media
      * (i.e when aud_cnt or vid_cnt is set to zero). This flag is only valid
-     * for #pjsua_call_make_call().
+     * for #pjsua_call_make_call(), #pjsua_call_reinvite(), and
+     * #pjsua_call_update(). Note that even this flag is applicable in
+     * #pjsua_call_reinvite() and #pjsua_call_update(), it will only take
+     * effect when the re-INVITE/UPDATE operation regenerates SDP offer,
+     * such as changing audio or video count in the call setting.
      */
     PJSUA_CALL_INCLUDE_DISABLED_MEDIA = 4,
@@ -4591 +4598 @@
 
 /**
- * Send re-INVITE to release hold.
+ * Send re-INVITE request or release hold.
  * The final status of the request itself will be reported on the
  * \a on_call_media_state() callback, which inform the application that
@@ -4611 +4618 @@
 
 /**
- * Send re-INVITE to release hold.
+ * Send re-INVITE request or release hold.
  * The final status of the request itself will be reported on the
  * \a on_call_media_state() callback, which inform the application that
@@ -4618 +4625 @@
  * @param call_id       Call identification.
  * @param opt           Optional call setting, if NULL, the current call
- *                      setting will remain unchanged.
+ *                      setting will be used. Note that to release hold
+ *                      or update contact or omit SDP offer, this parameter
+ *                      cannot be NULL and it must specify appropriate flags,
+ *                      e.g: PJSUA_CALL_UNHOLD, PJSUA_CALL_UPDATE_CONTACT,
+ *                      PJSUA_CALL_NO_SDP_OFFER.
  * @param msg_data      Optional message components to be sent with
  *                      the request.
@@ -4649 +4660 @@
  * @param call_id       Call identification.
  * @param opt           Optional call setting, if NULL, the current call
- *                      setting will remain unchanged.
+ *                      setting will be used. Note that to release hold
+ *                      or update contact or omit SDP offer, this parameter
+ *                      cannot be NULL and it must specify appropriate flags,
+ *                      e.g: PJSUA_CALL_UNHOLD, PJSUA_CALL_UPDATE_CONTACT,
+ *                      PJSUA_CALL_NO_SDP_OFFER.
  * @param msg_data      Optional message components to be sent with
  *                      the request.