|
Loading
|
|
SIP/media Features About: PJLIB, PJLIB-UTIL, PJSIP, and PJMEDIA are created by: Benny Prijono <bennylp  pjsip.org>
|
Home --> Documentations --> PJSIP Reference pjsua_acc_config Struct Reference
|
| unsigned pjsua_acc_config::proxy_cnt |
Number of proxies in the proxy array below.
| pj_str_t pjsua_acc_config::proxy[PJSUA_ACC_MAX_PROXIES] |
Optional URI of the proxies to be visited for all outgoing requests that are using this account (REGISTER, INVITE, etc). Application need to specify these proxies if the service provider requires that requests destined towards its network should go through certain proxies first (for example, border controllers).
These proxies will be put in the route set for this account, with maintaining the orders (the first proxy in the array will be visited first). If global outbound proxies are configured in pjsua_config, then these account proxies will be placed after the global outbound proxies in the routeset.
| unsigned pjsua_acc_config::reg_timeout |
Optional interval for registration, in seconds. If the value is zero, default interval will be used (PJSUA_REG_INTERVAL, 300 seconds).
Specify the number of seconds to refresh the client registration before the registration expires.
Default: PJSIP_REGISTER_CLIENT_DELAY_BEFORE_REFRESH, 5 seconds
| unsigned pjsua_acc_config::unreg_timeout |
Specify the maximum time to wait for unregistration requests to complete during library shutdown sequence.
Default: PJSUA_UNREG_TIMEOUT
| unsigned pjsua_acc_config::cred_count |
Number of credentials in the credential array.
| pjsip_cred_info pjsua_acc_config::cred_info[PJSUA_ACC_MAX_PROXIES] |
Array of credentials. If registration is desired, normally there should be at least one credential specified, to successfully authenticate against the service provider. More credentials can be specified, for example when the requests are expected to be challenged by the proxies in the route set.
Optionally bind this account to specific transport. This normally is not a good idea, as account should be able to send requests using any available transports according to the destination. But some application may want to have explicit control over the transport to use, so in that case it can set this field.
Default: -1 (PJSUA_INVALID_ID)
- See also:
- pjsua_acc_set_transport()
This option is used to update the transport address and the Contact header of REGISTER request. When this option is enabled, the library will keep track of the public IP address from the response of REGISTER request. Once it detects that the address has changed, it will unregister current Contact, update the Contact with transport address learned from Via header, and register a new Contact to the registrar. This will also update the public name of UDP transport if STUN is configured.
See also contact_rewrite_method field.
Default: 1 (yes)
Specify how Contact update will be done with the registration, if allow_contact_rewrite is enabled.
If set to 1, the Contact update will be done by sending unregistration to the currently registered Contact, while simultaneously sending new registration (with different Call-ID) for the updated Contact.
If set to 2, the Contact update will be done in a single, current registration session, by removing the current binding (by setting its Contact's expires parameter to zero) and adding a new Contact binding, all done in a single request.
Value 1 is the legacy behavior.
Default value: PJSUA_CONTACT_REWRITE_METHOD (2)
| unsigned pjsua_acc_config::use_rfc5626 |
Control the use of SIP outbound feature. SIP outbound is described in RFC 5626 to enable proxies or registrar to send inbound requests back to UA using the same connection initiated by the UA for its registration. This feature is highly useful in NAT-ed deployemtns, hence it is enabled by default.
Note: currently SIP outbound can only be used with TCP and TLS transports. If UDP is used for the registration, the SIP outbound feature will be silently ignored for the account.
Default: PJ_TRUE
Specify SIP outbound (RFC 5626) instance ID to be used by this application. If empty, an instance ID will be generated based on the hostname of this agent. If application specifies this parameter, the value will look like "<urn:uuid:00000000-0000-1000-8000-AABBCCDDEEFF>" without the doublequote.
Default: empty
Specify SIP outbound (RFC 5626) registration ID. The default value is empty, which would cause the library to automatically generate a suitable value.
Default: empty
| unsigned pjsua_acc_config::ka_interval |
Set the interval for periodic keep-alive transmission for this account. If this value is zero, keep-alive will be disabled for this account. The keep-alive transmission will be sent to the registrar's address, after successful registration.
Default: 15 (seconds)
Specify the data to be transmitted as keep-alive packets.
Default: CR-LF
Specify whether secure media transport should be used for this account. Valid values are PJMEDIA_SRTP_DISABLED, PJMEDIA_SRTP_OPTIONAL, and PJMEDIA_SRTP_MANDATORY.
Default: PJSUA_DEFAULT_USE_SRTP
Specify whether SRTP requires secure signaling to be used. This option is only used when use_srtp option above is non-zero.
Valid values are: 0: SRTP does not require secure signaling 1: SRTP requires secure transport such as TLS 2: SRTP requires secure end-to-end transport (SIPS)
Default: PJSUA_DEFAULT_SRTP_SECURE_SIGNALING
Specify whether SRTP in PJMEDIA_SRTP_OPTIONAL mode should compose duplicated media in SDP offer, i.e: unsecured and secured version. Otherwise, the SDP media will be composed as unsecured media but with SDP "crypto" attribute.
Default: PJ_FALSE
| unsigned pjsua_acc_config::reg_retry_interval |
Specify interval of auto registration retry upon registration failure (including caused by transport problem), in second. Set to 0 to disable auto re-registration. Note that if the registration retry occurs because of transport failure, the first retry will be done after reg_first_retry_interval seconds instead. Also note that the interval will be randomized slightly by approximately +/- ten seconds to avoid all clients re-registering at the same time.
See also reg_first_retry_interval setting.
Default: PJSUA_REG_RETRY_INTERVAL
This specifies the interval for the first registration retry. The registration retry is explained in reg_retry_interval. Note that the value here will also be randomized by +/- ten seconds.
Default: 0
Specify whether calls of the configured account should be dropped after registration failure and an attempt of re-registration has also failed.
Default: PJ_FALSE (disabled)
| unsigned pjsua_acc_config::reg_use_proxy |
Specify how the registration uses the outbound and account proxy settings. This controls if and what Route headers will appear in the REGISTER request of this account. The value is bitmask combination of PJSUA_REG_USE_OUTBOUND_PROXY and PJSUA_REG_USE_ACC_PROXY bits. If the value is set to 0, the REGISTER request will not use any proxy (i.e. it will not have any Route headers).
Default: 3 (PJSUA_REG_USE_OUTBOUND_PROXY | PJSUA_REG_USE_ACC_PROXY)
Specify whether stream keep-alive and NAT hole punching with non-codec-VAD mechanism (see PJMEDIA_STREAM_ENABLE_KA) is enabled for this account.
Default: PJ_FALSE (disabled)
Specify how to offer call hold to remote peer. Please see the documentation on pjsua_call_hold_type for more info.
Default: PJSUA_CALL_HOLD_TYPE_DEFAULT
Specify whether the account should register as soon as it is added to the UA. Application can set this to PJ_FALSE and control the registration manually with pjsua_acc_set_registration().
Default: PJ_TRUE
The documentation for this struct was generated from the following file:
- pjsua-lib/pjsua.h
Copyright (C) 2006-2008 Teluu Inc.