pjsua_acc_config class final

This structure describes account configuration to be specified when adding a new account with #pjsua_acc_add(). Application MUST initialize this structure first by calling #pjsua_acc_config_default().

Inheritance
Implemented types
Available extensions

Constructors

pjsua_acc_config.new()

Properties

address → Pointer<T>

Available on T, provided by the StructAddress extension

The memory address of the underlying data.
no setter
allow_contact_rewrite ↔ int
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.
getter/setter pair
allow_sdp_nat_rewrite ↔ int
This option controls whether the IP address in SDP should be replaced with the IP address found in Via header of the REGISTER response, ONLY when STUN and ICE are not used. If the value is FALSE (the original behavior), then the local IP address will be used. If TRUE, and when STUN and ICE are disabled, then the IP address found in registration response will be used.
getter/setter pair
allow_via_rewrite ↔ int
This option is used to overwrite the "sent-by" field of the Via header for outgoing messages with the same interface address as the one in the REGISTER request, as long as the request uses the same transport instance as the previous REGISTER request.
getter/setter pair
auth_pref ↔ pjsip_auth_clt_pref
Authentication preference.
getter/setter pair
call_hold_type ↔ int
Specify how to offer call hold to remote peer. Please see the documentation on #pjsua_call_hold_type for more info.
getter/setter pair
contact_params ↔ pj_str_t
Additional parameters that will be appended in the Contact header for this account. This will affect the Contact header in all SIP messages sent on behalf of this account, including but not limited to REGISTER, INVITE, and SUBCRIBE requests or responses.
getter/setter pair
contact_rewrite_method ↔ int
Specify how Contact update will be done with the registration, if \a allow_contact_rewrite is enabled. The value is bitmask combination of \a pjsua_contact_rewrite_method. See also pjsua_contact_rewrite_method.
getter/setter pair
contact_uri_params ↔ pj_str_t
Additional URI parameters that will be appended in the Contact URI for this account. This will affect the Contact URI in all SIP messages sent on behalf of this account, including but not limited to REGISTER, INVITE, and SUBCRIBE requests or responses.
getter/setter pair
contact_use_src_port ↔ int
Specify if source TCP port should be used as the initial Contact address if TCP/TLS transport is used. Note that this feature will be automatically turned off when nameserver is configured because it may yield different destination address due to DNS SRV resolution. Also some platforms are unable to report the local address of the TCP socket when it is still connecting. In these cases, this feature will also be turned off.
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. 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.
getter/setter pair
drop_calls_on_reg_fail ↔ int
Specify whether calls of the configured account should be dropped after registration failure and an attempt of re-registration has also failed.
getter/setter pair
enable_loopback ↔ int
Enable local loopback when loop_med_tp_use is set to PJ_TRUE. If enabled, packets sent to the transport will be sent back to the streams attached to the transport.
getter/setter pair
enable_rtcp_mux ↔ int
Enable RTP and RTCP multiplexing.
getter/setter pair
enable_rtcp_xr ↔ int
Enable RTCP Extended Report (RTCP XR).
getter/setter pair
force_contact ↔ pj_str_t
Optional URI to be put as Contact for this account. It is recommended that this field is left empty, so that the value will be calculated automatically based on the transport address.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
ice_cfg ↔ pjsua_ice_config
The custom ICE setting for this account. This setting will only be used if \a ice_cfg_use is set to PJSUA_ICE_CONFIG_USE_CUSTOM
getter/setter pair
ice_cfg_use ↔ int
Control the use of ICE in the account. By default, the settings in the \a pjsua_media_config will be used.
getter/setter pair
id ↔ pj_str_t
The full SIP URL for the account. The value can take name address or URL format, and will look something like "sip:account@serviceprovider" or ""Display Name" sip:account@provider".
getter/setter pair
ip_change_cfg ↔ pjsua_ip_change_acc_cfg
Specify account configuration specific to IP address change used when calling #pjsua_handle_ip_change().
getter/setter pair
ipv6_media_use ↔ int
Specify whether IPv6 should be used on media.
getter/setter pair
ipv6_sip_use ↔ int
Specify whether IPv6 should be used for SIP signalling.
getter/setter pair
ka_data ↔ pj_str_t
Specify the data to be transmitted as keep-alive packets.
getter/setter pair
ka_interval ↔ int
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.
getter/setter pair
lock_codec ↔ int
If remote sends SDP answer containing more than one format or codec in the media line, send re-INVITE or UPDATE with just one codec to lock which codec to use.
getter/setter pair
media_stun_use ↔ int
Control the use of STUN for the media transports.
getter/setter pair
media_upnp_use ↔ int
Control the use of UPnP for the media transports.
getter/setter pair
mwi_enabled ↔ int
Subscribe to message waiting indication events (RFC 3842).
getter/setter pair
mwi_expires ↔ int
Specify the default expiration time for Message Waiting Indication (RFC 3842) event subscription. This must not be zero.
getter/setter pair
nat64_opt ↔ int
Specify NAT64 options.
getter/setter pair
pidf_tuple_id ↔ pj_str_t
Optional PIDF tuple ID for outgoing PUBLISH and NOTIFY. If this value is not specified, a random string will be used.
getter/setter pair
priority ↔ int
Account priority, which is used to control the order of matching incoming/outgoing requests. The higher the number means the higher the priority is, and the account will be matched first.
getter/setter pair
proxy ↔ Array<pj_str_t>
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).
getter/setter pair
proxy_cnt ↔ int
Number of proxies in the proxy array below.
getter/setter pair
publish_enabled ↔ int
If this flag is set, the presence information of this account will be PUBLISH-ed to the server where the account belongs.
getter/setter pair
publish_opt ↔ pjsip_publishc_opt
Event publication options.
getter/setter pair
reg_contact_params ↔ pj_str_t
Additional parameters that will be appended in the Contact header for this account. This will only affect REGISTER requests and will be appended after \a contact_params;
getter/setter pair
reg_contact_uri_params ↔ pj_str_t
Additional URI parameters that will be appended in the Contact URI for this account. This will only affect REGISTER requests and will be appended after \a contact_uri_params;
getter/setter pair
reg_delay_before_refresh ↔ int
Specify the number of seconds to refresh the client registration before the registration expires.
getter/setter pair
reg_first_retry_interval ↔ int
This specifies the interval for the first registration retry. The registration retry is explained in \a reg_retry_interval. Note that the value here will also be randomized by some seconds (specified in \a reg_retry_random_interval) to avoid all clients re-registering at the same time.
getter/setter pair
reg_hdr_list ↔ pjsip_hdr
The optional custom SIP headers to be put in the registration request.
getter/setter pair
reg_retry_interval ↔ int
Specify interval of auto registration retry upon registration failure, in seconds. Set to 0 to disable auto re-registration. Note that registration will only be automatically retried for temporal failures considered to be recoverable in relatively short term, such as: 408 (Request Timeout), 480 (Temporarily Unavailable), 500 (Internal Server Error), 502 (Bad Gateway), 503 (Service Unavailable), 504 (Server Timeout), 6xx (global failure), and failure caused by transport problem. For registration retry caused by transport failure, the first retry will be done after \a reg_first_retry_interval seconds instead. Note that the interval will be randomized slightly by some seconds (specified in \a reg_retry_random_interval) to avoid all clients re-registering at the same time.
getter/setter pair
reg_retry_random_interval ↔ int
This specifies maximum randomized value to be added/substracted to/from the registration retry interval specified in \a reg_retry_interval and \a reg_first_retry_interval, in second. This is useful to avoid all clients re-registering at the same time. For example, if the registration retry interval is set to 100 seconds and this is set to 10 seconds, the actual registration retry interval will be in the range of 90 to 110 seconds.
getter/setter pair
reg_timeout ↔ int
Optional interval for registration, in seconds. If the value is zero, default interval will be used (PJSUA_REG_INTERVAL, 300 seconds).
getter/setter pair
reg_uri ↔ pj_str_t
This is the URL to be put in the request URI for the registration, and will look something like "sip:serviceprovider".
getter/setter pair
reg_use_proxy ↔ int
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).
getter/setter pair
register_on_acc_add ↔ int
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().
getter/setter pair
require_100rel ↔ int
Specify how support for reliable provisional response (100rel/ PRACK) should be used for all sessions in this account. See the documentation of pjsua_100rel_use enumeration for more info.
getter/setter pair
rfc5626_instance_id ↔ pj_str_t
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.
getter/setter pair
rfc5626_reg_id ↔ pj_str_t
Specify SIP outbound (RFC 5626) registration ID. The default value is empty, which would cause the library to automatically generate a suitable value.
getter/setter pair
rtcp_fb_cfg ↔ pjmedia_rtcp_fb_setting
RTCP Feedback configuration.
getter/setter pair
rtp_cfg ↔ pjsua_transport_config
Media transport config.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sip_stun_use ↔ int
Control the use of STUN for the SIP signaling.
getter/setter pair
sip_upnp_use ↔ int
Control the use of UPnP for the SIP signaling.
getter/setter pair
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
sub_hdr_list ↔ pjsip_hdr
The optional custom SIP headers to be put in the presence subscription request.
getter/setter pair
timer_setting ↔ pjsip_timer_setting
Specify Session Timer settings, see #pjsip_timer_setting.
getter/setter pair
transport_id ↔ int
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.
getter/setter pair
turn_cfg ↔ pjsua_turn_config
The custom TURN setting for this account. This setting will only be used if \a turn_cfg_use is set to PJSUA_TURN_CONFIG_USE_CUSTOM
getter/setter pair
turn_cfg_use ↔ int
Control the use of TURN in the account. By default, the settings in the \a pjsua_media_config will be used
getter/setter pair
unpublish_max_wait_time_msec ↔ int
Maximum time to wait for unpublication transaction(s) to complete during shutdown process, before sending unregistration. The library tries to wait for the unpublication (un-PUBLISH) to complete before sending REGISTER request to unregister the account, during library shutdown process. If the value is set too short, it is possible that the unregistration is sent before unpublication completes, causing unpublication request to fail.
getter/setter pair
unreg_timeout ↔ int
Specify the maximum time to wait for unregistration requests to complete during library shutdown sequence.
getter/setter pair
use_loop_med_tp ↔ int
Use loopback media transport. This may be useful if application doesn't want PJSIP to create real media transports/sockets, such as when using third party media.
getter/setter pair
use_rfc5626 ↔ int
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.
getter/setter pair
use_srtp ↔ int
Specify whether secure media transport should be used for this account. 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.
getter/setter pair
user_data ↔ Pointer<Void>
Arbitrary user data to be associated with the newly created account. Application may set this later with #pjsua_acc_set_user_data() and retrieve it with #pjsua_acc_get_user_data().
getter/setter pair
vid_cap_dev ↔ int
Specify the default capture device to be used by this account. If \a vid_out_auto_transmit is enabled, this device will be used for capturing video.
getter/setter pair
vid_in_auto_show ↔ int
Specify whether incoming video should be shown to screen by default. This applies to incoming call (INVITE), incoming re-INVITE, and incoming UPDATE requests.
getter/setter pair
vid_out_auto_transmit ↔ int
Specify whether outgoing video should be activated by default when making outgoing calls and/or when incoming video is detected. This applies to incoming and outgoing calls, incoming re-INVITE, and incoming UPDATE. If the setting is non-zero, outgoing video transmission will be started as soon as response to these requests is sent (or received).
getter/setter pair
vid_rend_dev ↔ int
Specify the default rendering device to be used by this account.
getter/setter pair
vid_stream_rc_cfg ↔ pjmedia_vid_stream_rc_config
Specify the send rate control for video stream.
getter/setter pair
vid_stream_sk_cfg ↔ pjmedia_vid_stream_sk_config
Specify the send keyframe config for video stream.
getter/setter pair
vid_wnd_flags ↔ int
Specify video window's flags. The value is a bitmask combination of #pjmedia_vid_dev_wnd_flag.
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