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

Timestamp:

Dec 26, 2006 12:11:48 AM (17 years ago)

Author:

bennylp

Message:

Added DTMF callback support all the way to PJSUA API (ticket #48)

File:

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

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

@@ -287 +287 @@
      * Application may then query the call info to get the
      * detail call states.
+     *
+     * @param call_id   The call index.
+     * @param e         Event which causes the call state to change.
      */
     void (*on_call_state)(pjsua_call_id call_id, pjsip_event *e);
@@ -292 +295 @@
     /**
      * Notify application on incoming call.
+     *
+     * @param acc_id    The account which match the incoming call.
+     * @param call_id   The call id that has just been created for
+     *                  the call.
+     * @param rdata     The incoming INVITE request.
      */
     void (*on_incoming_call)(pjsua_acc_id acc_id, pjsua_call_id call_id,
@@ -300 +308 @@
      * Normal application would need to implement this callback, e.g.
      * to connect the call's media to sound device.
+     *
+     * @param call_id   The call index.
      */
     void (*on_call_media_state)(pjsua_call_id call_id);
+
+    /**
+     * Notify application upon incoming DTMF digits.
+     *
+     * @param call_id   The call index.
+     * @param digit     DTMF ASCII digit.
+     */
+    void (*on_dtmf_digit)(pjsua_call_id call_id, int digit);
 
     /**
@@ -309 +327 @@
      * is not defined, the default behavior is to accept the
      * transfer.
+     *
+     * @param call_id   The call index.
+     * @param dst       The destination where the call will be 
+     *                  transfered to.
+     * @param code      Status code to be returned for the call transfer
+     *                  request. On input, it contains status code 200.
      */
     void (*on_call_transfer_request)(pjsua_call_id call_id,
@@ -373 +397 @@
      * Application may then query the account info to get the
      * registration details.
+     *
+     * @param acc_id        Account ID.
      */
     void (*on_reg_state)(pjsua_acc_id acc_id);
@@ -379 +405 @@
      * Notify application when the buddy state has changed.
      * Application may then query the buddy into to get the details.
+     *
+     * @param buddy_id      The buddy id.
      */
     void (*on_buddy_state)(pjsua_buddy_id buddy_id);
@@ -386 +414 @@
      * Argument call_id will be -1 if MESSAGE request is not related to an
      * existing call.
+     *
+     * @param call_id       Containts the ID of the call where the IM was
+     *                      sent, or PJSUA_INVALID_ID if the IM was sent
+     *                      outside call context.
+     * @param from          URI of the sender.
+     * @param to            URI of the destination message.
+     * @param contact       The Contact URI of the sender, if present.
+     * @param mime_type     MIME type of the message.
+     * @param body          The message content.
      */
     void (*on_pager)(pjsua_call_id call_id, const pj_str_t *from,
@@ -414 +451 @@
     /**
      * Notify application about typing indication.
+     *
+     * @param call_id       Containts the ID of the call where the IM was
+     *                      sent, or PJSUA_INVALID_ID if the IM was sent
+     *                      outside call context.
+     * @param from          URI of the sender.
+     * @param to            URI of the destination message.
+     * @param contact       The Contact URI of the sender, if present.
+     * @param is_typing     Non-zero if peer is typing, or zero if peer
+     *                      has stopped typing a message.
      */
     void (*on_typing)(pjsua_call_id call_id, const pj_str_t *from,