Group PJSUA_LIB_BASE

group PJSUA_LIB_BASE

Basic application creation/initialization, logging configuration, etc.

The base PJSUA API controls PJSUA creation, initialization, and startup, and also provides various auxiliary functions.

Defines

DISABLED_FOR_TICKET_1185

Disabled features temporarily for media reorganization

PJSUA_ACC_MAX_PROXIES

Maximum proxies in account.

PJSUA_DEFAULT_USE_SRTP

Default value of SRTP mode usage. Valid values are PJMEDIA_SRTP_DISABLED, PJMEDIA_SRTP_OPTIONAL, and PJMEDIA_SRTP_MANDATORY.

PJSUA_DEFAULT_SRTP_SECURE_SIGNALING

Default value of secure signaling requirement for SRTP. 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)

PJSUA_ADD_ICE_TAGS

Controls whether PJSUA-LIB should add ICE media feature tag parameter (the “;+sip.ice” parameter) to Contact header if ICE is enabled in the config.

Default: 1

PJSUA_ACQUIRE_CALL_TIMEOUT

Timeout value used to acquire mutex lock on a particular call.

Default: 2000 ms

PJSUA_HAS_VIDEO

Is video enabled.

PJSUA_VID_REQ_KEYFRAME_INTERVAL

Interval between two keyframe requests, in milliseconds.

Default: 3000 ms

PJSUA_SEPARATE_WORKER_FOR_TIMER

Specify whether timer heap events will be polled by a separate worker thread. If this is set/enabled, a worker thread will be dedicated to poll timer heap events only, and the rest worker thread(s) will poll ioqueue/network events only.

Note that if worker thread count setting (i.e: pjsua_config.thread_cnt) is set to zero, this setting will be ignored.

Default: 0 (disabled)

pjsip_cred_dup

The implementation has been moved to sip_auth.h

Typedefs

typedef int pjsua_call_id

Call identification

typedef int pjsua_acc_id

Account identification

typedef int pjsua_buddy_id

Buddy identification

typedef int pjsua_player_id

File player identification

typedef int pjsua_recorder_id

File recorder identification

typedef int pjsua_conf_port_id

Conference port identification

typedef pj_status_t (*pjsua_med_tp_state_cb)(pjsua_call_id call_id, const pjsua_med_tp_state_info *info)

Type of callback to be called when media transport state is changed.

Return

The callback must return PJ_SUCCESS at the moment.

Parameters
  • call_id: The call ID.

  • info: The media transport state info.

typedef void (*pj_stun_resolve_cb)(const pj_stun_resolve_result *result)

Typedef of callback to be registered to pjsua_resolve_stun_servers() and to be called when STUN resolution completes.

Enums

enum pjsua_invalid_id_const_

Constant to identify invalid ID for all sorts of IDs.

Values:

PJSUA_INVALID_ID = -1
enum pjsua_state

This enumeration represents pjsua state.

Values:

PJSUA_STATE_NULL

The library has not been initialized.

PJSUA_STATE_CREATED

After pjsua_create() is called but before pjsua_init() is called.

PJSUA_STATE_INIT

After pjsua_init() is called but before pjsua_start() is called.

PJSUA_STATE_STARTING

After pjsua_start() is called but before everything is running.

PJSUA_STATE_RUNNING

After pjsua_start() is called and before pjsua_destroy() is called.

PJSUA_STATE_CLOSING

After pjsua_destroy() is called but before the function returns.

enum pjsua_med_tp_st

Enumeration of media transport state types.

Values:

PJSUA_MED_TP_NULL

Null, this is the state before media transport is created.

PJSUA_MED_TP_CREATING

Just before media transport is created, which can finish asynchronously later.

PJSUA_MED_TP_IDLE

Media transport creation is completed, but not initialized yet.

PJSUA_MED_TP_INIT

Initialized (media_create() has been called).

PJSUA_MED_TP_RUNNING

Running (media_start() has been called).

PJSUA_MED_TP_DISABLED

Disabled (transport is initialized, but media is being disabled).

enum pjsua_create_media_transport_flag

This enumeration specifies the options for custom media transport creation.

Values:

PJSUA_MED_TP_CLOSE_MEMBER = 1

This flag indicates that the media transport must also close its “member” or “child” transport when pjmedia_transport_close() is called. If this flag is not specified, then the media transport must not call pjmedia_transport_close() of its member transport.

enum pjsua_contact_rewrite_method

This enumeration specifies the contact rewrite method.

Values:

PJSUA_CONTACT_REWRITE_UNREGISTER = 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.

PJSUA_CONTACT_REWRITE_NO_UNREG = 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.

