Developer Documentation

Developing Clients

You may browse the Doxygen generated programming documentation for the client API. (Run make doxygen to generate this documentation from the source tree).

If you want to write a volume control application, make sure to read this.

Also, make sure to set properties on all PA connections, make sure to read this.

*Finally, make sure you know everything about latency control! *

Here are some examples that uses the async (complex) API, Sample Async Device List and Sample Async Playback.

Developing PulseAudio

Instructions for building and installing the current development version.

Instructions for sending patches with git send-email.

When working on PulseAudio, please mind the Coding Style.

Developing Modules

There are several reasons for writing loadable modules for PulseAudio:

  • Extended device driver support
  • Protocol support beyond ESOUND's protocol and the native protocol. (such as NAS or a subset of aRts)
  • New programming interfaces such as XMLRPC or DBUS for controlling the daemon.
  • Hooking audio event sources directly into PulseAudio (similar to module-x11-bell)
  • For low latency applications such as VOIP: load the VOIP core directly into PulseAudio and have a slim GUI frontend to control it. There is currently a little bit of documentation available on how to write loadable modules for PulseAudio. Beyond this, read the source, Luke! If you are interested in writing new modules feel free to contact the authors in case you have any questions.

  • Writing Modules

  • Core API
  • Module API
  • Module Arguments API
  • Threading Model
  • A discussion about writing a sink
  • Rewinding explained Some things that might be relevant for people hacking on specific modules:

  • BlueZ issues/limitations list

  • ALSA issues/limitations list

Porting to other platforms