croczilla.com 
 home   stratified   bits&pieces   blog   personal   
  home > bits&pieces > zap

Welcome to zap!

Zap brings advanced scalable internet communication to Mozilla.

A project started by 8x8 Inc, our goal is to build a robust platform for the client-side use of technologies such as ICE, SIP and RTP.

Zap comes with a fully-functional SIP client application, but it can also be used as a framework for writing other programs. It has e.g. been used as the basis of the standalone Joost video client.

The Zap source code is open-source and published under the MPL/LGPL/GPL disjunctive trilicense.

Please read the Zap Project Overview for more information.


Getting the code & building it

We don't currently provide binary builds, so the only way to get zap is to compile it yourself.

The zap code is maintained as a Mercurial repository at http://hg.mozilla.org/users/alex_croczilla.com/zap-central. It consists of a clone of the mozilla-central repository with some patches and the additional zap-specific code.

For more information on the repository layout and for detailed build instructions, please read the Zap Build Documentation.

We also maintain a buildbot cluster here, which is being used for build verification on our 4 main target platforms (linux-i686, linux-amd64, osx, win32), for generating doxygen documentation, and (in future) for providing binary zap builds.

Our buildbot has a try scheduler which can be used to test patches against the current zap sources on all or some of the target platforms. Patches can be submitted on this webform (restricted access).


API documentation

For an overview of the ZAP APIs and up-to-date Doxygen documentation please refer to the Zap Sourcecode Documentation.

Note

Tutorials demonstrating the usage of some of the ZAP APIs coming soon.


Zap Universal SIP client

The Zap Universal SIP client is a fully functional application that can be used with many SIP service providers. It also serves as a reference client implementation that showcases how the lower level APIs are typically used in a XULRunner application.

For more information, please read the Zap SIP Client Documentation.


Zap Sandbox

The Zap Sandbox is a little XULRunner JavaScript shell frontend, useful for quickly testing out some JavaScript code, or for following the tutorial material in the documentation section.

Note

The Zap Sandbox is still under development and not yet part of the build!


Community

The Zap community consists of a number of developers employed by 8x8, as well as some external contributors and users.

Code contributions - be they bug-fixes, new features or work on the core code - are always welcome, but it is probably a good idea to coordinate with us first, so that we don't duplicate efforts or tread on each others' tows.

Our primary means of communication are:

  • The very low volume developer mailinglist. You need to be subscribed to post.
  • IRC, server irc.mozilla.org, channel #zap

Some notable external projects include: