diff options
| author | Liong Sauw Ming <ming@teluu.com> | 2014-01-16 05:30:46 +0000 |
|---|---|---|
| committer | Liong Sauw Ming <ming@teluu.com> | 2014-01-16 05:30:46 +0000 |
| commit | e56ea14ab8531ee3cec375460577d1b89bf62e26 (patch) | |
| tree | df77c3acb961514b2022ee9e030071b691145920 /doc/pjsip-book/intro.rst | |
| parent | bd1c47e995a3a844868f1d4dcc8f77f163ae721b (diff) | |
Closed #1723: Merging pjsua2 branch into trunk
git-svn-id: http://svn.pjsip.org/repos/pjproject/trunk@4704 74dad513-b988-da41-8d7b-12977e46ad98
Diffstat (limited to 'doc/pjsip-book/intro.rst')
| -rw-r--r-- | doc/pjsip-book/intro.rst | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/pjsip-book/intro.rst b/doc/pjsip-book/intro.rst new file mode 100644 index 00000000..69e63035 --- /dev/null +++ b/doc/pjsip-book/intro.rst @@ -0,0 +1,33 @@ + +
+Introduction to PJSUA2
+*******************************
+This 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.
+
+This 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.
+
+Getting Started with PJSIP
+==============================
+To begin using PJSIP
+http://trac.pjsip.org/repos/wiki/Getting-Started
+
+PJSIP Info and Documentation
+================================
+PJSIP General Wiki:
+http://trac.pjsip.org/repos/wiki
+
+PJSIP FAQ:
+http://trac.pjsip.org/repos/wiki/FAQ
+
+PJSIP Reference Manual:
+http://trac.pjsip.org/repos/wiki - Reference Manual
+
+Building PJSUA2
+=================
+PJSUA2 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.
+
+PJSUA2 Language Binding Support
+===================================
+Optional if you want to:
+​SWIG (minimum version 2.0.5)
+
|