PJSUA_CONTACT_REWRITE_ALWAYS_UPDATE = 4

The Contact update will be done when receiving any registration final response. If this flag is not specified, contact update will only be done upon receiving 2xx response. This flag MUST be used with PJSUA_CONTACT_REWRITE_UNREGISTER or PJSUA_CONTACT_REWRITE_NO_UNREG above to specify how the Contact update should be performed when receiving 2xx response.

enum pjsua_ip_change_op

This enumeration specifies the operation when handling IP change.

Values:

PJSUA_IP_CHANGE_OP_NULL

Hasn’t start ip change process.

PJSUA_IP_CHANGE_OP_RESTART_LIS

The restart listener process.

PJSUA_IP_CHANGE_OP_ACC_SHUTDOWN_TP

The shutdown transport process.

PJSUA_IP_CHANGE_OP_ACC_UPDATE_CONTACT

The update contact process.

PJSUA_IP_CHANGE_OP_ACC_HANGUP_CALLS

The hanging up call process.

PJSUA_IP_CHANGE_OP_ACC_REINVITE_CALLS

The re-INVITE call process.

PJSUA_IP_CHANGE_OP_COMPLETED

The ip change process has completed.

enum pjsua_dtmf_method

This enumeration specifies DTMF method.

Values:

PJSUA_DTMF_METHOD_RFC2833

Send DTMF using RFC2833.

PJSUA_DTMF_METHOD_SIP_INFO

Send DTMF using SIP INFO. Notes:

  • This method is not finalized in any standard/rfc, however it is commonly used.

  • Warning: in case the remote doesn’t support SIP INFO, response might not be sent and the sender will deal this as timeout and disconnect the call.

enum pjsua_sip_timer_use

This enumeration specifies the usage of SIP Session Timers extension.

Values:

PJSUA_SIP_TIMER_INACTIVE

When this flag is specified, Session Timers will not be used in any session, except it is explicitly required in the remote request.

PJSUA_SIP_TIMER_OPTIONAL

When this flag is specified, Session Timers will be used in all sessions whenever remote supports and uses it.

PJSUA_SIP_TIMER_REQUIRED

When this flag is specified, Session Timers support will be a requirement for the remote to be able to establish a session.

PJSUA_SIP_TIMER_ALWAYS

When this flag is specified, Session Timers will always be used in all sessions, regardless whether remote supports/uses it or not.

enum pjsua_100rel_use

This constants controls the use of 100rel extension.

Values:

PJSUA_100REL_NOT_USED

Not used. For UAC, support for 100rel will be indicated in Supported header so that peer can opt to use it if it wants to. As UAS, this option will NOT cause 100rel to be used even if UAC indicates that it supports this feature.

PJSUA_100REL_MANDATORY

Mandatory. UAC will place 100rel in Require header, and UAS will reject incoming calls unless it has 100rel in Supported header.

PJSUA_100REL_OPTIONAL

Optional. Similar to PJSUA_100REL_NOT_USED, except that as UAS, this option will cause 100rel to be used if UAC indicates that it supports it.

enum pjsua_destroy_flag

Flags to be given to pjsua_destroy2()

Values:

PJSUA_DESTROY_NO_RX_MSG = 1

Allow sending outgoing messages (such as unregistration, event unpublication, BYEs, unsubscription, etc.), but do not wait for responses. This is useful to perform “best effort” clean up without delaying the shutdown process waiting for responses.

PJSUA_DESTROY_NO_TX_MSG = 2

If this flag is set, do not send any outgoing messages at all. This flag is useful if application knows that the network which the messages are to be sent on is currently down.

PJSUA_DESTROY_NO_NETWORK = PJSUA_DESTROY_NO_RX_MSG | PJSUA_DESTROY_NO_TX_MSG

Do not send or receive messages during destroy. This flag is shorthand for PJSUA_DESTROY_NO_RX_MSG + PJSUA_DESTROY_NO_TX_MSG.

Functions

void pjsua_logging_config_default(pjsua_logging_config *cfg)

Use this function to initialize logging config.

Parameters
  • cfg: The logging config to be initialized.

void pjsua_logging_config_dup(pj_pool_t *pool, pjsua_logging_config *dst, const pjsua_logging_config *src)

Use this function to duplicate logging config.

Parameters
  • pool: Pool to use.

  • dst: Destination config.

  • src: Source config.

void pjsua_config_default(pjsua_config *cfg)

Use this function to initialize pjsua config.

Parameters
  • cfg: pjsua config to be initialized.

void pjsua_config_dup(pj_pool_t *pool, pjsua_config *dst, const pjsua_config *src)

Duplicate pjsua_config.

