blob: 69e630352a460273bebadcd3f038a7445489a798 [file] [log] [blame]
Alexandre Lision0e143012014-01-22 11:02:46 -05001
2
3Introduction to PJSUA2
4*******************************
5This documentation is intended for developers looking to develop Session Initiation Protocol (SIP) based client application. Some knowledge on SIP is definitely required, and of course some programming experience. Prior knowledge of PJSUA C API is not needed, although it will probably help.
6
7This PJSUA2 module provides very high level API to do SIP calls, presence, and instant messaging, as well as handling media and NAT traversal. Knowledge of SIP protocol details (such as the grammar, transaction, dialog, and whatnot) are not required, however you should know how SIP works in general and particularly how to configure SIP clients to, e.g. register to a SIP provider, specify SIP URI to make call to, and so on, to use the module.
8
9Getting Started with PJSIP
10==============================
11To begin using PJSIP
12http://trac.pjsip.org/repos/wiki/Getting-Started
13
14PJSIP Info and Documentation
15================================
16PJSIP General Wiki:
17http://trac.pjsip.org/repos/wiki
18
19PJSIP FAQ:
20http://trac.pjsip.org/repos/wiki/FAQ
21
22PJSIP Reference Manual:
23http://trac.pjsip.org/repos/wiki - Reference Manual
24
25Building PJSUA2
26=================
27PJSUA2 API declaration can be found in pjproject/pjsip/include/pjsua2 while the source codes are located in pjproject/pjsip/src/pjsua2. It will be automatically built when you compile PJSIP.
28
29PJSUA2 Language Binding Support
30===================================
31Optional if you want to:
32SWIG (minimum version 2.0.5)
33