mirrors/pulseaudio
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pulseaudio/pulseaudio.git synced 2025-11-02 09:01:46 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Document explicitly that the internal sink/source states are not considered part of the ABI/API

Browse source
This commit is contained in:
Lennart Poettering 2009-01-19 23:54:44 +01:00
parent 310f433848
commit 8886e66ff6
1 changed files with 18 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

24
src/pulse/def.h
View file

@ -627,13 +627,19 @@ typedef enum pa_sink_state { /* enum serialized in u8 */
PA_SINK_SUSPENDED = 2,
/**< When suspended, actual sink access can be closed, for instance \since 0.9.15 */
/* *** PRIVATE: server-side values *** */
/** \cond fulldocs */
/* PRIVATE: Server-side values -- DO NOT USE THIS ON THE CLIENT
* SIDE! These values are *not* considered part of the official PA
* API/ABI. If you use them your application might break when PA
* is upgraded. Also, please note that these values are not useful
* on the client side anyway. */
PA_SINK_INIT = -2,
/* Initialization state */
/**< Initialization state */
PA_SINK_UNLINKED = -3
/* The state when the sink is getting unregistered and removed from client access */
/**< The state when the sink is getting unregistered and removed from client access */
/** \endcond */
} pa_sink_state_t;
@ -696,13 +702,19 @@ typedef enum pa_source_state {
PA_SOURCE_SUSPENDED = 2,
/**< When suspended, actual source access can be closed, for instance \since 0.9.15 */
/* *** PRIVATE: server-side values *** */
/** \cond fulldocs */
/* PRIVATE: Server-side values -- DO NOT USE THIS ON THE CLIENT
* SIDE! These values are *not* considered part of the official PA
* API/ABI. If you use them your application might break when PA
* is upgraded. Also, please note that these values are not useful
* on the client side anyway. */
PA_SOURCE_INIT = -2,
/* Initialization state */
/**< Initialization state */
PA_SOURCE_UNLINKED = -3
/* The state when the source is getting unregistered and removed from client access */
/**< The state when the source is getting unregistered and removed from client access */
/** \endcond */
} pa_source_state_t;