Parameters
  • pool: The pool to get memory from.

  • dst: Destination config.

  • src: Source config.

void pjsua_msg_data_init(pjsua_msg_data *msg_data)

Initialize message data.

Parameters
  • msg_data: Message data to be initialized.

pjsua_msg_data *pjsua_msg_data_clone(pj_pool_t *pool, const pjsua_msg_data *rhs)

Clone message data.

Return

The new message data.

Parameters
  • pool: Pool to allocate memory for the new message data.

  • rhs: Message data to be cloned.

pj_status_t pjsua_create(void)

Instantiate pjsua application. Application must call this function before calling any other functions, to make sure that the underlying libraries are properly initialized. Once this function has returned success, application must call pjsua_destroy() before quitting.

Return

PJ_SUCCESS on success, or the appropriate error code.

pj_status_t pjsua_init(const pjsua_config *ua_cfg, const pjsua_logging_config *log_cfg, const pjsua_media_config *media_cfg)

Initialize pjsua with the specified settings. All the settings are optional, and the default values will be used when the config is not specified.

Note that pjsua_create() MUST be called before calling this function.

Return

PJ_SUCCESS on success, or the appropriate error code.

Parameters
  • ua_cfg: User agent configuration.

  • log_cfg: Optional logging configuration.

  • media_cfg: Optional media configuration.

pj_status_t pjsua_start(void)

Application is recommended to call this function after all initialization is done, so that the library can do additional checking set up additional

Application may call this function anytime after pjsua_init().

Return

PJ_SUCCESS on success, or the appropriate error code.

pj_status_t pjsua_destroy(void)

Destroy pjsua. Application is recommended to perform graceful shutdown before calling this function (such as unregister the account from the SIP server, terminate presense subscription, and hangup active calls), however, this function will do all of these if it finds there are active sessions that need to be terminated. This function will approximately block for one second to wait for replies from remote.

Application.may safely call this function more than once if it doesn’t keep track of it’s state.

See

pjsua_destroy2()

Return

PJ_SUCCESS on success, or the appropriate error code.

pjsua_state pjsua_get_state(void)

Retrieve pjsua state.

Return

pjsua state.

pj_status_t pjsua_destroy2(unsigned flags)

Variant of destroy with additional flags.

Return

PJ_SUCCESS on success, or the appropriate error code.

Parameters
  • flags: Combination of pjsua_destroy_flag enumeration.

int pjsua_handle_events(unsigned msec_timeout)

Poll pjsua for events, and if necessary block the caller thread for the specified maximum interval (in miliseconds).

Application doesn’t normally need to call this function if it has configured worker thread (thread_cnt field) in pjsua_config structure, because polling then will be done by these worker threads instead.

Return

The number of events that have been handled during the poll. Negative value indicates error, and application can retrieve the error as (status = -return_value).

Parameters
  • msec_timeout: Maximum time to wait, in miliseconds.

void pjsua_stop_worker_threads(void)

Signal all worker threads to quit. This will only wait until internal threads are done.

pj_pool_t *pjsua_pool_create(const char *name, pj_size_t init_size, pj_size_t increment)

Create memory pool to be used by the application. Once application finished using the pool, it must be released with pj_pool_release().

Return

The pool, or NULL when there’s no memory.

Parameters
  • name: Optional pool name.

  • init_size: Initial size of the pool.

  • increment: Increment size.

pj_status_t pjsua_reconfigure_logging(const pjsua_logging_config *c)

Application can call this function at any time (after pjsua_create(), of course) to change logging settings.

Return

PJ_SUCCESS on success, or the appropriate error code.

Parameters
  • c: Logging configuration.

pjsip_endpoint *pjsua_get_pjsip_endpt(void)

Internal function to get SIP endpoint instance of pjsua, which is needed for example to register module, create transports, etc. Only valid after pjsua_init() is called.

Return

SIP endpoint instance.

pjmedia_endpt *pjsua_get_pjmedia_endpt(void)

Internal function to get media endpoint instance. Only valid after pjsua_init() is called.

Return

Media endpoint instance.

pj_pool_factory *pjsua_get_pool_factory(void)

Internal function to get PJSUA pool factory. Only valid after pjsua_create() is called.

Return

Pool factory currently used by PJSUA.

void pjsua_ip_change_param_default(pjsua_ip_change_param *param)

Call this function to initialize pjsua_ip_change_param with default values.

Parameters
  • param: The IP change param to be initialized.

pj_status_t pjsua_detect_nat_type(void)

This is a utility function to detect NAT type in front of this endpoint. Once invoked successfully, this function will complete asynchronously and report the result in on_nat_detect() callback of pjsua_callback.

