SipDeveloperGuide

Version 139 (Adrian Georgescu, 05/03/2010 01:42 pm)

1 61 Adrian Georgescu
= Developer Guide =
2 1 Adrian Georgescu
3 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.
4 73 Adrian Georgescu
5 127 Adrian Georgescu
== Prerequisites ==
6 127 Adrian Georgescu
7 136 Adrian Georgescu
To use SIP SIMPLE client SDK you must:
8 1 Adrian Georgescu
9 136 Adrian Georgescu
 1. Be familiar with [http://python.org Python programming language]
10 136 Adrian Georgescu
 2. Have basic knowledge of [http://www.tech-invite.com/Ti-sip-ex3261.html SIP protocol]
11 136 Adrian Georgescu
12 125 Adrian Georgescu
[wiki:SipInstallation Installation Instructions]
13 125 Adrian Georgescu
14 129 Adrian Georgescu
== Middleware API ==
15 1 Adrian Georgescu
16 131 Adrian Georgescu
To develop your SIP application you use the Middleware API that hides the complexity of the interactions of the low level SIP, DNS, SDP, RTP, ICE, MSRP and XCAP protocols. 
17 1 Adrian Georgescu
18 97 Adrian Georgescu
[wiki:SipMiddlewareApi Middleware API]
19 90 Adrian Georgescu
20 1 Adrian Georgescu
=== Sample Code ===
21 1 Adrian Georgescu
22 120 Adrian Georgescu
 * [wiki:SipSessionExample Hello World!] - minimalist example for setting up an Audio Session
23 119 Adrian Georgescu
 * [wiki:SipTesting Command Line Tools] - detailed examples for all SDK functions
24 85 Adrian Georgescu
 * [http://icanblink.com Blink], a fully featured and easy to use SIP client
25 105 Adrian Georgescu
26 134 Adrian Georgescu
== Low Level API ==
27 1 Adrian Georgescu
28 130 Adrian Georgescu
The following APIs provide granular control over their respective components:
29 1 Adrian Georgescu
30 113 Adrian Georgescu
 * [wiki:SipCoreApiDocumentation SIP Core API] - SIP, RTP, ICE and Audio Engine
31 77 Adrian Georgescu
 * [wiki:SipMSRPApi MSRP API]  - Message Session Relay Protocol (MSRP) and its Relay Extension
32 1 Adrian Georgescu
 * [wiki:SipXCAPApi XCAP API]  - Manage presence policy documents on XCAP servers
33 135 Adrian Georgescu
 * [wiki:SipPayloadsApi Payloads API]  - Payloads used for publication, subscription and notifications of SIP events