pjsua_config class final

This structure describes the settings to control the API and user agent behavior, and can be specified when calling #pjsua_init(). Before setting the values, application must call #pjsua_config_default() to initialize this structure with the default values.

Inheritance
Implemented types
Available extensions

Constructors

pjsua_config.new()

Properties

address → Pointer<T>

Available on T, provided by the StructAddress extension

The memory address of the underlying data.
no setter
cb ↔ pjsua_callback
Application callback to receive various event notifications from the library.
getter/setter pair
cred_count ↔ int
Number of credentials in the credential array.
getter/setter pair
cred_info ↔ Array<pjsip_cred_info>
Array of credentials. These credentials will be used by all accounts, and can be used to authenticate against outbound proxies. If the credential is specific to the account, then application should set the credential in the pjsua_acc_config rather than the credential here.
getter/setter pair
enable_unsolicited_mwi ↔ int
Handle unsolicited NOTIFY requests containing message waiting indication (MWI) info. Unsolicited MWI is incoming NOTIFY requests which are not requested by client with SUBSCRIBE request.
getter/setter pair
enable_upnp ↔ int
Specify whether to enable UPnP.
getter/setter pair
force_lr ↔ int
Force loose-route to be used in all route/proxy URIs (outbound_proxy and account's proxy settings). When this setting is enabled, the library will check all the route/proxy URIs specified in the settings and append ";lr" parameter to the URI if the parameter is not present.
getter/setter pair
hangup_forked_call ↔ int
Disconnect other call legs when more than one 2xx responses for outgoing INVITE are received due to forking. Currently the library is not able to handle simultaneous forked media, so disconnecting the other call legs is necessary.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
max_calls ↔ int
Maximum calls to support (default: 4). The value specified here must be smaller than or equal to the compile time maximum settings PJSUA_MAX_CALLS. To increase this limit, the library must be recompiled with new PJSUA_MAX_CALLS value.
getter/setter pair
nameserver ↔ Array<pj_str_t>
Array of nameservers to be used by the SIP resolver subsystem. The order of the name server specifies the priority (first name server will be used first, unless it is not reachable).
getter/setter pair
nameserver_count ↔ int
Number of nameservers. If no name server is configured, the SIP SRV resolution would be disabled, and domain will be resolved with standard pj_gethostbyname() function.
getter/setter pair
nat_type_in_sdp ↔ int
Support for adding and parsing NAT type in the SDP to assist troubleshooting. The valid values are:
getter/setter pair
outbound_proxy ↔ Array<pj_str_t>
Specify the URL of outbound proxies to visit for all outgoing requests. The outbound proxies will be used for all accounts, and it will be used to build the route set for outgoing requests. The final route set for outgoing requests will consists of the outbound proxies and the proxy configured in the account.
getter/setter pair
outbound_proxy_cnt ↔ int
Number of outbound proxies in the \a outbound_proxy array.
getter/setter pair
require_100rel ↔ int
Specify how the support for reliable provisional response (100rel/ PRACK) should be used by default. Note that this setting can be further customized in account configuration (#pjsua_acc_config).
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
srtp_opt ↔ pjsua_srtp_opt
Specify SRTP transport setting. Application can initialize it with default values using pjsua_srtp_opt_default().
getter/setter pair
srtp_optional_dup_offer ↔ int
This setting has been deprecated and will be ignored.
getter/setter pair
srtp_secure_signaling ↔ int
Specify whether SRTP requires secure signaling to be used. This option is only used when \a use_srtp option above is non-zero.
getter/setter pair
stun_domain ↔ pj_str_t
Warning: deprecated, please use \a stun_srv field instead. To maintain backward compatibility, if \a stun_srv_cnt is zero then the value of this field will be copied to \a stun_srv field, if present.
getter/setter pair
stun_host ↔ pj_str_t
Warning: deprecated, please use \a stun_srv field instead. To maintain backward compatibility, if \a stun_srv_cnt is zero then the value of this field will be copied to \a stun_srv field, if present.
getter/setter pair
stun_ignore_failure ↔ int
This specifies if the library should ignore failure with the STUN servers. If this is set to PJ_FALSE, the library will refuse to start if it fails to resolve or contact any of the STUN servers.
getter/setter pair
stun_map_use_stun2 ↔ int
This specifies whether STUN requests for resolving socket mapped address should use the new format, i.e: having STUN magic cookie in its transaction ID.
getter/setter pair
stun_srv ↔ Array<pj_str_t>
Array of STUN servers to try. The library will try to resolve and contact each of the STUN server entry until it finds one that is usable. Each entry may be a domain name, host name, IP address, and it may contain an optional port number. For example:
getter/setter pair
stun_srv_cnt ↔ int
Number of STUN server entries in \a stun_srv array.
getter/setter pair
stun_try_ipv6 ↔ int
This specifies if the library should try to do an IPv6 resolution of the STUN servers if the IPv4 resolution fails. It can be useful in an IPv6-only environment, including on NAT64.
getter/setter pair
thread_cnt ↔ int
Number of worker threads. Normally application will want to have at least one worker thread, unless when it wants to poll the library periodically, which in this case the worker thread can be set to zero.
getter/setter pair
timer_setting ↔ pjsip_timer_setting
Specify Session Timer settings, see #pjsip_timer_setting. Note that this setting can be further customized in account configuration (#pjsua_acc_config).
getter/setter pair
upnp_if_name ↔ pj_str_t
Specify which interface to use for UPnP. If empty, UPnP will use the first suitable interface found.
getter/setter pair
use_srtp ↔ int
Specify default value of secure media transport usage. Valid values are PJMEDIA_SRTP_DISABLED, PJMEDIA_SRTP_OPTIONAL, and PJMEDIA_SRTP_MANDATORY.
getter/setter pair
use_timer ↔ int
Specify the usage of Session Timers for all sessions. See the #pjsua_sip_timer_use for possible values. Note that this setting can be further customized in account configuration (#pjsua_acc_config).
getter/setter pair
user_agent ↔ pj_str_t
Optional user agent string (default empty). If it's empty, no User-Agent header will be sent with outgoing requests.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited