blob: d178a863bff6fd435875e92c27b811f081778398 [file] [log] [blame]
Benny Prijono268ca612006-02-07 12:34:11 +00001/* $Id$ */
2/*
Benny Prijono844653c2008-12-23 17:27:53 +00003 * Copyright (C) 2008-2009 Teluu Inc. (http://www.teluu.com)
Benny Prijono32177c02008-06-20 22:44:47 +00004 * Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org>
Benny Prijono268ca612006-02-07 12:34:11 +00005 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 */
20#ifndef __PJSUA_H__
21#define __PJSUA_H__
22
Benny Prijono312aff92006-06-17 04:08:30 +000023/**
24 * @file pjsua.h
25 * @brief PJSUA API.
26 */
27
28
Benny Prijono268ca612006-02-07 12:34:11 +000029/* Include all PJSIP core headers. */
30#include <pjsip.h>
31
32/* Include all PJMEDIA headers. */
33#include <pjmedia.h>
34
Benny Prijono1f9afba2006-02-10 15:57:32 +000035/* Include all PJMEDIA-CODEC headers. */
36#include <pjmedia-codec.h>
37
Benny Prijono268ca612006-02-07 12:34:11 +000038/* Include all PJSIP-UA headers */
39#include <pjsip_ua.h>
40
Benny Prijono834aee32006-02-19 01:38:06 +000041/* Include all PJSIP-SIMPLE headers */
42#include <pjsip_simple.h>
43
Benny Prijono4ab9fbb2007-10-12 12:14:27 +000044/* Include all PJNATH headers */
45#include <pjnath.h>
46
Benny Prijono268ca612006-02-07 12:34:11 +000047/* Include all PJLIB-UTIL headers. */
48#include <pjlib-util.h>
49
50/* Include all PJLIB headers. */
51#include <pjlib.h>
52
53
Benny Prijonoe6ead542007-01-31 20:53:31 +000054PJ_BEGIN_DECL
55
56
Benny Prijono312aff92006-06-17 04:08:30 +000057/**
Benny Prijono58163a22009-06-03 08:40:24 +000058 * @defgroup PJSUA_LIB PJSUA API - High Level Softphone API
Benny Prijono312aff92006-06-17 04:08:30 +000059 * @brief Very high level API for constructing SIP UA applications.
60 * @{
61 *
Benny Prijono58163a22009-06-03 08:40:24 +000062 * @section pjsua_api_intro A SIP User Agent API for C/C++
Benny Prijonoe6ead542007-01-31 20:53:31 +000063 *
Benny Prijono58163a22009-06-03 08:40:24 +000064 * PJSUA API is very high level API for constructing SIP multimedia user agent
Benny Prijono312aff92006-06-17 04:08:30 +000065 * applications. It wraps together the signaling and media functionalities
66 * into an easy to use call API, provides account management, buddy
67 * management, presence, instant messaging, along with multimedia
68 * features such as conferencing, file streaming, local playback,
69 * voice recording, and so on.
70 *
Benny Prijonoe6ead542007-01-31 20:53:31 +000071 * @subsection pjsua_for_c_cpp C/C++ Binding
Benny Prijono312aff92006-06-17 04:08:30 +000072 * Application must link with <b>pjsua-lib</b> to use this API. In addition,
73 * this library depends on the following libraries:
74 * - <b>pjsip-ua</b>,
75 * - <b>pjsip-simple</b>,
76 * - <b>pjsip-core</b>,
77 * - <b>pjmedia</b>,
78 * - <b>pjmedia-codec</b>,
79 * - <b>pjlib-util</b>, and
80 * - <b>pjlib</b>,
81 *
Benny Prijonoe6ead542007-01-31 20:53:31 +000082 * so application must also link with these libraries as well. For more
83 * information, please refer to
84 * <A HREF="http://www.pjsip.org/using.htm">Getting Started with PJSIP</A>
85 * page.
Benny Prijono312aff92006-06-17 04:08:30 +000086 *
Benny Prijonoe6ead542007-01-31 20:53:31 +000087 * @section pjsua_samples
88 *
Benny Prijono58163a22009-06-03 08:40:24 +000089 * Few samples are provided:
Benny Prijonoe6ead542007-01-31 20:53:31 +000090 *
91 - @ref page_pjsip_sample_simple_pjsuaua_c\n
92 Very simple SIP User Agent with registration, call, and media, using
93 PJSUA-API, all in under 200 lines of code.
94
95 - @ref page_pjsip_samples_pjsua\n
96 This is the reference implementation for PJSIP and PJMEDIA.
97 PJSUA is a console based application, designed to be simple enough
98 to be readble, but powerful enough to demonstrate all features
99 available in PJSIP and PJMEDIA.\n
100
Benny Prijono312aff92006-06-17 04:08:30 +0000101 * @section root_using_pjsua_lib Using PJSUA API
102 *
Benny Prijonoe6ead542007-01-31 20:53:31 +0000103 * Please refer to @ref PJSUA_LIB_BASE on how to create and initialize the API.
104 * And then see the Modules on the bottom of this page for more information
105 * about specific subject.
Benny Prijono312aff92006-06-17 04:08:30 +0000106 */
107
Benny Prijonoa91a0032006-02-26 21:23:45 +0000108
Benny Prijonof3195072006-02-14 21:15:30 +0000109
Benny Prijono312aff92006-06-17 04:08:30 +0000110/*****************************************************************************
111 * BASE API
112 */
113
Benny Prijonof04ffdd2006-02-21 00:11:18 +0000114/**
Benny Prijonoe6ead542007-01-31 20:53:31 +0000115 * @defgroup PJSUA_LIB_BASE PJSUA-API Basic API
Benny Prijono312aff92006-06-17 04:08:30 +0000116 * @ingroup PJSUA_LIB
117 * @brief Basic application creation/initialization, logging configuration, etc.
118 * @{
119 *
120 * The base PJSUA API controls PJSUA creation, initialization, and startup, and
121 * also provides various auxiliary functions.
122 *
123 * @section using_pjsua_lib Using PJSUA Library
124 *
125 * @subsection creating_pjsua_lib Creating PJSUA
126 *
Benny Prijono58163a22009-06-03 08:40:24 +0000127 * Before anything else, application must create PJSUA by calling
128 * #pjsua_create().
Benny Prijono312aff92006-06-17 04:08:30 +0000129 * This, among other things, will initialize PJLIB, which is crucial before
Benny Prijonoe6ead542007-01-31 20:53:31 +0000130 * any PJLIB functions can be called, PJLIB-UTIL, and create a SIP endpoint.
131 *
132 * After this function is called, application can create a memory pool (with
133 * #pjsua_pool_create()) and read configurations from command line or file to
134 * build the settings to initialize PJSUA below.
Benny Prijono312aff92006-06-17 04:08:30 +0000135 *
136 * @subsection init_pjsua_lib Initializing PJSUA
137 *
138 * After PJSUA is created, application can initialize PJSUA by calling
Benny Prijonoe6ead542007-01-31 20:53:31 +0000139 * #pjsua_init(). This function takes several optional configuration settings
140 * in the argument, if application wants to set them.
Benny Prijono312aff92006-06-17 04:08:30 +0000141 *
Benny Prijonoe6ead542007-01-31 20:53:31 +0000142 * @subsubsection init_pjsua_lib_c_cpp PJSUA-LIB Initialization (in C)
143 * Sample code to initialize PJSUA in C code:
Benny Prijono312aff92006-06-17 04:08:30 +0000144 \code
145
Benny Prijonob5388cf2007-01-04 22:45:08 +0000146 #include <pjsua-lib/pjsua.h>
147
148 #define THIS_FILE __FILE__
149
150 static pj_status_t app_init(void)
151 {
Benny Prijono312aff92006-06-17 04:08:30 +0000152 pjsua_config ua_cfg;
153 pjsua_logging_config log_cfg;
154 pjsua_media_config media_cfg;
Benny Prijonob5388cf2007-01-04 22:45:08 +0000155 pj_status_t status;
156
157 // Must create pjsua before anything else!
158 status = pjsua_create();
159 if (status != PJ_SUCCESS) {
160 pjsua_perror(THIS_FILE, "Error initializing pjsua", status);
161 return status;
162 }
Benny Prijono312aff92006-06-17 04:08:30 +0000163
164 // Initialize configs with default settings.
165 pjsua_config_default(&ua_cfg);
166 pjsua_logging_config_default(&log_cfg);
167 pjsua_media_config_default(&media_cfg);
168
169 // At the very least, application would want to override
170 // the call callbacks in pjsua_config:
171 ua_cfg.cb.on_incoming_call = ...
172 ua_cfg.cb.on_call_state = ..
173 ...
174
175 // Customize other settings (or initialize them from application specific
176 // configuration file):
177 ...
178
179 // Initialize pjsua
180 status = pjsua_init(&ua_cfg, &log_cfg, &media_cfg);
181 if (status != PJ_SUCCESS) {
182 pjsua_perror(THIS_FILE, "Error initializing pjsua", status);
183 return status;
184 }
Benny Prijonob5388cf2007-01-04 22:45:08 +0000185 .
186 ...
187 }
Benny Prijono312aff92006-06-17 04:08:30 +0000188 \endcode
189 *
Benny Prijonoe6ead542007-01-31 20:53:31 +0000190 *
Benny Prijonoe6ead542007-01-31 20:53:31 +0000191
192
Benny Prijono312aff92006-06-17 04:08:30 +0000193 * @subsection other_init_pjsua_lib Other Initialization
194 *
195 * After PJSUA is initialized with #pjsua_init(), application will normally
196 * need/want to perform the following tasks:
197 *
Benny Prijonoe6ead542007-01-31 20:53:31 +0000198 * - create SIP transport with #pjsua_transport_create(). Application would
199 * to call #pjsua_transport_create() for each transport types that it
200 * wants to support (for example, UDP, TCP, and TLS). Please see
Benny Prijono312aff92006-06-17 04:08:30 +0000201 * @ref PJSUA_LIB_TRANSPORT section for more info.
202 * - create one or more SIP accounts with #pjsua_acc_add() or
Benny Prijonoe6ead542007-01-31 20:53:31 +0000203 * #pjsua_acc_add_local(). The SIP account is used for registering with
204 * the SIP server, if any. Please see @ref PJSUA_LIB_ACC for more info.
Benny Prijono312aff92006-06-17 04:08:30 +0000205 * - add one or more buddies with #pjsua_buddy_add(). Please see
206 * @ref PJSUA_LIB_BUDDY section for more info.
207 * - optionally configure the sound device, codec settings, and other
208 * media settings. Please see @ref PJSUA_LIB_MEDIA for more info.
209 *
210 *
211 * @subsection starting_pjsua_lib Starting PJSUA
212 *
213 * After all initializations have been done, application must call
214 * #pjsua_start() to start PJSUA. This function will check that all settings
Benny Prijonoe6ead542007-01-31 20:53:31 +0000215 * have been properly configured, and apply default settings when they haven't,
216 * or report error status when it is unable to recover from missing settings.
Benny Prijono312aff92006-06-17 04:08:30 +0000217 *
218 * Most settings can be changed during run-time. For example, application
219 * may add, modify, or delete accounts, buddies, or change media settings
220 * during run-time.
Benny Prijonob5388cf2007-01-04 22:45:08 +0000221 *
Benny Prijonoe6ead542007-01-31 20:53:31 +0000222 * @subsubsection starting_pjsua_lib_c C Example for Starting PJSUA
Benny Prijonob5388cf2007-01-04 22:45:08 +0000223 * Sample code:
224 \code
225 static pj_status_t app_run(void)
226 {
227 pj_status_t status;
228
229 // Start pjsua
230 status = pjsua_start();
231 if (status != PJ_SUCCESS) {
232 pjsua_destroy();
233 pjsua_perror(THIS_FILE, "Error starting pjsua", status);
234 return status;
235 }
236
237 // Run application loop
238 while (1) {
239 char choice[10];
240
241 printf("Select menu: ");
242 fgets(choice, sizeof(choice), stdin);
243 ...
244 }
245 }
246 \endcode
Benny Prijonoe6ead542007-01-31 20:53:31 +0000247
Benny Prijonof04ffdd2006-02-21 00:11:18 +0000248 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +0000249
Benny Prijono312aff92006-06-17 04:08:30 +0000250/** Constant to identify invalid ID for all sorts of IDs. */
251#define PJSUA_INVALID_ID (-1)
Benny Prijonoeebe9af2006-06-13 22:57:13 +0000252
253/** Call identification */
254typedef int pjsua_call_id;
255
Benny Prijono312aff92006-06-17 04:08:30 +0000256/** Account identification */
257typedef int pjsua_acc_id;
Benny Prijonoeebe9af2006-06-13 22:57:13 +0000258
259/** Buddy identification */
Benny Prijono8b1889b2006-06-06 18:40:40 +0000260typedef int pjsua_buddy_id;
Benny Prijonoeebe9af2006-06-13 22:57:13 +0000261
262/** File player identification */
Benny Prijono8b1889b2006-06-06 18:40:40 +0000263typedef int pjsua_player_id;
Benny Prijonoeebe9af2006-06-13 22:57:13 +0000264
265/** File recorder identification */
Benny Prijono8b1889b2006-06-06 18:40:40 +0000266typedef int pjsua_recorder_id;
Benny Prijonoeebe9af2006-06-13 22:57:13 +0000267
268/** Conference port identification */
Benny Prijono8b1889b2006-06-06 18:40:40 +0000269typedef int pjsua_conf_port_id;
270
Benny Prijono63fba012008-07-17 14:19:10 +0000271/** Opaque declaration for server side presence subscription */
272typedef struct pjsua_srv_pres pjsua_srv_pres;
273
274/** Forward declaration for pjsua_msg_data */
275typedef struct pjsua_msg_data pjsua_msg_data;
Benny Prijono8b1889b2006-06-06 18:40:40 +0000276
Benny Prijonoeebe9af2006-06-13 22:57:13 +0000277
Benny Prijonoa91a0032006-02-26 21:23:45 +0000278/**
Benny Prijono312aff92006-06-17 04:08:30 +0000279 * Maximum proxies in account.
Benny Prijonodc39fe82006-05-26 12:17:46 +0000280 */
Benny Prijono312aff92006-06-17 04:08:30 +0000281#ifndef PJSUA_ACC_MAX_PROXIES
282# define PJSUA_ACC_MAX_PROXIES 8
283#endif
Benny Prijonoeebe9af2006-06-13 22:57:13 +0000284
Benny Prijonod8179652008-01-23 20:39:07 +0000285#if defined(PJMEDIA_HAS_SRTP) && (PJMEDIA_HAS_SRTP != 0)
Benny Prijonoeebe9af2006-06-13 22:57:13 +0000286
Benny Prijonod8179652008-01-23 20:39:07 +0000287/**
288 * Default value of SRTP mode usage. Valid values are PJMEDIA_SRTP_DISABLED,
289 * PJMEDIA_SRTP_OPTIONAL, and PJMEDIA_SRTP_MANDATORY.
290 */
291#ifndef PJSUA_DEFAULT_USE_SRTP
292 #define PJSUA_DEFAULT_USE_SRTP PJMEDIA_SRTP_DISABLED
293#endif
294
295/**
296 * Default value of secure signaling requirement for SRTP.
297 * Valid values are:
298 * 0: SRTP does not require secure signaling
299 * 1: SRTP requires secure transport such as TLS
300 * 2: SRTP requires secure end-to-end transport (SIPS)
301 */
302#ifndef PJSUA_DEFAULT_SRTP_SECURE_SIGNALING
303 #define PJSUA_DEFAULT_SRTP_SECURE_SIGNALING 1
304#endif
305
306#endif
Benny Prijonoeebe9af2006-06-13 22:57:13 +0000307
308/**
Benny Prijono07fe2302010-06-24 12:33:18 +0000309 * Controls whether PJSUA-LIB should add ICE media feature tag
310 * parameter (the ";+sip.ice" parameter) to Contact header if ICE
311 * is enabled in the config.
312 *
313 * Default: 1
314 */
315#ifndef PJSUA_ADD_ICE_TAGS
316# define PJSUA_ADD_ICE_TAGS 1
317#endif
318
Sauw Ming844c1c92010-09-07 05:12:02 +0000319/**
320 * Timeout value used to acquire mutex lock on a particular call.
321 *
322 * Default: 2000 ms
323 */
324#ifndef PJSUA_ACQUIRE_CALL_TIMEOUT
325# define PJSUA_ACQUIRE_CALL_TIMEOUT 2000
326#endif
327
Benny Prijono07fe2302010-06-24 12:33:18 +0000328
329/**
Benny Prijonob5388cf2007-01-04 22:45:08 +0000330 * Logging configuration, which can be (optionally) specified when calling
331 * #pjsua_init(). Application must call #pjsua_logging_config_default() to
332 * initialize this structure with the default values.
Benny Prijonoeebe9af2006-06-13 22:57:13 +0000333 */
334typedef struct pjsua_logging_config
335{
336 /**
337 * Log incoming and outgoing SIP message? Yes!
338 */
339 pj_bool_t msg_logging;
340
341 /**
342 * Input verbosity level. Value 5 is reasonable.
343 */
344 unsigned level;
345
346 /**
347 * Verbosity level for console. Value 4 is reasonable.
348 */
349 unsigned console_level;
350
351 /**
352 * Log decoration.
353 */
354 unsigned decor;
355
356 /**
357 * Optional log filename.
358 */
359 pj_str_t log_filename;
360
361 /**
Benny Prijonodbe3f4b2009-05-07 16:56:04 +0000362 * Additional flags to be given to #pj_file_open() when opening
363 * the log file. By default, the flag is PJ_O_WRONLY. Application
364 * may set PJ_O_APPEND here so that logs are appended to existing
365 * file instead of overwriting it.
366 *
367 * Default is 0.
368 */
369 unsigned log_file_flags;
370
371 /**
Benny Prijonoeebe9af2006-06-13 22:57:13 +0000372 * Optional callback function to be called to write log to
373 * application specific device. This function will be called for
374 * log messages on input verbosity level.
375 */
Benny Prijonofe7d87b2007-11-29 11:35:44 +0000376 void (*cb)(int level, const char *data, int len);
Benny Prijonoeebe9af2006-06-13 22:57:13 +0000377
378
379} pjsua_logging_config;
380
381
382/**
383 * Use this function to initialize logging config.
384 *
385 * @param cfg The logging config to be initialized.
386 */
Benny Prijono1f61a8f2007-08-16 10:11:44 +0000387PJ_DECL(void) pjsua_logging_config_default(pjsua_logging_config *cfg);
Benny Prijonoeebe9af2006-06-13 22:57:13 +0000388
Benny Prijonoeebe9af2006-06-13 22:57:13 +0000389
390/**
391 * Use this function to duplicate logging config.
392 *
393 * @param pool Pool to use.
394 * @param dst Destination config.
395 * @param src Source config.
396 */
Benny Prijono1f61a8f2007-08-16 10:11:44 +0000397PJ_DECL(void) pjsua_logging_config_dup(pj_pool_t *pool,
398 pjsua_logging_config *dst,
399 const pjsua_logging_config *src);
Benny Prijonoeebe9af2006-06-13 22:57:13 +0000400
Benny Prijonodc39fe82006-05-26 12:17:46 +0000401
402/**
Benny Prijono4dd961b2009-10-26 11:21:37 +0000403 * Structure to be passed on MWI callback.
404 */
405typedef struct pjsua_mwi_info
406{
407 pjsip_evsub *evsub; /**< Event subscription session, for
408 reference. */
409 pjsip_rx_data *rdata; /**< The received NOTIFY request. */
410} pjsua_mwi_info;
411
412
413/**
Nanang Izzuddin4ea1bcc2010-09-28 04:57:01 +0000414 * Structure to be passed on registration callback.
415 */
416typedef struct pjsua_reg_info
417{
418 struct pjsip_regc_cbparam *cbparam; /**< Parameters returned by
419 registration callback. */
420} pjsua_reg_info;
421
422
423/**
Benny Prijonob5388cf2007-01-04 22:45:08 +0000424 * This structure describes application callback to receive various event
425 * notification from PJSUA-API. All of these callbacks are OPTIONAL,
426 * although definitely application would want to implement some of
427 * the important callbacks (such as \a on_incoming_call).
Benny Prijonodc39fe82006-05-26 12:17:46 +0000428 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +0000429typedef struct pjsua_callback
Benny Prijonodc39fe82006-05-26 12:17:46 +0000430{
431 /**
Benny Prijono9fc735d2006-05-28 14:58:12 +0000432 * Notify application when invite state has changed.
433 * Application may then query the call info to get the
Benny Prijonoe6ead542007-01-31 20:53:31 +0000434 * detail call states by calling pjsua_call_get_info() function.
Benny Prijono0875ae82006-12-26 00:11:48 +0000435 *
436 * @param call_id The call index.
437 * @param e Event which causes the call state to change.
Benny Prijonodc39fe82006-05-26 12:17:46 +0000438 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +0000439 void (*on_call_state)(pjsua_call_id call_id, pjsip_event *e);
Benny Prijonodc39fe82006-05-26 12:17:46 +0000440
441 /**
Benny Prijono8b1889b2006-06-06 18:40:40 +0000442 * Notify application on incoming call.
Benny Prijono0875ae82006-12-26 00:11:48 +0000443 *
444 * @param acc_id The account which match the incoming call.
445 * @param call_id The call id that has just been created for
446 * the call.
447 * @param rdata The incoming INVITE request.
Benny Prijono8b1889b2006-06-06 18:40:40 +0000448 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +0000449 void (*on_incoming_call)(pjsua_acc_id acc_id, pjsua_call_id call_id,
Benny Prijono8b1889b2006-06-06 18:40:40 +0000450 pjsip_rx_data *rdata);
451
452 /**
Benny Prijonofeb69f42007-10-05 09:12:26 +0000453 * This is a general notification callback which is called whenever
454 * a transaction within the call has changed state. Application can
455 * implement this callback for example to monitor the state of
456 * outgoing requests, or to answer unhandled incoming requests
457 * (such as INFO) with a final response.
458 *
459 * @param call_id Call identification.
460 * @param tsx The transaction which has changed state.
461 * @param e Transaction event that caused the state change.
462 */
463 void (*on_call_tsx_state)(pjsua_call_id call_id,
464 pjsip_transaction *tsx,
465 pjsip_event *e);
466
467 /**
Benny Prijonoeebe9af2006-06-13 22:57:13 +0000468 * Notify application when media state in the call has changed.
469 * Normal application would need to implement this callback, e.g.
Benny Prijono6ba8c542007-10-16 01:34:14 +0000470 * to connect the call's media to sound device. When ICE is used,
471 * this callback will also be called to report ICE negotiation
472 * failure.
Benny Prijono0875ae82006-12-26 00:11:48 +0000473 *
474 * @param call_id The call index.
Benny Prijonoeebe9af2006-06-13 22:57:13 +0000475 */
476 void (*on_call_media_state)(pjsua_call_id call_id);
477
Benny Prijonofc13bf62008-02-20 08:56:15 +0000478
479 /**
480 * Notify application when media session is created and before it is
481 * registered to the conference bridge. Application may return different
482 * media port if it has added media processing port to the stream. This
483 * media port then will be added to the conference bridge instead.
484 *
485 * @param call_id Call identification.
486 * @param sess Media session for the call.
487 * @param stream_idx Stream index in the media session.
488 * @param p_port On input, it specifies the media port of the
489 * stream. Application may modify this pointer to
490 * point to different media port to be registered
491 * to the conference bridge.
Benny Prijonofc13bf62008-02-20 08:56:15 +0000492 */
493 void (*on_stream_created)(pjsua_call_id call_id,
494 pjmedia_session *sess,
495 unsigned stream_idx,
496 pjmedia_port **p_port);
497
498 /**
499 * Notify application when media session has been unregistered from the
500 * conference bridge and about to be destroyed.
501 *
502 * @param call_id Call identification.
503 * @param sess Media session for the call.
504 * @param stream_idx Stream index in the media session.
Benny Prijonofc13bf62008-02-20 08:56:15 +0000505 */
506 void (*on_stream_destroyed)(pjsua_call_id call_id,
507 pjmedia_session *sess,
508 unsigned stream_idx);
509
Benny Prijonoeebe9af2006-06-13 22:57:13 +0000510 /**
Benny Prijono0875ae82006-12-26 00:11:48 +0000511 * Notify application upon incoming DTMF digits.
512 *
513 * @param call_id The call index.
514 * @param digit DTMF ASCII digit.
515 */
516 void (*on_dtmf_digit)(pjsua_call_id call_id, int digit);
517
518 /**
Benny Prijonob5388cf2007-01-04 22:45:08 +0000519 * Notify application on call being transfered (i.e. REFER is received).
Benny Prijono9fc735d2006-05-28 14:58:12 +0000520 * Application can decide to accept/reject transfer request
Benny Prijonoc54dcb32008-04-08 23:33:15 +0000521 * by setting the code (default is 202). When this callback
Benny Prijono9fc735d2006-05-28 14:58:12 +0000522 * is not defined, the default behavior is to accept the
523 * transfer.
Benny Prijono0875ae82006-12-26 00:11:48 +0000524 *
525 * @param call_id The call index.
526 * @param dst The destination where the call will be
527 * transfered to.
528 * @param code Status code to be returned for the call transfer
529 * request. On input, it contains status code 200.
Benny Prijono9fc735d2006-05-28 14:58:12 +0000530 */
Benny Prijono4ddad2c2006-10-18 17:16:34 +0000531 void (*on_call_transfer_request)(pjsua_call_id call_id,
532 const pj_str_t *dst,
533 pjsip_status_code *code);
534
535 /**
536 * Notify application of the status of previously sent call
537 * transfer request. Application can monitor the status of the
538 * call transfer request, for example to decide whether to
539 * terminate existing call.
540 *
541 * @param call_id Call ID.
Benny Prijonoe6ead542007-01-31 20:53:31 +0000542 * @param st_code Status progress of the transfer request.
543 * @param st_text Status progress text.
Benny Prijono4ddad2c2006-10-18 17:16:34 +0000544 * @param final If non-zero, no further notification will
Benny Prijonoe6ead542007-01-31 20:53:31 +0000545 * be reported. The st_code specified in
Benny Prijono4ddad2c2006-10-18 17:16:34 +0000546 * this callback is the final status.
547 * @param p_cont Initially will be set to non-zero, application
548 * can set this to FALSE if it no longer wants
549 * to receie further notification (for example,
550 * after it hangs up the call).
551 */
552 void (*on_call_transfer_status)(pjsua_call_id call_id,
Benny Prijonoe6ead542007-01-31 20:53:31 +0000553 int st_code,
554 const pj_str_t *st_text,
Benny Prijono4ddad2c2006-10-18 17:16:34 +0000555 pj_bool_t final,
556 pj_bool_t *p_cont);
Benny Prijono9fc735d2006-05-28 14:58:12 +0000557
558 /**
Benny Prijono053f5222006-11-11 16:16:04 +0000559 * Notify application about incoming INVITE with Replaces header.
560 * Application may reject the request by setting non-2xx code.
561 *
562 * @param call_id The call ID to be replaced.
563 * @param rdata The incoming INVITE request to replace the call.
564 * @param st_code Status code to be set by application. Application
565 * should only return a final status (200-699).
566 * @param st_text Optional status text to be set by application.
567 */
568 void (*on_call_replace_request)(pjsua_call_id call_id,
569 pjsip_rx_data *rdata,
570 int *st_code,
571 pj_str_t *st_text);
572
573 /**
574 * Notify application that an existing call has been replaced with
575 * a new call. This happens when PJSUA-API receives incoming INVITE
576 * request with Replaces header.
577 *
578 * After this callback is called, normally PJSUA-API will disconnect
579 * \a old_call_id and establish \a new_call_id.
580 *
581 * @param old_call_id Existing call which to be replaced with the
582 * new call.
583 * @param new_call_id The new call.
584 * @param rdata The incoming INVITE with Replaces request.
585 */
586 void (*on_call_replaced)(pjsua_call_id old_call_id,
587 pjsua_call_id new_call_id);
588
589
590 /**
Benny Prijono9fc735d2006-05-28 14:58:12 +0000591 * Notify application when registration status has changed.
592 * Application may then query the account info to get the
593 * registration details.
Benny Prijono0875ae82006-12-26 00:11:48 +0000594 *
Nanang Izzuddin4ea1bcc2010-09-28 04:57:01 +0000595 * @param acc_id The account ID.
Benny Prijonodc39fe82006-05-26 12:17:46 +0000596 */
Benny Prijono8b1889b2006-06-06 18:40:40 +0000597 void (*on_reg_state)(pjsua_acc_id acc_id);
Benny Prijonodc39fe82006-05-26 12:17:46 +0000598
599 /**
Nanang Izzuddin4ea1bcc2010-09-28 04:57:01 +0000600 * Notify application when registration status has changed.
601 * Application may inspect the registration info to get the
602 * registration status details.
603 *
604 * @param acc_id The account ID.
605 * @param info The registration info.
606 */
607 void (*on_reg_state2)(pjsua_acc_id acc_id, pjsua_reg_info *info);
608
609 /**
Benny Prijono63fba012008-07-17 14:19:10 +0000610 * Notification when incoming SUBSCRIBE request is received. Application
611 * may use this callback to authorize the incoming subscribe request
612 * (e.g. ask user permission if the request should be granted).
613 *
614 * If this callback is not implemented, all incoming presence subscription
615 * requests will be accepted.
616 *
617 * If this callback is implemented, application has several choices on
618 * what to do with the incoming request:
619 * - it may reject the request immediately by specifying non-200 class
620 * final response in the \a code argument.
621 * - it may immediately accept the request by specifying 200 as the
622 * \a code argument. This is the default value if application doesn't
623 * set any value to the \a code argument. In this case, the library
624 * will automatically send NOTIFY request upon returning from this
625 * callback.
626 * - it may delay the processing of the request, for example to request
627 * user permission whether to accept or reject the request. In this
628 * case, the application MUST set the \a code argument to 202, and
629 * later calls #pjsua_pres_notify() to accept or reject the
630 * subscription request.
631 *
632 * Any \a code other than 200 and 202 will be treated as 200.
633 *
634 * Application MUST return from this callback immediately (e.g. it must
635 * not block in this callback while waiting for user confirmation).
636 *
637 * @param srv_pres Server presence subscription instance. If
638 * application delays the acceptance of the request,
639 * it will need to specify this object when calling
640 * #pjsua_pres_notify().
641 * @param acc_id Account ID most appropriate for this request.
642 * @param buddy_id ID of the buddy matching the sender of the
643 * request, if any, or PJSUA_INVALID_ID if no
644 * matching buddy is found.
645 * @param from The From URI of the request.
646 * @param rdata The incoming request.
647 * @param code The status code to respond to the request. The
648 * default value is 200. Application may set this
649 * to other final status code to accept or reject
650 * the request.
651 * @param reason The reason phrase to respond to the request.
652 * @param msg_data If the application wants to send additional
653 * headers in the response, it can put it in this
654 * parameter.
655 */
656 void (*on_incoming_subscribe)(pjsua_acc_id acc_id,
657 pjsua_srv_pres *srv_pres,
658 pjsua_buddy_id buddy_id,
659 const pj_str_t *from,
660 pjsip_rx_data *rdata,
661 pjsip_status_code *code,
662 pj_str_t *reason,
663 pjsua_msg_data *msg_data);
664
665 /**
666 * Notification when server side subscription state has changed.
667 * This callback is optional as application normally does not need
668 * to do anything to maintain server side presence subscription.
669 *
670 * @param acc_id The account ID.
671 * @param srv_pres Server presence subscription object.
672 * @param remote_uri Remote URI string.
673 * @param state New subscription state.
674 * @param event PJSIP event that triggers the state change.
675 */
676 void (*on_srv_subscribe_state)(pjsua_acc_id acc_id,
677 pjsua_srv_pres *srv_pres,
678 const pj_str_t *remote_uri,
679 pjsip_evsub_state state,
680 pjsip_event *event);
681
682 /**
Benny Prijono9fc735d2006-05-28 14:58:12 +0000683 * Notify application when the buddy state has changed.
684 * Application may then query the buddy into to get the details.
Benny Prijono0875ae82006-12-26 00:11:48 +0000685 *
686 * @param buddy_id The buddy id.
Benny Prijono9fc735d2006-05-28 14:58:12 +0000687 */
Benny Prijono8b1889b2006-06-06 18:40:40 +0000688 void (*on_buddy_state)(pjsua_buddy_id buddy_id);
Benny Prijono9fc735d2006-05-28 14:58:12 +0000689
690 /**
691 * Notify application on incoming pager (i.e. MESSAGE request).
Benny Prijonoeebe9af2006-06-13 22:57:13 +0000692 * Argument call_id will be -1 if MESSAGE request is not related to an
Benny Prijonodc39fe82006-05-26 12:17:46 +0000693 * existing call.
Benny Prijono0875ae82006-12-26 00:11:48 +0000694 *
Benny Prijonobbeb3992007-05-21 13:48:35 +0000695 * See also \a on_pager2() callback for the version with \a pjsip_rx_data
696 * passed as one of the argument.
697 *
Benny Prijono0875ae82006-12-26 00:11:48 +0000698 * @param call_id Containts the ID of the call where the IM was
699 * sent, or PJSUA_INVALID_ID if the IM was sent
700 * outside call context.
701 * @param from URI of the sender.
702 * @param to URI of the destination message.
703 * @param contact The Contact URI of the sender, if present.
704 * @param mime_type MIME type of the message.
705 * @param body The message content.
Benny Prijonodc39fe82006-05-26 12:17:46 +0000706 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +0000707 void (*on_pager)(pjsua_call_id call_id, const pj_str_t *from,
708 const pj_str_t *to, const pj_str_t *contact,
709 const pj_str_t *mime_type, const pj_str_t *body);
710
711 /**
Benny Prijonobbeb3992007-05-21 13:48:35 +0000712 * This is the alternative version of the \a on_pager() callback with
713 * \a pjsip_rx_data argument.
714 *
715 * @param call_id Containts the ID of the call where the IM was
716 * sent, or PJSUA_INVALID_ID if the IM was sent
717 * outside call context.
718 * @param from URI of the sender.
719 * @param to URI of the destination message.
720 * @param contact The Contact URI of the sender, if present.
721 * @param mime_type MIME type of the message.
722 * @param body The message content.
723 * @param rdata The incoming MESSAGE request.
Benny Prijonoba736c42008-07-10 20:45:03 +0000724 * @param acc_id Account ID most suitable for this message.
Benny Prijonobbeb3992007-05-21 13:48:35 +0000725 */
726 void (*on_pager2)(pjsua_call_id call_id, const pj_str_t *from,
727 const pj_str_t *to, const pj_str_t *contact,
728 const pj_str_t *mime_type, const pj_str_t *body,
Benny Prijonoba736c42008-07-10 20:45:03 +0000729 pjsip_rx_data *rdata, pjsua_acc_id acc_id);
Benny Prijonobbeb3992007-05-21 13:48:35 +0000730
731 /**
Benny Prijonoeebe9af2006-06-13 22:57:13 +0000732 * Notify application about the delivery status of outgoing pager
Benny Prijono4da0b1d2007-06-11 18:22:54 +0000733 * request. See also on_pager_status2() callback for the version with
734 * \a pjsip_rx_data in the argument list.
Benny Prijonoeebe9af2006-06-13 22:57:13 +0000735 *
736 * @param call_id Containts the ID of the call where the IM was
737 * sent, or PJSUA_INVALID_ID if the IM was sent
738 * outside call context.
739 * @param to Destination URI.
740 * @param body Message body.
741 * @param user_data Arbitrary data that was specified when sending
742 * IM message.
743 * @param status Delivery status.
744 * @param reason Delivery status reason.
745 */
746 void (*on_pager_status)(pjsua_call_id call_id,
747 const pj_str_t *to,
748 const pj_str_t *body,
749 void *user_data,
750 pjsip_status_code status,
751 const pj_str_t *reason);
Benny Prijonodc39fe82006-05-26 12:17:46 +0000752
753 /**
Benny Prijono4da0b1d2007-06-11 18:22:54 +0000754 * Notify application about the delivery status of outgoing pager
755 * request.
756 *
757 * @param call_id Containts the ID of the call where the IM was
758 * sent, or PJSUA_INVALID_ID if the IM was sent
759 * outside call context.
760 * @param to Destination URI.
761 * @param body Message body.
762 * @param user_data Arbitrary data that was specified when sending
763 * IM message.
764 * @param status Delivery status.
765 * @param reason Delivery status reason.
Benny Prijono0a982002007-06-12 16:22:09 +0000766 * @param tdata The original MESSAGE request.
Benny Prijono4da0b1d2007-06-11 18:22:54 +0000767 * @param rdata The incoming MESSAGE response, or NULL if the
768 * message transaction fails because of time out
769 * or transport error.
Benny Prijonoba736c42008-07-10 20:45:03 +0000770 * @param acc_id Account ID from this the instant message was
771 * send.
Benny Prijono4da0b1d2007-06-11 18:22:54 +0000772 */
773 void (*on_pager_status2)(pjsua_call_id call_id,
774 const pj_str_t *to,
775 const pj_str_t *body,
776 void *user_data,
777 pjsip_status_code status,
778 const pj_str_t *reason,
Benny Prijono0a982002007-06-12 16:22:09 +0000779 pjsip_tx_data *tdata,
Benny Prijonoba736c42008-07-10 20:45:03 +0000780 pjsip_rx_data *rdata,
781 pjsua_acc_id acc_id);
Benny Prijono4da0b1d2007-06-11 18:22:54 +0000782
783 /**
Benny Prijono9fc735d2006-05-28 14:58:12 +0000784 * Notify application about typing indication.
Benny Prijono0875ae82006-12-26 00:11:48 +0000785 *
786 * @param call_id Containts the ID of the call where the IM was
787 * sent, or PJSUA_INVALID_ID if the IM was sent
788 * outside call context.
789 * @param from URI of the sender.
790 * @param to URI of the destination message.
791 * @param contact The Contact URI of the sender, if present.
792 * @param is_typing Non-zero if peer is typing, or zero if peer
793 * has stopped typing a message.
Benny Prijonodc39fe82006-05-26 12:17:46 +0000794 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +0000795 void (*on_typing)(pjsua_call_id call_id, const pj_str_t *from,
796 const pj_str_t *to, const pj_str_t *contact,
797 pj_bool_t is_typing);
Benny Prijonodc39fe82006-05-26 12:17:46 +0000798
Benny Prijono6ba8c542007-10-16 01:34:14 +0000799 /**
Benny Prijonoba736c42008-07-10 20:45:03 +0000800 * Notify application about typing indication.
801 *
802 * @param call_id Containts the ID of the call where the IM was
803 * sent, or PJSUA_INVALID_ID if the IM was sent
804 * outside call context.
805 * @param from URI of the sender.
806 * @param to URI of the destination message.
807 * @param contact The Contact URI of the sender, if present.
808 * @param is_typing Non-zero if peer is typing, or zero if peer
809 * has stopped typing a message.
810 * @param rdata The received request.
811 * @param acc_id Account ID most suitable for this message.
812 */
813 void (*on_typing2)(pjsua_call_id call_id, const pj_str_t *from,
814 const pj_str_t *to, const pj_str_t *contact,
815 pj_bool_t is_typing, pjsip_rx_data *rdata,
816 pjsua_acc_id acc_id);
817
818 /**
Benny Prijono6ba8c542007-10-16 01:34:14 +0000819 * Callback when the library has finished performing NAT type
820 * detection.
821 *
822 * @param res NAT detection result.
823 */
824 void (*on_nat_detect)(const pj_stun_nat_detect_result *res);
825
Benny Prijono5e51a4e2008-11-27 00:06:46 +0000826 /**
827 * This callback is called when the call is about to resend the
828 * INVITE request to the specified target, following the previously
829 * received redirection response.
830 *
831 * Application may accept the redirection to the specified target
832 * (the default behavior if this callback is implemented), reject
833 * this target only and make the session continue to try the next
834 * target in the list if such target exists, stop the whole
835 * redirection process altogether and cause the session to be
836 * disconnected, or defer the decision to ask for user confirmation.
837 *
838 * This callback is optional. If this callback is not implemented,
839 * the default behavior is to NOT follow the redirection response.
840 *
841 * @param call_id The call ID.
842 * @param target The current target to be tried.
Benny Prijono08a48b82008-11-27 12:42:07 +0000843 * @param e The event that caused this callback to be called.
844 * This could be the receipt of 3xx response, or
845 * 4xx/5xx response received for the INVITE sent to
846 * subsequent targets, or NULL if this callback is
847 * called from within #pjsua_call_process_redirect()
848 * context.
849 *
850 * @return Action to be performed for the target. Set this
Benny Prijono5e51a4e2008-11-27 00:06:46 +0000851 * parameter to one of the value below:
852 * - PJSIP_REDIRECT_ACCEPT: immediately accept the
853 * redirection (default value). When set, the
854 * call will immediately resend INVITE request
855 * to the target.
856 * - PJSIP_REDIRECT_REJECT: immediately reject this
857 * target. The call will continue retrying with
858 * next target if present, or disconnect the call
859 * if there is no more target to try.
860 * - PJSIP_REDIRECT_STOP: stop the whole redirection
861 * process and immediately disconnect the call. The
862 * on_call_state() callback will be called with
863 * PJSIP_INV_STATE_DISCONNECTED state immediately
864 * after this callback returns.
865 * - PJSIP_REDIRECT_PENDING: set to this value if
866 * no decision can be made immediately (for example
867 * to request confirmation from user). Application
868 * then MUST call #pjsua_call_process_redirect()
869 * to either accept or reject the redirection upon
870 * getting user decision.
Benny Prijono5e51a4e2008-11-27 00:06:46 +0000871 */
Benny Prijono08a48b82008-11-27 12:42:07 +0000872 pjsip_redirect_op (*on_call_redirected)(pjsua_call_id call_id,
873 const pjsip_uri *target,
874 const pjsip_event *e);
Benny Prijono5e51a4e2008-11-27 00:06:46 +0000875
Benny Prijono4dd961b2009-10-26 11:21:37 +0000876 /**
877 * This callback is called when a NOTIFY request for message summary /
878 * message waiting indication is received.
879 *
880 * @param acc_id The account ID.
881 * @param mwi_info Structure containing details of the event,
882 * including the received NOTIFY request in the
883 * \a rdata field.
884 */
885 void (*on_mwi_info)(pjsua_acc_id acc_id, pjsua_mwi_info *mwi_info);
886
Nanang Izzuddin2fb937e2010-02-24 05:43:34 +0000887 /**
888 * This callback is called when transport state is changed. See also
889 * #pjsip_tp_state_callback.
Nanang Izzuddin2fb937e2010-02-24 05:43:34 +0000890 */
Nanang Izzuddin5e69da52010-02-25 11:58:19 +0000891 pjsip_tp_state_callback on_transport_state;
Nanang Izzuddin2fb937e2010-02-24 05:43:34 +0000892
Benny Prijono4d6ff4d2010-06-19 12:35:33 +0000893 /**
894 * This callback is called to report error in ICE media transport.
895 * Currently it is used to report TURN Refresh error.
896 *
897 * @param index Transport index.
898 * @param op Operation which trigger the failure.
899 * @param status Error status.
900 * @param param Additional info about the event. Currently this will
901 * always be set to NULL.
902 */
903 void (*on_ice_transport_error)(int index, pj_ice_strans_op op,
904 pj_status_t status, void *param);
905
Benny Prijonoeebe9af2006-06-13 22:57:13 +0000906} pjsua_callback;
907
908
Nanang Izzuddin742ef4b2010-09-07 09:36:15 +0000909/**
910 * This enumeration specifies the usage of SIP Session Timers extension.
911 */
912typedef enum pjsua_sip_timer_use
913{
914 /**
915 * When this flag is specified, Session Timers will not be used in any
916 * session, except it is explicitly required in the remote request.
917 */
918 PJSUA_SIP_TIMER_INACTIVE,
919
920 /**
921 * When this flag is specified, Session Timers will be used in all
922 * sessions whenever remote supports and uses it.
923 */
924 PJSUA_SIP_TIMER_OPTIONAL,
925
926 /**
927 * When this flag is specified, Session Timers support will be
928 * a requirement for the remote to be able to establish a session.
929 */
930 PJSUA_SIP_TIMER_REQUIRED,
931
932 /**
933 * When this flag is specified, Session Timers will always be used
934 * in all sessions, regardless whether remote supports/uses it or not.
935 */
936 PJSUA_SIP_TIMER_ALWAYS
937
938} pjsua_sip_timer_use;
Benny Prijonoeebe9af2006-06-13 22:57:13 +0000939
Benny Prijonodc39fe82006-05-26 12:17:46 +0000940
941/**
Benny Prijonob5388cf2007-01-04 22:45:08 +0000942 * This structure describes the settings to control the API and
943 * user agent behavior, and can be specified when calling #pjsua_init().
944 * Before setting the values, application must call #pjsua_config_default()
945 * to initialize this structure with the default values.
Benny Prijonodc39fe82006-05-26 12:17:46 +0000946 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +0000947typedef struct pjsua_config
948{
949
950 /**
Benny Prijonob5388cf2007-01-04 22:45:08 +0000951 * Maximum calls to support (default: 4). The value specified here
952 * must be smaller than the compile time maximum settings
953 * PJSUA_MAX_CALLS, which by default is 32. To increase this
954 * limit, the library must be recompiled with new PJSUA_MAX_CALLS
955 * value.
Benny Prijonoeebe9af2006-06-13 22:57:13 +0000956 */
957 unsigned max_calls;
958
959 /**
960 * Number of worker threads. Normally application will want to have at
961 * least one worker thread, unless when it wants to poll the library
962 * periodically, which in this case the worker thread can be set to
963 * zero.
964 */
965 unsigned thread_cnt;
966
967 /**
Benny Prijonofa9e5b12006-10-08 12:39:34 +0000968 * Number of nameservers. If no name server is configured, the SIP SRV
969 * resolution would be disabled, and domain will be resolved with
970 * standard pj_gethostbyname() function.
971 */
972 unsigned nameserver_count;
973
974 /**
975 * Array of nameservers to be used by the SIP resolver subsystem.
976 * The order of the name server specifies the priority (first name
977 * server will be used first, unless it is not reachable).
978 */
979 pj_str_t nameserver[4];
980
981 /**
Benny Prijono91d06b62008-09-20 12:16:56 +0000982 * Force loose-route to be used in all route/proxy URIs (outbound_proxy
983 * and account's proxy settings). When this setting is enabled, the
984 * library will check all the route/proxy URIs specified in the settings
985 * and append ";lr" parameter to the URI if the parameter is not present.
986 *
987 * Default: 1
988 */
989 pj_bool_t force_lr;
990
991 /**
Benny Prijonob5388cf2007-01-04 22:45:08 +0000992 * Number of outbound proxies in the \a outbound_proxy array.
Benny Prijonoeebe9af2006-06-13 22:57:13 +0000993 */
994 unsigned outbound_proxy_cnt;
995
996 /**
997 * Specify the URL of outbound proxies to visit for all outgoing requests.
998 * The outbound proxies will be used for all accounts, and it will
999 * be used to build the route set for outgoing requests. The final
1000 * route set for outgoing requests will consists of the outbound proxies
1001 * and the proxy configured in the account.
1002 */
1003 pj_str_t outbound_proxy[4];
1004
Benny Prijonoc97608e2007-03-23 16:34:20 +00001005 /**
Benny Prijonobb995fd2009-08-12 11:03:23 +00001006 * Warning: deprecated, please use \a stun_srv field instead. To maintain
1007 * backward compatibility, if \a stun_srv_cnt is zero then the value of
1008 * this field will be copied to \a stun_srv field, if present.
1009 *
Benny Prijonoebbf6892007-03-24 17:37:25 +00001010 * Specify domain name to be resolved with DNS SRV resolution to get the
Benny Prijonof76e1392008-06-06 14:51:48 +00001011 * address of the STUN server. Alternatively application may specify
1012 * \a stun_host instead.
Benny Prijonoebbf6892007-03-24 17:37:25 +00001013 *
1014 * If DNS SRV resolution failed for this domain, then DNS A resolution
1015 * will be performed only if \a stun_host is specified.
Benny Prijonoc97608e2007-03-23 16:34:20 +00001016 */
Benny Prijonoebbf6892007-03-24 17:37:25 +00001017 pj_str_t stun_domain;
1018
1019 /**
Benny Prijonobb995fd2009-08-12 11:03:23 +00001020 * Warning: deprecated, please use \a stun_srv field instead. To maintain
1021 * backward compatibility, if \a stun_srv_cnt is zero then the value of
1022 * this field will be copied to \a stun_srv field, if present.
1023 *
Benny Prijonoaf09dc32007-04-22 12:48:30 +00001024 * Specify STUN server to be used, in "HOST[:PORT]" format. If port is
1025 * not specified, default port 3478 will be used.
Benny Prijonoebbf6892007-03-24 17:37:25 +00001026 */
1027 pj_str_t stun_host;
1028
1029 /**
Benny Prijonobb995fd2009-08-12 11:03:23 +00001030 * Number of STUN server entries in \a stun_srv array.
1031 */
1032 unsigned stun_srv_cnt;
1033
1034 /**
1035 * Array of STUN servers to try. The library will try to resolve and
1036 * contact each of the STUN server entry until it finds one that is
1037 * usable. Each entry may be a domain name, host name, IP address, and
1038 * it may contain an optional port number. For example:
1039 * - "pjsip.org" (domain name)
1040 * - "sip.pjsip.org" (host name)
1041 * - "pjsip.org:33478" (domain name and a non-standard port number)
1042 * - "10.0.0.1:3478" (IP address and port number)
1043 *
1044 * When nameserver is configured in the \a pjsua_config.nameserver field,
1045 * if entry is not an IP address, it will be resolved with DNS SRV
1046 * resolution first, and it will fallback to use DNS A resolution if this
1047 * fails. Port number may be specified even if the entry is a domain name,
1048 * in case the DNS SRV resolution should fallback to a non-standard port.
1049 *
1050 * When nameserver is not configured, entries will be resolved with
1051 * #pj_gethostbyname() if it's not an IP address. Port number may be
1052 * specified if the server is not listening in standard STUN port.
1053 */
1054 pj_str_t stun_srv[8];
1055
1056 /**
1057 * This specifies if the library startup should ignore failure with the
1058 * STUN servers. If this is set to PJ_FALSE, the library will refuse to
1059 * start if it fails to resolve or contact any of the STUN servers.
1060 *
1061 * Default: PJ_TRUE
1062 */
1063 pj_bool_t stun_ignore_failure;
1064
1065 /**
Benny Prijono91a6a172007-10-31 08:59:29 +00001066 * Support for adding and parsing NAT type in the SDP to assist
1067 * troubleshooting. The valid values are:
1068 * - 0: no information will be added in SDP, and parsing is disabled.
Benny Prijono6ba8c542007-10-16 01:34:14 +00001069 * - 1: only the NAT type number is added.
1070 * - 2: add both NAT type number and name.
1071 *
Benny Prijono91a6a172007-10-31 08:59:29 +00001072 * Default: 1
Benny Prijono6ba8c542007-10-16 01:34:14 +00001073 */
1074 int nat_type_in_sdp;
1075
1076 /**
Benny Prijonodcfc0ba2007-09-30 16:50:27 +00001077 * Specify whether support for reliable provisional response (100rel and
1078 * PRACK) should be required by default. Note that this setting can be
1079 * further customized in account configuration (#pjsua_acc_config).
1080 *
1081 * Default: PJ_FALSE
1082 */
1083 pj_bool_t require_100rel;
1084
Nanang Izzuddin59dffb12009-08-11 12:42:38 +00001085 /**
Nanang Izzuddin742ef4b2010-09-07 09:36:15 +00001086 * Specify the usage of Session Timers for all sessions. See the
1087 * #pjsua_sip_timer_use for possible values. Note that this setting can be
1088 * further customized in account configuration (#pjsua_acc_config).
Nanang Izzuddin59dffb12009-08-11 12:42:38 +00001089 *
Nanang Izzuddin742ef4b2010-09-07 09:36:15 +00001090 * Default: PJSUA_SIP_TIMER_OPTIONAL
Nanang Izzuddin59dffb12009-08-11 12:42:38 +00001091 */
Nanang Izzuddin742ef4b2010-09-07 09:36:15 +00001092 pjsua_sip_timer_use use_timer;
Nanang Izzuddin59dffb12009-08-11 12:42:38 +00001093
1094 /**
Benny Prijonofe1bd342009-11-20 23:33:07 +00001095 * Handle unsolicited NOTIFY requests containing message waiting
1096 * indication (MWI) info. Unsolicited MWI is incoming NOTIFY requests
1097 * which are not requested by client with SUBSCRIBE request.
1098 *
1099 * If this is enabled, the library will respond 200/OK to the NOTIFY
1100 * request and forward the request to \a on_mwi_info() callback.
1101 *
1102 * See also \a mwi_enabled field #on pjsua_acc_config.
1103 *
1104 * Default: PJ_TRUE
1105 *
1106 */
1107 pj_bool_t enable_unsolicited_mwi;
1108
1109 /**
Nanang Izzuddin65add622009-08-11 16:26:20 +00001110 * Specify Session Timer settings, see #pjsip_timer_setting.
Nanang Izzuddin59dffb12009-08-11 12:42:38 +00001111 * Note that this setting can be further customized in account
1112 * configuration (#pjsua_acc_config).
Nanang Izzuddin59dffb12009-08-11 12:42:38 +00001113 */
Nanang Izzuddin65add622009-08-11 16:26:20 +00001114 pjsip_timer_setting timer_setting;
Nanang Izzuddin59dffb12009-08-11 12:42:38 +00001115
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001116 /**
1117 * Number of credentials in the credential array.
1118 */
1119 unsigned cred_count;
1120
1121 /**
1122 * Array of credentials. These credentials will be used by all accounts,
Benny Prijonob5388cf2007-01-04 22:45:08 +00001123 * and can be used to authenticate against outbound proxies. If the
1124 * credential is specific to the account, then application should set
1125 * the credential in the pjsua_acc_config rather than the credential
1126 * here.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001127 */
1128 pjsip_cred_info cred_info[PJSUA_ACC_MAX_PROXIES];
1129
1130 /**
Benny Prijonob5388cf2007-01-04 22:45:08 +00001131 * Application callback to receive various event notifications from
1132 * the library.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001133 */
1134 pjsua_callback cb;
1135
Benny Prijono56315612006-07-18 14:39:40 +00001136 /**
Benny Prijonob5388cf2007-01-04 22:45:08 +00001137 * Optional user agent string (default empty). If it's empty, no
1138 * User-Agent header will be sent with outgoing requests.
Benny Prijono56315612006-07-18 14:39:40 +00001139 */
1140 pj_str_t user_agent;
1141
Benny Prijonod8179652008-01-23 20:39:07 +00001142#if defined(PJMEDIA_HAS_SRTP) && (PJMEDIA_HAS_SRTP != 0)
1143 /**
1144 * Specify default value of secure media transport usage.
1145 * Valid values are PJMEDIA_SRTP_DISABLED, PJMEDIA_SRTP_OPTIONAL, and
1146 * PJMEDIA_SRTP_MANDATORY.
1147 *
1148 * Note that this setting can be further customized in account
1149 * configuration (#pjsua_acc_config).
1150 *
1151 * Default: #PJSUA_DEFAULT_USE_SRTP
1152 */
1153 pjmedia_srtp_use use_srtp;
1154
1155 /**
1156 * Specify whether SRTP requires secure signaling to be used. This option
1157 * is only used when \a use_srtp option above is non-zero.
1158 *
1159 * Valid values are:
1160 * 0: SRTP does not require secure signaling
1161 * 1: SRTP requires secure transport such as TLS
1162 * 2: SRTP requires secure end-to-end transport (SIPS)
1163 *
1164 * Note that this setting can be further customized in account
1165 * configuration (#pjsua_acc_config).
1166 *
1167 * Default: #PJSUA_DEFAULT_SRTP_SECURE_SIGNALING
1168 */
1169 int srtp_secure_signaling;
Nanang Izzuddind89cc3a2010-05-13 05:22:51 +00001170
1171 /**
1172 * Specify whether SRTP in PJMEDIA_SRTP_OPTIONAL mode should compose
1173 * duplicated media in SDP offer, i.e: unsecured and secured version.
1174 * Otherwise, the SDP media will be composed as unsecured media but
1175 * with SDP "crypto" attribute.
1176 *
1177 * Default: PJ_FALSE
1178 */
1179 pj_bool_t srtp_optional_dup_offer;
Benny Prijonod8179652008-01-23 20:39:07 +00001180#endif
1181
Benny Prijono3c5e28b2008-09-24 10:10:15 +00001182 /**
1183 * Disconnect other call legs when more than one 2xx responses for
1184 * outgoing INVITE are received due to forking. Currently the library
1185 * is not able to handle simultaneous forked media, so disconnecting
1186 * the other call legs is necessary.
1187 *
1188 * With this setting enabled, the library will handle only one of the
1189 * connected call leg, and the other connected call legs will be
1190 * disconnected.
1191 *
1192 * Default: PJ_TRUE (only disable this setting for testing purposes).
1193 */
1194 pj_bool_t hangup_forked_call;
1195
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001196} pjsua_config;
1197
1198
1199/**
1200 * Use this function to initialize pjsua config.
1201 *
1202 * @param cfg pjsua config to be initialized.
1203 */
Benny Prijono1f61a8f2007-08-16 10:11:44 +00001204PJ_DECL(void) pjsua_config_default(pjsua_config *cfg);
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001205
1206
Benny Prijonoa7b376b2008-01-25 16:06:33 +00001207/** The implementation has been moved to sip_auth.h */
Benny Prijono7977f9f2007-10-10 11:37:56 +00001208#define pjsip_cred_dup pjsip_cred_info_dup
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001209
1210
1211/**
1212 * Duplicate pjsua_config.
Benny Prijonoe6ead542007-01-31 20:53:31 +00001213 *
1214 * @param pool The pool to get memory from.
1215 * @param dst Destination config.
1216 * @param src Source config.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001217 */
Benny Prijono1f61a8f2007-08-16 10:11:44 +00001218PJ_DECL(void) pjsua_config_dup(pj_pool_t *pool,
1219 pjsua_config *dst,
1220 const pjsua_config *src);
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001221
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001222
1223/**
1224 * This structure describes additional information to be sent with
Benny Prijonob5388cf2007-01-04 22:45:08 +00001225 * outgoing SIP message. It can (optionally) be specified for example
1226 * with #pjsua_call_make_call(), #pjsua_call_answer(), #pjsua_call_hangup(),
1227 * #pjsua_call_set_hold(), #pjsua_call_send_im(), and many more.
1228 *
1229 * Application MUST call #pjsua_msg_data_init() to initialize this
1230 * structure before setting its values.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001231 */
Benny Prijono63fba012008-07-17 14:19:10 +00001232struct pjsua_msg_data
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001233{
1234 /**
Benny Prijonoc92ca5c2007-06-11 17:03:41 +00001235 * Additional message headers as linked list. Application can add
1236 * headers to the list by creating the header, either from the heap/pool
1237 * or from temporary local variable, and add the header using
1238 * linked list operation. See pjsip_apps.c for some sample codes.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001239 */
1240 pjsip_hdr hdr_list;
1241
1242 /**
1243 * MIME type of optional message body.
1244 */
1245 pj_str_t content_type;
1246
1247 /**
Benny Prijono1c1d7342010-08-01 09:48:51 +00001248 * Optional message body to be added to the message, only when the
1249 * message doesn't have a body.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001250 */
1251 pj_str_t msg_body;
1252
Benny Prijono1c1d7342010-08-01 09:48:51 +00001253 /**
1254 * Content type of the multipart body. If application wants to send
1255 * multipart message bodies, it puts the parts in \a parts and set
1256 * the content type in \a multipart_ctype. If the message already
1257 * contains a body, the body will be added to the multipart bodies.
1258 */
1259 pjsip_media_type multipart_ctype;
1260
1261 /**
1262 * List of multipart parts. If application wants to send multipart
1263 * message bodies, it puts the parts in \a parts and set the content
1264 * type in \a multipart_ctype. If the message already contains a body,
1265 * the body will be added to the multipart bodies.
1266 */
1267 pjsip_multipart_part multipart_parts;
Benny Prijono63fba012008-07-17 14:19:10 +00001268};
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001269
1270
1271/**
1272 * Initialize message data.
1273 *
1274 * @param msg_data Message data to be initialized.
1275 */
Benny Prijono1f61a8f2007-08-16 10:11:44 +00001276PJ_DECL(void) pjsua_msg_data_init(pjsua_msg_data *msg_data);
Benny Prijono268ca612006-02-07 12:34:11 +00001277
Benny Prijono268ca612006-02-07 12:34:11 +00001278
1279/**
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001280 * Instantiate pjsua application. Application must call this function before
1281 * calling any other functions, to make sure that the underlying libraries
1282 * are properly initialized. Once this function has returned success,
1283 * application must call pjsua_destroy() before quitting.
1284 *
1285 * @return PJ_SUCCESS on success, or the appropriate error code.
Benny Prijonodc39fe82006-05-26 12:17:46 +00001286 */
1287PJ_DECL(pj_status_t) pjsua_create(void);
1288
1289
Benny Prijonoa7b376b2008-01-25 16:06:33 +00001290/** Forward declaration */
Benny Prijonoe6ead542007-01-31 20:53:31 +00001291typedef struct pjsua_media_config pjsua_media_config;
1292
1293
Benny Prijonodc39fe82006-05-26 12:17:46 +00001294/**
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001295 * Initialize pjsua with the specified settings. All the settings are
1296 * optional, and the default values will be used when the config is not
1297 * specified.
Benny Prijonoccf95622006-02-07 18:48:01 +00001298 *
Benny Prijonob5388cf2007-01-04 22:45:08 +00001299 * Note that #pjsua_create() MUST be called before calling this function.
1300 *
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001301 * @param ua_cfg User agent configuration.
1302 * @param log_cfg Optional logging configuration.
1303 * @param media_cfg Optional media configuration.
Benny Prijonoccf95622006-02-07 18:48:01 +00001304 *
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001305 * @return PJ_SUCCESS on success, or the appropriate error code.
Benny Prijono268ca612006-02-07 12:34:11 +00001306 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001307PJ_DECL(pj_status_t) pjsua_init(const pjsua_config *ua_cfg,
1308 const pjsua_logging_config *log_cfg,
1309 const pjsua_media_config *media_cfg);
Benny Prijono268ca612006-02-07 12:34:11 +00001310
1311
1312/**
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001313 * Application is recommended to call this function after all initialization
1314 * is done, so that the library can do additional checking set up
1315 * additional
Benny Prijonoccf95622006-02-07 18:48:01 +00001316 *
Benny Prijonob5388cf2007-01-04 22:45:08 +00001317 * Application may call this function anytime after #pjsua_init().
1318 *
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001319 * @return PJ_SUCCESS on success, or the appropriate error code.
Benny Prijonoccf95622006-02-07 18:48:01 +00001320 */
Benny Prijonodc39fe82006-05-26 12:17:46 +00001321PJ_DECL(pj_status_t) pjsua_start(void);
Benny Prijonoccf95622006-02-07 18:48:01 +00001322
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001323
Benny Prijonoccf95622006-02-07 18:48:01 +00001324/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00001325 * Destroy pjsua. Application is recommended to perform graceful shutdown
1326 * before calling this function (such as unregister the account from the SIP
1327 * server, terminate presense subscription, and hangup active calls), however,
1328 * this function will do all of these if it finds there are active sessions
1329 * that need to be terminated. This function will approximately block for
1330 * one second to wait for replies from remote.
1331 *
1332 * Application.may safely call this function more than once if it doesn't
1333 * keep track of it's state.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001334 *
1335 * @return PJ_SUCCESS on success, or the appropriate error code.
Benny Prijono268ca612006-02-07 12:34:11 +00001336 */
Benny Prijonodc39fe82006-05-26 12:17:46 +00001337PJ_DECL(pj_status_t) pjsua_destroy(void);
Benny Prijonoa91a0032006-02-26 21:23:45 +00001338
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001339
Benny Prijono9fc735d2006-05-28 14:58:12 +00001340/**
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001341 * Poll pjsua for events, and if necessary block the caller thread for
1342 * the specified maximum interval (in miliseconds).
1343 *
Benny Prijonob5388cf2007-01-04 22:45:08 +00001344 * Application doesn't normally need to call this function if it has
1345 * configured worker thread (\a thread_cnt field) in pjsua_config structure,
1346 * because polling then will be done by these worker threads instead.
1347 *
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001348 * @param msec_timeout Maximum time to wait, in miliseconds.
1349 *
1350 * @return The number of events that have been handled during the
1351 * poll. Negative value indicates error, and application
Benny Prijonoe6ead542007-01-31 20:53:31 +00001352 * can retrieve the error as (status = -return_value).
Benny Prijonob9b32ab2006-06-01 12:28:44 +00001353 */
1354PJ_DECL(int) pjsua_handle_events(unsigned msec_timeout);
1355
1356
1357/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00001358 * Create memory pool to be used by the application. Once application
1359 * finished using the pool, it must be released with pj_pool_release().
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001360 *
1361 * @param name Optional pool name.
Benny Prijono312aff92006-06-17 04:08:30 +00001362 * @param init_size Initial size of the pool.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001363 * @param increment Increment size.
1364 *
1365 * @return The pool, or NULL when there's no memory.
1366 */
1367PJ_DECL(pj_pool_t*) pjsua_pool_create(const char *name, pj_size_t init_size,
1368 pj_size_t increment);
1369
1370
1371/**
1372 * Application can call this function at any time (after pjsua_create(), of
1373 * course) to change logging settings.
1374 *
1375 * @param c Logging configuration.
1376 *
1377 * @return PJ_SUCCESS on success, or the appropriate error code.
1378 */
1379PJ_DECL(pj_status_t) pjsua_reconfigure_logging(const pjsua_logging_config *c);
1380
1381
1382/**
1383 * Internal function to get SIP endpoint instance of pjsua, which is
1384 * needed for example to register module, create transports, etc.
Benny Prijonob5388cf2007-01-04 22:45:08 +00001385 * Only valid after #pjsua_init() is called.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001386 *
1387 * @return SIP endpoint instance.
Benny Prijono9fc735d2006-05-28 14:58:12 +00001388 */
1389PJ_DECL(pjsip_endpoint*) pjsua_get_pjsip_endpt(void);
1390
1391/**
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001392 * Internal function to get media endpoint instance.
1393 * Only valid after #pjsua_init() is called.
1394 *
1395 * @return Media endpoint instance.
Benny Prijono9fc735d2006-05-28 14:58:12 +00001396 */
1397PJ_DECL(pjmedia_endpt*) pjsua_get_pjmedia_endpt(void);
1398
Benny Prijono97b87172006-08-24 14:25:14 +00001399/**
1400 * Internal function to get PJSUA pool factory.
Benny Prijonob5388cf2007-01-04 22:45:08 +00001401 * Only valid after #pjsua_create() is called.
Benny Prijono97b87172006-08-24 14:25:14 +00001402 *
1403 * @return Pool factory currently used by PJSUA.
1404 */
1405PJ_DECL(pj_pool_factory*) pjsua_get_pool_factory(void);
1406
1407
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001408
1409/*****************************************************************************
Benny Prijono312aff92006-06-17 04:08:30 +00001410 * Utilities.
1411 *
Benny Prijono9fc735d2006-05-28 14:58:12 +00001412 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001413
1414/**
Benny Prijonobb995fd2009-08-12 11:03:23 +00001415 * This structure is used to represent the result of the STUN server
1416 * resolution and testing, the #pjsua_resolve_stun_servers() function.
1417 * This structure will be passed in #pj_stun_resolve_cb callback.
1418 */
1419typedef struct pj_stun_resolve_result
1420{
1421 /**
1422 * Arbitrary data that was passed to #pjsua_resolve_stun_servers()
1423 * function.
1424 */
1425 void *token;
1426
1427 /**
1428 * This will contain PJ_SUCCESS if at least one usable STUN server
1429 * is found, otherwise it will contain the last error code during
1430 * the operation.
1431 */
1432 pj_status_t status;
1433
1434 /**
1435 * The server name that yields successful result. This will only
1436 * contain value if status is successful.
1437 */
1438 pj_str_t name;
1439
1440 /**
1441 * The server IP address. This will only contain value if status
1442 * is successful.
1443 */
1444 pj_sockaddr addr;
1445
1446} pj_stun_resolve_result;
1447
1448
1449/**
1450 * Typedef of callback to be registered to #pjsua_resolve_stun_servers().
1451 */
1452typedef void (*pj_stun_resolve_cb)(const pj_stun_resolve_result *result);
1453
1454/**
Benny Prijono4ab9fbb2007-10-12 12:14:27 +00001455 * This is a utility function to detect NAT type in front of this
1456 * endpoint. Once invoked successfully, this function will complete
Benny Prijono6ba8c542007-10-16 01:34:14 +00001457 * asynchronously and report the result in \a on_nat_detect() callback
1458 * of pjsua_callback.
Benny Prijono4ab9fbb2007-10-12 12:14:27 +00001459 *
Benny Prijono6ba8c542007-10-16 01:34:14 +00001460 * After NAT has been detected and the callback is called, application can
1461 * get the detected NAT type by calling #pjsua_get_nat_type(). Application
1462 * can also perform NAT detection by calling #pjsua_detect_nat_type()
1463 * again at later time.
Benny Prijono4ab9fbb2007-10-12 12:14:27 +00001464 *
Benny Prijono6ba8c542007-10-16 01:34:14 +00001465 * Note that STUN must be enabled to run this function successfully.
1466 *
1467 * @return PJ_SUCCESS on success, or the appropriate error code.
Benny Prijono4ab9fbb2007-10-12 12:14:27 +00001468 */
Benny Prijono6ba8c542007-10-16 01:34:14 +00001469PJ_DECL(pj_status_t) pjsua_detect_nat_type(void);
1470
1471
1472/**
1473 * Get the NAT type as detected by #pjsua_detect_nat_type() function.
1474 * This function will only return useful NAT type after #pjsua_detect_nat_type()
1475 * has completed successfully and \a on_nat_detect() callback has been called.
1476 *
1477 * @param type NAT type.
1478 *
1479 * @return When detection is in progress, this function will
1480 * return PJ_EPENDING and \a type will be set to
1481 * PJ_STUN_NAT_TYPE_UNKNOWN. After NAT type has been
1482 * detected successfully, this function will return
1483 * PJ_SUCCESS and \a type will be set to the correct
1484 * value. Other return values indicate error and
1485 * \a type will be set to PJ_STUN_NAT_TYPE_ERR_UNKNOWN.
Benny Prijono91a6a172007-10-31 08:59:29 +00001486 *
1487 * @see pjsua_call_get_rem_nat_type()
Benny Prijono6ba8c542007-10-16 01:34:14 +00001488 */
1489PJ_DECL(pj_status_t) pjsua_get_nat_type(pj_stun_nat_type *type);
Benny Prijono4ab9fbb2007-10-12 12:14:27 +00001490
1491
1492/**
Benny Prijonobb995fd2009-08-12 11:03:23 +00001493 * Auxiliary function to resolve and contact each of the STUN server
1494 * entries (sequentially) to find which is usable. The #pjsua_init() must
1495 * have been called before calling this function.
1496 *
1497 * @param count Number of STUN server entries to try.
1498 * @param srv Array of STUN server entries to try. Please see
1499 * the \a stun_srv field in the #pjsua_config
1500 * documentation about the format of this entry.
1501 * @param wait Specify non-zero to make the function block until
1502 * it gets the result. In this case, the function
1503 * will block while the resolution is being done,
1504 * and the callback will be called before this function
1505 * returns.
1506 * @param token Arbitrary token to be passed back to application
1507 * in the callback.
1508 * @param cb Callback to be called to notify the result of
1509 * the function.
1510 *
1511 * @return If \a wait parameter is non-zero, this will return
1512 * PJ_SUCCESS if one usable STUN server is found.
1513 * Otherwise it will always return PJ_SUCCESS, and
1514 * application will be notified about the result in
1515 * the callback.
1516 */
1517PJ_DECL(pj_status_t) pjsua_resolve_stun_servers(unsigned count,
1518 pj_str_t srv[],
1519 pj_bool_t wait,
1520 void *token,
1521 pj_stun_resolve_cb cb);
1522
1523/**
1524 * Cancel pending STUN resolution which match the specified token.
1525 *
1526 * @param token The token to match. This token was given to
1527 * #pjsua_resolve_stun_servers()
1528 * @param notify_cb Boolean to control whether the callback should
1529 * be called for cancelled resolutions. When the
1530 * callback is called, the status in the result
1531 * will be set as PJ_ECANCELLED.
1532 *
1533 * @return PJ_SUCCESS if there is at least one pending STUN
1534 * resolution cancelled, or PJ_ENOTFOUND if there is
1535 * no matching one, or other error.
1536 */
1537PJ_DECL(pj_status_t) pjsua_cancel_stun_resolution(void *token,
1538 pj_bool_t notify_cb);
1539
1540
1541/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00001542 * This is a utility function to verify that valid SIP url is given. If the
Benny Prijonoc7545782010-09-28 07:43:18 +00001543 * URL is a valid SIP/SIPS scheme, PJ_SUCCESS will be returned.
Benny Prijono312aff92006-06-17 04:08:30 +00001544 *
Benny Prijonoe6ead542007-01-31 20:53:31 +00001545 * @param url The URL, as NULL terminated string.
Benny Prijono312aff92006-06-17 04:08:30 +00001546 *
1547 * @return PJ_SUCCESS on success, or the appropriate error code.
Benny Prijonoc7545782010-09-28 07:43:18 +00001548 *
1549 * @see pjsua_verify_url()
Benny Prijono312aff92006-06-17 04:08:30 +00001550 */
Benny Prijonoe6ead542007-01-31 20:53:31 +00001551PJ_DECL(pj_status_t) pjsua_verify_sip_url(const char *url);
Benny Prijono312aff92006-06-17 04:08:30 +00001552
1553
1554/**
Benny Prijonoc7545782010-09-28 07:43:18 +00001555 * This is a utility function to verify that valid URI is given. Unlike
1556 * pjsua_verify_sip_url(), this function will return PJ_SUCCESS if tel: URI
1557 * is given.
1558 *
1559 * @param url The URL, as NULL terminated string.
1560 *
1561 * @return PJ_SUCCESS on success, or the appropriate error code.
1562 *
1563 * @see pjsua_verify_sip_url()
1564 */
1565PJ_DECL(pj_status_t) pjsua_verify_url(const char *url);
1566
1567
1568/**
Benny Prijono73bb7232009-10-20 13:56:26 +00001569 * Schedule a timer entry. Note that the timer callback may be executed
1570 * by different thread, depending on whether worker thread is enabled or
1571 * not.
1572 *
1573 * @param entry Timer heap entry.
1574 * @param delay The interval to expire.
1575 *
1576 * @return PJ_SUCCESS on success, or the appropriate error code.
1577 *
1578 * @see pjsip_endpt_schedule_timer()
1579 */
1580PJ_DECL(pj_status_t) pjsua_schedule_timer(pj_timer_entry *entry,
1581 const pj_time_val *delay);
1582
1583
1584/**
1585 * Cancel the previously scheduled timer.
1586 *
1587 * @param entry Timer heap entry.
1588 *
1589 * @see pjsip_endpt_cancel_timer()
1590 */
1591PJ_DECL(void) pjsua_cancel_timer(pj_timer_entry *entry);
1592
1593
1594/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00001595 * This is a utility function to display error message for the specified
1596 * error code. The error message will be sent to the log.
Benny Prijono312aff92006-06-17 04:08:30 +00001597 *
1598 * @param sender The log sender field.
1599 * @param title Message title for the error.
1600 * @param status Status code.
1601 */
1602PJ_DECL(void) pjsua_perror(const char *sender, const char *title,
1603 pj_status_t status);
1604
1605
Benny Prijonoda9785b2007-04-02 20:43:06 +00001606/**
1607 * This is a utility function to dump the stack states to log, using
1608 * verbosity level 3.
1609 *
1610 * @param detail Will print detailed output (such as list of
1611 * SIP transactions) when non-zero.
1612 */
1613PJ_DECL(void) pjsua_dump(pj_bool_t detail);
Benny Prijono312aff92006-06-17 04:08:30 +00001614
1615/**
1616 * @}
1617 */
1618
1619
1620
1621/*****************************************************************************
1622 * TRANSPORT API
1623 */
1624
1625/**
Benny Prijonoe6ead542007-01-31 20:53:31 +00001626 * @defgroup PJSUA_LIB_TRANSPORT PJSUA-API Signaling Transport
Benny Prijono312aff92006-06-17 04:08:30 +00001627 * @ingroup PJSUA_LIB
1628 * @brief API for managing SIP transports
1629 * @{
Benny Prijonoe6ead542007-01-31 20:53:31 +00001630 *
1631 * PJSUA-API supports creating multiple transport instances, for example UDP,
1632 * TCP, and TLS transport. SIP transport must be created before adding an
1633 * account.
Benny Prijono312aff92006-06-17 04:08:30 +00001634 */
1635
1636
Benny Prijonoe6ead542007-01-31 20:53:31 +00001637/** SIP transport identification.
1638 */
Benny Prijono312aff92006-06-17 04:08:30 +00001639typedef int pjsua_transport_id;
1640
1641
1642/**
Benny Prijono0a5cad82006-09-26 13:21:02 +00001643 * Transport configuration for creating transports for both SIP
Benny Prijonob5388cf2007-01-04 22:45:08 +00001644 * and media. Before setting some values to this structure, application
1645 * MUST call #pjsua_transport_config_default() to initialize its
1646 * values with default settings.
Benny Prijono312aff92006-06-17 04:08:30 +00001647 */
1648typedef struct pjsua_transport_config
1649{
1650 /**
1651 * UDP port number to bind locally. This setting MUST be specified
1652 * even when default port is desired. If the value is zero, the
1653 * transport will be bound to any available port, and application
1654 * can query the port by querying the transport info.
1655 */
1656 unsigned port;
1657
1658 /**
Benny Prijono0a5cad82006-09-26 13:21:02 +00001659 * Optional address to advertise as the address of this transport.
1660 * Application can specify any address or hostname for this field,
1661 * for example it can point to one of the interface address in the
1662 * system, or it can point to the public address of a NAT router
1663 * where port mappings have been configured for the application.
1664 *
1665 * Note: this option can be used for both UDP and TCP as well!
Benny Prijono312aff92006-06-17 04:08:30 +00001666 */
Benny Prijono0a5cad82006-09-26 13:21:02 +00001667 pj_str_t public_addr;
1668
1669 /**
1670 * Optional address where the socket should be bound to. This option
1671 * SHOULD only be used to selectively bind the socket to particular
1672 * interface (instead of 0.0.0.0), and SHOULD NOT be used to set the
1673 * published address of a transport (the public_addr field should be
1674 * used for that purpose).
1675 *
1676 * Note that unlike public_addr field, the address (or hostname) here
1677 * MUST correspond to the actual interface address in the host, since
1678 * this address will be specified as bind() argument.
1679 */
1680 pj_str_t bound_addr;
Benny Prijono312aff92006-06-17 04:08:30 +00001681
1682 /**
Benny Prijonob5388cf2007-01-04 22:45:08 +00001683 * This specifies TLS settings for TLS transport. It is only be used
1684 * when this transport config is being used to create a SIP TLS
1685 * transport.
Benny Prijono6e0e54b2006-12-08 21:58:31 +00001686 */
Benny Prijonof3bbc132006-12-25 06:43:59 +00001687 pjsip_tls_setting tls_setting;
Benny Prijono6e0e54b2006-12-08 21:58:31 +00001688
Benny Prijono4d79b0f2009-10-25 09:02:07 +00001689 /**
1690 * QoS traffic type to be set on this transport. When application wants
1691 * to apply QoS tagging to the transport, it's preferable to set this
1692 * field rather than \a qos_param fields since this is more portable.
1693 *
1694 * Default is QoS not set.
1695 */
1696 pj_qos_type qos_type;
1697
1698 /**
1699 * Set the low level QoS parameters to the transport. This is a lower
1700 * level operation than setting the \a qos_type field and may not be
1701 * supported on all platforms.
1702 *
1703 * Default is QoS not set.
1704 */
1705 pj_qos_params qos_params;
1706
Benny Prijono312aff92006-06-17 04:08:30 +00001707} pjsua_transport_config;
1708
1709
1710/**
1711 * Call this function to initialize UDP config with default values.
1712 *
1713 * @param cfg The UDP config to be initialized.
1714 */
Benny Prijono1f61a8f2007-08-16 10:11:44 +00001715PJ_DECL(void) pjsua_transport_config_default(pjsua_transport_config *cfg);
Benny Prijono312aff92006-06-17 04:08:30 +00001716
1717
1718/**
Benny Prijono312aff92006-06-17 04:08:30 +00001719 * Duplicate transport config.
Benny Prijonoe6ead542007-01-31 20:53:31 +00001720 *
1721 * @param pool The pool.
1722 * @param dst The destination config.
1723 * @param src The source config.
Benny Prijono312aff92006-06-17 04:08:30 +00001724 */
Benny Prijono1f61a8f2007-08-16 10:11:44 +00001725PJ_DECL(void) pjsua_transport_config_dup(pj_pool_t *pool,
1726 pjsua_transport_config *dst,
1727 const pjsua_transport_config *src);
Benny Prijono312aff92006-06-17 04:08:30 +00001728
1729
1730/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00001731 * This structure describes transport information returned by
1732 * #pjsua_transport_get_info() function.
Benny Prijono312aff92006-06-17 04:08:30 +00001733 */
1734typedef struct pjsua_transport_info
1735{
1736 /**
1737 * PJSUA transport identification.
1738 */
1739 pjsua_transport_id id;
1740
1741 /**
1742 * Transport type.
1743 */
1744 pjsip_transport_type_e type;
1745
1746 /**
1747 * Transport type name.
1748 */
1749 pj_str_t type_name;
1750
1751 /**
1752 * Transport string info/description.
1753 */
1754 pj_str_t info;
1755
1756 /**
1757 * Transport flag (see ##pjsip_transport_flags_e).
1758 */
1759 unsigned flag;
1760
1761 /**
1762 * Local address length.
1763 */
1764 unsigned addr_len;
1765
1766 /**
1767 * Local/bound address.
1768 */
1769 pj_sockaddr local_addr;
1770
1771 /**
1772 * Published address (or transport address name).
1773 */
1774 pjsip_host_port local_name;
1775
1776 /**
1777 * Current number of objects currently referencing this transport.
1778 */
1779 unsigned usage_count;
1780
1781
1782} pjsua_transport_info;
1783
1784
1785/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00001786 * Create and start a new SIP transport according to the specified
1787 * settings.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001788 *
1789 * @param type Transport type.
1790 * @param cfg Transport configuration.
1791 * @param p_id Optional pointer to receive transport ID.
1792 *
1793 * @return PJ_SUCCESS on success, or the appropriate error code.
1794 */
1795PJ_DECL(pj_status_t) pjsua_transport_create(pjsip_transport_type_e type,
1796 const pjsua_transport_config *cfg,
1797 pjsua_transport_id *p_id);
1798
1799/**
Benny Prijonoe6ead542007-01-31 20:53:31 +00001800 * Register transport that has been created by application. This function
1801 * is useful if application wants to implement custom SIP transport and use
1802 * it with pjsua.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001803 *
1804 * @param tp Transport instance.
1805 * @param p_id Optional pointer to receive transport ID.
1806 *
1807 * @return PJ_SUCCESS on success, or the appropriate error code.
1808 */
1809PJ_DECL(pj_status_t) pjsua_transport_register(pjsip_transport *tp,
1810 pjsua_transport_id *p_id);
1811
1812
1813/**
Benny Prijonoe6ead542007-01-31 20:53:31 +00001814 * Enumerate all transports currently created in the system. This function
1815 * will return all transport IDs, and application may then call
1816 * #pjsua_transport_get_info() function to retrieve detailed information
1817 * about the transport.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001818 *
1819 * @param id Array to receive transport ids.
1820 * @param count In input, specifies the maximum number of elements.
1821 * On return, it contains the actual number of elements.
1822 *
1823 * @return PJ_SUCCESS on success, or the appropriate error code.
1824 */
1825PJ_DECL(pj_status_t) pjsua_enum_transports( pjsua_transport_id id[],
1826 unsigned *count );
1827
1828
1829/**
1830 * Get information about transports.
1831 *
1832 * @param id Transport ID.
1833 * @param info Pointer to receive transport info.
1834 *
1835 * @return PJ_SUCCESS on success, or the appropriate error code.
1836 */
1837PJ_DECL(pj_status_t) pjsua_transport_get_info(pjsua_transport_id id,
1838 pjsua_transport_info *info);
1839
1840
1841/**
1842 * Disable a transport or re-enable it. By default transport is always
1843 * enabled after it is created. Disabling a transport does not necessarily
1844 * close the socket, it will only discard incoming messages and prevent
1845 * the transport from being used to send outgoing messages.
1846 *
1847 * @param id Transport ID.
1848 * @param enabled Non-zero to enable, zero to disable.
1849 *
1850 * @return PJ_SUCCESS on success, or the appropriate error code.
1851 */
1852PJ_DECL(pj_status_t) pjsua_transport_set_enable(pjsua_transport_id id,
1853 pj_bool_t enabled);
1854
1855
1856/**
1857 * Close the transport. If transport is forcefully closed, it will be
1858 * immediately closed, and any pending transactions that are using the
Benny Prijonob5388cf2007-01-04 22:45:08 +00001859 * transport may not terminate properly (it may even crash). Otherwise,
1860 * the system will wait until all transactions are closed while preventing
1861 * new users from using the transport, and will close the transport when
1862 * it is safe to do so.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001863 *
1864 * @param id Transport ID.
1865 * @param force Non-zero to immediately close the transport. This
1866 * is not recommended!
1867 *
1868 * @return PJ_SUCCESS on success, or the appropriate error code.
1869 */
1870PJ_DECL(pj_status_t) pjsua_transport_close( pjsua_transport_id id,
1871 pj_bool_t force );
Benny Prijono9fc735d2006-05-28 14:58:12 +00001872
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001873/**
Benny Prijono312aff92006-06-17 04:08:30 +00001874 * @}
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001875 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001876
1877
Benny Prijonoeebe9af2006-06-13 22:57:13 +00001878
1879
1880/*****************************************************************************
Benny Prijono312aff92006-06-17 04:08:30 +00001881 * ACCOUNT API
Benny Prijonoa91a0032006-02-26 21:23:45 +00001882 */
1883
Benny Prijono312aff92006-06-17 04:08:30 +00001884
1885/**
Benny Prijonoe6ead542007-01-31 20:53:31 +00001886 * @defgroup PJSUA_LIB_ACC PJSUA-API Accounts Management
Benny Prijono312aff92006-06-17 04:08:30 +00001887 * @ingroup PJSUA_LIB
Benny Prijonoe6ead542007-01-31 20:53:31 +00001888 * @brief PJSUA Accounts management
Benny Prijono312aff92006-06-17 04:08:30 +00001889 * @{
Benny Prijonoe6ead542007-01-31 20:53:31 +00001890 *
Benny Prijono312aff92006-06-17 04:08:30 +00001891 * PJSUA accounts provide identity (or identities) of the user who is currently
Benny Prijonoe6ead542007-01-31 20:53:31 +00001892 * using the application. In SIP terms, the identity is used as the <b>From</b>
1893 * header in outgoing requests.
1894 *
1895 * PJSUA-API supports creating and managing multiple accounts. The maximum
1896 * number of accounts is limited by a compile time constant
1897 * <tt>PJSUA_MAX_ACC</tt>.
Benny Prijono312aff92006-06-17 04:08:30 +00001898 *
1899 * Account may or may not have client registration associated with it.
1900 * An account is also associated with <b>route set</b> and some <b>authentication
1901 * credentials</b>, which are used when sending SIP request messages using the
1902 * account. An account also has presence's <b>online status</b>, which
Benny Prijonoe6ead542007-01-31 20:53:31 +00001903 * will be reported to remote peer when they subscribe to the account's
1904 * presence, or which is published to a presence server if presence
1905 * publication is enabled for the account.
Benny Prijono312aff92006-06-17 04:08:30 +00001906 *
1907 * At least one account MUST be created in the application. If no user
1908 * association is required, application can create a userless account by
1909 * calling #pjsua_acc_add_local(). A userless account identifies local endpoint
Benny Prijonoe6ead542007-01-31 20:53:31 +00001910 * instead of a particular user, and it correspond with a particular
1911 * transport instance.
Benny Prijono312aff92006-06-17 04:08:30 +00001912 *
1913 * Also one account must be set as the <b>default account</b>, which is used as
1914 * the account to use when PJSUA fails to match a request with any other
1915 * accounts.
1916 *
1917 * When sending outgoing SIP requests (such as making calls or sending
1918 * instant messages), normally PJSUA requires the application to specify
1919 * which account to use for the request. If no account is specified,
1920 * PJSUA may be able to select the account by matching the destination
1921 * domain name, and fall back to default account when no match is found.
1922 */
1923
1924/**
1925 * Maximum accounts.
1926 */
1927#ifndef PJSUA_MAX_ACC
1928# define PJSUA_MAX_ACC 8
1929#endif
1930
1931
1932/**
1933 * Default registration interval.
1934 */
1935#ifndef PJSUA_REG_INTERVAL
Benny Prijonobddef2c2007-10-31 13:28:08 +00001936# define PJSUA_REG_INTERVAL 300
Benny Prijono312aff92006-06-17 04:08:30 +00001937#endif
1938
1939
1940/**
Benny Prijono384dab42009-10-14 01:58:04 +00001941 * Default maximum time to wait for account unregistration transactions to
1942 * complete during library shutdown sequence.
1943 *
1944 * Default: 4000 (4 seconds)
1945 */
1946#ifndef PJSUA_UNREG_TIMEOUT
1947# define PJSUA_UNREG_TIMEOUT 4000
1948#endif
1949
1950
1951/**
Benny Prijono3a5e1ab2006-08-15 20:26:34 +00001952 * Default PUBLISH expiration
1953 */
1954#ifndef PJSUA_PUBLISH_EXPIRATION
Benny Prijono53984d12009-04-28 22:19:49 +00001955# define PJSUA_PUBLISH_EXPIRATION PJSIP_PUBC_EXPIRATION_NOT_SPECIFIED
Benny Prijono3a5e1ab2006-08-15 20:26:34 +00001956#endif
1957
1958
1959/**
Benny Prijono093d3022006-09-24 00:07:11 +00001960 * Default account priority.
1961 */
1962#ifndef PJSUA_DEFAULT_ACC_PRIORITY
1963# define PJSUA_DEFAULT_ACC_PRIORITY 0
1964#endif
1965
1966
1967/**
Benny Prijono8058a622007-06-08 04:37:05 +00001968 * This macro specifies the URI scheme to use in Contact header
1969 * when secure transport such as TLS is used. Application can specify
1970 * either "sip" or "sips".
1971 */
1972#ifndef PJSUA_SECURE_SCHEME
Benny Prijono4c82c1e2008-10-16 08:14:51 +00001973# define PJSUA_SECURE_SCHEME "sip"
Benny Prijono8058a622007-06-08 04:37:05 +00001974#endif
1975
1976
1977/**
Benny Prijono534a9ba2009-10-13 14:01:59 +00001978 * Maximum time to wait for unpublication transaction(s) to complete
1979 * during shutdown process, before sending unregistration. The library
1980 * tries to wait for the unpublication (un-PUBLISH) to complete before
1981 * sending REGISTER request to unregister the account, during library
1982 * shutdown process. If the value is set too short, it is possible that
1983 * the unregistration is sent before unpublication completes, causing
1984 * unpublication request to fail.
1985 *
1986 * Default: 2000 (2 seconds)
1987 */
1988#ifndef PJSUA_UNPUBLISH_MAX_WAIT_TIME_MSEC
1989# define PJSUA_UNPUBLISH_MAX_WAIT_TIME_MSEC 2000
1990#endif
1991
1992
1993/**
Nanang Izzuddin36dd5b62010-03-30 11:13:59 +00001994 * Default auto retry re-registration interval, in seconds. Set to 0
1995 * to disable this. Application can set the timer on per account basis
1996 * by setting the pjsua_acc_config.reg_retry_interval field instead.
1997 *
1998 * Default: 300 (5 minutes)
1999 */
2000#ifndef PJSUA_REG_RETRY_INTERVAL
2001# define PJSUA_REG_RETRY_INTERVAL 300
2002#endif
2003
2004
2005/**
Benny Prijonoc6d5fdc2010-06-20 08:58:26 +00002006 * This macro specifies the default value for \a contact_rewrite_method
2007 * field in pjsua_acc_config. I specifies how Contact update will be
2008 * done with the registration, if \a allow_contact_rewrite is enabled in
2009 * the account config.
2010 *
2011 * If set to 1, the Contact update will be done by sending unregistration
2012 * to the currently registered Contact, while simultaneously sending new
2013 * registration (with different Call-ID) for the updated Contact.
2014 *
2015 * If set to 2, the Contact update will be done in a single, current
2016 * registration session, by removing the current binding (by setting its
2017 * Contact's expires parameter to zero) and adding a new Contact binding,
2018 * all done in a single request.
2019 *
2020 * Value 1 is the legacy behavior.
2021 *
2022 * Default value: 2
2023 */
2024#ifndef PJSUA_CONTACT_REWRITE_METHOD
2025# define PJSUA_CONTACT_REWRITE_METHOD 2
2026#endif
2027
2028
2029/**
Benny Prijono29c8ca32010-06-22 06:02:13 +00002030 * Bit value used in pjsua_acc_config.reg_use_proxy field to indicate that
2031 * the global outbound proxy list should be added to the REGISTER request.
2032 */
2033#define PJSUA_REG_USE_OUTBOUND_PROXY 1
2034
2035
2036/**
2037 * Bit value used in pjsua_acc_config.reg_use_proxy field to indicate that
2038 * the account proxy list should be added to the REGISTER request.
2039 */
2040#define PJSUA_REG_USE_ACC_PROXY 2
2041
2042
2043/**
Benny Prijonodd63b992010-10-01 02:03:42 +00002044 * This enumeration specifies how we should offer call hold request to
2045 * remote peer. The default value is set by compile time constant
2046 * PJSUA_CALL_HOLD_TYPE_DEFAULT, and application may control the setting
2047 * on per-account basis by manipulating \a call_hold_type field in
2048 * #pjsua_acc_config.
2049 */
2050typedef enum pjsua_call_hold_type
2051{
2052 /**
2053 * This will follow RFC 3264 recommendation to use a=sendonly,
2054 * a=recvonly, and a=inactive attribute as means to signal call
2055 * hold status. This is the correct value to use.
2056 */
2057 PJSUA_CALL_HOLD_TYPE_RFC3264,
2058
2059 /**
2060 * This will use the old and deprecated method as specified in RFC 2543,
2061 * and will offer c=0.0.0.0 in the SDP instead. Using this has many
2062 * drawbacks such as inability to keep the media transport alive while
2063 * the call is being put on hold, and should only be used if remote
2064 * does not understand RFC 3264 style call hold offer.
2065 */
2066 PJSUA_CALL_HOLD_TYPE_RFC2543
2067
2068} pjsua_call_hold_type;
2069
2070
2071/**
2072 * Specify the default call hold type to be used in #pjsua_acc_config.
2073 *
2074 * Default is PJSUA_CALL_HOLD_TYPE_RFC3264, and there's no reason to change
2075 * this except if you're communicating with an old/non-standard peer.
2076 */
2077#ifndef PJSUA_CALL_HOLD_TYPE_DEFAULT
2078# define PJSUA_CALL_HOLD_TYPE_DEFAULT PJSUA_CALL_HOLD_TYPE_RFC3264
2079#endif
2080
2081
2082/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00002083 * This structure describes account configuration to be specified when
2084 * adding a new account with #pjsua_acc_add(). Application MUST initialize
2085 * this structure first by calling #pjsua_acc_config_default().
Benny Prijono312aff92006-06-17 04:08:30 +00002086 */
2087typedef struct pjsua_acc_config
2088{
Benny Prijono093d3022006-09-24 00:07:11 +00002089 /**
Benny Prijono705e7842008-07-21 18:12:51 +00002090 * Arbitrary user data to be associated with the newly created account.
2091 * Application may set this later with #pjsua_acc_set_user_data() and
2092 * retrieve it with #pjsua_acc_get_user_data().
2093 */
2094 void *user_data;
2095
2096 /**
Benny Prijono093d3022006-09-24 00:07:11 +00002097 * Account priority, which is used to control the order of matching
2098 * incoming/outgoing requests. The higher the number means the higher
2099 * the priority is, and the account will be matched first.
2100 */
2101 int priority;
2102
Benny Prijono312aff92006-06-17 04:08:30 +00002103 /**
2104 * The full SIP URL for the account. The value can take name address or
2105 * URL format, and will look something like "sip:account@serviceprovider".
2106 *
2107 * This field is mandatory.
2108 */
2109 pj_str_t id;
2110
2111 /**
2112 * This is the URL to be put in the request URI for the registration,
2113 * and will look something like "sip:serviceprovider".
2114 *
2115 * This field should be specified if registration is desired. If the
2116 * value is empty, no account registration will be performed.
2117 */
2118 pj_str_t reg_uri;
2119
Nanang Izzuddin60e8aa92010-09-28 10:48:48 +00002120 /**
2121 * The optional custom SIP headers to be put in the registration
2122 * request.
2123 */
2124 pjsip_hdr reg_hdr_list;
2125
Benny Prijono3a5e1ab2006-08-15 20:26:34 +00002126 /**
Benny Prijonofe1bd342009-11-20 23:33:07 +00002127 * Subscribe to message waiting indication events (RFC 3842).
2128 *
2129 * See also \a enable_unsolicited_mwi field on #pjsua_config.
Benny Prijono4dd961b2009-10-26 11:21:37 +00002130 *
2131 * Default: no
2132 */
2133 pj_bool_t mwi_enabled;
2134
2135 /**
Benny Prijonob5388cf2007-01-04 22:45:08 +00002136 * If this flag is set, the presence information of this account will
2137 * be PUBLISH-ed to the server where the account belongs.
Benny Prijono48ab2b72007-11-08 09:24:30 +00002138 *
2139 * Default: PJ_FALSE
Benny Prijono3a5e1ab2006-08-15 20:26:34 +00002140 */
2141 pj_bool_t publish_enabled;
2142
Benny Prijonofe04fb52007-08-24 08:28:52 +00002143 /**
Benny Prijonofe50c9e2009-10-12 07:44:14 +00002144 * Event publication options.
2145 */
2146 pjsip_publishc_opt publish_opt;
2147
2148 /**
Benny Prijono534a9ba2009-10-13 14:01:59 +00002149 * Maximum time to wait for unpublication transaction(s) to complete
2150 * during shutdown process, before sending unregistration. The library
2151 * tries to wait for the unpublication (un-PUBLISH) to complete before
2152 * sending REGISTER request to unregister the account, during library
2153 * shutdown process. If the value is set too short, it is possible that
2154 * the unregistration is sent before unpublication completes, causing
2155 * unpublication request to fail.
2156 *
2157 * Default: PJSUA_UNPUBLISH_MAX_WAIT_TIME_MSEC
2158 */
2159 unsigned unpublish_max_wait_time_msec;
2160
2161 /**
Benny Prijono48ab2b72007-11-08 09:24:30 +00002162 * Authentication preference.
2163 */
2164 pjsip_auth_clt_pref auth_pref;
2165
2166 /**
Benny Prijonofe04fb52007-08-24 08:28:52 +00002167 * Optional PIDF tuple ID for outgoing PUBLISH and NOTIFY. If this value
2168 * is not specified, a random string will be used.
2169 */
2170 pj_str_t pidf_tuple_id;
2171
Benny Prijono312aff92006-06-17 04:08:30 +00002172 /**
2173 * Optional URI to be put as Contact for this account. It is recommended
2174 * that this field is left empty, so that the value will be calculated
2175 * automatically based on the transport address.
2176 */
Benny Prijonob4a17c92006-07-10 14:40:21 +00002177 pj_str_t force_contact;
Benny Prijono312aff92006-06-17 04:08:30 +00002178
2179 /**
Nanang Izzuddine2c7e852009-08-04 14:36:17 +00002180 * Additional parameters that will be appended in the Contact header
Benny Prijono30fe4852008-12-10 16:54:16 +00002181 * for this account. This will affect the Contact header in all SIP
2182 * messages sent on behalf of this account, including but not limited to
2183 * REGISTER, INVITE, and SUBCRIBE requests or responses.
2184 *
2185 * The parameters should be preceeded by semicolon, and all strings must
2186 * be properly escaped. Example:
2187 * ";my-param=X;another-param=Hi%20there"
2188 */
2189 pj_str_t contact_params;
2190
2191 /**
Nanang Izzuddine2c7e852009-08-04 14:36:17 +00002192 * Additional URI parameters that will be appended in the Contact URI
2193 * for this account. This will affect the Contact URI in all SIP
2194 * messages sent on behalf of this account, including but not limited to
2195 * REGISTER, INVITE, and SUBCRIBE requests or responses.
2196 *
2197 * The parameters should be preceeded by semicolon, and all strings must
2198 * be properly escaped. Example:
2199 * ";my-param=X;another-param=Hi%20there"
2200 */
2201 pj_str_t contact_uri_params;
2202
2203 /**
Benny Prijonodcfc0ba2007-09-30 16:50:27 +00002204 * Specify whether support for reliable provisional response (100rel and
2205 * PRACK) should be required for all sessions of this account.
2206 *
2207 * Default: PJ_FALSE
2208 */
2209 pj_bool_t require_100rel;
2210
2211 /**
Nanang Izzuddin742ef4b2010-09-07 09:36:15 +00002212 * Specify the usage of Session Timers for all sessions. See the
2213 * #pjsua_sip_timer_use for possible values.
Nanang Izzuddin59dffb12009-08-11 12:42:38 +00002214 *
Nanang Izzuddin742ef4b2010-09-07 09:36:15 +00002215 * Default: PJSUA_SIP_TIMER_OPTIONAL
Nanang Izzuddin59dffb12009-08-11 12:42:38 +00002216 */
Nanang Izzuddin742ef4b2010-09-07 09:36:15 +00002217 pjsua_sip_timer_use use_timer;
Nanang Izzuddin59dffb12009-08-11 12:42:38 +00002218
2219 /**
Nanang Izzuddin65add622009-08-11 16:26:20 +00002220 * Specify Session Timer settings, see #pjsip_timer_setting.
Nanang Izzuddin59dffb12009-08-11 12:42:38 +00002221 */
Nanang Izzuddin65add622009-08-11 16:26:20 +00002222 pjsip_timer_setting timer_setting;
Nanang Izzuddin59dffb12009-08-11 12:42:38 +00002223
2224 /**
Benny Prijono312aff92006-06-17 04:08:30 +00002225 * Number of proxies in the proxy array below.
2226 */
2227 unsigned proxy_cnt;
2228
2229 /**
2230 * Optional URI of the proxies to be visited for all outgoing requests
2231 * that are using this account (REGISTER, INVITE, etc). Application need
2232 * to specify these proxies if the service provider requires that requests
2233 * destined towards its network should go through certain proxies first
2234 * (for example, border controllers).
2235 *
2236 * These proxies will be put in the route set for this account, with
2237 * maintaining the orders (the first proxy in the array will be visited
Benny Prijonob5388cf2007-01-04 22:45:08 +00002238 * first). If global outbound proxies are configured in pjsua_config,
2239 * then these account proxies will be placed after the global outbound
2240 * proxies in the routeset.
Benny Prijono312aff92006-06-17 04:08:30 +00002241 */
2242 pj_str_t proxy[PJSUA_ACC_MAX_PROXIES];
2243
2244 /**
2245 * Optional interval for registration, in seconds. If the value is zero,
Benny Prijonobddef2c2007-10-31 13:28:08 +00002246 * default interval will be used (PJSUA_REG_INTERVAL, 300 seconds).
Benny Prijono312aff92006-06-17 04:08:30 +00002247 */
2248 unsigned reg_timeout;
2249
Benny Prijono384dab42009-10-14 01:58:04 +00002250 /**
2251 * Specify the maximum time to wait for unregistration requests to
2252 * complete during library shutdown sequence.
2253 *
2254 * Default: PJSUA_UNREG_TIMEOUT
2255 */
2256 unsigned unreg_timeout;
2257
Benny Prijono312aff92006-06-17 04:08:30 +00002258 /**
2259 * Number of credentials in the credential array.
2260 */
2261 unsigned cred_count;
2262
2263 /**
2264 * Array of credentials. If registration is desired, normally there should
2265 * be at least one credential specified, to successfully authenticate
2266 * against the service provider. More credentials can be specified, for
2267 * example when the requests are expected to be challenged by the
2268 * proxies in the route set.
2269 */
2270 pjsip_cred_info cred_info[PJSUA_ACC_MAX_PROXIES];
2271
Benny Prijono62c5c5b2007-01-13 23:22:40 +00002272 /**
2273 * Optionally bind this account to specific transport. This normally is
2274 * not a good idea, as account should be able to send requests using
2275 * any available transports according to the destination. But some
2276 * application may want to have explicit control over the transport to
2277 * use, so in that case it can set this field.
2278 *
2279 * Default: -1 (PJSUA_INVALID_ID)
2280 *
2281 * @see pjsua_acc_set_transport()
2282 */
2283 pjsua_transport_id transport_id;
2284
Benny Prijono15b02302007-09-27 14:07:07 +00002285 /**
Benny Prijonocca2e432010-02-25 09:33:18 +00002286 * This option is used to update the transport address and the Contact
Benny Prijonoe8554ef2008-03-22 09:33:52 +00002287 * header of REGISTER request. When this option is enabled, the library
2288 * will keep track of the public IP address from the response of REGISTER
2289 * request. Once it detects that the address has changed, it will
2290 * unregister current Contact, update the Contact with transport address
2291 * learned from Via header, and register a new Contact to the registrar.
2292 * This will also update the public name of UDP transport if STUN is
Benny Prijonocca2e432010-02-25 09:33:18 +00002293 * configured.
Benny Prijono15b02302007-09-27 14:07:07 +00002294 *
Benny Prijonoc6d5fdc2010-06-20 08:58:26 +00002295 * See also contact_rewrite_method field.
2296 *
Benny Prijono15b02302007-09-27 14:07:07 +00002297 * Default: 1 (yes)
2298 */
Benny Prijonoe8554ef2008-03-22 09:33:52 +00002299 pj_bool_t allow_contact_rewrite;
Benny Prijono15b02302007-09-27 14:07:07 +00002300
Benny Prijonobddef2c2007-10-31 13:28:08 +00002301 /**
Benny Prijonoc6d5fdc2010-06-20 08:58:26 +00002302 * Specify how Contact update will be done with the registration, if
2303 * \a allow_contact_rewrite is enabled.
2304 *
2305 * If set to 1, the Contact update will be done by sending unregistration
2306 * to the currently registered Contact, while simultaneously sending new
2307 * registration (with different Call-ID) for the updated Contact.
2308 *
2309 * If set to 2, the Contact update will be done in a single, current
2310 * registration session, by removing the current binding (by setting its
2311 * Contact's expires parameter to zero) and adding a new Contact binding,
2312 * all done in a single request.
2313 *
2314 * Value 1 is the legacy behavior.
2315 *
2316 * Default value: PJSUA_CONTACT_REWRITE_METHOD (2)
2317 */
2318 int contact_rewrite_method;
2319
2320 /**
Benny Prijonobddef2c2007-10-31 13:28:08 +00002321 * Set the interval for periodic keep-alive transmission for this account.
2322 * If this value is zero, keep-alive will be disabled for this account.
2323 * The keep-alive transmission will be sent to the registrar's address,
2324 * after successful registration.
2325 *
Benny Prijonobddef2c2007-10-31 13:28:08 +00002326 * Default: 15 (seconds)
2327 */
2328 unsigned ka_interval;
2329
2330 /**
2331 * Specify the data to be transmitted as keep-alive packets.
2332 *
2333 * Default: CR-LF
2334 */
2335 pj_str_t ka_data;
2336
Benny Prijonod8179652008-01-23 20:39:07 +00002337#if defined(PJMEDIA_HAS_SRTP) && (PJMEDIA_HAS_SRTP != 0)
2338 /**
2339 * Specify whether secure media transport should be used for this account.
2340 * Valid values are PJMEDIA_SRTP_DISABLED, PJMEDIA_SRTP_OPTIONAL, and
2341 * PJMEDIA_SRTP_MANDATORY.
2342 *
2343 * Default: #PJSUA_DEFAULT_USE_SRTP
2344 */
2345 pjmedia_srtp_use use_srtp;
2346
2347 /**
2348 * Specify whether SRTP requires secure signaling to be used. This option
2349 * is only used when \a use_srtp option above is non-zero.
2350 *
2351 * Valid values are:
2352 * 0: SRTP does not require secure signaling
2353 * 1: SRTP requires secure transport such as TLS
2354 * 2: SRTP requires secure end-to-end transport (SIPS)
2355 *
2356 * Default: #PJSUA_DEFAULT_SRTP_SECURE_SIGNALING
2357 */
2358 int srtp_secure_signaling;
Nanang Izzuddind89cc3a2010-05-13 05:22:51 +00002359
2360 /**
2361 * Specify whether SRTP in PJMEDIA_SRTP_OPTIONAL mode should compose
2362 * duplicated media in SDP offer, i.e: unsecured and secured version.
2363 * Otherwise, the SDP media will be composed as unsecured media but
2364 * with SDP "crypto" attribute.
2365 *
2366 * Default: PJ_FALSE
2367 */
2368 pj_bool_t srtp_optional_dup_offer;
Benny Prijonod8179652008-01-23 20:39:07 +00002369#endif
2370
Nanang Izzuddin36dd5b62010-03-30 11:13:59 +00002371 /**
2372 * Specify interval of auto registration retry upon registration failure
2373 * (including caused by transport problem), in second. Set to 0 to
2374 * disable auto re-registration.
2375 *
2376 * Default: #PJSUA_REG_RETRY_INTERVAL
2377 */
2378 unsigned reg_retry_interval;
2379
2380 /**
2381 * Specify whether calls of the configured account should be dropped
2382 * after registration failure and an attempt of re-registration has
2383 * also failed.
2384 *
2385 * Default: PJ_FALSE (disabled)
2386 */
2387 pj_bool_t drop_calls_on_reg_fail;
2388
Benny Prijono29c8ca32010-06-22 06:02:13 +00002389 /**
2390 * Specify how the registration uses the outbound and account proxy
2391 * settings. This controls if and what Route headers will appear in
2392 * the REGISTER request of this account. The value is bitmask combination
2393 * of PJSUA_REG_USE_OUTBOUND_PROXY and PJSUA_REG_USE_ACC_PROXY bits.
2394 * If the value is set to 0, the REGISTER request will not use any proxy
2395 * (i.e. it will not have any Route headers).
2396 *
2397 * Default: 3 (PJSUA_REG_USE_OUTBOUND_PROXY | PJSUA_REG_USE_ACC_PROXY)
2398 */
2399 unsigned reg_use_proxy;
2400
Nanang Izzuddin5e39a2b2010-09-20 06:13:02 +00002401#if defined(PJMEDIA_STREAM_ENABLE_KA) && (PJMEDIA_STREAM_ENABLE_KA != 0)
2402 /**
2403 * Specify whether stream keep-alive and NAT hole punching with
2404 * non-codec-VAD mechanism (see @ref PJMEDIA_STREAM_ENABLE_KA) is enabled
2405 * for this account.
2406 *
2407 * Default: PJ_FALSE (disabled)
2408 */
2409 pj_bool_t use_stream_ka;
2410#endif
2411
Benny Prijonodd63b992010-10-01 02:03:42 +00002412 /**
2413 * Specify how to offer call hold to remote peer. Please see the
2414 * documentation on #pjsua_call_hold_type for more info.
2415 *
2416 * Default: PJSUA_CALL_HOLD_TYPE_DEFAULT
2417 */
2418 pjsua_call_hold_type call_hold_type;
2419
Benny Prijono312aff92006-06-17 04:08:30 +00002420} pjsua_acc_config;
2421
2422
2423/**
2424 * Call this function to initialize account config with default values.
2425 *
2426 * @param cfg The account config to be initialized.
2427 */
Benny Prijono1f61a8f2007-08-16 10:11:44 +00002428PJ_DECL(void) pjsua_acc_config_default(pjsua_acc_config *cfg);
Benny Prijono312aff92006-06-17 04:08:30 +00002429
2430
2431/**
Benny Prijonobddef2c2007-10-31 13:28:08 +00002432 * Duplicate account config.
2433 *
2434 * @param pool Pool to be used for duplicating the config.
2435 * @param dst Destination configuration.
2436 * @param src Source configuration.
2437 */
2438PJ_DECL(void) pjsua_acc_config_dup(pj_pool_t *pool,
2439 pjsua_acc_config *dst,
2440 const pjsua_acc_config *src);
2441
2442
2443/**
Benny Prijono312aff92006-06-17 04:08:30 +00002444 * Account info. Application can query account info by calling
2445 * #pjsua_acc_get_info().
2446 */
2447typedef struct pjsua_acc_info
2448{
2449 /**
2450 * The account ID.
2451 */
2452 pjsua_acc_id id;
2453
2454 /**
2455 * Flag to indicate whether this is the default account.
2456 */
2457 pj_bool_t is_default;
2458
2459 /**
2460 * Account URI
2461 */
2462 pj_str_t acc_uri;
2463
2464 /**
2465 * Flag to tell whether this account has registration setting
2466 * (reg_uri is not empty).
2467 */
2468 pj_bool_t has_registration;
2469
2470 /**
2471 * An up to date expiration interval for account registration session.
2472 */
2473 int expires;
2474
2475 /**
2476 * Last registration status code. If status code is zero, the account
2477 * is currently not registered. Any other value indicates the SIP
2478 * status code of the registration.
2479 */
2480 pjsip_status_code status;
2481
2482 /**
Sauw Ming48f6dbf2010-09-07 05:10:25 +00002483 * Last registration error code. When the status field contains a SIP
2484 * status code that indicates a registration failure, last registration
2485 * error code contains the error code that causes the failure. In any
2486 * other case, its value is zero.
2487 */
2488 pj_status_t reg_last_err;
2489
2490 /**
Benny Prijono312aff92006-06-17 04:08:30 +00002491 * String describing the registration status.
2492 */
2493 pj_str_t status_text;
2494
2495 /**
2496 * Presence online status for this account.
2497 */
2498 pj_bool_t online_status;
2499
2500 /**
Benny Prijono4461c7d2007-08-25 13:36:15 +00002501 * Presence online status text.
2502 */
2503 pj_str_t online_status_text;
2504
2505 /**
2506 * Extended RPID online status information.
2507 */
2508 pjrpid_element rpid;
2509
2510 /**
Benny Prijono312aff92006-06-17 04:08:30 +00002511 * Buffer that is used internally to store the status text.
2512 */
2513 char buf_[PJ_ERR_MSG_SIZE];
2514
2515} pjsua_acc_info;
2516
2517
2518
2519/**
2520 * Get number of current accounts.
2521 *
2522 * @return Current number of accounts.
2523 */
2524PJ_DECL(unsigned) pjsua_acc_get_count(void);
2525
2526
2527/**
2528 * Check if the specified account ID is valid.
2529 *
2530 * @param acc_id Account ID to check.
2531 *
2532 * @return Non-zero if account ID is valid.
2533 */
2534PJ_DECL(pj_bool_t) pjsua_acc_is_valid(pjsua_acc_id acc_id);
2535
2536
2537/**
Benny Prijono21b9ad92006-08-15 13:11:22 +00002538 * Set default account to be used when incoming and outgoing
2539 * requests doesn't match any accounts.
2540 *
2541 * @param acc_id The account ID to be used as default.
2542 *
2543 * @return PJ_SUCCESS on success.
2544 */
2545PJ_DECL(pj_status_t) pjsua_acc_set_default(pjsua_acc_id acc_id);
2546
2547
2548/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00002549 * Get default account to be used when receiving incoming requests (calls),
2550 * when the destination of the incoming call doesn't match any other
2551 * accounts.
Benny Prijono21b9ad92006-08-15 13:11:22 +00002552 *
2553 * @return The default account ID, or PJSUA_INVALID_ID if no
2554 * default account is configured.
2555 */
2556PJ_DECL(pjsua_acc_id) pjsua_acc_get_default(void);
2557
2558
2559/**
Benny Prijono312aff92006-06-17 04:08:30 +00002560 * Add a new account to pjsua. PJSUA must have been initialized (with
Benny Prijonob5388cf2007-01-04 22:45:08 +00002561 * #pjsua_init()) before calling this function. If registration is configured
2562 * for this account, this function would also start the SIP registration
2563 * session with the SIP registrar server. This SIP registration session
2564 * will be maintained internally by the library, and application doesn't
2565 * need to do anything to maintain the registration session.
2566 *
Benny Prijono312aff92006-06-17 04:08:30 +00002567 *
Benny Prijonoe6ead542007-01-31 20:53:31 +00002568 * @param acc_cfg Account configuration.
Benny Prijono312aff92006-06-17 04:08:30 +00002569 * @param is_default If non-zero, this account will be set as the default
2570 * account. The default account will be used when sending
2571 * outgoing requests (e.g. making call) when no account is
2572 * specified, and when receiving incoming requests when the
2573 * request does not match any accounts. It is recommended
2574 * that default account is set to local/LAN account.
2575 * @param p_acc_id Pointer to receive account ID of the new account.
2576 *
2577 * @return PJ_SUCCESS on success, or the appropriate error code.
2578 */
Benny Prijonoe6ead542007-01-31 20:53:31 +00002579PJ_DECL(pj_status_t) pjsua_acc_add(const pjsua_acc_config *acc_cfg,
Benny Prijono312aff92006-06-17 04:08:30 +00002580 pj_bool_t is_default,
2581 pjsua_acc_id *p_acc_id);
2582
2583
2584/**
2585 * Add a local account. A local account is used to identify local endpoint
2586 * instead of a specific user, and for this reason, a transport ID is needed
2587 * to obtain the local address information.
2588 *
2589 * @param tid Transport ID to generate account address.
2590 * @param is_default If non-zero, this account will be set as the default
2591 * account. The default account will be used when sending
2592 * outgoing requests (e.g. making call) when no account is
2593 * specified, and when receiving incoming requests when the
2594 * request does not match any accounts. It is recommended
2595 * that default account is set to local/LAN account.
2596 * @param p_acc_id Pointer to receive account ID of the new account.
2597 *
2598 * @return PJ_SUCCESS on success, or the appropriate error code.
2599 */
2600PJ_DECL(pj_status_t) pjsua_acc_add_local(pjsua_transport_id tid,
2601 pj_bool_t is_default,
2602 pjsua_acc_id *p_acc_id);
2603
2604/**
Benny Prijono705e7842008-07-21 18:12:51 +00002605 * Set arbitrary data to be associated with the account.
2606 *
2607 * @param acc_id The account ID.
2608 * @param user_data User/application data.
2609 *
2610 * @return PJ_SUCCESS on success, or the appropriate error code.
2611 */
2612PJ_DECL(pj_status_t) pjsua_acc_set_user_data(pjsua_acc_id acc_id,
2613 void *user_data);
2614
2615
2616/**
2617 * Retrieve arbitrary data associated with the account.
2618 *
2619 * @param acc_id The account ID.
2620 *
2621 * @return The user data. In the case where the account ID is
2622 * not valid, NULL is returned.
2623 */
2624PJ_DECL(void*) pjsua_acc_get_user_data(pjsua_acc_id acc_id);
2625
2626
2627/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00002628 * Delete an account. This will unregister the account from the SIP server,
2629 * if necessary, and terminate server side presence subscriptions associated
2630 * with this account.
Benny Prijono312aff92006-06-17 04:08:30 +00002631 *
2632 * @param acc_id Id of the account to be deleted.
2633 *
2634 * @return PJ_SUCCESS on success, or the appropriate error code.
2635 */
2636PJ_DECL(pj_status_t) pjsua_acc_del(pjsua_acc_id acc_id);
2637
2638
2639/**
2640 * Modify account information.
2641 *
2642 * @param acc_id Id of the account to be modified.
Benny Prijonoe6ead542007-01-31 20:53:31 +00002643 * @param acc_cfg New account configuration.
Benny Prijono312aff92006-06-17 04:08:30 +00002644 *
2645 * @return PJ_SUCCESS on success, or the appropriate error code.
2646 */
2647PJ_DECL(pj_status_t) pjsua_acc_modify(pjsua_acc_id acc_id,
Benny Prijonoe6ead542007-01-31 20:53:31 +00002648 const pjsua_acc_config *acc_cfg);
Benny Prijono312aff92006-06-17 04:08:30 +00002649
2650
2651/**
2652 * Modify account's presence status to be advertised to remote/presence
Benny Prijonob5388cf2007-01-04 22:45:08 +00002653 * subscribers. This would trigger the sending of outgoing NOTIFY request
Benny Prijono4461c7d2007-08-25 13:36:15 +00002654 * if there are server side presence subscription for this account, and/or
2655 * outgoing PUBLISH if presence publication is enabled for this account.
2656 *
2657 * @see pjsua_acc_set_online_status2()
Benny Prijono312aff92006-06-17 04:08:30 +00002658 *
2659 * @param acc_id The account ID.
2660 * @param is_online True of false.
2661 *
2662 * @return PJ_SUCCESS on success, or the appropriate error code.
2663 */
2664PJ_DECL(pj_status_t) pjsua_acc_set_online_status(pjsua_acc_id acc_id,
2665 pj_bool_t is_online);
2666
Benny Prijono4461c7d2007-08-25 13:36:15 +00002667/**
2668 * Modify account's presence status to be advertised to remote/presence
2669 * subscribers. This would trigger the sending of outgoing NOTIFY request
2670 * if there are server side presence subscription for this account, and/or
2671 * outgoing PUBLISH if presence publication is enabled for this account.
2672 *
2673 * @see pjsua_acc_set_online_status()
2674 *
2675 * @param acc_id The account ID.
2676 * @param is_online True of false.
2677 * @param pr Extended information in subset of RPID format
2678 * which allows setting custom presence text.
2679 *
2680 * @return PJ_SUCCESS on success, or the appropriate error code.
2681 */
2682PJ_DECL(pj_status_t) pjsua_acc_set_online_status2(pjsua_acc_id acc_id,
2683 pj_bool_t is_online,
2684 const pjrpid_element *pr);
Benny Prijono312aff92006-06-17 04:08:30 +00002685
2686/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00002687 * Update registration or perform unregistration. If registration is
2688 * configured for this account, then initial SIP REGISTER will be sent
2689 * when the account is added with #pjsua_acc_add(). Application normally
2690 * only need to call this function if it wants to manually update the
2691 * registration or to unregister from the server.
Benny Prijono312aff92006-06-17 04:08:30 +00002692 *
2693 * @param acc_id The account ID.
2694 * @param renew If renew argument is zero, this will start
2695 * unregistration process.
2696 *
2697 * @return PJ_SUCCESS on success, or the appropriate error code.
2698 */
2699PJ_DECL(pj_status_t) pjsua_acc_set_registration(pjsua_acc_id acc_id,
2700 pj_bool_t renew);
2701
Benny Prijono312aff92006-06-17 04:08:30 +00002702/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00002703 * Get information about the specified account.
Benny Prijono312aff92006-06-17 04:08:30 +00002704 *
2705 * @param acc_id Account identification.
2706 * @param info Pointer to receive account information.
2707 *
2708 * @return PJ_SUCCESS on success, or the appropriate error code.
2709 */
2710PJ_DECL(pj_status_t) pjsua_acc_get_info(pjsua_acc_id acc_id,
2711 pjsua_acc_info *info);
2712
2713
2714/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00002715 * Enumerate all account currently active in the library. This will fill
2716 * the array with the account Ids, and application can then query the
2717 * account information for each id with #pjsua_acc_get_info().
2718 *
2719 * @see pjsua_acc_enum_info().
Benny Prijono312aff92006-06-17 04:08:30 +00002720 *
2721 * @param ids Array of account IDs to be initialized.
2722 * @param count In input, specifies the maximum number of elements.
2723 * On return, it contains the actual number of elements.
2724 *
2725 * @return PJ_SUCCESS on success, or the appropriate error code.
2726 */
2727PJ_DECL(pj_status_t) pjsua_enum_accs(pjsua_acc_id ids[],
2728 unsigned *count );
2729
2730
2731/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00002732 * Enumerate account informations.
Benny Prijono312aff92006-06-17 04:08:30 +00002733 *
2734 * @param info Array of account infos to be initialized.
2735 * @param count In input, specifies the maximum number of elements.
2736 * On return, it contains the actual number of elements.
2737 *
2738 * @return PJ_SUCCESS on success, or the appropriate error code.
2739 */
2740PJ_DECL(pj_status_t) pjsua_acc_enum_info( pjsua_acc_info info[],
2741 unsigned *count );
2742
2743
2744/**
2745 * This is an internal function to find the most appropriate account to
2746 * used to reach to the specified URL.
2747 *
2748 * @param url The remote URL to reach.
2749 *
2750 * @return Account id.
2751 */
2752PJ_DECL(pjsua_acc_id) pjsua_acc_find_for_outgoing(const pj_str_t *url);
2753
2754
2755/**
2756 * This is an internal function to find the most appropriate account to be
2757 * used to handle incoming calls.
2758 *
2759 * @param rdata The incoming request message.
2760 *
2761 * @return Account id.
2762 */
2763PJ_DECL(pjsua_acc_id) pjsua_acc_find_for_incoming(pjsip_rx_data *rdata);
2764
2765
Benny Prijonoc570f2d2006-07-18 00:33:02 +00002766/**
Benny Prijonofff245c2007-04-02 11:44:47 +00002767 * Create arbitrary requests using the account. Application should only use
2768 * this function to create auxiliary requests outside dialog, such as
2769 * OPTIONS, and use the call or presence API to create dialog related
2770 * requests.
2771 *
2772 * @param acc_id The account ID.
2773 * @param method The SIP method of the request.
2774 * @param target Target URI.
2775 * @param p_tdata Pointer to receive the request.
2776 *
2777 * @return PJ_SUCCESS or the error code.
2778 */
2779PJ_DECL(pj_status_t) pjsua_acc_create_request(pjsua_acc_id acc_id,
2780 const pjsip_method *method,
2781 const pj_str_t *target,
2782 pjsip_tx_data **p_tdata);
2783
2784
2785/**
Nanang Izzuddin5af37ff2009-08-05 18:41:23 +00002786 * Create a suitable Contact header value, based on the specified target URI
2787 * for the specified account.
Benny Prijonoc570f2d2006-07-18 00:33:02 +00002788 *
2789 * @param pool Pool to allocate memory for the string.
Nanang Izzuddin5af37ff2009-08-05 18:41:23 +00002790 * @param contact The string where the Contact will be stored.
Benny Prijonoc570f2d2006-07-18 00:33:02 +00002791 * @param acc_id Account ID.
2792 * @param uri Destination URI of the request.
2793 *
2794 * @return PJ_SUCCESS on success, other on error.
2795 */
2796PJ_DECL(pj_status_t) pjsua_acc_create_uac_contact( pj_pool_t *pool,
2797 pj_str_t *contact,
2798 pjsua_acc_id acc_id,
2799 const pj_str_t *uri);
2800
2801
2802
2803/**
Nanang Izzuddin5af37ff2009-08-05 18:41:23 +00002804 * Create a suitable Contact header value, based on the information in the
2805 * incoming request.
Benny Prijonoc570f2d2006-07-18 00:33:02 +00002806 *
2807 * @param pool Pool to allocate memory for the string.
Nanang Izzuddin5af37ff2009-08-05 18:41:23 +00002808 * @param contact The string where the Contact will be stored.
Benny Prijonoc570f2d2006-07-18 00:33:02 +00002809 * @param acc_id Account ID.
2810 * @param rdata Incoming request.
2811 *
2812 * @return PJ_SUCCESS on success, other on error.
2813 */
2814PJ_DECL(pj_status_t) pjsua_acc_create_uas_contact( pj_pool_t *pool,
2815 pj_str_t *contact,
2816 pjsua_acc_id acc_id,
2817 pjsip_rx_data *rdata );
2818
2819
Benny Prijono62c5c5b2007-01-13 23:22:40 +00002820/**
2821 * Lock/bind this account to a specific transport/listener. Normally
2822 * application shouldn't need to do this, as transports will be selected
2823 * automatically by the stack according to the destination.
2824 *
2825 * When account is locked/bound to a specific transport, all outgoing
2826 * requests from this account will use the specified transport (this
2827 * includes SIP registration, dialog (call and event subscription), and
2828 * out-of-dialog requests such as MESSAGE).
2829 *
2830 * Note that transport_id may be specified in pjsua_acc_config too.
2831 *
2832 * @param acc_id The account ID.
2833 * @param tp_id The transport ID.
2834 *
2835 * @return PJ_SUCCESS on success.
2836 */
2837PJ_DECL(pj_status_t) pjsua_acc_set_transport(pjsua_acc_id acc_id,
2838 pjsua_transport_id tp_id);
2839
Benny Prijono312aff92006-06-17 04:08:30 +00002840
2841/**
2842 * @}
2843 */
2844
2845
2846/*****************************************************************************
2847 * CALLS API
2848 */
2849
2850
2851/**
Benny Prijonoe6ead542007-01-31 20:53:31 +00002852 * @defgroup PJSUA_LIB_CALL PJSUA-API Calls Management
Benny Prijono312aff92006-06-17 04:08:30 +00002853 * @ingroup PJSUA_LIB
2854 * @brief Call manipulation.
2855 * @{
2856 */
2857
2858/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00002859 * Maximum simultaneous calls.
Benny Prijono312aff92006-06-17 04:08:30 +00002860 */
2861#ifndef PJSUA_MAX_CALLS
2862# define PJSUA_MAX_CALLS 32
2863#endif
2864
2865
2866
2867/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00002868 * This enumeration specifies the media status of a call, and it's part
2869 * of pjsua_call_info structure.
Benny Prijono312aff92006-06-17 04:08:30 +00002870 */
2871typedef enum pjsua_call_media_status
2872{
Benny Prijonob5388cf2007-01-04 22:45:08 +00002873 /** Call currently has no media */
Benny Prijono312aff92006-06-17 04:08:30 +00002874 PJSUA_CALL_MEDIA_NONE,
Benny Prijonob5388cf2007-01-04 22:45:08 +00002875
2876 /** The media is active */
Benny Prijono312aff92006-06-17 04:08:30 +00002877 PJSUA_CALL_MEDIA_ACTIVE,
Benny Prijonob5388cf2007-01-04 22:45:08 +00002878
2879 /** The media is currently put on hold by local endpoint */
Benny Prijono312aff92006-06-17 04:08:30 +00002880 PJSUA_CALL_MEDIA_LOCAL_HOLD,
Benny Prijonob5388cf2007-01-04 22:45:08 +00002881
2882 /** The media is currently put on hold by remote endpoint */
Benny Prijono312aff92006-06-17 04:08:30 +00002883 PJSUA_CALL_MEDIA_REMOTE_HOLD,
Benny Prijonob5388cf2007-01-04 22:45:08 +00002884
Benny Prijono096c56c2007-09-15 08:30:16 +00002885 /** The media has reported error (e.g. ICE negotiation) */
2886 PJSUA_CALL_MEDIA_ERROR
2887
Benny Prijono312aff92006-06-17 04:08:30 +00002888} pjsua_call_media_status;
2889
2890
2891/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00002892 * This structure describes the information and current status of a call.
Benny Prijono312aff92006-06-17 04:08:30 +00002893 */
2894typedef struct pjsua_call_info
2895{
2896 /** Call identification. */
2897 pjsua_call_id id;
2898
2899 /** Initial call role (UAC == caller) */
2900 pjsip_role_e role;
2901
Benny Prijono90315512006-09-14 16:05:16 +00002902 /** The account ID where this call belongs. */
2903 pjsua_acc_id acc_id;
2904
Benny Prijono312aff92006-06-17 04:08:30 +00002905 /** Local URI */
2906 pj_str_t local_info;
2907
2908 /** Local Contact */
2909 pj_str_t local_contact;
2910
2911 /** Remote URI */
2912 pj_str_t remote_info;
2913
2914 /** Remote contact */
2915 pj_str_t remote_contact;
2916
2917 /** Dialog Call-ID string. */
2918 pj_str_t call_id;
2919
2920 /** Call state */
2921 pjsip_inv_state state;
2922
2923 /** Text describing the state */
2924 pj_str_t state_text;
2925
2926 /** Last status code heard, which can be used as cause code */
2927 pjsip_status_code last_status;
2928
2929 /** The reason phrase describing the status. */
2930 pj_str_t last_status_text;
2931
2932 /** Call media status. */
2933 pjsua_call_media_status media_status;
2934
2935 /** Media direction */
2936 pjmedia_dir media_dir;
2937
2938 /** The conference port number for the call */
2939 pjsua_conf_port_id conf_slot;
2940
2941 /** Up-to-date call connected duration (zero when call is not
2942 * established)
2943 */
2944 pj_time_val connect_duration;
2945
2946 /** Total call duration, including set-up time */
2947 pj_time_val total_duration;
2948
2949 /** Internal */
2950 struct {
2951 char local_info[128];
2952 char local_contact[128];
2953 char remote_info[128];
2954 char remote_contact[128];
2955 char call_id[128];
2956 char last_status_text[128];
2957 } buf_;
2958
2959} pjsua_call_info;
2960
2961
2962
Benny Prijonoa91a0032006-02-26 21:23:45 +00002963/**
Benny Prijono9fc735d2006-05-28 14:58:12 +00002964 * Get maximum number of calls configured in pjsua.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00002965 *
2966 * @return Maximum number of calls configured.
Benny Prijono9fc735d2006-05-28 14:58:12 +00002967 */
Benny Prijono8b1889b2006-06-06 18:40:40 +00002968PJ_DECL(unsigned) pjsua_call_get_max_count(void);
Benny Prijono9fc735d2006-05-28 14:58:12 +00002969
2970/**
Benny Prijonoeebe9af2006-06-13 22:57:13 +00002971 * Get number of currently active calls.
2972 *
2973 * @return Number of currently active calls.
Benny Prijono9fc735d2006-05-28 14:58:12 +00002974 */
Benny Prijono8b1889b2006-06-06 18:40:40 +00002975PJ_DECL(unsigned) pjsua_call_get_count(void);
Benny Prijono9fc735d2006-05-28 14:58:12 +00002976
2977/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00002978 * Enumerate all active calls. Application may then query the information and
2979 * state of each call by calling #pjsua_call_get_info().
Benny Prijonoeebe9af2006-06-13 22:57:13 +00002980 *
2981 * @param ids Array of account IDs to be initialized.
2982 * @param count In input, specifies the maximum number of elements.
2983 * On return, it contains the actual number of elements.
2984 *
2985 * @return PJ_SUCCESS on success, or the appropriate error code.
2986 */
2987PJ_DECL(pj_status_t) pjsua_enum_calls(pjsua_call_id ids[],
2988 unsigned *count);
2989
2990
2991/**
2992 * Make outgoing call to the specified URI using the specified account.
2993 *
2994 * @param acc_id The account to be used.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00002995 * @param dst_uri URI to be put in the To header (normally is the same
2996 * as the target URI).
2997 * @param options Options (must be zero at the moment).
2998 * @param user_data Arbitrary user data to be attached to the call, and
2999 * can be retrieved later.
3000 * @param msg_data Optional headers etc to be added to outgoing INVITE
3001 * request, or NULL if no custom header is desired.
3002 * @param p_call_id Pointer to receive call identification.
3003 *
3004 * @return PJ_SUCCESS on success, or the appropriate error code.
3005 */
3006PJ_DECL(pj_status_t) pjsua_call_make_call(pjsua_acc_id acc_id,
3007 const pj_str_t *dst_uri,
3008 unsigned options,
3009 void *user_data,
3010 const pjsua_msg_data *msg_data,
3011 pjsua_call_id *p_call_id);
3012
3013
3014/**
Benny Prijono9fc735d2006-05-28 14:58:12 +00003015 * Check if the specified call has active INVITE session and the INVITE
3016 * session has not been disconnected.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003017 *
3018 * @param call_id Call identification.
3019 *
3020 * @return Non-zero if call is active.
Benny Prijono9fc735d2006-05-28 14:58:12 +00003021 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003022PJ_DECL(pj_bool_t) pjsua_call_is_active(pjsua_call_id call_id);
Benny Prijono9fc735d2006-05-28 14:58:12 +00003023
3024
3025/**
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003026 * Check if call has an active media session.
3027 *
3028 * @param call_id Call identification.
3029 *
3030 * @return Non-zero if yes.
Benny Prijono9fc735d2006-05-28 14:58:12 +00003031 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003032PJ_DECL(pj_bool_t) pjsua_call_has_media(pjsua_call_id call_id);
Benny Prijono9fc735d2006-05-28 14:58:12 +00003033
3034
3035/**
Benny Prijonocf986c42008-09-02 11:25:07 +00003036 * Retrieve the media session associated with this call. Note that the media
3037 * session may not be available depending on the current call's media status
3038 * (the pjsua_call_media_status information in pjsua_call_info). Application
3039 * may use the media session to retrieve more detailed information about the
3040 * call's media.
3041 *
3042 * @param call_id Call identification.
3043 *
3044 * @return Call media session.
3045 */
3046PJ_DECL(pjmedia_session*) pjsua_call_get_media_session(pjsua_call_id call_id);
3047
3048
3049/**
3050 * Retrieve the media transport instance that is used for this call.
3051 * Application may use the media transport to query more detailed information
3052 * about the media transport.
3053 *
3054 * @param cid Call identification (the call_id).
3055 *
3056 * @return Call media transport.
3057 */
3058PJ_DECL(pjmedia_transport*) pjsua_call_get_media_transport(pjsua_call_id cid);
3059
3060
3061/**
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003062 * Get the conference port identification associated with the call.
3063 *
3064 * @param call_id Call identification.
3065 *
3066 * @return Conference port ID, or PJSUA_INVALID_ID when the
3067 * media has not been established or is not active.
Benny Prijono9fc735d2006-05-28 14:58:12 +00003068 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003069PJ_DECL(pjsua_conf_port_id) pjsua_call_get_conf_port(pjsua_call_id call_id);
3070
3071/**
3072 * Obtain detail information about the specified call.
3073 *
3074 * @param call_id Call identification.
3075 * @param info Call info to be initialized.
3076 *
3077 * @return PJ_SUCCESS on success, or the appropriate error code.
3078 */
3079PJ_DECL(pj_status_t) pjsua_call_get_info(pjsua_call_id call_id,
Benny Prijono9fc735d2006-05-28 14:58:12 +00003080 pjsua_call_info *info);
3081
Nanang Izzuddin2a1b9ee2010-06-03 10:41:32 +00003082/**
3083 * Check if remote peer support the specified capability.
3084 *
3085 * @param call_id Call identification.
3086 * @param htype The header type to be checked, which value may be:
3087 * - PJSIP_H_ACCEPT
3088 * - PJSIP_H_ALLOW
3089 * - PJSIP_H_SUPPORTED
3090 * @param hname If htype specifies PJSIP_H_OTHER, then the header
3091 * name must be supplied in this argument. Otherwise the
3092 * value must be set to NULL.
3093 * @param token The capability token to check. For example, if \a
3094 * htype is PJSIP_H_ALLOW, then \a token specifies the
3095 * method names; if \a htype is PJSIP_H_SUPPORTED, then
3096 * \a token specifies the extension names such as
3097 * "100rel".
3098 *
3099 * @return PJSIP_DIALOG_CAP_SUPPORTED if the specified capability
3100 * is explicitly supported, see @pjsip_dialog_cap_status
3101 * for more info.
3102 */
3103PJ_DECL(pjsip_dialog_cap_status) pjsua_call_remote_has_cap(
3104 pjsua_call_id call_id,
3105 int htype,
3106 const pj_str_t *hname,
3107 const pj_str_t *token);
Benny Prijono9fc735d2006-05-28 14:58:12 +00003108
3109/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00003110 * Attach application specific data to the call. Application can then
3111 * inspect this data by calling #pjsua_call_get_user_data().
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003112 *
3113 * @param call_id Call identification.
3114 * @param user_data Arbitrary data to be attached to the call.
3115 *
3116 * @return The user data.
Benny Prijono9fc735d2006-05-28 14:58:12 +00003117 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003118PJ_DECL(pj_status_t) pjsua_call_set_user_data(pjsua_call_id call_id,
3119 void *user_data);
Benny Prijono9fc735d2006-05-28 14:58:12 +00003120
3121
3122/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00003123 * Get user data attached to the call, which has been previously set with
3124 * #pjsua_call_set_user_data().
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003125 *
3126 * @param call_id Call identification.
3127 *
3128 * @return The user data.
Benny Prijono268ca612006-02-07 12:34:11 +00003129 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003130PJ_DECL(void*) pjsua_call_get_user_data(pjsua_call_id call_id);
Benny Prijono84126ab2006-02-09 09:30:09 +00003131
3132
3133/**
Benny Prijono91a6a172007-10-31 08:59:29 +00003134 * Get the NAT type of remote's endpoint. This is a proprietary feature
3135 * of PJSUA-LIB which sends its NAT type in the SDP when \a nat_type_in_sdp
3136 * is set in #pjsua_config.
3137 *
3138 * This function can only be called after SDP has been received from remote,
3139 * which means for incoming call, this function can be called as soon as
3140 * call is received as long as incoming call contains SDP, and for outgoing
3141 * call, this function can be called only after SDP is received (normally in
3142 * 200/OK response to INVITE). As a general case, application should call
3143 * this function after or in \a on_call_media_state() callback.
3144 *
3145 * @param call_id Call identification.
3146 * @param p_type Pointer to store the NAT type. Application can then
3147 * retrieve the string description of the NAT type
3148 * by calling pj_stun_get_nat_name().
3149 *
3150 * @return PJ_SUCCESS on success.
3151 *
3152 * @see pjsua_get_nat_type(), nat_type_in_sdp
3153 */
3154PJ_DECL(pj_status_t) pjsua_call_get_rem_nat_type(pjsua_call_id call_id,
3155 pj_stun_nat_type *p_type);
3156
3157/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00003158 * Send response to incoming INVITE request. Depending on the status
3159 * code specified as parameter, this function may send provisional
3160 * response, establish the call, or terminate the call.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003161 *
3162 * @param call_id Incoming call identification.
3163 * @param code Status code, (100-699).
3164 * @param reason Optional reason phrase. If NULL, default text
3165 * will be used.
3166 * @param msg_data Optional list of headers etc to be added to outgoing
3167 * response message.
3168 *
3169 * @return PJ_SUCCESS on success, or the appropriate error code.
Benny Prijonoa91a0032006-02-26 21:23:45 +00003170 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003171PJ_DECL(pj_status_t) pjsua_call_answer(pjsua_call_id call_id,
3172 unsigned code,
3173 const pj_str_t *reason,
3174 const pjsua_msg_data *msg_data);
Benny Prijonoa91a0032006-02-26 21:23:45 +00003175
3176/**
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003177 * Hangup call by using method that is appropriate according to the
Benny Prijonob5388cf2007-01-04 22:45:08 +00003178 * call state. This function is different than answering the call with
3179 * 3xx-6xx response (with #pjsua_call_answer()), in that this function
3180 * will hangup the call regardless of the state and role of the call,
3181 * while #pjsua_call_answer() only works with incoming calls on EARLY
3182 * state.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003183 *
3184 * @param call_id Call identification.
3185 * @param code Optional status code to be sent when we're rejecting
3186 * incoming call. If the value is zero, "603/Decline"
3187 * will be sent.
3188 * @param reason Optional reason phrase to be sent when we're rejecting
3189 * incoming call. If NULL, default text will be used.
3190 * @param msg_data Optional list of headers etc to be added to outgoing
3191 * request/response message.
3192 *
3193 * @return PJ_SUCCESS on success, or the appropriate error code.
Benny Prijono26ff9062006-02-21 23:47:00 +00003194 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003195PJ_DECL(pj_status_t) pjsua_call_hangup(pjsua_call_id call_id,
3196 unsigned code,
3197 const pj_str_t *reason,
3198 const pjsua_msg_data *msg_data);
Benny Prijono26ff9062006-02-21 23:47:00 +00003199
Benny Prijono5e51a4e2008-11-27 00:06:46 +00003200/**
3201 * Accept or reject redirection response. Application MUST call this function
3202 * after it signaled PJSIP_REDIRECT_PENDING in the \a on_call_redirected()
3203 * callback, to notify the call whether to accept or reject the redirection
3204 * to the current target. Application can use the combination of
3205 * PJSIP_REDIRECT_PENDING command in \a on_call_redirected() callback and
3206 * this function to ask for user permission before redirecting the call.
3207 *
3208 * Note that if the application chooses to reject or stop redirection (by
3209 * using PJSIP_REDIRECT_REJECT or PJSIP_REDIRECT_STOP respectively), the
3210 * call disconnection callback will be called before this function returns.
3211 * And if the application rejects the target, the \a on_call_redirected()
3212 * callback may also be called before this function returns if there is
3213 * another target to try.
3214 *
3215 * @param call_id The call ID.
3216 * @param cmd Redirection operation to be applied to the current
3217 * target. The semantic of this argument is similar
3218 * to the description in the \a on_call_redirected()
3219 * callback, except that the PJSIP_REDIRECT_PENDING is
3220 * not accepted here.
3221 *
3222 * @return PJ_SUCCESS on successful operation.
3223 */
3224PJ_DECL(pj_status_t) pjsua_call_process_redirect(pjsua_call_id call_id,
3225 pjsip_redirect_op cmd);
Benny Prijono26ff9062006-02-21 23:47:00 +00003226
3227/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00003228 * Put the specified call on hold. This will send re-INVITE with the
3229 * appropriate SDP to inform remote that the call is being put on hold.
3230 * The final status of the request itself will be reported on the
3231 * \a on_call_media_state() callback, which inform the application that
3232 * the media state of the call has changed.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003233 *
3234 * @param call_id Call identification.
3235 * @param msg_data Optional message components to be sent with
3236 * the request.
3237 *
3238 * @return PJ_SUCCESS on success, or the appropriate error code.
Benny Prijono26ff9062006-02-21 23:47:00 +00003239 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003240PJ_DECL(pj_status_t) pjsua_call_set_hold(pjsua_call_id call_id,
3241 const pjsua_msg_data *msg_data);
Benny Prijono26ff9062006-02-21 23:47:00 +00003242
3243
3244/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00003245 * Send re-INVITE to release hold.
3246 * The final status of the request itself will be reported on the
3247 * \a on_call_media_state() callback, which inform the application that
3248 * the media state of the call has changed.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003249 *
3250 * @param call_id Call identification.
3251 * @param unhold If this argument is non-zero and the call is locally
3252 * held, this will release the local hold.
3253 * @param msg_data Optional message components to be sent with
3254 * the request.
3255 *
3256 * @return PJ_SUCCESS on success, or the appropriate error code.
Benny Prijono26ff9062006-02-21 23:47:00 +00003257 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003258PJ_DECL(pj_status_t) pjsua_call_reinvite(pjsua_call_id call_id,
3259 pj_bool_t unhold,
3260 const pjsua_msg_data *msg_data);
Benny Prijono26ff9062006-02-21 23:47:00 +00003261
Benny Prijonoc08682e2007-10-04 06:17:58 +00003262/**
3263 * Send UPDATE request.
3264 *
3265 * @param call_id Call identification.
3266 * @param options Must be zero for now.
3267 * @param msg_data Optional message components to be sent with
3268 * the request.
3269 *
3270 * @return PJ_SUCCESS on success, or the appropriate error code.
3271 */
3272PJ_DECL(pj_status_t) pjsua_call_update(pjsua_call_id call_id,
3273 unsigned options,
3274 const pjsua_msg_data *msg_data);
Benny Prijono26ff9062006-02-21 23:47:00 +00003275
3276/**
Benny Prijono053f5222006-11-11 16:16:04 +00003277 * Initiate call transfer to the specified address. This function will send
3278 * REFER request to instruct remote call party to initiate a new INVITE
3279 * session to the specified destination/target.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003280 *
Benny Prijonob5388cf2007-01-04 22:45:08 +00003281 * If application is interested to monitor the successfulness and
3282 * the progress of the transfer request, it can implement
3283 * \a on_call_transfer_status() callback which will report the progress
3284 * of the call transfer request.
3285 *
Benny Prijono053f5222006-11-11 16:16:04 +00003286 * @param call_id The call id to be transfered.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003287 * @param dest Address of new target to be contacted.
3288 * @param msg_data Optional message components to be sent with
3289 * the request.
3290 *
3291 * @return PJ_SUCCESS on success, or the appropriate error code.
Benny Prijono26ff9062006-02-21 23:47:00 +00003292 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003293PJ_DECL(pj_status_t) pjsua_call_xfer(pjsua_call_id call_id,
3294 const pj_str_t *dest,
3295 const pjsua_msg_data *msg_data);
Benny Prijono9fc735d2006-05-28 14:58:12 +00003296
3297/**
Benny Prijono053f5222006-11-11 16:16:04 +00003298 * Flag to indicate that "Require: replaces" should not be put in the
3299 * outgoing INVITE request caused by REFER request created by
3300 * #pjsua_call_xfer_replaces().
3301 */
3302#define PJSUA_XFER_NO_REQUIRE_REPLACES 1
3303
3304/**
3305 * Initiate attended call transfer. This function will send REFER request
3306 * to instruct remote call party to initiate new INVITE session to the URL
3307 * of \a dest_call_id. The party at \a dest_call_id then should "replace"
3308 * the call with us with the new call from the REFER recipient.
3309 *
3310 * @param call_id The call id to be transfered.
3311 * @param dest_call_id The call id to be replaced.
3312 * @param options Application may specify PJSUA_XFER_NO_REQUIRE_REPLACES
3313 * to suppress the inclusion of "Require: replaces" in
3314 * the outgoing INVITE request created by the REFER
3315 * request.
3316 * @param msg_data Optional message components to be sent with
3317 * the request.
3318 *
3319 * @return PJ_SUCCESS on success, or the appropriate error code.
3320 */
3321PJ_DECL(pj_status_t) pjsua_call_xfer_replaces(pjsua_call_id call_id,
3322 pjsua_call_id dest_call_id,
3323 unsigned options,
3324 const pjsua_msg_data *msg_data);
3325
3326/**
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003327 * Send DTMF digits to remote using RFC 2833 payload formats.
3328 *
3329 * @param call_id Call identification.
Benny Prijonoe6ead542007-01-31 20:53:31 +00003330 * @param digits DTMF string digits to be sent.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003331 *
3332 * @return PJ_SUCCESS on success, or the appropriate error code.
Benny Prijono9fc735d2006-05-28 14:58:12 +00003333 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003334PJ_DECL(pj_status_t) pjsua_call_dial_dtmf(pjsua_call_id call_id,
Benny Prijono9fc735d2006-05-28 14:58:12 +00003335 const pj_str_t *digits);
Benny Prijono26ff9062006-02-21 23:47:00 +00003336
Benny Prijono26ff9062006-02-21 23:47:00 +00003337/**
Benny Prijonob0808372006-03-02 21:18:58 +00003338 * Send instant messaging inside INVITE session.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003339 *
3340 * @param call_id Call identification.
3341 * @param mime_type Optional MIME type. If NULL, then "text/plain" is
3342 * assumed.
3343 * @param content The message content.
3344 * @param msg_data Optional list of headers etc to be included in outgoing
3345 * request. The body descriptor in the msg_data is
3346 * ignored.
3347 * @param user_data Optional user data, which will be given back when
3348 * the IM callback is called.
3349 *
3350 * @return PJ_SUCCESS on success, or the appropriate error code.
Benny Prijonob0808372006-03-02 21:18:58 +00003351 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003352PJ_DECL(pj_status_t) pjsua_call_send_im( pjsua_call_id call_id,
3353 const pj_str_t *mime_type,
3354 const pj_str_t *content,
3355 const pjsua_msg_data *msg_data,
3356 void *user_data);
Benny Prijonob0808372006-03-02 21:18:58 +00003357
3358
3359/**
3360 * Send IM typing indication inside INVITE session.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003361 *
3362 * @param call_id Call identification.
3363 * @param is_typing Non-zero to indicate to remote that local person is
3364 * currently typing an IM.
3365 * @param msg_data Optional list of headers etc to be included in outgoing
3366 * request.
3367 *
3368 * @return PJ_SUCCESS on success, or the appropriate error code.
Benny Prijonob0808372006-03-02 21:18:58 +00003369 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003370PJ_DECL(pj_status_t) pjsua_call_send_typing_ind(pjsua_call_id call_id,
3371 pj_bool_t is_typing,
3372 const pjsua_msg_data*msg_data);
Benny Prijonob0808372006-03-02 21:18:58 +00003373
3374/**
Benny Prijonofeb69f42007-10-05 09:12:26 +00003375 * Send arbitrary request with the call. This is useful for example to send
3376 * INFO request. Note that application should not use this function to send
3377 * requests which would change the invite session's state, such as re-INVITE,
3378 * UPDATE, PRACK, and BYE.
3379 *
3380 * @param call_id Call identification.
3381 * @param method SIP method of the request.
3382 * @param msg_data Optional message body and/or list of headers to be
3383 * included in outgoing request.
3384 *
3385 * @return PJ_SUCCESS on success, or the appropriate error code.
3386 */
3387PJ_DECL(pj_status_t) pjsua_call_send_request(pjsua_call_id call_id,
3388 const pj_str_t *method,
3389 const pjsua_msg_data *msg_data);
3390
3391
3392/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00003393 * Terminate all calls. This will initiate #pjsua_call_hangup() for all
3394 * currently active calls.
Benny Prijono834aee32006-02-19 01:38:06 +00003395 */
Benny Prijonodc39fe82006-05-26 12:17:46 +00003396PJ_DECL(void) pjsua_call_hangup_all(void);
Benny Prijono834aee32006-02-19 01:38:06 +00003397
3398
Benny Prijonob9b32ab2006-06-01 12:28:44 +00003399/**
3400 * Dump call and media statistics to string.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003401 *
3402 * @param call_id Call identification.
3403 * @param with_media Non-zero to include media information too.
3404 * @param buffer Buffer where the statistics are to be written to.
3405 * @param maxlen Maximum length of buffer.
3406 * @param indent Spaces for left indentation.
3407 *
3408 * @return PJ_SUCCESS on success.
Benny Prijonob9b32ab2006-06-01 12:28:44 +00003409 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003410PJ_DECL(pj_status_t) pjsua_call_dump(pjsua_call_id call_id,
3411 pj_bool_t with_media,
3412 char *buffer,
3413 unsigned maxlen,
3414 const char *indent);
Benny Prijonob9b32ab2006-06-01 12:28:44 +00003415
Benny Prijono9fc735d2006-05-28 14:58:12 +00003416/**
Benny Prijono312aff92006-06-17 04:08:30 +00003417 * @}
Benny Prijono9fc735d2006-05-28 14:58:12 +00003418 */
Benny Prijono834aee32006-02-19 01:38:06 +00003419
3420
3421/*****************************************************************************
Benny Prijono312aff92006-06-17 04:08:30 +00003422 * BUDDY API
Benny Prijono834aee32006-02-19 01:38:06 +00003423 */
3424
Benny Prijono312aff92006-06-17 04:08:30 +00003425
3426/**
Benny Prijonoe6ead542007-01-31 20:53:31 +00003427 * @defgroup PJSUA_LIB_BUDDY PJSUA-API Buddy, Presence, and Instant Messaging
Benny Prijono312aff92006-06-17 04:08:30 +00003428 * @ingroup PJSUA_LIB
3429 * @brief Buddy management, buddy's presence, and instant messaging.
3430 * @{
Benny Prijonoe6ead542007-01-31 20:53:31 +00003431 *
3432 * This section describes PJSUA-APIs related to buddies management,
3433 * presence management, and instant messaging.
Benny Prijono312aff92006-06-17 04:08:30 +00003434 */
3435
3436/**
3437 * Max buddies in buddy list.
3438 */
3439#ifndef PJSUA_MAX_BUDDIES
3440# define PJSUA_MAX_BUDDIES 256
3441#endif
3442
3443
3444/**
Benny Prijono6ab05322009-10-21 03:03:06 +00003445 * This specifies how long the library should wait before retrying failed
3446 * SUBSCRIBE request, and there is no rule to automatically resubscribe
3447 * (for example, no "retry-after" parameter in Subscription-State header).
3448 *
3449 * This also controls the duration before failed PUBLISH request will be
3450 * retried.
Benny Prijonoa17496a2007-10-31 10:20:31 +00003451 *
3452 * Default: 300 seconds
3453 */
3454#ifndef PJSUA_PRES_TIMER
3455# define PJSUA_PRES_TIMER 300
3456#endif
3457
3458
3459/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00003460 * This structure describes buddy configuration when adding a buddy to
3461 * the buddy list with #pjsua_buddy_add(). Application MUST initialize
3462 * the structure with #pjsua_buddy_config_default() to initialize this
3463 * structure with default configuration.
Benny Prijono312aff92006-06-17 04:08:30 +00003464 */
3465typedef struct pjsua_buddy_config
3466{
3467 /**
3468 * Buddy URL or name address.
3469 */
3470 pj_str_t uri;
3471
3472 /**
3473 * Specify whether presence subscription should start immediately.
3474 */
3475 pj_bool_t subscribe;
3476
Benny Prijono705e7842008-07-21 18:12:51 +00003477 /**
3478 * Specify arbitrary application data to be associated with with
3479 * the buddy object.
3480 */
3481 void *user_data;
3482
Benny Prijono312aff92006-06-17 04:08:30 +00003483} pjsua_buddy_config;
3484
3485
3486/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00003487 * This enumeration describes basic buddy's online status.
Benny Prijono312aff92006-06-17 04:08:30 +00003488 */
3489typedef enum pjsua_buddy_status
3490{
3491 /**
3492 * Online status is unknown (possibly because no presence subscription
3493 * has been established).
3494 */
3495 PJSUA_BUDDY_STATUS_UNKNOWN,
3496
3497 /**
Benny Prijonofc24e692007-01-27 18:31:51 +00003498 * Buddy is known to be online.
Benny Prijono312aff92006-06-17 04:08:30 +00003499 */
3500 PJSUA_BUDDY_STATUS_ONLINE,
3501
3502 /**
3503 * Buddy is offline.
3504 */
3505 PJSUA_BUDDY_STATUS_OFFLINE,
3506
3507} pjsua_buddy_status;
3508
3509
3510
3511/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00003512 * This structure describes buddy info, which can be retrieved by calling
3513 * #pjsua_buddy_get_info().
Benny Prijono312aff92006-06-17 04:08:30 +00003514 */
3515typedef struct pjsua_buddy_info
3516{
3517 /**
3518 * The buddy ID.
3519 */
3520 pjsua_buddy_id id;
3521
3522 /**
3523 * The full URI of the buddy, as specified in the configuration.
3524 */
3525 pj_str_t uri;
3526
3527 /**
3528 * Buddy's Contact, only available when presence subscription has
3529 * been established to the buddy.
3530 */
3531 pj_str_t contact;
3532
3533 /**
3534 * Buddy's online status.
3535 */
3536 pjsua_buddy_status status;
3537
3538 /**
3539 * Text to describe buddy's online status.
3540 */
3541 pj_str_t status_text;
3542
3543 /**
3544 * Flag to indicate that we should monitor the presence information for
3545 * this buddy (normally yes, unless explicitly disabled).
3546 */
3547 pj_bool_t monitor_pres;
3548
3549 /**
Benny Prijono63fba012008-07-17 14:19:10 +00003550 * If \a monitor_pres is enabled, this specifies the last state of the
3551 * presence subscription. If presence subscription session is currently
3552 * active, the value will be PJSIP_EVSUB_STATE_ACTIVE. If presence
3553 * subscription request has been rejected, the value will be
3554 * PJSIP_EVSUB_STATE_TERMINATED, and the termination reason will be
3555 * specified in \a sub_term_reason.
3556 */
3557 pjsip_evsub_state sub_state;
3558
3559 /**
Benny Prijonod06d8c52009-06-30 13:53:47 +00003560 * String representation of subscription state.
3561 */
3562 const char *sub_state_name;
3563
3564 /**
Benny Prijono73bb7232009-10-20 13:56:26 +00003565 * Specifies the last presence subscription termination code. This would
3566 * return the last status of the SUBSCRIBE request. If the subscription
3567 * is terminated with NOTIFY by the server, this value will be set to
3568 * 200, and subscription termination reason will be given in the
3569 * \a sub_term_reason field.
3570 */
3571 unsigned sub_term_code;
3572
3573 /**
3574 * Specifies the last presence subscription termination reason. If
Benny Prijono63fba012008-07-17 14:19:10 +00003575 * presence subscription is currently active, the value will be empty.
3576 */
3577 pj_str_t sub_term_reason;
3578
3579 /**
Benny Prijono4461c7d2007-08-25 13:36:15 +00003580 * Extended RPID information about the person.
3581 */
3582 pjrpid_element rpid;
3583
3584 /**
Benny Prijono28add7e2009-06-15 16:03:40 +00003585 * Extended presence info.
3586 */
3587 pjsip_pres_status pres_status;
3588
3589 /**
Benny Prijono312aff92006-06-17 04:08:30 +00003590 * Internal buffer.
3591 */
Benny Prijono4461c7d2007-08-25 13:36:15 +00003592 char buf_[512];
Benny Prijono312aff92006-06-17 04:08:30 +00003593
3594} pjsua_buddy_info;
3595
3596
Benny Prijono834aee32006-02-19 01:38:06 +00003597/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00003598 * Set default values to the buddy config.
3599 */
Benny Prijono1f61a8f2007-08-16 10:11:44 +00003600PJ_DECL(void) pjsua_buddy_config_default(pjsua_buddy_config *cfg);
Benny Prijonob5388cf2007-01-04 22:45:08 +00003601
3602
3603/**
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003604 * Get total number of buddies.
3605 *
3606 * @return Number of buddies.
Benny Prijono9fc735d2006-05-28 14:58:12 +00003607 */
3608PJ_DECL(unsigned) pjsua_get_buddy_count(void);
3609
3610
3611/**
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003612 * Check if buddy ID is valid.
3613 *
3614 * @param buddy_id Buddy ID to check.
3615 *
3616 * @return Non-zero if buddy ID is valid.
Benny Prijono9fc735d2006-05-28 14:58:12 +00003617 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003618PJ_DECL(pj_bool_t) pjsua_buddy_is_valid(pjsua_buddy_id buddy_id);
3619
3620
3621/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00003622 * Enumerate all buddy IDs in the buddy list. Application then can use
3623 * #pjsua_buddy_get_info() to get the detail information for each buddy
3624 * id.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003625 *
3626 * @param ids Array of ids to be initialized.
3627 * @param count On input, specifies max elements in the array.
3628 * On return, it contains actual number of elements
3629 * that have been initialized.
3630 *
3631 * @return PJ_SUCCESS on success, or the appropriate error code.
3632 */
3633PJ_DECL(pj_status_t) pjsua_enum_buddies(pjsua_buddy_id ids[],
3634 unsigned *count);
3635
3636/**
Benny Prijono705e7842008-07-21 18:12:51 +00003637 * Find the buddy ID with the specified URI.
3638 *
3639 * @param uri The buddy URI.
3640 *
3641 * @return The buddy ID, or PJSUA_INVALID_ID if not found.
3642 */
3643PJ_DECL(pjsua_buddy_id) pjsua_buddy_find(const pj_str_t *uri);
3644
3645
3646/**
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003647 * Get detailed buddy info.
3648 *
3649 * @param buddy_id The buddy identification.
3650 * @param info Pointer to receive information about buddy.
3651 *
3652 * @return PJ_SUCCESS on success, or the appropriate error code.
3653 */
3654PJ_DECL(pj_status_t) pjsua_buddy_get_info(pjsua_buddy_id buddy_id,
Benny Prijono9fc735d2006-05-28 14:58:12 +00003655 pjsua_buddy_info *info);
3656
3657/**
Benny Prijono705e7842008-07-21 18:12:51 +00003658 * Set the user data associated with the buddy object.
3659 *
3660 * @param buddy_id The buddy identification.
3661 * @param user_data Arbitrary application data to be associated with
3662 * the buddy object.
3663 *
3664 * @return PJ_SUCCESS on success, or the appropriate error code.
3665 */
3666PJ_DECL(pj_status_t) pjsua_buddy_set_user_data(pjsua_buddy_id buddy_id,
3667 void *user_data);
3668
3669
3670/**
3671 * Get the user data associated with the budy object.
3672 *
3673 * @param buddy_id The buddy identification.
3674 *
3675 * @return The application data.
3676 */
3677PJ_DECL(void*) pjsua_buddy_get_user_data(pjsua_buddy_id buddy_id);
3678
3679
3680/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00003681 * Add new buddy to the buddy list. If presence subscription is enabled
3682 * for this buddy, this function will also start the presence subscription
3683 * session immediately.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003684 *
Benny Prijonoa7b376b2008-01-25 16:06:33 +00003685 * @param buddy_cfg Buddy configuration.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003686 * @param p_buddy_id Pointer to receive buddy ID.
3687 *
3688 * @return PJ_SUCCESS on success, or the appropriate error code.
Benny Prijono9fc735d2006-05-28 14:58:12 +00003689 */
Benny Prijonoe6ead542007-01-31 20:53:31 +00003690PJ_DECL(pj_status_t) pjsua_buddy_add(const pjsua_buddy_config *buddy_cfg,
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003691 pjsua_buddy_id *p_buddy_id);
Benny Prijono8b1889b2006-06-06 18:40:40 +00003692
3693
3694/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00003695 * Delete the specified buddy from the buddy list. Any presence subscription
3696 * to this buddy will be terminated.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003697 *
3698 * @param buddy_id Buddy identification.
3699 *
3700 * @return PJ_SUCCESS on success, or the appropriate error code.
Benny Prijono8b1889b2006-06-06 18:40:40 +00003701 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003702PJ_DECL(pj_status_t) pjsua_buddy_del(pjsua_buddy_id buddy_id);
Benny Prijono9fc735d2006-05-28 14:58:12 +00003703
3704
3705/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00003706 * Enable/disable buddy's presence monitoring. Once buddy's presence is
3707 * subscribed, application will be informed about buddy's presence status
3708 * changed via \a on_buddy_state() callback.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003709 *
3710 * @param buddy_id Buddy identification.
3711 * @param subscribe Specify non-zero to activate presence subscription to
3712 * the specified buddy.
3713 *
3714 * @return PJ_SUCCESS on success, or the appropriate error code.
Benny Prijono9fc735d2006-05-28 14:58:12 +00003715 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003716PJ_DECL(pj_status_t) pjsua_buddy_subscribe_pres(pjsua_buddy_id buddy_id,
3717 pj_bool_t subscribe);
Benny Prijono9fc735d2006-05-28 14:58:12 +00003718
3719
3720/**
Benny Prijono10861432007-10-31 10:54:53 +00003721 * Update the presence information for the buddy. Although the library
3722 * periodically refreshes the presence subscription for all buddies, some
3723 * application may want to refresh the buddy's presence subscription
3724 * immediately, and in this case it can use this function to accomplish
3725 * this.
3726 *
3727 * Note that the buddy's presence subscription will only be initiated
3728 * if presence monitoring is enabled for the buddy. See
3729 * #pjsua_buddy_subscribe_pres() for more info. Also if presence subscription
3730 * for the buddy is already active, this function will not do anything.
3731 *
3732 * Once the presence subscription is activated successfully for the buddy,
3733 * application will be notified about the buddy's presence status in the
3734 * on_buddy_state() callback.
3735 *
3736 * @param buddy_id Buddy identification.
3737 *
3738 * @return PJ_SUCCESS on success, or the appropriate error code.
3739 */
3740PJ_DECL(pj_status_t) pjsua_buddy_update_pres(pjsua_buddy_id buddy_id);
3741
3742
3743/**
Benny Prijono63fba012008-07-17 14:19:10 +00003744 * Send NOTIFY to inform account presence status or to terminate server
3745 * side presence subscription. If application wants to reject the incoming
3746 * request, it should set the \a state to PJSIP_EVSUB_STATE_TERMINATED.
3747 *
3748 * @param acc_id Account ID.
3749 * @param srv_pres Server presence subscription instance.
3750 * @param state New state to set.
3751 * @param state_str Optionally specify the state string name, if state
3752 * is not "active", "pending", or "terminated".
3753 * @param reason If the new state is PJSIP_EVSUB_STATE_TERMINATED,
3754 * optionally specify the termination reason.
3755 * @param with_body If the new state is PJSIP_EVSUB_STATE_TERMINATED,
3756 * this specifies whether the NOTIFY request should
3757 * contain message body containing account's presence
3758 * information.
3759 * @param msg_data Optional list of headers to be sent with the NOTIFY
3760 * request.
3761 *
3762 * @return PJ_SUCCESS on success.
3763 */
3764PJ_DECL(pj_status_t) pjsua_pres_notify(pjsua_acc_id acc_id,
3765 pjsua_srv_pres *srv_pres,
3766 pjsip_evsub_state state,
3767 const pj_str_t *state_str,
3768 const pj_str_t *reason,
3769 pj_bool_t with_body,
3770 const pjsua_msg_data *msg_data);
3771
3772/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00003773 * Dump presence subscriptions to log.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003774 *
3775 * @param verbose Yes or no.
Benny Prijono834aee32006-02-19 01:38:06 +00003776 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003777PJ_DECL(void) pjsua_pres_dump(pj_bool_t verbose);
Benny Prijono834aee32006-02-19 01:38:06 +00003778
3779
Benny Prijonob0808372006-03-02 21:18:58 +00003780/**
3781 * The MESSAGE method (defined in pjsua_im.c)
3782 */
3783extern const pjsip_method pjsip_message_method;
3784
3785
Benny Prijonob0808372006-03-02 21:18:58 +00003786
3787/**
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003788 * Send instant messaging outside dialog, using the specified account for
3789 * route set and authentication.
3790 *
3791 * @param acc_id Account ID to be used to send the request.
3792 * @param to Remote URI.
3793 * @param mime_type Optional MIME type. If NULL, then "text/plain" is
3794 * assumed.
3795 * @param content The message content.
3796 * @param msg_data Optional list of headers etc to be included in outgoing
3797 * request. The body descriptor in the msg_data is
3798 * ignored.
3799 * @param user_data Optional user data, which will be given back when
3800 * the IM callback is called.
3801 *
3802 * @return PJ_SUCCESS on success, or the appropriate error code.
Benny Prijonob0808372006-03-02 21:18:58 +00003803 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003804PJ_DECL(pj_status_t) pjsua_im_send(pjsua_acc_id acc_id,
3805 const pj_str_t *to,
3806 const pj_str_t *mime_type,
3807 const pj_str_t *content,
3808 const pjsua_msg_data *msg_data,
3809 void *user_data);
Benny Prijonob0808372006-03-02 21:18:58 +00003810
3811
3812/**
3813 * Send typing indication outside dialog.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003814 *
3815 * @param acc_id Account ID to be used to send the request.
3816 * @param to Remote URI.
3817 * @param is_typing If non-zero, it tells remote person that local person
3818 * is currently composing an IM.
3819 * @param msg_data Optional list of headers etc to be added to outgoing
3820 * request.
3821 *
3822 * @return PJ_SUCCESS on success, or the appropriate error code.
Benny Prijonob0808372006-03-02 21:18:58 +00003823 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +00003824PJ_DECL(pj_status_t) pjsua_im_typing(pjsua_acc_id acc_id,
3825 const pj_str_t *to,
3826 pj_bool_t is_typing,
3827 const pjsua_msg_data *msg_data);
Benny Prijonob0808372006-03-02 21:18:58 +00003828
3829
Benny Prijonof3195072006-02-14 21:15:30 +00003830
Benny Prijono312aff92006-06-17 04:08:30 +00003831/**
3832 * @}
Benny Prijono9fc735d2006-05-28 14:58:12 +00003833 */
3834
Benny Prijono312aff92006-06-17 04:08:30 +00003835
3836/*****************************************************************************
3837 * MEDIA API
3838 */
3839
3840
3841/**
Benny Prijonoe6ead542007-01-31 20:53:31 +00003842 * @defgroup PJSUA_LIB_MEDIA PJSUA-API Media Manipulation
Benny Prijono312aff92006-06-17 04:08:30 +00003843 * @ingroup PJSUA_LIB
3844 * @brief Media manipulation.
3845 * @{
3846 *
3847 * PJSUA has rather powerful media features, which are built around the
Benny Prijonoe6ead542007-01-31 20:53:31 +00003848 * PJMEDIA conference bridge. Basically, all media "ports" (such as calls, WAV
3849 * players, WAV playlist, file recorders, sound device, tone generators, etc)
Benny Prijono312aff92006-06-17 04:08:30 +00003850 * are terminated in the conference bridge, and application can manipulate
Benny Prijonoe6ead542007-01-31 20:53:31 +00003851 * the interconnection between these terminations freely.
3852 *
3853 * The conference bridge provides powerful switching and mixing functionality
3854 * for application. With the conference bridge, each conference slot (e.g.
3855 * a call) can transmit to multiple destinations, and one destination can
3856 * receive from multiple sources. If more than one media terminations are
3857 * terminated in the same slot, the conference bridge will mix the signal
3858 * automatically.
Benny Prijono312aff92006-06-17 04:08:30 +00003859 *
3860 * Application connects one media termination/slot to another by calling
3861 * #pjsua_conf_connect() function. This will establish <b>unidirectional</b>
Benny Prijonoe6ead542007-01-31 20:53:31 +00003862 * media flow from the source termination to the sink termination. To
3863 * establish bidirectional media flow, application wound need to make another
3864 * call to #pjsua_conf_connect(), this time inverting the source and
3865 * destination slots in the parameter.
3866 *
3867 * For example, to stream a WAV file to remote call, application may use
Benny Prijono312aff92006-06-17 04:08:30 +00003868 * the following steps:
3869 *
3870 \code
3871
3872 pj_status_t stream_to_call( pjsua_call_id call_id )
3873 {
3874 pjsua_player_id player_id;
3875
3876 status = pjsua_player_create("mysong.wav", 0, NULL, &player_id);
3877 if (status != PJ_SUCCESS)
3878 return status;
3879
3880 status = pjsua_conf_connect( pjsua_player_get_conf_port(),
3881 pjsua_call_get_conf_port() );
3882 }
3883 \endcode
3884 *
3885 *
3886 * Other features of PJSUA media:
3887 * - efficient N to M interconnections between media terminations.
3888 * - media termination can be connected to itself to create loopback
3889 * media.
3890 * - the media termination may have different clock rates, and resampling
3891 * will be done automatically by conference bridge.
3892 * - media terminations may also have different frame time; the
3893 * conference bridge will perform the necessary bufferring to adjust
3894 * the difference between terminations.
3895 * - interconnections are removed automatically when media termination
3896 * is removed from the bridge.
3897 * - sound device may be changed even when there are active media
3898 * interconnections.
3899 * - correctly report call's media quality (in #pjsua_call_dump()) from
3900 * RTCP packet exchange.
3901 */
3902
3903/**
Benny Prijono37c710b2008-01-10 12:09:26 +00003904 * Max ports in the conference bridge. This setting is the default value
3905 * for pjsua_media_config.max_media_ports.
Benny Prijono312aff92006-06-17 04:08:30 +00003906 */
3907#ifndef PJSUA_MAX_CONF_PORTS
Benny Prijono12a669c2006-11-23 07:32:13 +00003908# define PJSUA_MAX_CONF_PORTS 254
Benny Prijono312aff92006-06-17 04:08:30 +00003909#endif
3910
Benny Prijonob5388cf2007-01-04 22:45:08 +00003911/**
Benny Prijono37c710b2008-01-10 12:09:26 +00003912 * The default clock rate to be used by the conference bridge. This setting
3913 * is the default value for pjsua_media_config.clock_rate.
Benny Prijonob5388cf2007-01-04 22:45:08 +00003914 */
Benny Prijono12a669c2006-11-23 07:32:13 +00003915#ifndef PJSUA_DEFAULT_CLOCK_RATE
3916# define PJSUA_DEFAULT_CLOCK_RATE 16000
3917#endif
3918
Benny Prijonob5388cf2007-01-04 22:45:08 +00003919/**
Benny Prijono37c710b2008-01-10 12:09:26 +00003920 * Default frame length in the conference bridge. This setting
3921 * is the default value for pjsua_media_config.audio_frame_ptime.
3922 */
3923#ifndef PJSUA_DEFAULT_AUDIO_FRAME_PTIME
Nanang Izzuddinaf974842008-05-08 09:51:16 +00003924# define PJSUA_DEFAULT_AUDIO_FRAME_PTIME 20
Benny Prijono37c710b2008-01-10 12:09:26 +00003925#endif
3926
3927
3928/**
3929 * Default codec quality settings. This setting is the default value
3930 * for pjsua_media_config.quality.
Benny Prijonob5388cf2007-01-04 22:45:08 +00003931 */
Benny Prijono12a669c2006-11-23 07:32:13 +00003932#ifndef PJSUA_DEFAULT_CODEC_QUALITY
Nanang Izzuddin9dbad152008-06-10 18:56:10 +00003933# define PJSUA_DEFAULT_CODEC_QUALITY 8
Benny Prijono12a669c2006-11-23 07:32:13 +00003934#endif
3935
Benny Prijonob5388cf2007-01-04 22:45:08 +00003936/**
Benny Prijono37c710b2008-01-10 12:09:26 +00003937 * Default iLBC mode. This setting is the default value for
3938 * pjsua_media_config.ilbc_mode.
Benny Prijonob5388cf2007-01-04 22:45:08 +00003939 */
Benny Prijono12a669c2006-11-23 07:32:13 +00003940#ifndef PJSUA_DEFAULT_ILBC_MODE
Benny Prijono37c710b2008-01-10 12:09:26 +00003941# define PJSUA_DEFAULT_ILBC_MODE 30
Benny Prijono12a669c2006-11-23 07:32:13 +00003942#endif
3943
Benny Prijonob5388cf2007-01-04 22:45:08 +00003944/**
Benny Prijono37c710b2008-01-10 12:09:26 +00003945 * The default echo canceller tail length. This setting
3946 * is the default value for pjsua_media_config.ec_tail_len.
Benny Prijonob5388cf2007-01-04 22:45:08 +00003947 */
Benny Prijono12a669c2006-11-23 07:32:13 +00003948#ifndef PJSUA_DEFAULT_EC_TAIL_LEN
Benny Prijono427439c2007-10-21 09:41:24 +00003949# define PJSUA_DEFAULT_EC_TAIL_LEN 200
Benny Prijono12a669c2006-11-23 07:32:13 +00003950#endif
Benny Prijono312aff92006-06-17 04:08:30 +00003951
3952
3953/**
Benny Prijonocba59d92007-02-16 09:22:56 +00003954 * The maximum file player.
3955 */
3956#ifndef PJSUA_MAX_PLAYERS
3957# define PJSUA_MAX_PLAYERS 32
3958#endif
3959
3960
3961/**
3962 * The maximum file player.
3963 */
3964#ifndef PJSUA_MAX_RECORDERS
3965# define PJSUA_MAX_RECORDERS 32
3966#endif
3967
3968
3969/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00003970 * This structure describes media configuration, which will be specified
3971 * when calling #pjsua_init(). Application MUST initialize this structure
3972 * by calling #pjsua_media_config_default().
Benny Prijono312aff92006-06-17 04:08:30 +00003973 */
3974struct pjsua_media_config
3975{
3976 /**
3977 * Clock rate to be applied to the conference bridge.
Benny Prijonob5388cf2007-01-04 22:45:08 +00003978 * If value is zero, default clock rate will be used
3979 * (PJSUA_DEFAULT_CLOCK_RATE, which by default is 16KHz).
Benny Prijono312aff92006-06-17 04:08:30 +00003980 */
3981 unsigned clock_rate;
3982
3983 /**
Benny Prijonof3758ee2008-02-26 15:32:16 +00003984 * Clock rate to be applied when opening the sound device.
3985 * If value is zero, conference bridge clock rate will be used.
3986 */
3987 unsigned snd_clock_rate;
3988
3989 /**
Benny Prijono7d60d052008-03-29 12:24:20 +00003990 * Channel count be applied when opening the sound device and
3991 * conference bridge.
3992 */
3993 unsigned channel_count;
3994
3995 /**
Benny Prijonocf0b4b22007-10-06 17:31:09 +00003996 * Specify audio frame ptime. The value here will affect the
3997 * samples per frame of both the sound device and the conference
3998 * bridge. Specifying lower ptime will normally reduce the
3999 * latency.
4000 *
Benny Prijono37c710b2008-01-10 12:09:26 +00004001 * Default value: PJSUA_DEFAULT_AUDIO_FRAME_PTIME
Benny Prijonocf0b4b22007-10-06 17:31:09 +00004002 */
4003 unsigned audio_frame_ptime;
4004
4005 /**
Benny Prijono312aff92006-06-17 04:08:30 +00004006 * Specify maximum number of media ports to be created in the
4007 * conference bridge. Since all media terminate in the bridge
4008 * (calls, file player, file recorder, etc), the value must be
4009 * large enough to support all of them. However, the larger
4010 * the value, the more computations are performed.
Benny Prijono37c710b2008-01-10 12:09:26 +00004011 *
4012 * Default value: PJSUA_MAX_CONF_PORTS
Benny Prijono312aff92006-06-17 04:08:30 +00004013 */
4014 unsigned max_media_ports;
4015
4016 /**
4017 * Specify whether the media manager should manage its own
4018 * ioqueue for the RTP/RTCP sockets. If yes, ioqueue will be created
4019 * and at least one worker thread will be created too. If no,
4020 * the RTP/RTCP sockets will share the same ioqueue as SIP sockets,
4021 * and no worker thread is needed.
4022 *
4023 * Normally application would say yes here, unless it wants to
4024 * run everything from a single thread.
4025 */
4026 pj_bool_t has_ioqueue;
4027
4028 /**
4029 * Specify the number of worker threads to handle incoming RTP
4030 * packets. A value of one is recommended for most applications.
4031 */
4032 unsigned thread_cnt;
4033
Benny Prijono0498d902006-06-19 14:49:14 +00004034 /**
4035 * Media quality, 0-10, according to this table:
Benny Prijono7ca96da2006-08-07 12:11:40 +00004036 * 5-10: resampling use large filter,
4037 * 3-4: resampling use small filter,
Benny Prijono0498d902006-06-19 14:49:14 +00004038 * 1-2: resampling use linear.
4039 * The media quality also sets speex codec quality/complexity to the
4040 * number.
4041 *
Benny Prijono70972992006-08-05 11:13:58 +00004042 * Default: 5 (PJSUA_DEFAULT_CODEC_QUALITY).
Benny Prijono0498d902006-06-19 14:49:14 +00004043 */
4044 unsigned quality;
Benny Prijono0a12f002006-07-26 17:05:39 +00004045
4046 /**
Benny Prijonocf0b4b22007-10-06 17:31:09 +00004047 * Specify default codec ptime.
Benny Prijono0a12f002006-07-26 17:05:39 +00004048 *
4049 * Default: 0 (codec specific)
4050 */
4051 unsigned ptime;
4052
4053 /**
4054 * Disable VAD?
4055 *
4056 * Default: 0 (no (meaning VAD is enabled))
4057 */
4058 pj_bool_t no_vad;
Benny Prijono00cae612006-07-31 15:19:36 +00004059
4060 /**
4061 * iLBC mode (20 or 30).
4062 *
Benny Prijono37c710b2008-01-10 12:09:26 +00004063 * Default: 30 (PJSUA_DEFAULT_ILBC_MODE)
Benny Prijono00cae612006-07-31 15:19:36 +00004064 */
4065 unsigned ilbc_mode;
4066
4067 /**
4068 * Percentage of RTP packet to drop in TX direction
4069 * (to simulate packet lost).
4070 *
4071 * Default: 0
4072 */
4073 unsigned tx_drop_pct;
4074
4075 /**
4076 * Percentage of RTP packet to drop in RX direction
4077 * (to simulate packet lost).
4078 *
4079 * Default: 0
4080 */
4081 unsigned rx_drop_pct;
4082
Benny Prijonoc8e24a12006-08-02 18:22:22 +00004083 /**
Benny Prijono5da50432006-08-07 10:24:52 +00004084 * Echo canceller options (see #pjmedia_echo_create())
4085 *
4086 * Default: 0.
4087 */
4088 unsigned ec_options;
4089
4090 /**
Benny Prijonoc8e24a12006-08-02 18:22:22 +00004091 * Echo canceller tail length, in miliseconds.
4092 *
Benny Prijono669643c2006-09-20 20:02:18 +00004093 * Default: PJSUA_DEFAULT_EC_TAIL_LEN
Benny Prijonoc8e24a12006-08-02 18:22:22 +00004094 */
4095 unsigned ec_tail_len;
Benny Prijono1d0ca0c2006-11-21 09:06:47 +00004096
Benny Prijono10454dc2009-02-21 14:21:59 +00004097 /**
4098 * Audio capture buffer length, in milliseconds.
4099 *
4100 * Default: PJMEDIA_SND_DEFAULT_REC_LATENCY
4101 */
4102 unsigned snd_rec_latency;
4103
4104 /**
4105 * Audio playback buffer length, in milliseconds.
4106 *
4107 * Default: PJMEDIA_SND_DEFAULT_PLAY_LATENCY
4108 */
4109 unsigned snd_play_latency;
4110
Benny Prijono1d0ca0c2006-11-21 09:06:47 +00004111 /**
4112 * Jitter buffer initial prefetch delay in msec. The value must be
4113 * between jb_min_pre and jb_max_pre below.
4114 *
4115 * Default: -1 (to use default stream settings, currently 150 msec)
4116 */
4117 int jb_init;
4118
4119 /**
4120 * Jitter buffer minimum prefetch delay in msec.
4121 *
4122 * Default: -1 (to use default stream settings, currently 60 msec)
4123 */
4124 int jb_min_pre;
4125
4126 /**
4127 * Jitter buffer maximum prefetch delay in msec.
4128 *
4129 * Default: -1 (to use default stream settings, currently 240 msec)
4130 */
4131 int jb_max_pre;
4132
4133 /**
4134 * Set maximum delay that can be accomodated by the jitter buffer msec.
4135 *
4136 * Default: -1 (to use default stream settings, currently 360 msec)
4137 */
4138 int jb_max;
4139
Benny Prijonoc97608e2007-03-23 16:34:20 +00004140 /**
4141 * Enable ICE
4142 */
4143 pj_bool_t enable_ice;
4144
4145 /**
Benny Prijono329d6382009-05-29 13:04:03 +00004146 * Set the maximum number of host candidates.
4147 *
4148 * Default: -1 (maximum not set)
Benny Prijonoc97608e2007-03-23 16:34:20 +00004149 */
Benny Prijono329d6382009-05-29 13:04:03 +00004150 int ice_max_host_cands;
4151
4152 /**
4153 * ICE session options.
4154 */
4155 pj_ice_sess_options ice_opt;
Benny Prijonof76e1392008-06-06 14:51:48 +00004156
4157 /**
Benny Prijono551af422008-08-07 09:55:52 +00004158 * Disable RTCP component.
4159 *
4160 * Default: no
4161 */
4162 pj_bool_t ice_no_rtcp;
4163
4164 /**
Benny Prijonof76e1392008-06-06 14:51:48 +00004165 * Enable TURN relay candidate in ICE.
4166 */
4167 pj_bool_t enable_turn;
4168
4169 /**
4170 * Specify TURN domain name or host name, in in "DOMAIN:PORT" or
4171 * "HOST:PORT" format.
4172 */
4173 pj_str_t turn_server;
4174
4175 /**
4176 * Specify the connection type to be used to the TURN server. Valid
4177 * values are PJ_TURN_TP_UDP or PJ_TURN_TP_TCP.
4178 *
4179 * Default: PJ_TURN_TP_UDP
4180 */
4181 pj_turn_tp_type turn_conn_type;
4182
4183 /**
4184 * Specify the credential to authenticate with the TURN server.
4185 */
4186 pj_stun_auth_cred turn_auth_cred;
Nanang Izzuddin68559c32008-06-13 17:01:46 +00004187
4188 /**
4189 * Specify idle time of sound device before it is automatically closed,
Benny Prijonof798e502009-03-09 13:08:16 +00004190 * in seconds. Use value -1 to disable the auto-close feature of sound
4191 * device
Nanang Izzuddin68559c32008-06-13 17:01:46 +00004192 *
Benny Prijonof798e502009-03-09 13:08:16 +00004193 * Default : 1
Nanang Izzuddin68559c32008-06-13 17:01:46 +00004194 */
4195 int snd_auto_close_time;
Benny Prijono312aff92006-06-17 04:08:30 +00004196};
4197
4198
4199/**
4200 * Use this function to initialize media config.
4201 *
4202 * @param cfg The media config to be initialized.
4203 */
Benny Prijono1f61a8f2007-08-16 10:11:44 +00004204PJ_DECL(void) pjsua_media_config_default(pjsua_media_config *cfg);
Benny Prijono312aff92006-06-17 04:08:30 +00004205
4206
4207/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00004208 * This structure describes codec information, which can be retrieved by
4209 * calling #pjsua_enum_codecs().
Benny Prijono312aff92006-06-17 04:08:30 +00004210 */
4211typedef struct pjsua_codec_info
4212{
4213 /**
4214 * Codec unique identification.
4215 */
4216 pj_str_t codec_id;
4217
4218 /**
4219 * Codec priority (integer 0-255).
4220 */
4221 pj_uint8_t priority;
4222
4223 /**
4224 * Internal buffer.
4225 */
4226 char buf_[32];
4227
4228} pjsua_codec_info;
4229
4230
4231/**
Benny Prijonob5388cf2007-01-04 22:45:08 +00004232 * This structure descibes information about a particular media port that
4233 * has been registered into the conference bridge. Application can query
4234 * this info by calling #pjsua_conf_get_port_info().
Benny Prijono312aff92006-06-17 04:08:30 +00004235 */
4236typedef struct pjsua_conf_port_info
4237{
4238 /** Conference port number. */
4239 pjsua_conf_port_id slot_id;
4240
4241 /** Port name. */
4242 pj_str_t name;
4243
4244 /** Clock rate. */
4245 unsigned clock_rate;
4246
4247 /** Number of channels. */
4248 unsigned channel_count;
4249
4250 /** Samples per frame */
4251 unsigned samples_per_frame;
4252
4253 /** Bits per sample */
4254 unsigned bits_per_sample;
4255
4256 /** Number of listeners in the array. */
4257 unsigned listener_cnt;
4258
4259 /** Array of listeners (in other words, ports where this port is
4260 * transmitting to.
4261 */
4262 pjsua_conf_port_id listeners[PJSUA_MAX_CONF_PORTS];
4263
4264} pjsua_conf_port_info;
4265
4266
4267/**
4268 * This structure holds information about custom media transport to
4269 * be registered to pjsua.
4270 */
4271typedef struct pjsua_media_transport
4272{
4273 /**
4274 * Media socket information containing the address information
4275 * of the RTP and RTCP socket.
4276 */
4277 pjmedia_sock_info skinfo;
4278
4279 /**
4280 * The media transport instance.
4281 */
4282 pjmedia_transport *transport;
4283
4284} pjsua_media_transport;
4285
4286
4287
4288
Benny Prijono9fc735d2006-05-28 14:58:12 +00004289/**
4290 * Get maxinum number of conference ports.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004291 *
4292 * @return Maximum number of ports in the conference bridge.
Benny Prijono9fc735d2006-05-28 14:58:12 +00004293 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004294PJ_DECL(unsigned) pjsua_conf_get_max_ports(void);
Benny Prijono9fc735d2006-05-28 14:58:12 +00004295
4296
4297/**
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004298 * Get current number of active ports in the bridge.
4299 *
4300 * @return The number.
Benny Prijono9fc735d2006-05-28 14:58:12 +00004301 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004302PJ_DECL(unsigned) pjsua_conf_get_active_ports(void);
4303
4304
4305/**
4306 * Enumerate all conference ports.
4307 *
4308 * @param id Array of conference port ID to be initialized.
4309 * @param count On input, specifies max elements in the array.
4310 * On return, it contains actual number of elements
4311 * that have been initialized.
4312 *
4313 * @return PJ_SUCCESS on success, or the appropriate error code.
4314 */
4315PJ_DECL(pj_status_t) pjsua_enum_conf_ports(pjsua_conf_port_id id[],
4316 unsigned *count);
Benny Prijono8b1889b2006-06-06 18:40:40 +00004317
4318
4319/**
4320 * Get information about the specified conference port
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004321 *
Benny Prijonoe6ead542007-01-31 20:53:31 +00004322 * @param port_id Port identification.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004323 * @param info Pointer to store the port info.
4324 *
4325 * @return PJ_SUCCESS on success, or the appropriate error code.
Benny Prijono8b1889b2006-06-06 18:40:40 +00004326 */
Benny Prijonoe6ead542007-01-31 20:53:31 +00004327PJ_DECL(pj_status_t) pjsua_conf_get_port_info( pjsua_conf_port_id port_id,
Benny Prijono8b1889b2006-06-06 18:40:40 +00004328 pjsua_conf_port_info *info);
Benny Prijono9fc735d2006-05-28 14:58:12 +00004329
4330
4331/**
Benny Prijonoe909eac2006-07-27 22:04:56 +00004332 * Add arbitrary media port to PJSUA's conference bridge. Application
4333 * can use this function to add the media port that it creates. For
4334 * media ports that are created by PJSUA-LIB (such as calls, file player,
4335 * or file recorder), PJSUA-LIB will automatically add the port to
4336 * the bridge.
4337 *
4338 * @param pool Pool to use.
4339 * @param port Media port to be added to the bridge.
4340 * @param p_id Optional pointer to receive the conference
4341 * slot id.
4342 *
4343 * @return PJ_SUCCESS on success, or the appropriate error code.
4344 */
4345PJ_DECL(pj_status_t) pjsua_conf_add_port(pj_pool_t *pool,
4346 pjmedia_port *port,
4347 pjsua_conf_port_id *p_id);
4348
4349
4350/**
4351 * Remove arbitrary slot from the conference bridge. Application should only
Benny Prijonob5388cf2007-01-04 22:45:08 +00004352 * call this function if it registered the port manually with previous call
4353 * to #pjsua_conf_add_port().
Benny Prijonoe909eac2006-07-27 22:04:56 +00004354 *
Benny Prijonoe6ead542007-01-31 20:53:31 +00004355 * @param port_id The slot id of the port to be removed.
Benny Prijonoe909eac2006-07-27 22:04:56 +00004356 *
4357 * @return PJ_SUCCESS on success, or the appropriate error code.
4358 */
Benny Prijonoe6ead542007-01-31 20:53:31 +00004359PJ_DECL(pj_status_t) pjsua_conf_remove_port(pjsua_conf_port_id port_id);
Benny Prijonoe909eac2006-07-27 22:04:56 +00004360
4361
4362/**
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004363 * Establish unidirectional media flow from souce to sink. One source
4364 * may transmit to multiple destinations/sink. And if multiple
4365 * sources are transmitting to the same sink, the media will be mixed
4366 * together. Source and sink may refer to the same ID, effectively
4367 * looping the media.
4368 *
4369 * If bidirectional media flow is desired, application needs to call
4370 * this function twice, with the second one having the arguments
4371 * reversed.
4372 *
4373 * @param source Port ID of the source media/transmitter.
4374 * @param sink Port ID of the destination media/received.
4375 *
4376 * @return PJ_SUCCESS on success, or the appropriate error code.
Benny Prijono9fc735d2006-05-28 14:58:12 +00004377 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004378PJ_DECL(pj_status_t) pjsua_conf_connect(pjsua_conf_port_id source,
4379 pjsua_conf_port_id sink);
Benny Prijono9fc735d2006-05-28 14:58:12 +00004380
4381
4382/**
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004383 * Disconnect media flow from the source to destination port.
4384 *
4385 * @param source Port ID of the source media/transmitter.
4386 * @param sink Port ID of the destination media/received.
4387 *
4388 * @return PJ_SUCCESS on success, or the appropriate error code.
Benny Prijono9fc735d2006-05-28 14:58:12 +00004389 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004390PJ_DECL(pj_status_t) pjsua_conf_disconnect(pjsua_conf_port_id source,
4391 pjsua_conf_port_id sink);
Benny Prijono9fc735d2006-05-28 14:58:12 +00004392
4393
Benny Prijono6dd967c2006-12-26 02:27:14 +00004394/**
4395 * Adjust the signal level to be transmitted from the bridge to the
4396 * specified port by making it louder or quieter.
4397 *
4398 * @param slot The conference bridge slot number.
4399 * @param level Signal level adjustment. Value 1.0 means no level
4400 * adjustment, while value 0 means to mute the port.
4401 *
4402 * @return PJ_SUCCESS on success, or the appropriate error code.
4403 */
4404PJ_DECL(pj_status_t) pjsua_conf_adjust_tx_level(pjsua_conf_port_id slot,
4405 float level);
4406
4407/**
4408 * Adjust the signal level to be received from the specified port (to
4409 * the bridge) by making it louder or quieter.
4410 *
4411 * @param slot The conference bridge slot number.
4412 * @param level Signal level adjustment. Value 1.0 means no level
4413 * adjustment, while value 0 means to mute the port.
4414 *
4415 * @return PJ_SUCCESS on success, or the appropriate error code.
4416 */
4417PJ_DECL(pj_status_t) pjsua_conf_adjust_rx_level(pjsua_conf_port_id slot,
4418 float level);
4419
4420/**
4421 * Get last signal level transmitted to or received from the specified port.
4422 * The signal level is an integer value in zero to 255, with zero indicates
4423 * no signal, and 255 indicates the loudest signal level.
4424 *
4425 * @param slot The conference bridge slot number.
4426 * @param tx_level Optional argument to receive the level of signal
4427 * transmitted to the specified port (i.e. the direction
4428 * is from the bridge to the port).
4429 * @param rx_level Optional argument to receive the level of signal
4430 * received from the port (i.e. the direction is from the
4431 * port to the bridge).
4432 *
4433 * @return PJ_SUCCESS on success.
4434 */
4435PJ_DECL(pj_status_t) pjsua_conf_get_signal_level(pjsua_conf_port_id slot,
4436 unsigned *tx_level,
4437 unsigned *rx_level);
4438
Benny Prijono6dd967c2006-12-26 02:27:14 +00004439
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004440/*****************************************************************************
Benny Prijonoa66c3312007-01-21 23:12:40 +00004441 * File player and playlist.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004442 */
4443
Benny Prijono9fc735d2006-05-28 14:58:12 +00004444/**
Benny Prijonoa66c3312007-01-21 23:12:40 +00004445 * Create a file player, and automatically add this player to
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004446 * the conference bridge.
4447 *
4448 * @param filename The filename to be played. Currently only
Benny Prijono312aff92006-06-17 04:08:30 +00004449 * WAV files are supported, and the WAV file MUST be
4450 * formatted as 16bit PCM mono/single channel (any
4451 * clock rate is supported).
Benny Prijono58add7c2008-01-18 13:24:07 +00004452 * @param options Optional option flag. Application may specify
4453 * PJMEDIA_FILE_NO_LOOP to prevent playback loop.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004454 * @param p_id Pointer to receive player ID.
4455 *
4456 * @return PJ_SUCCESS on success, or the appropriate error code.
Benny Prijono9fc735d2006-05-28 14:58:12 +00004457 */
4458PJ_DECL(pj_status_t) pjsua_player_create(const pj_str_t *filename,
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004459 unsigned options,
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004460 pjsua_player_id *p_id);
Benny Prijono9fc735d2006-05-28 14:58:12 +00004461
4462
4463/**
Benny Prijonoa66c3312007-01-21 23:12:40 +00004464 * Create a file playlist media port, and automatically add the port
4465 * to the conference bridge.
4466 *
4467 * @param file_names Array of file names to be added to the play list.
4468 * Note that the files must have the same clock rate,
4469 * number of channels, and number of bits per sample.
4470 * @param file_count Number of files in the array.
4471 * @param label Optional label to be set for the media port.
4472 * @param options Optional option flag. Application may specify
4473 * PJMEDIA_FILE_NO_LOOP to prevent looping.
4474 * @param p_id Optional pointer to receive player ID.
4475 *
4476 * @return PJ_SUCCESS on success, or the appropriate error code.
4477 */
4478PJ_DECL(pj_status_t) pjsua_playlist_create(const pj_str_t file_names[],
4479 unsigned file_count,
4480 const pj_str_t *label,
4481 unsigned options,
4482 pjsua_player_id *p_id);
4483
4484/**
4485 * Get conference port ID associated with player or playlist.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004486 *
4487 * @param id The file player ID.
4488 *
4489 * @return Conference port ID associated with this player.
Benny Prijono9fc735d2006-05-28 14:58:12 +00004490 */
Benny Prijono8b1889b2006-06-06 18:40:40 +00004491PJ_DECL(pjsua_conf_port_id) pjsua_player_get_conf_port(pjsua_player_id id);
Benny Prijono9fc735d2006-05-28 14:58:12 +00004492
4493
4494/**
Benny Prijonoa66c3312007-01-21 23:12:40 +00004495 * Get the media port for the player or playlist.
Benny Prijono469b1522006-12-26 03:05:17 +00004496 *
4497 * @param id The player ID.
4498 * @param p_port The media port associated with the player.
4499 *
4500 * @return PJ_SUCCESS on success.
4501 */
Benny Prijono58add7c2008-01-18 13:24:07 +00004502PJ_DECL(pj_status_t) pjsua_player_get_port(pjsua_player_id id,
Benny Prijono469b1522006-12-26 03:05:17 +00004503 pjmedia_port **p_port);
4504
4505/**
Benny Prijonoa66c3312007-01-21 23:12:40 +00004506 * Set playback position. This operation is not valid for playlist.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004507 *
4508 * @param id The file player ID.
4509 * @param samples The playback position, in samples. Application can
4510 * specify zero to re-start the playback.
4511 *
4512 * @return PJ_SUCCESS on success, or the appropriate error code.
Benny Prijono9fc735d2006-05-28 14:58:12 +00004513 */
4514PJ_DECL(pj_status_t) pjsua_player_set_pos(pjsua_player_id id,
4515 pj_uint32_t samples);
4516
4517
4518/**
Benny Prijonoa66c3312007-01-21 23:12:40 +00004519 * Close the file of playlist, remove the player from the bridge, and free
4520 * resources associated with the file player or playlist.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004521 *
4522 * @param id The file player ID.
4523 *
4524 * @return PJ_SUCCESS on success, or the appropriate error code.
Benny Prijono9fc735d2006-05-28 14:58:12 +00004525 */
4526PJ_DECL(pj_status_t) pjsua_player_destroy(pjsua_player_id id);
4527
4528
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004529/*****************************************************************************
4530 * File recorder.
4531 */
Benny Prijono9fc735d2006-05-28 14:58:12 +00004532
4533/**
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004534 * Create a file recorder, and automatically connect this recorder to
Benny Prijonoc95a0f02007-04-09 07:06:08 +00004535 * the conference bridge. The recorder currently supports recording WAV file.
4536 * The type of the recorder to use is determined by the extension of the file
4537 * (e.g. ".wav").
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004538 *
Benny Prijonob3cdb2b2006-10-19 15:49:47 +00004539 * @param filename Output file name. The function will determine the
4540 * default format to be used based on the file extension.
Benny Prijonoc95a0f02007-04-09 07:06:08 +00004541 * Currently ".wav" is supported on all platforms.
Benny Prijono8f310522006-10-20 11:08:49 +00004542 * @param enc_type Optionally specify the type of encoder to be used to
4543 * compress the media, if the file can support different
4544 * encodings. This value must be zero for now.
4545 * @param enc_param Optionally specify codec specific parameter to be
Benny Prijonoc95a0f02007-04-09 07:06:08 +00004546 * passed to the file writer.
Benny Prijono8f310522006-10-20 11:08:49 +00004547 * For .WAV recorder, this value must be NULL.
4548 * @param max_size Maximum file size. Specify zero or -1 to remove size
4549 * limitation. This value must be zero or -1 for now.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004550 * @param options Optional options.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004551 * @param p_id Pointer to receive the recorder instance.
4552 *
4553 * @return PJ_SUCCESS on success, or the appropriate error code.
Benny Prijono9fc735d2006-05-28 14:58:12 +00004554 */
4555PJ_DECL(pj_status_t) pjsua_recorder_create(const pj_str_t *filename,
Benny Prijono8f310522006-10-20 11:08:49 +00004556 unsigned enc_type,
4557 void *enc_param,
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004558 pj_ssize_t max_size,
4559 unsigned options,
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004560 pjsua_recorder_id *p_id);
Benny Prijono9fc735d2006-05-28 14:58:12 +00004561
4562
4563/**
4564 * Get conference port associated with recorder.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004565 *
4566 * @param id The recorder ID.
4567 *
4568 * @return Conference port ID associated with this recorder.
Benny Prijono9fc735d2006-05-28 14:58:12 +00004569 */
Benny Prijono8b1889b2006-06-06 18:40:40 +00004570PJ_DECL(pjsua_conf_port_id) pjsua_recorder_get_conf_port(pjsua_recorder_id id);
Benny Prijono9fc735d2006-05-28 14:58:12 +00004571
4572
4573/**
Benny Prijono469b1522006-12-26 03:05:17 +00004574 * Get the media port for the recorder.
4575 *
4576 * @param id The recorder ID.
4577 * @param p_port The media port associated with the recorder.
4578 *
4579 * @return PJ_SUCCESS on success.
4580 */
4581PJ_DECL(pj_status_t) pjsua_recorder_get_port(pjsua_recorder_id id,
4582 pjmedia_port **p_port);
4583
4584
4585/**
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004586 * Destroy recorder (this will complete recording).
4587 *
4588 * @param id The recorder ID.
4589 *
4590 * @return PJ_SUCCESS on success, or the appropriate error code.
Benny Prijono9fc735d2006-05-28 14:58:12 +00004591 */
4592PJ_DECL(pj_status_t) pjsua_recorder_destroy(pjsua_recorder_id id);
4593
4594
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004595/*****************************************************************************
4596 * Sound devices.
4597 */
4598
Benny Prijono9fc735d2006-05-28 14:58:12 +00004599/**
Benny Prijonof798e502009-03-09 13:08:16 +00004600 * Enum all audio devices installed in the system.
4601 *
4602 * @param info Array of info to be initialized.
4603 * @param count On input, specifies max elements in the array.
4604 * On return, it contains actual number of elements
4605 * that have been initialized.
4606 *
4607 * @return PJ_SUCCESS on success, or the appropriate error code.
4608 */
4609PJ_DECL(pj_status_t) pjsua_enum_aud_devs(pjmedia_aud_dev_info info[],
4610 unsigned *count);
4611
4612/**
4613 * Enum all sound devices installed in the system (old API).
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004614 *
4615 * @param info Array of info to be initialized.
4616 * @param count On input, specifies max elements in the array.
4617 * On return, it contains actual number of elements
4618 * that have been initialized.
4619 *
4620 * @return PJ_SUCCESS on success, or the appropriate error code.
Benny Prijono9fc735d2006-05-28 14:58:12 +00004621 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004622PJ_DECL(pj_status_t) pjsua_enum_snd_devs(pjmedia_snd_dev_info info[],
4623 unsigned *count);
Benny Prijonoa3cbb1c2006-08-25 12:41:05 +00004624
4625/**
4626 * Get currently active sound devices. If sound devices has not been created
4627 * (for example when pjsua_start() is not called), it is possible that
4628 * the function returns PJ_SUCCESS with -1 as device IDs.
4629 *
4630 * @param capture_dev On return it will be filled with device ID of the
4631 * capture device.
4632 * @param playback_dev On return it will be filled with device ID of the
4633 * device ID of the playback device.
4634 *
4635 * @return PJ_SUCCESS on success, or the appropriate error code.
4636 */
4637PJ_DECL(pj_status_t) pjsua_get_snd_dev(int *capture_dev,
4638 int *playback_dev);
4639
4640
Benny Prijono9fc735d2006-05-28 14:58:12 +00004641/**
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004642 * Select or change sound device. Application may call this function at
4643 * any time to replace current sound device.
4644 *
4645 * @param capture_dev Device ID of the capture device.
4646 * @param playback_dev Device ID of the playback device.
4647 *
4648 * @return PJ_SUCCESS on success, or the appropriate error code.
Benny Prijono9fc735d2006-05-28 14:58:12 +00004649 */
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004650PJ_DECL(pj_status_t) pjsua_set_snd_dev(int capture_dev,
4651 int playback_dev);
4652
4653
4654/**
4655 * Set pjsua to use null sound device. The null sound device only provides
4656 * the timing needed by the conference bridge, and will not interract with
4657 * any hardware.
4658 *
4659 * @return PJ_SUCCESS on success, or the appropriate error code.
4660 */
4661PJ_DECL(pj_status_t) pjsua_set_null_snd_dev(void);
4662
4663
Benny Prijonoe909eac2006-07-27 22:04:56 +00004664/**
4665 * Disconnect the main conference bridge from any sound devices, and let
4666 * application connect the bridge to it's own sound device/master port.
4667 *
4668 * @return The port interface of the conference bridge,
4669 * so that application can connect this to it's own
4670 * sound device or master port.
4671 */
4672PJ_DECL(pjmedia_port*) pjsua_set_no_snd_dev(void);
4673
4674
Benny Prijonof20687a2006-08-04 18:27:19 +00004675/**
Benny Prijonoe506c8c2009-03-10 13:28:43 +00004676 * Change the echo cancellation settings.
Benny Prijonof798e502009-03-09 13:08:16 +00004677 *
4678 * The behavior of this function depends on whether the sound device is
4679 * currently active, and if it is, whether device or software AEC is
4680 * being used.
Benny Prijono10454dc2009-02-21 14:21:59 +00004681 *
4682 * If the sound device is currently active, and if the device supports AEC,
4683 * this function will forward the change request to the device and it will
4684 * be up to the device on whether support the request. If software AEC is
4685 * being used (the software EC will be used if the device does not support
4686 * AEC), this function will change the software EC settings. In all cases,
4687 * the setting will be saved for future opening of the sound device.
4688 *
4689 * If the sound device is not currently active, this will only change the
4690 * default AEC settings and the setting will be applied next time the
4691 * sound device is opened.
Benny Prijonof20687a2006-08-04 18:27:19 +00004692 *
4693 * @param tail_ms The tail length, in miliseconds. Set to zero to
4694 * disable AEC.
Benny Prijonoa7b376b2008-01-25 16:06:33 +00004695 * @param options Options to be passed to pjmedia_echo_create().
Benny Prijono5da50432006-08-07 10:24:52 +00004696 * Normally the value should be zero.
Benny Prijonof20687a2006-08-04 18:27:19 +00004697 *
4698 * @return PJ_SUCCESS on success.
4699 */
Benny Prijono5da50432006-08-07 10:24:52 +00004700PJ_DECL(pj_status_t) pjsua_set_ec(unsigned tail_ms, unsigned options);
Benny Prijonof20687a2006-08-04 18:27:19 +00004701
4702
4703/**
Benny Prijonoe506c8c2009-03-10 13:28:43 +00004704 * Get current echo canceller tail length.
Benny Prijonof20687a2006-08-04 18:27:19 +00004705 *
4706 * @param p_tail_ms Pointer to receive the tail length, in miliseconds.
4707 * If AEC is disabled, the value will be zero.
4708 *
4709 * @return PJ_SUCCESS on success.
4710 */
Benny Prijono22dfe592006-08-06 12:07:13 +00004711PJ_DECL(pj_status_t) pjsua_get_ec_tail(unsigned *p_tail_ms);
Benny Prijonof20687a2006-08-04 18:27:19 +00004712
4713
Nanang Izzuddin0cb3b022009-02-27 17:37:35 +00004714/**
Benny Prijonof798e502009-03-09 13:08:16 +00004715 * Check whether the sound device is currently active. The sound device
4716 * may be inactive if the application has set the auto close feature to
4717 * non-zero (the snd_auto_close_time setting in #pjsua_media_config), or
4718 * if null sound device or no sound device has been configured via the
4719 * #pjsua_set_no_snd_dev() function.
Nanang Izzuddin0cb3b022009-02-27 17:37:35 +00004720 */
Benny Prijonof798e502009-03-09 13:08:16 +00004721PJ_DECL(pj_bool_t) pjsua_snd_is_active(void);
4722
4723
4724/**
4725 * Configure sound device setting to the sound device being used. If sound
4726 * device is currently active, the function will forward the setting to the
4727 * sound device instance to be applied immediately, if it supports it.
4728 *
4729 * The setting will be saved for future opening of the sound device, if the
4730 * "keep" argument is set to non-zero. If the sound device is currently
4731 * inactive, and the "keep" argument is false, this function will return
4732 * error.
4733 *
4734 * Note that in case the setting is kept for future use, it will be applied
4735 * to any devices, even when application has changed the sound device to be
4736 * used.
4737 *
Benny Prijonoe506c8c2009-03-10 13:28:43 +00004738 * Note also that the echo cancellation setting should be set with
4739 * #pjsua_set_ec() API instead.
4740 *
Benny Prijonof798e502009-03-09 13:08:16 +00004741 * See also #pjmedia_aud_stream_set_cap() for more information about setting
4742 * an audio device capability.
4743 *
4744 * @param cap The sound device setting to change.
4745 * @param pval Pointer to value. Please see #pjmedia_aud_dev_cap
4746 * documentation about the type of value to be
4747 * supplied for each setting.
4748 * @param keep Specify whether the setting is to be kept for future
4749 * use.
4750 *
4751 * @return PJ_SUCCESS on success or the appropriate error code.
4752 */
4753PJ_DECL(pj_status_t) pjsua_snd_set_setting(pjmedia_aud_dev_cap cap,
4754 const void *pval,
4755 pj_bool_t keep);
4756
4757/**
4758 * Retrieve a sound device setting. If sound device is currently active,
4759 * the function will forward the request to the sound device. If sound device
4760 * is currently inactive, and if application had previously set the setting
4761 * and mark the setting as kept, then that setting will be returned.
4762 * Otherwise, this function will return error.
4763 *
Benny Prijonoe506c8c2009-03-10 13:28:43 +00004764 * Note that echo cancellation settings should be retrieved with
4765 * #pjsua_get_ec_tail() API instead.
4766 *
Benny Prijonof798e502009-03-09 13:08:16 +00004767 * @param cap The sound device setting to retrieve.
4768 * @param pval Pointer to receive the value.
4769 * Please see #pjmedia_aud_dev_cap documentation about
4770 * the type of value to be supplied for each setting.
4771 *
4772 * @return PJ_SUCCESS on success or the appropriate error code.
4773 */
4774PJ_DECL(pj_status_t) pjsua_snd_get_setting(pjmedia_aud_dev_cap cap,
4775 void *pval);
Nanang Izzuddin0cb3b022009-02-27 17:37:35 +00004776
4777
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004778/*****************************************************************************
4779 * Codecs.
4780 */
4781
4782/**
4783 * Enum all supported codecs in the system.
4784 *
4785 * @param id Array of ID to be initialized.
4786 * @param count On input, specifies max elements in the array.
4787 * On return, it contains actual number of elements
4788 * that have been initialized.
4789 *
4790 * @return PJ_SUCCESS on success, or the appropriate error code.
4791 */
4792PJ_DECL(pj_status_t) pjsua_enum_codecs( pjsua_codec_info id[],
4793 unsigned *count );
4794
4795
4796/**
4797 * Change codec priority.
4798 *
Benny Prijonoe6ead542007-01-31 20:53:31 +00004799 * @param codec_id Codec ID, which is a string that uniquely identify
4800 * the codec (such as "speex/8000"). Please see pjsua
4801 * manual or pjmedia codec reference for details.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004802 * @param priority Codec priority, 0-255, where zero means to disable
4803 * the codec.
4804 *
4805 * @return PJ_SUCCESS on success, or the appropriate error code.
4806 */
Benny Prijonoe6ead542007-01-31 20:53:31 +00004807PJ_DECL(pj_status_t) pjsua_codec_set_priority( const pj_str_t *codec_id,
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004808 pj_uint8_t priority );
4809
4810
4811/**
4812 * Get codec parameters.
4813 *
Benny Prijonoe6ead542007-01-31 20:53:31 +00004814 * @param codec_id Codec ID.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004815 * @param param Structure to receive codec parameters.
4816 *
4817 * @return PJ_SUCCESS on success, or the appropriate error code.
4818 */
Benny Prijonoe6ead542007-01-31 20:53:31 +00004819PJ_DECL(pj_status_t) pjsua_codec_get_param( const pj_str_t *codec_id,
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004820 pjmedia_codec_param *param );
4821
4822
4823/**
4824 * Set codec parameters.
4825 *
Benny Prijonoe6ead542007-01-31 20:53:31 +00004826 * @param codec_id Codec ID.
Nanang Izzuddin06839e72010-01-27 11:48:31 +00004827 * @param param Codec parameter to set. Set to NULL to reset
4828 * codec parameter to library default settings.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004829 *
4830 * @return PJ_SUCCESS on success, or the appropriate error code.
4831 */
Benny Prijonoe6ead542007-01-31 20:53:31 +00004832PJ_DECL(pj_status_t) pjsua_codec_set_param( const pj_str_t *codec_id,
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004833 const pjmedia_codec_param *param);
4834
4835
4836
Benny Prijono9fc735d2006-05-28 14:58:12 +00004837
Benny Prijono312aff92006-06-17 04:08:30 +00004838/**
4839 * Create UDP media transports for all the calls. This function creates
4840 * one UDP media transport for each call.
Benny Prijonof3195072006-02-14 21:15:30 +00004841 *
Benny Prijono312aff92006-06-17 04:08:30 +00004842 * @param cfg Media transport configuration. The "port" field in the
4843 * configuration is used as the start port to bind the
4844 * sockets.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004845 *
4846 * @return PJ_SUCCESS on success, or the appropriate error code.
Benny Prijonof3195072006-02-14 21:15:30 +00004847 */
Benny Prijono312aff92006-06-17 04:08:30 +00004848PJ_DECL(pj_status_t)
4849pjsua_media_transports_create(const pjsua_transport_config *cfg);
Benny Prijonof3195072006-02-14 21:15:30 +00004850
Benny Prijonodc39fe82006-05-26 12:17:46 +00004851
4852/**
Benny Prijono312aff92006-06-17 04:08:30 +00004853 * Register custom media transports to be used by calls. There must
4854 * enough media transports for all calls.
Benny Prijonoeebe9af2006-06-13 22:57:13 +00004855 *
Benny Prijono312aff92006-06-17 04:08:30 +00004856 * @param tp The media transport array.
4857 * @param count Number of elements in the array. This number MUST
4858 * match the number of maximum calls configured when
4859 * pjsua is created.
4860 * @param auto_delete Flag to indicate whether the transports should be
4861 * destroyed when pjsua is shutdown.
4862 *
4863 * @return PJ_SUCCESS on success, or the appropriate error code.
Benny Prijonodc39fe82006-05-26 12:17:46 +00004864 */
Benny Prijono312aff92006-06-17 04:08:30 +00004865PJ_DECL(pj_status_t)
4866pjsua_media_transports_attach( pjsua_media_transport tp[],
4867 unsigned count,
4868 pj_bool_t auto_delete);
Benny Prijonodc39fe82006-05-26 12:17:46 +00004869
4870
Benny Prijono312aff92006-06-17 04:08:30 +00004871/**
4872 * @}
4873 */
4874
Benny Prijonof3195072006-02-14 21:15:30 +00004875
Benny Prijono268ca612006-02-07 12:34:11 +00004876
Benny Prijono312aff92006-06-17 04:08:30 +00004877/**
4878 * @}
4879 */
4880
Benny Prijonoe6ead542007-01-31 20:53:31 +00004881PJ_END_DECL
4882
Benny Prijono312aff92006-06-17 04:08:30 +00004883
Benny Prijono268ca612006-02-07 12:34:11 +00004884#endif /* __PJSUA_H__ */