SipDeveloperGuide

Version 86 (Adrian Georgescu, 03/27/2010 10:37 am)

1 61 Adrian Georgescu
= Developer Guide =
2 1 Adrian Georgescu
3 86 Adrian Georgescu
[[TOC(WikiStart, Sip*, depth=1)]]
4 1 Adrian Georgescu
5 73 Adrian Georgescu
The goal of SIP SIMPLE client SDK is to provide a simple to use API to create Real Time Communications Applications for Internet end-points based on SIP and related protocols.
6 1 Adrian Georgescu
7 73 Adrian Georgescu
By using this API you can add Audio, Instant Messaging, File Transfer capabilities to and existing product or create a new product from scratch.
8 73 Adrian Georgescu
9 41 Adrian Georgescu
== Prerequisites ==
10 41 Adrian Georgescu
11 79 Adrian Georgescu
To use SIP SIMPLE client SDK and the concepts described below you must be familiar with Python programming language and have basic [http://www.tech-invite.com/Ti-sip-ex3261.html SIP knowledge]. Understanding of TCP/IP networking in general and real time application development in particular are strongly recommended.
12 1 Adrian Georgescu
13 79 Adrian Georgescu
Detailed instructions for installing the SDK are found [wiki:SipInstallation here].
14 11 Adrian Georgescu
15 1 Adrian Georgescu
== Middleware ==
16 1 Adrian Georgescu
17 79 Adrian Georgescu
To develop your SIP client Application you should use the Middleware API that hides the complexity and the interactions of the low level SIP, SDP, RTP, ICE, MSRP, XCAP protocols. With a minimal amount of coding you can create a rich client for setting up Audio, Instant Messaging, File Transfer and Desktop Sharing sessions.
18 1 Adrian Georgescu
19 83 Adrian Georgescu
 * [wiki:SipMiddlewareApi Middleware API] - middleware for developing of SIP clients
20 1 Adrian Georgescu
 * [wiki:SipConfigurationAPI Configuration API] - used for managing the settings used by the Middleware
21 1 Adrian Georgescu
22 1 Adrian Georgescu
=== Sample Code ===
23 76 Adrian Georgescu
24 85 Adrian Georgescu
 * [wiki:SipSessionExample Minimalist Session sample code] - provides an example for setting up a Audio session
25 85 Adrian Georgescu
 * [wiki:SipTesting Command Line Tools] provide detailed practical examples for how to use all functions available in the SDK
26 85 Adrian Georgescu
 * [http://icanblink.com Blink], a fully featured and easy to use SIP client or MacOSX
27 1 Adrian Georgescu
28 50 Adrian Georgescu
=== Components ===
29 1 Adrian Georgescu
30 79 Adrian Georgescu
If you wish to develop your own middleware or application while having full control over the underlying protocol layers yourself, you can use the following APIs that provide granular control over their respective components:
31 1 Adrian Georgescu
32 77 Adrian Georgescu
 * [wiki:SipCoreApiDocumentation SIP Core API] - SIP, RTP, ICE and Audio Engine including cross platform audio-device abstraction, codecs and jitter buffer
33 77 Adrian Georgescu
 * [wiki:SipMSRPApi MSRP API]  - Message Session Relay Protocol (MSRP) and its Relay Extension
34 77 Adrian Georgescu
 * [wiki:SipPresenceApi Presence API]  - Payloads carried within SIP signaling used for publication, subscription and notifications of SIP events
35 77 Adrian Georgescu
 * [wiki:SipXCAPApi XCAP API]  - Manage presence policy documents on XCAP servers