]> code.delx.au - pulseaudio/blobdiff - src/pulse/pulseaudio.h
alsa: cover bass boost mixer element
[pulseaudio] / src / pulse / pulseaudio.h
index ee8a4bb8417545a602375b8ed738a01067194002..793ba9b15be3936beea74dca55a449d49930d7f5 100644 (file)
 #include <pulse/mainloop-signal.h>
 #include <pulse/util.h>
 #include <pulse/timeval.h>
+#include <pulse/proplist.h>
+#include <pulse/rtclock.h>
 
 /** \file
- * Include all libpulse header files at once. The following
- * files are included: \ref mainloop-api.h, \ref sample.h, \ref def.h,
- * \ref context.h, \ref stream.h, \ref introspect.h, \ref subscribe.h,
- * \ref scache.h, \ref version.h, \ref error.h, \ref channelmap.h,
- * \ref operation.h,\ref volume.h, \ref xmalloc.h, \ref utf8.h, \ref
- * thread-mainloop.h, \ref mainloop.h, \ref util.h, \ref timeval.h and
- * \ref mainloop-signal.h at once */
+ * Include all libpulse header files at once. The following files are
+ * included: \ref mainloop-api.h, \ref sample.h, \ref def.h, \ref
+ * context.h, \ref stream.h, \ref introspect.h, \ref subscribe.h, \ref
+ * scache.h, \ref version.h, \ref error.h, \ref channelmap.h, \ref
+ * operation.h,\ref volume.h, \ref xmalloc.h, \ref utf8.h, \ref
+ * thread-mainloop.h, \ref mainloop.h, \ref util.h, \ref proplist.h,
+ * \ref timeval.h, \ref rtclock.h and \ref mainloop-signal.h at
+ * once */
 
 /** \mainpage
  *
  * \section intro_sec Introduction
  *
  * This document describes the client API for the PulseAudio sound
- * server. The API comes in two flavours to accomodate different styles
+ * server. The API comes in two flavours to accommodate different styles
  * of applications and different needs in complexity:
  *
  * \li The complete but somewhat complicated to use asynchronous API
  *
  * \section thread_sec Threads
  *
- * The PulseAudio client libraries are not designed to be used in a
- * heavily threaded environment. They are however designed to be reentrant
- * safe.
+ * The PulseAudio client libraries are not designed to be directly
+ * thread-safe. They are however designed to be reentrant and
+ * threads-aware.
  *
- * To use the libraries in a threaded environment, you must assure that
+ * To use the libraries in a threaded environment, you must assure that
  * all objects are only used in one thread at a time. Normally, this means
  * that all objects belonging to a single context must be accessed from the
  * same thread.
  *
  * The included main loop implementation is also not thread safe. Take care
- * to make sure event lists are not manipulated when any other code is
+ * to make sure event objects are not manipulated when any other code is
  * using the main loop.
  *
  * \section pkgconfig pkg-config
  * modules:
  *
  * \li libpulse - The asynchronous API and the internal main loop implementation.
- * \li libpulse-mainloop-glib12 - GLIB 1.2 main loop bindings.
  * \li libpulse-mainloop-glib - GLIB 2.x main loop bindings.
  * \li libpulse-simple - The simple PulseAudio API.
  */