SipDeveloperGuide
Version 153 (Adrian Georgescu, 06/12/2011 08:45 pm)
1 | 61 | Adrian Georgescu | = Developer Guide = |
---|---|---|---|
2 | 1 | Adrian Georgescu | |
3 | 147 | Adrian Georgescu | [[TOC(SipDeveloperGuide, depth=2)]] |
4 | 147 | Adrian Georgescu | |
5 | 93 | Adrian Georgescu | The goal of ''SIP SIMPLE client SDK'' is to allow easy development of Real Time Applications based on SIP and related protocols. By using this SDK you can add Audio, Video, Instant Messaging, File Transfer and Desktop Sharing capabilities to an existing product or create a new product from scratch. |
6 | 73 | Adrian Georgescu | |
7 | 146 | Adrian Georgescu | The application that uses SIP SIMPLE client SDK must import the relevant Python modules from it, start the engine than make use of the SDK classes and functions. |
8 | 146 | Adrian Georgescu | |
9 | 127 | Adrian Georgescu | == Prerequisites == |
10 | 127 | Adrian Georgescu | |
11 | 136 | Adrian Georgescu | To use SIP SIMPLE client SDK you must: |
12 | 1 | Adrian Georgescu | |
13 | 136 | Adrian Georgescu | 1. Be familiar with [http://python.org Python programming language] |
14 | 1 | Adrian Georgescu | 3. Install the SDK according to [wiki:SipInstallation Installation Instructions] |
15 | 151 | Adrian Georgescu | |
16 | 151 | Adrian Georgescu | Knowledge of [http://www.tech-invite.com/Ti-sip-ex3261.html SIP protocol] is useful but not mandatory. |
17 | 151 | Adrian Georgescu | |
18 | 142 | Adrian Georgescu | |
19 | 149 | Adrian Georgescu | == Printing Format == |
20 | 149 | Adrian Georgescu | |
21 | 149 | Adrian Georgescu | ||[[Image(/raw-attachment/wiki/WikiStart/SIPSIMPLE-Manual.jpg, nolink)]]||[http://download.ag-projects.com/SipClient/SIPSIMPLE-Manual.pdf SIP SIMPLE client SDK - Developer Guide] - PDF format |
22 | 149 | Adrian Georgescu | |
23 | 1 | Adrian Georgescu | == High Level API == |
24 | 1 | Adrian Georgescu | |
25 | 149 | Adrian Georgescu | To develop your application you should use the Middleware API that abstract the complexity the low level protocols into a high-level middleware. |
26 | 1 | Adrian Georgescu | |
27 | 1 | Adrian Georgescu | * [wiki:SipMiddlewareApi Middleware API] |
28 | 149 | Adrian Georgescu | |
29 | 90 | Adrian Georgescu | |
30 | 1 | Adrian Georgescu | === Sample Code === |
31 | 1 | Adrian Georgescu | |
32 | 120 | Adrian Georgescu | * [wiki:SipSessionExample Hello World!] - minimalist example for setting up an Audio Session |
33 | 119 | Adrian Georgescu | * [wiki:SipTesting Command Line Tools] - detailed examples for all SDK functions |
34 | 153 | Adrian Georgescu | * [http://icanblink.com Blink], a SIP client for MacOSX, Windows and Linux |
35 | 152 | Adrian Georgescu | * [http://sylkserver.com SylkServer], a SIP application server for Linux |
36 | 105 | Adrian Georgescu | |
37 | 148 | Adrian Georgescu | == Low Level APIs == |
38 | 1 | Adrian Georgescu | |
39 | 130 | Adrian Georgescu | The following APIs provide granular control over their respective components: |
40 | 1 | Adrian Georgescu | |
41 | 113 | Adrian Georgescu | * [wiki:SipCoreApiDocumentation SIP Core API] - SIP, RTP, ICE and Audio Engine |
42 | 77 | Adrian Georgescu | * [wiki:SipMSRPApi MSRP API] - Message Session Relay Protocol (MSRP) and its Relay Extension |
43 | 1 | Adrian Georgescu | * [wiki:SipXCAPApi XCAP API] - Manage presence policy documents on XCAP servers |
44 | 135 | Adrian Georgescu | * [wiki:SipPayloadsApi Payloads API] - Payloads used for publication, subscription and notifications of SIP events |