mirror of
https://gitlab.freedesktop.org/pulseaudio/pulseaudio.git
synced 2025-10-29 05:40:23 -04:00
befd734aac
git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@139 fefdeb5f-60dc-0310-8127-8f9354f1896f
93 lines
3.1 KiB
C
93 lines
3.1 KiB
C
#ifndef foopolyplibhfoo
|
|
#define foopolyplibhfoo
|
|
|
|
/* $Id$ */
|
|
|
|
/***
|
|
This file is part of polypaudio.
|
|
|
|
polypaudio is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published
|
|
by the Free Software Foundation; either version 2 of the License,
|
|
or (at your option) any later version.
|
|
|
|
polypaudio is distributed in the hope that it will be useful, but
|
|
WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with polypaudio; if not, write to the Free Software
|
|
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
|
|
USA.
|
|
***/
|
|
|
|
#include "cdecl.h"
|
|
#include "mainloop-api.h"
|
|
#include "sample.h"
|
|
#include "polyplib-def.h"
|
|
#include "polyplib-context.h"
|
|
#include "polyplib-stream.h"
|
|
#include "polyplib-introspect.h"
|
|
#include "polyplib-subscribe.h"
|
|
#include "polyplib-scache.h"
|
|
#include "polyplib-version.h"
|
|
|
|
/** \file
|
|
* Include all polyplib header file at once. The following files are included: \ref mainloop-api.h, \ref sample.h,
|
|
* \ref polyplib-def.h, \ref polyplib-context.h, \ref polyplib-stream.h,
|
|
* \ref polyplib-introspect.h, \ref polyplib-subscribe.h and \ref polyplib-scache.h \ref polyplib-version.h
|
|
* at once */
|
|
|
|
/** \mainpage
|
|
*
|
|
* \section intro_sec Introduction
|
|
*
|
|
* This document describes the client API for the polypaudio sound
|
|
* server. The API comes in two flavours:
|
|
*
|
|
* \li The complete but somewhat complicated to use asynchronous API
|
|
* \li And the simplified, easy to use, but limited synchronous API
|
|
*
|
|
* The polypaudio client libraries are thread safe as long as all
|
|
* objects created by any library function are accessed from the thread
|
|
* that created them only.
|
|
*
|
|
* \section simple_sec Simple API
|
|
*
|
|
* Use this if you develop your program in synchronous style and just
|
|
* need a way to play or record data on the sound server. See
|
|
* \ref polyplib-simple.h for more details.
|
|
*
|
|
* \section async_api Asynchronous API
|
|
*
|
|
* Use this if you develop your programs in asynchronous, main loop
|
|
* based style or want to use advanced features of the polypaudio
|
|
* API. A good starting point is \ref polyplib-context.h
|
|
*
|
|
* The asynchronous API relies on an abstract main loop API that is
|
|
* described in \ref mainloop-api.h. Two distinct implementations are
|
|
* available:
|
|
*
|
|
* \li \ref mainloop.h: a minimal but fast implementation based on poll()
|
|
* \li \ref glib-mainloop.h: a wrapper around GLIB's main loop
|
|
*
|
|
* UNIX signals may be hooked to a main loop using the functions from
|
|
* \ref mainloop-signal.h
|
|
*
|
|
* \section pkgconfig pkg-config
|
|
*
|
|
* The polypaudio libraries provide pkg-config snippets for the different modules. To use the
|
|
* asynchronous API use "polyplib" as pkg-config file. GLIB main loop
|
|
* support is available as "polyplib-glib-mainloop". The simple
|
|
* synchronous API is available as "polyplib-simple".
|
|
*/
|
|
|
|
PA_C_DECL_BEGIN
|
|
|
|
/** Return the version of the library the current application is linked to */
|
|
const char* pa_get_library_version(void);
|
|
|
|
PA_C_DECL_END
|
|
|
|
#endif
|