pjsip logo pjsip.org
Open source SIP stack and media stack for presence, im/instant messaging, and multimedia communication

HOME

SIP/media Features
High Performance SIP
Small Footprint SIP
Symbian Port

FAQ

Documentation

Licensing

Download

Development (Trac)

Projects using pjsip

Mailing List

Open Source Links


About: PJLIB, PJLIB-UTIL, PJSIP, and PJMEDIA are created by: Benny Prijono
<bennylp@pjsip.org>


 

Home --> Documentations

 

SIP and Media Documentation


[Last Update: $Date: 2007-09-24 17:10:03 +0100 (Mon, 24 Sep 2007) $]

 

Please check list of answers to frequently asked questions first for any questions or if you are having problems.

Please find links to various documentations below.

 

Tutorials

Title

Description

Getting Started

Getting Started: Building and Using PJSIP and PJMEDIA.

PJSUA Tutorial

A simple example to perform SIP registration, call, and audio communication using PJSUA-API (in less than 200 lines of code).

Python SIP Tutorial

A simple page to get started with developing SIP multimedia application using Python binding of PJSUA-API.

Samples / Screenshots

Title

Description

PJMEDIA Samples/Screenshots

Collection of samples on how to use PJMEDIA.

PJSIP Samples/Screenshots

PJSIP samples collection.

Articles

Title

Description

Getting Started

Getting Started: Building and Using PJSIP and PJMEDIA.

SIP and Media Features

Up to date SIP and media features implemented by PJSIP and PJMEDIA.

SIP Performance/Benchmark

Benchmarking PJSIP SIP stack performance and scalability.

SIP and Media Footprint

Measuring the footprint of PJ SIP and media stack on various platforms.

Porting SIP and Media Stack to Embedded Systems

Guide on porting the libraries and applications into new platforms, especially embedded/deeply-embedded/small footprint systems.

Symbian OS Port

Porting, building, and running PJ libraries and applications on SymbianOS.

Understanding Media Flow

Explains how audio frame is flowing between media components such as sound device, conference bridge, stream, and network, as well as how media timing is derived.

Troubleshooting Audio Problems

Start from this article to solve various problems with audio/sound.

Building the Software for Windows 95/98/ME (win95/98/me)

How to enable Win95/98/ME support in the software.

 

Documentation by Architecture

Browse documentation by clicking the component from the architecture diagram below:

Architecture Diagram

Diagram: Libraries Architecture

Click on the component to go the its documentation.

PJLIB Documentation PJLIB-UTIL documentation PJNATH documentation PJSIP-CORE documentation PJMEDIA documentation PJMEDIA-CODEC documentation PJSIP-SIMPLE documentation PJSIP-UA documentation PJSUA-API documentation pjsua manual

 

Reference and Manuals

Browse documentation by titles:

Title

Description

PJLIB Online Manual

PJLIB is the base/foundation library for all other libraries and it provides complete OS abstraction layer and some useful data structures.

PJLIB Manual (PDF)

An older version of PJLIB reference.

PJLIB-UTIL Online Manual

PJLIB-UTIL provides supplementary features such as text scanner, STUN, XML, DNS resolver, etc. that are needed by higher layer libraries.

PJNATH Online Manual

PJNATH is a NAT traversal helper library, providing an Open Source implementation of STUN and ICE.

PJMEDIA Online Manual

PJMEDIA is the media stack/framework providing rich components for creating multimedia sessions.

PJSIP Developer's Guide (PDF)

This is a lenghty documentation which was created during PJSIP design process. It explains concepts, relations ("class library"), and other descriptions about most objects in PJSIP. This document can also serve as general design document for writing SIP stacks.

PJSIP Online Manual

This is the documentation for PJSIP SIP stack.

PJSUA-API Manual

PJSUA-API is a highest layer API provided by the libraries, and it integrates PJSIP and PJMEDIA into an easy to use (but still poweful!) API.

PJSUA Python Module Manual

Python module implementing PJSUA-API in object-oriented manner.

PJSUA Manual

This is PJSUA manual.

 

Even More Documentation

Title

Description

Trac Wiki

The Trac Wiki page contains growing number of tutorials, troubleshooting howtos, technical articles, and other useful info which are otherwise not indexed on this page. Please check it out.