After NAT has been detected and the callback is called, application can get the detected NAT type by calling pjsua_get_nat_type(). Application can also perform NAT detection by calling pjsua_detect_nat_type() again at later time.

Note that STUN must be enabled to run this function successfully.

Return

PJ_SUCCESS on success, or the appropriate error code.

pj_status_t pjsua_get_nat_type(pj_stun_nat_type *type)

Get the NAT type as detected by pjsua_detect_nat_type() function. This function will only return useful NAT type after pjsua_detect_nat_type() has completed successfully and on_nat_detect() callback has been called.

Return

When detection is in progress, this function will return PJ_EPENDING and type will be set to PJ_STUN_NAT_TYPE_UNKNOWN. After NAT type has been detected successfully, this function will return PJ_SUCCESS and type will be set to the correct value. Other return values indicate error and type will be set to PJ_STUN_NAT_TYPE_ERR_UNKNOWN.

See

pjsua_call_get_rem_nat_type()

Parameters
  • type: NAT type.

pj_status_t pjsua_update_stun_servers(unsigned count, pj_str_t srv[], pj_bool_t wait)

Update the STUN servers list. The pjsua_init() must have been called before calling this function.

Return

If wait parameter is non-zero, this will return PJ_SUCCESS if one usable STUN server is found. Otherwise it will always return PJ_SUCCESS, and application will be notified about the result in the callback #on_stun_resolution_complete.

Parameters
  • count: Number of STUN server entries.

  • srv: Array of STUN server entries to try. Please see the stun_srv field in the pjsua_config documentation about the format of this entry.

  • wait: Specify non-zero to make the function block until it gets the result. In this case, the function will block while the resolution is being done, and the callback will be called before this function returns.

pj_status_t pjsua_resolve_stun_servers(unsigned count, pj_str_t srv[], pj_bool_t wait, void *token, pj_stun_resolve_cb cb)

Auxiliary function to resolve and contact each of the STUN server entries (sequentially) to find which is usable. The pjsua_init() must have been called before calling this function.

Return

If wait parameter is non-zero, this will return PJ_SUCCESS if one usable STUN server is found. Otherwise it will always return PJ_SUCCESS, and application will be notified about the result in the callback.

Parameters
  • count: Number of STUN server entries to try.

  • srv: Array of STUN server entries to try. Please see the stun_srv field in the pjsua_config documentation about the format of this entry.

  • wait: Specify non-zero to make the function block until it gets the result. In this case, the function will block while the resolution is being done, and the callback will be called before this function returns.

  • token: Arbitrary token to be passed back to application in the callback.

  • cb: Callback to be called to notify the result of the function.

pj_status_t pjsua_cancel_stun_resolution(void *token, pj_bool_t notify_cb)

Cancel pending STUN resolution which match the specified token.

Return

PJ_SUCCESS if there is at least one pending STUN resolution cancelled, or PJ_ENOTFOUND if there is no matching one, or other error.

Parameters
  • token: The token to match. This token was given to pjsua_resolve_stun_servers()

  • notify_cb: Boolean to control whether the callback should be called for cancelled resolutions. When the callback is called, the status in the result will be set as PJ_ECANCELLED.

pj_status_t pjsua_verify_sip_url(const char *url)

This is a utility function to verify that valid SIP url is given. If the URL is a valid SIP/SIPS scheme, PJ_SUCCESS will be returned.

Return

PJ_SUCCESS on success, or the appropriate error code.

See

pjsua_verify_url()

Parameters
  • url: The URL, as NULL terminated string.

pj_status_t pjsua_verify_url(const char *url)

This is a utility function to verify that valid URI is given. Unlike pjsua_verify_sip_url(), this function will return PJ_SUCCESS if tel: URI is given.

Return

PJ_SUCCESS on success, or the appropriate error code.

See

pjsua_verify_sip_url()

Parameters
  • url: The URL, as NULL terminated string.

pj_status_t pjsua_schedule_timer(pj_timer_entry *entry, const pj_time_val *delay)

Schedule a timer entry. Note that the timer callback may be executed by different thread, depending on whether worker thread is enabled or not.

Return

PJ_SUCCESS on success, or the appropriate error code.

See

pjsip_endpt_schedule_timer()

Parameters
  • entry: Timer heap entry.

  • delay: The interval to expire.

pj_status_t pjsua_schedule_timer2(void (*cb)(void *user_data), void *user_data, unsigned msec_delay, )

Schedule a callback function to be called after a specified time interval. Note that the callback may be executed by different thread, depending on whether worker thread is enabled or not.

Return

PJ_SUCCESS on success, or the appropriate error code.

