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

Timestamp:

Oct 31, 2007 8:59:29 AM (16 years ago)

Author:

bennylp

Message:

More ticket #399: added PJSUA API to retrieve the remote NAT type

File:

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

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

@@ -990 +990 @@
 
     /**
-     * Include local endpoint's NAT type in the SDP to assist troubleshooting.
-     * The valid values are:
-     *  - 0: no information will be added in SDP.
+     * Support for adding and parsing NAT type in the SDP to assist 
+     * troubleshooting. The valid values are:
+     *  - 0: no information will be added in SDP, and parsing is disabled.
      *  - 1: only the NAT type number is added.
      *  - 2: add both NAT type number and name.
      *
-     * Default: 2
+     * Default: 1
      */
     int             nat_type_in_sdp;
@@ -1366 +1366 @@
  *                      value. Other return values indicate error and
  *                      \a type will be set to PJ_STUN_NAT_TYPE_ERR_UNKNOWN.
+ *
+ * @see pjsua_call_get_rem_nat_type()
  */
 PJ_DECL(pj_status_t) pjsua_get_nat_type(pj_stun_nat_type *type);
@@ -2730 +2732 @@
 PJ_DECL(void*) pjsua_call_get_user_data(pjsua_call_id call_id);
 
+
+/**
+ * Get the NAT type of remote's endpoint. This is a proprietary feature
+ * of PJSUA-LIB which sends its NAT type in the SDP when \a nat_type_in_sdp
+ * is set in #pjsua_config.
+ *
+ * This function can only be called after SDP has been received from remote,
+ * which means for incoming call, this function can be called as soon as
+ * call is received as long as incoming call contains SDP, and for outgoing
+ * call, this function can be called only after SDP is received (normally in
+ * 200/OK response to INVITE). As a general case, application should call 
+ * this function after or in \a on_call_media_state() callback.
+ *
+ * @param call_id       Call identification.
+ * @param p_type        Pointer to store the NAT type. Application can then
+ *                      retrieve the string description of the NAT type
+ *                      by calling pj_stun_get_nat_name().
+ *
+ * @return              PJ_SUCCESS on success.
+ *
+ * @see pjsua_get_nat_type(), nat_type_in_sdp
+ */
+PJ_DECL(pj_status_t) pjsua_call_get_rem_nat_type(pjsua_call_id call_id,
+                                                 pj_stun_nat_type *p_type);
 
 /**