fdo-mirrors/pulseaudio
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pulseaudio/pulseaudio.git synced 2026-05-26 03:58:13 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
pulseaudio/src/pulse
History
Alexander E. Patrakov 3535fd7a07 Documentation of known misuse of PulseAudio API 
Hello.

Over time, I became aware of several instances of tempting but
semantically incorrect usage of PulseAudio API (one from my own bad
proposal of "improving" Wine, one from Parole media player and one
from Webkit-GTK). I want to document these gotchas so that other
developers don't fall for that. See the attached patch.

I have checked that the rendered HTML is correct, but need someone to
confirm the factual accuracy of the proposed changes and, possibly, to
improve the wording.

--
Alexander E. Patrakov
2014-01-03 12:53:07 +02:00
..
.gitignore add another .gitignore file, this time for pulse/ 2008-06-18 00:47:32 +02:00
cdecl.h Use LGPL 2.1 on all files previously using LGPL 2 2009-03-03 20:23:02 +00:00
channelmap.c Add pa_channels_valid() 2013-12-15 11:44:35 +01:00
channelmap.h channelmap, volume: Don't refer to bool in the public API documentation 2013-07-04 12:35:55 +03:00
client-conf-x11.c client-conf: refactor cookie loaders 2013-08-21 15:08:46 +03:00
client-conf-x11.h Use LGPL 2.1 on all files previously using LGPL 2 2009-03-03 20:23:02 +00:00
client-conf.c client-conf: refactor cookie loaders 2013-08-21 15:08:46 +03:00
client-conf.h client-conf: refactor cookie loaders 2013-08-21 15:08:46 +03:00
client.conf.in client.conf.in: Typo. s/a/are/ 2010-02-02 09:02:21 +01:00
context.c hashmap: Add the ability to free keys 2013-09-17 18:01:22 +05:30
context.h context: add pa_context_load_cookie_from_file() 2013-08-27 16:41:58 +03:00
def.h doc: Some more nitpicking in pulse/def.h doxygen documentation 2013-04-17 08:12:23 +02:00
error.c error: Fix spelling of 'initialization' in errortab for PA_ERR_MODINITFAILED 2011-12-12 23:57:54 +00:00
error.h Remove unnecessary #includes 2011-06-22 23:12:20 +01:00
ext-device-manager.c Remove pa_bool_t and replace it with bool. 2013-07-04 12:25:30 +03:00
ext-device-manager.h Remove unnecessary #includes 2011-06-22 23:12:20 +01:00
ext-device-restore.c Remove pa_bool_t and replace it with bool. 2013-07-04 12:25:30 +03:00
ext-device-restore.h device-restore: Change the API to include type information (sink vs. source) 2011-08-18 17:33:08 +01:00
ext-stream-restore.c Remove pa_bool_t and replace it with bool. 2013-07-04 12:25:30 +03:00
ext-stream-restore.h Remove unnecessary #includes 2011-06-22 23:12:20 +01:00
fork-detect.c Remove pa_bool_t and replace it with bool. 2013-07-04 12:25:30 +03:00
fork-detect.h try to detect when stupid clients forks and refuse all service from then on 2009-03-05 04:33:40 +01:00
format.c Remove pa_bool_t and replace it with bool. 2013-07-04 12:25:30 +03:00
format.h format: Add #defines for enum values 2013-02-22 14:25:36 +02:00
gccmacro.h gccmacro: Disable printf-like format checking on mingw32 compilers. 2012-10-23 15:50:23 +05:30
glib-mainloop.c mainloop, glib-mainloop: time_restart could cause incorrect event ordering 2013-10-29 19:14:00 +02:00
glib-mainloop.h doxygen: Add 'See also' linking to the overview page 2010-10-13 09:07:39 +01:00
internal.h Remove pa_bool_t and replace it with bool. 2013-07-04 12:25:30 +03:00
introspect.c introspect: Fix ABI break introduced by b98a2e1 2013-11-05 21:26:34 +02:00
introspect.h Documentation of known misuse of PulseAudio API 2014-01-03 12:53:07 +02:00
mainloop-api.c Move i18n.[ch] to src/pulsecore 2011-08-11 13:23:42 +02:00
mainloop-api.h doc: Fix reference to pa_threaded_mainloop 2013-12-20 12:48:41 +02:00
mainloop-signal.c mainloop-signal: Explicitly ignore pa_write() return value. 2012-12-19 12:31:50 +02:00
mainloop-signal.h Use LGPL 2.1 on all files previously using LGPL 2 2009-03-03 20:23:02 +00:00
mainloop.c core: Remove dead code in pa_mainloop_run() 2013-12-20 12:55:17 +01:00
mainloop.h doxygen: Add 'See also' linking to the overview page 2010-10-13 09:07:39 +01:00
Makefile build-sys: readd stub makefiles to subdirectories to make building with emacs easier 2012-05-15 14:17:58 +02:00
operation.c pulse: Initialize pa_operation objects to all-zero. 2013-01-13 03:15:23 +02:00
operation.h pulse: Document the operation state behavior on context disconnection. 2013-03-13 16:10:16 +02:00
proplist.c hashmap: Add the ability to free keys 2013-09-17 18:01:22 +05:30
proplist.h doc: Mostly fixing up i.e. versus i.e.\ in doxygen documentation 2013-04-17 08:08:42 +02:00
pulseaudio.h pulse: Document general error handling. 2012-01-28 15:07:20 +02:00
rtclock.c Add sys/time.h include to rtclock.c 2011-06-24 00:29:47 +01:00
rtclock.h Remove unnecessary #includes 2011-06-22 23:12:20 +01:00
sample.c Add pa_channels_valid() 2013-12-15 11:44:35 +01:00
sample.h Add pa_channels_valid() 2013-12-15 11:44:35 +01:00
scache.c Remove pa_bool_t and replace it with bool. 2013-07-04 12:25:30 +03:00
scache.h doxygen: Add 'See also' linking to the overview page 2010-10-13 09:07:39 +01:00
simple.c simple: Enable pa_simple_flush() on record streams and amend documentation 2013-12-20 12:50:23 +02:00
simple.h simple: Enable pa_simple_flush() on record streams and amend documentation 2013-12-20 12:50:23 +02:00
stream.c Add pa_sample_rate_valid() 2013-12-15 11:21:56 +01:00
stream.h Documentation of known misuse of PulseAudio API 2014-01-03 12:53:07 +02:00
subscribe.c Remove unnecessary #includes 2011-06-22 23:12:20 +01:00
subscribe.h Style fix: Remove new lines from opening brackets 2013-06-24 16:56:24 +03:00
thread-mainloop.c Remove pa_bool_t and replace it with bool. 2013-07-04 12:25:30 +03:00
thread-mainloop.h mainloop: Add API to set thread name for threaded mainloop 2013-06-04 00:38:43 +05:30
timeval.c More spelling fixes 2011-08-25 11:27:47 +01:00
timeval.h Spelling fixes in public headers 2011-08-25 11:27:35 +01:00
utf8.c Remove pa_bool_t and replace it with bool. 2013-07-04 12:25:30 +03:00
utf8.h utf8: Fix doxygen file description for utf8.h 2011-12-12 23:57:54 +00:00
util.c win32: Make some unused-variable warnings go away 2011-06-24 00:34:05 +01:00
util.h Remove unnecessary #includes 2011-06-22 23:12:20 +01:00
version.h.in libpulse: Always return a three part version number in API calls. 2011-10-01 13:21:03 +01:00
volume.c Add pa_channels_valid() 2013-12-15 11:44:35 +01:00
volume.h Documentation of known misuse of PulseAudio API 2014-01-03 12:53:07 +02:00
xmalloc.c Use LGPL 2.1 on all files previously using LGPL 2 2009-03-03 20:23:02 +00:00
xmalloc.h malloc: implement pa_xrenew() 2009-06-17 03:07:42 +02:00