Parameters
  • cb: The callback function.

  • user_data: The user data.

  • msec_delay: The time interval in msec.

void pjsua_cancel_timer(pj_timer_entry *entry)

Cancel the previously scheduled timer.

See

pjsip_endpt_cancel_timer()

Parameters
  • entry: Timer heap entry.

void pjsua_perror(const char *sender, const char *title, pj_status_t status)

This is a utility function to display error message for the specified error code. The error message will be sent to the log.

Parameters
  • sender: The log sender field.

  • title: Message title for the error.

  • status: Status code.

void pjsua_dump(pj_bool_t detail)

This is a utility function to dump the stack states to log, using verbosity level 3.

Parameters
  • detail: Will print detailed output (such as list of SIP transactions) when non-zero.

pj_status_t pjsua_handle_ip_change(const pjsua_ip_change_param *param)

Inform the stack that IP address change event was detected. The stack will:

  1. Restart the listener (this step is configurable via pjsua_ip_change_param.restart_listener).

  2. Shutdown the transport used by account registration (this step is configurable via pjsua_acc_config.ip_change_cfg.shutdown_tp).

  3. Update contact URI by sending re-Registration (this step is configurable via a\ pjsua_acc_config.allow_contact_rewrite and a\ pjsua_acc_config.contact_rewrite_method)

  4. Hangup active calls (this step is configurable via a\ pjsua_acc_config.ip_change_cfg.hangup_calls) or continue the call by sending re-INVITE (configurable via pjsua_acc_config.ip_change_cfg.reinvite_flags).

Return

PJ_SUCCESS on success, other on error.

Parameters

struct pjsua_logging_config
#include <pjsua.h>

Logging configuration, which can be (optionally) specified when calling pjsua_init(). Application must call pjsua_logging_config_default() to initialize this structure with the default values.

struct pjsua_mwi_info
#include <pjsua.h>

Structure to be passed on MWI callback.

struct pjsua_reg_info
#include <pjsua.h>

Structure to be passed on registration callback.

struct pjsua_on_stream_created_param
#include <pjsua.h>

Structure to be passed to on stream created callback. See #on_stream_created2().

struct pjsua_med_tp_state_info
#include <pjsua.h>

Structure to be passed on media transport state callback.

struct pjsua_srtp_opt
#include <pjsua.h>

Specify SRTP media transport settings.

union pjsua_ip_change_op_info
#include <pjsua.h>

This will contain the information of the callback on_ip_change_progress.

Public Members

int transport_id
struct pjsua_ip_change_op_info::[anonymous] lis_restart

The information from listener restart operation.

int acc_id
struct pjsua_ip_change_op_info::[anonymous] acc_shutdown_tp

The information from shutdown transport.

pjsua_acc_id acc_id
pj_bool_t is_register

SIP Register if PJ_TRUE.

int code

SIP status code received.

struct pjsua_ip_change_op_info::[anonymous] acc_update_contact

The information from updating contact.

pjsua_call_id call_id
struct pjsua_ip_change_op_info::[anonymous] acc_hangup_calls

The information from hanging up call operation.

struct pjsua_ip_change_op_info::[anonymous] acc_reinvite_calls

The information from re-Invite call operation.

struct pjsua_dtmf_info
#include <pjsua.h>

This will contain the information of the callback on_dtmf_digit2.

struct pjsua_call_setting
#include <pjsua.h>

Call settings.

struct pjsua_callback
#include <pjsua.h>

This structure describes application callback to receive various event notification from PJSUA-API. All of these callbacks are OPTIONAL, although definitely application would want to implement some of the important callbacks (such as on_incoming_call).

struct pjsua_config
#include <pjsua.h>

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.

struct pjsua_msg_data
#include <pjsua.h>

This structure describes additional information to be sent with outgoing SIP message. It can (optionally) be specified for example with pjsua_call_make_call(), pjsua_call_answer(), pjsua_call_hangup(), pjsua_call_set_hold(), pjsua_call_send_im(), and many more.

Application MUST call pjsua_msg_data_init() to initialize this structure before setting its values.

Forward declaration for pjsua_msg_data

struct pj_stun_resolve_result
#include <pjsua.h>

This structure is used to represent the result of the STUN server resolution and testing, the pjsua_resolve_stun_servers() function. This structure will be passed in pj_stun_resolve_cb callback.

Forward declaration for pj_stun_resolve_result

struct pjsua_ip_change_param
#include <pjsua.h>

This structure describe the parameter passed to pjsua_handle_ip_change().

struct pjsua_ip_change_acc_cfg
#include <pjsua.h>

This structure describe the account config specific to IP address change.