diff options
Diffstat (limited to 'pjsip/include/pjsua-lib/pjsua.h')
| -rw-r--r-- | pjsip/include/pjsua-lib/pjsua.h | 17 |
1 files changed, 15 insertions, 2 deletions
diff --git a/pjsip/include/pjsua-lib/pjsua.h b/pjsip/include/pjsua-lib/pjsua.h index 1d9594c3..4d5fa69a 100644 --- a/pjsip/include/pjsua-lib/pjsua.h +++ b/pjsip/include/pjsua-lib/pjsua.h @@ -3644,8 +3644,21 @@ PJ_DECL(pj_status_t) pjsua_acc_get_config(pjsua_acc_id acc_id, /** - * Modify account information. - * + * Modify account configuration setting. This function may trigger + * unregistration (of old account setting) and re-registration (of the new + * account setting), e.g: changing account ID, credential, registar, or + * proxy setting. + * + * Note: + * - when the new config triggers unregistration, the pjsua callback + * on_reg_state()/on_reg_state2() for the unregistration will not be called + * and any failure in the unregistration will be ignored, so if application + * needs to be sure about the unregistration status, it should unregister + * manually and wait for the callback before calling this function + * - when the new config triggers re-registration and the re-registration + * fails, the account setting will not be reverted back to the old setting + * and the account will be in unregistered state. + * * @param acc_id Id of the account to be modified. * @param acc_cfg New account configuration. * |