SipDeveloperGuide
Version 39 (Adrian Georgescu, 03/13/2009 02:10 pm)
| 1 | 1 | Adrian Georgescu | = Developer guide = |
|---|---|---|---|
| 2 | 1 | Adrian Georgescu | |
| 3 | 1 | Adrian Georgescu | [[TOC(WikiStart, Sip*, depth=2)]] |
| 4 | 1 | Adrian Georgescu | |
| 5 | 16 | Adrian Georgescu | The main goal of this library is to provide a simple to use API to create real-time communications applications between end-points based on SIP protocol. |
| 6 | 16 | Adrian Georgescu | |
| 7 | 28 | Adrian Georgescu | To use the library and the concepts described below you must be familiar with Python programming language. Familiarity with SIP and related protocols protocol is not required but having a good understanding of TCP/IP networking and real time application development in general are strongly recommended. |
| 8 | 1 | Adrian Georgescu | |
| 9 | 32 | Adrian Georgescu | Instructions for installing the library are found [wiki:SipInstallation here]. |
| 10 | 31 | Adrian Georgescu | |
| 11 | 11 | Adrian Georgescu | == Middleware == |
| 12 | 1 | Adrian Georgescu | |
| 13 | 37 | Adrian Georgescu | To develop your application you should use the middleware API that hides the complexity and interactions of the lower level SIP, SDP, RTP, ICE, MSRP, XCAP and related protocols. With a minimal amount of coding you can create a client SIP application for setting up audio, instant messaging and desktop sharing sessions. |
| 14 | 1 | Adrian Georgescu | |
| 15 | 26 | Adrian Georgescu | * [wiki:SipMiddlewareApi Middleware API] - event driven middleware suitable for developing interactive user interfaces |
| 16 | 25 | Adrian Georgescu | * [wiki:SipSettingsAPI Settings API] - used to reading and writing settings used by the middleware |
| 17 | 24 | Adrian Georgescu | |
| 18 | 38 | Adrian Georgescu | === Sample code === |
| 19 | 38 | Adrian Georgescu | |
| 20 | 24 | Adrian Georgescu | The middleware API is used by the command line tools used for [wiki:SipTesting testing the library]. |
| 21 | 1 | Adrian Georgescu | |
| 22 | 11 | Adrian Georgescu | == Components == |
| 23 | 1 | Adrian Georgescu | |
| 24 | 17 | Adrian Georgescu | To develop your own middleware or application while controlling the underlying lower layers and protocols yourself, you must use the following APIs that provides granular control over their respective components: |
| 25 | 1 | Adrian Georgescu | |
| 26 | 36 | Adrian Georgescu | * [wiki:SipCoreApiDocumentation SIP core API] - The API for the SIP, SDP, RTP, ICE and audio engine (cross platform sound-card abstraction, codecs) |
| 27 | 35 | Adrian Georgescu | * [wiki:SipMSRPApi MSRP API] - The API for Message Session Relay Protocol (MSRP) and its relay extension used for instant messaging, file transfers and desktop sharing applications |
| 28 | 30 | Adrian Georgescu | * [wiki:SipPresenceApi Presence API] - The API for payloads carried within SIP signaling used for publication, subscription and notifications of SIP events |
| 29 | 19 | Adrian Georgescu | * [wiki:SipXCAPApi XCAP API] - The API for XCAP document manipulation used for storage of buddy lists and presence policy documents |