1 #ifndef foointrospecthfoo
2 #define foointrospecthfoo
5 This file is part of PulseAudio.
7 Copyright 2004-2006 Lennart Poettering
8 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
10 PulseAudio is free software; you can redistribute it and/or modify
11 it under the terms of the GNU Lesser General Public License as published
12 by the Free Software Foundation; either version 2.1 of the License,
13 or (at your option) any later version.
15 PulseAudio is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 General Public License for more details.
20 You should have received a copy of the GNU Lesser General Public License
21 along with PulseAudio; if not, write to the Free Software
22 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
28 #include <pulse/operation.h>
29 #include <pulse/context.h>
30 #include <pulse/cdecl.h>
31 #include <pulse/gccmacro.h>
32 #include <pulse/channelmap.h>
33 #include <pulse/volume.h>
34 #include <pulse/proplist.h>
35 #include <pulse/version.h>
37 /** \page introspect Server Query and Control
39 * \section overv_sec Overview
41 * Sometimes it is necessary to query and modify global settings in the
42 * server. For this, PulseAudio has the introspection API. It can list sinks,
43 * sources, samples and other aspects of the server. It can also modify the
44 * attributes of the server that will affect operations on a global level,
45 * and not just the application's context.
47 * \section query_sec Querying
49 * All querying is done through callbacks. This design is necessary to
50 * maintain an asynchronous design. The client will request the information
51 * and some time later, the server will respond with the desired data.
53 * Some objects can have multiple entries at the server. When requesting all
54 * of these at once, the callback will be called multiple times, once for
55 * each object. When the list has been exhausted, the callback will be called
56 * without an information structure and the eol parameter set to a positive
59 * Note that even if a single object is requested, and not the entire list,
60 * the terminating call will still be made.
62 * If an error occurs, the callback will be called without and information
63 * structure and eol set to a negative value..
65 * Data members in the information structures are only valid during the
66 * duration of the callback. If they are required after the callback is
67 * finished, a deep copy must be performed.
69 * \subsection server_subsec Server Information
71 * The server can be queried about its name, the environment it's running on
72 * and the currently active global defaults. Calling
73 * pa_context_get_server_info() will get access to a pa_server_info structure
74 * containing all of these.
76 * \subsection memstat_subsec Memory Usage
78 * Statistics about memory usage can be fetched using pa_context_stat(),
79 * giving a pa_stat_info structure.
81 * \subsection sinksrc_subsec Sinks and Sources
83 * The server can have an arbitrary number of sinks and sources. Each sink
84 * and source have both an index and a name associated with it. As such
85 * there are three ways to get access to them:
87 * \li By index - pa_context_get_sink_info_by_index() /
88 * pa_context_get_source_info_by_index()
89 * \li By name - pa_context_get_sink_info_by_name() /
90 * pa_context_get_source_info_by_name()
91 * \li All - pa_context_get_sink_info_list() /
92 * pa_context_get_source_info_list()
94 * All three method use the same callback and will provide a pa_sink_info or
95 * pa_source_info structure.
97 * \subsection siso_subsec Sink Inputs and Source Outputs
99 * Sink inputs and source outputs are the representations of the client ends
100 * of streams inside the server. I.e. they connect a client stream to one of
101 * the global sinks or sources.
103 * Sink inputs and source outputs only have an index to identify them. As
104 * such, there are only two ways to get information about them:
106 * \li By index - pa_context_get_sink_input_info() /
107 * pa_context_get_source_output_info()
108 * \li All - pa_context_get_sink_input_info_list() /
109 * pa_context_get_source_output_info_list()
111 * The structure returned is the pa_sink_input_info or pa_source_output_info
114 * \subsection samples_subsec Samples
116 * The list of cached samples can be retrieved from the server. Three methods
117 * exist for querying the sample cache list:
119 * \li By index - pa_context_get_sample_info_by_index()
120 * \li By name - pa_context_get_sample_info_by_name()
121 * \li All - pa_context_get_sample_info_list()
123 * Note that this only retrieves information about the sample, not the sample
126 * \subsection module_subsec Driver Modules
128 * PulseAudio driver modules are identified by index and are retrieved using either
129 * pa_context_get_module_info() or pa_context_get_module_info_list(). The
130 * information structure is called pa_module_info.
132 * \subsection client_subsec Clients
134 * PulseAudio clients are also identified by index and are retrieved using
135 * either pa_context_get_client_info() or pa_context_get_client_info_list().
136 * The information structure is called pa_client_info.
138 * \section ctrl_sec Control
140 * Some parts of the server are only possible to read, but most can also be
141 * modified in different ways. Note that these changes will affect all
142 * connected clients and not just the one issuing the request.
144 * \subsection sinksrc_subsec Sinks and Sources
146 * The most common change one would want to do to sinks and sources is to
147 * modify the volume of the audio. Identical to how sinks and sources can
148 * be queried, there are two ways of identifying them:
150 * \li By index - pa_context_set_sink_volume_by_index() /
151 * pa_context_set_source_volume_by_index()
152 * \li By name - pa_context_set_sink_volume_by_name() /
153 * pa_context_set_source_volume_by_name()
155 * It is also possible to mute a sink or source:
157 * \li By index - pa_context_set_sink_mute_by_index() /
158 * pa_context_set_source_mute_by_index()
159 * \li By name - pa_context_set_sink_mute_by_name() /
160 * pa_context_set_source_mute_by_name()
162 * \subsection siso_subsec Sink Inputs and Source Outputs
164 * If an application desires to modify the volume of just a single stream
165 * (commonly one of its own streams), this can be done by setting the volume
166 * of its associated sink input, using pa_context_set_sink_input_volume().
168 * There is no support for modifying the volume of source outputs.
170 * It is also possible to remove sink inputs and source outputs, terminating
171 * the streams associated with them:
173 * \li Sink input - pa_context_kill_sink_input()
174 * \li Source output - pa_context_kill_source_output()
176 * \subsection module_subsec Modules
178 * Server modules can be remotely loaded and unloaded using
179 * pa_context_load_module() and pa_context_unload_module().
181 * \subsection client_subsec Clients
183 * The only operation supported on clients, is the possibility of kicking
184 * them off the server using pa_context_kill_client().
189 * Routines for daemon introspection.
194 /** @{ \name Sinks */
196 /** Stores information about sinks. Please note that this structure
197 * can be extended as part of evolutionary API updates at any time in
198 * any new release. */
199 typedef struct pa_sink_info
{
200 const char *name
; /**< Name of the sink */
201 uint32_t index
; /**< Index of the sink */
202 const char *description
; /**< Description of this sink */
203 pa_sample_spec sample_spec
; /**< Sample spec of this sink */
204 pa_channel_map channel_map
; /**< Channel map */
205 uint32_t owner_module
; /**< Index of the owning module of this sink, or PA_INVALID_INDEX */
206 pa_cvolume volume
; /**< Volume of the sink */
207 int mute
; /**< Mute switch of the sink */
208 uint32_t monitor_source
; /**< Index of the monitor source connected to this sink */
209 const char *monitor_source_name
; /**< The name of the monitor source */
210 pa_usec_t latency
; /**< Length of queued audio in the output buffer. */
211 const char *driver
; /**< Driver name. */
212 pa_sink_flags_t flags
; /**< Flags */
213 pa_proplist
*proplist
; /**< Property list \since 0.9.11 */
214 pa_usec_t configured_latency
; /**< The latency this device has been configured to. \since 0.9.11 */
215 pa_volume_t base_volume
; /**< Some kind of "base" volume that refers to unamplified/unattenuated volume in the context of the output device. \since 0.9.15 */
216 pa_sink_state_t state
; /**< State \since 0.9.15 */
217 uint32_t n_volume_steps
; /**< Number of volume steps for sinks which do not support arbitrary volumes. \since 0.9.15 */
218 uint32_t card
; /**< Card index, or PA_INVALID_INDEX. \since 0.9.15 */
221 /** Callback prototype for pa_context_get_sink_info_by_name() and friends */
222 typedef void (*pa_sink_info_cb_t
)(pa_context
*c
, const pa_sink_info
*i
, int eol
, void *userdata
);
224 /** Get information about a sink by its name */
225 pa_operation
* pa_context_get_sink_info_by_name(pa_context
*c
, const char *name
, pa_sink_info_cb_t cb
, void *userdata
);
227 /** Get information about a sink by its index */
228 pa_operation
* pa_context_get_sink_info_by_index(pa_context
*c
, uint32_t idx
, pa_sink_info_cb_t cb
, void *userdata
);
230 /** Get the complete sink list */
231 pa_operation
* pa_context_get_sink_info_list(pa_context
*c
, pa_sink_info_cb_t cb
, void *userdata
);
233 /** Set the volume of a sink device specified by its index */
234 pa_operation
* pa_context_set_sink_volume_by_index(pa_context
*c
, uint32_t idx
, const pa_cvolume
*volume
, pa_context_success_cb_t cb
, void *userdata
);
236 /** Set the volume of a sink device specified by its name */
237 pa_operation
* pa_context_set_sink_volume_by_name(pa_context
*c
, const char *name
, const pa_cvolume
*volume
, pa_context_success_cb_t cb
, void *userdata
);
239 /** Set the mute switch of a sink device specified by its index */
240 pa_operation
* pa_context_set_sink_mute_by_index(pa_context
*c
, uint32_t idx
, int mute
, pa_context_success_cb_t cb
, void *userdata
);
242 /** Set the mute switch of a sink device specified by its name */
243 pa_operation
* pa_context_set_sink_mute_by_name(pa_context
*c
, const char *name
, int mute
, pa_context_success_cb_t cb
, void *userdata
);
245 /** Suspend/Resume a sink. \since 0.9.7 */
246 pa_operation
* pa_context_suspend_sink_by_name(pa_context
*c
, const char *sink_name
, int suspend
, pa_context_success_cb_t cb
, void* userdata
);
248 /** Suspend/Resume a sink. If idx is PA_INVALID_INDEX all sinks will be suspended. \since 0.9.7 */
249 pa_operation
* pa_context_suspend_sink_by_index(pa_context
*c
, uint32_t idx
, int suspend
, pa_context_success_cb_t cb
, void* userdata
);
251 /** Change the profile of a sink. \since 0.9.16 */
252 pa_operation
* pa_context_set_sink_port_by_index(pa_context
*c
, uint32_t idx
, const char*port
, pa_context_success_cb_t cb
, void *userdata
);
254 /** Change the profile of a sink. \since 0.9.15 */
255 pa_operation
* pa_context_set_sink_port_by_name(pa_context
*c
, const char*name
, const char*port
, pa_context_success_cb_t cb
, void *userdata
);
259 /** @{ \name Sources */
261 /** Stores information about sources. Please note that this structure
262 * can be extended as part of evolutionary API updates at any time in
263 * any new release. */
264 typedef struct pa_source_info
{
265 const char *name
; /**< Name of the source */
266 uint32_t index
; /**< Index of the source */
267 const char *description
; /**< Description of this source */
268 pa_sample_spec sample_spec
; /**< Sample spec of this source */
269 pa_channel_map channel_map
; /**< Channel map */
270 uint32_t owner_module
; /**< Owning module index, or PA_INVALID_INDEX */
271 pa_cvolume volume
; /**< Volume of the source */
272 int mute
; /**< Mute switch of the sink */
273 uint32_t monitor_of_sink
; /**< If this is a monitor source the index of the owning sink, otherwise PA_INVALID_INDEX */
274 const char *monitor_of_sink_name
; /**< Name of the owning sink, or PA_INVALID_INDEX */
275 pa_usec_t latency
; /**< Length of filled record buffer of this source. */
276 const char *driver
; /**< Driver name */
277 pa_source_flags_t flags
; /**< Flags */
278 pa_proplist
*proplist
; /**< Property list \since 0.9.11 */
279 pa_usec_t configured_latency
; /**< The latency this device has been configured to. \since 0.9.11 */
280 pa_volume_t base_volume
; /**< Some kind of "base" volume that refers to unamplified/unattenuated volume in the context of the input device. \since 0.9.15 */
281 pa_source_state_t state
; /**< State \since 0.9.15 */
282 uint32_t n_volume_steps
; /**< Number of volume steps for sources which do not support arbitrary volumes. \since 0.9.15 */
283 uint32_t card
; /**< Card index, or PA_INVALID_INDEX. \since 0.9.15 */
286 /** Callback prototype for pa_context_get_source_info_by_name() and friends */
287 typedef void (*pa_source_info_cb_t
)(pa_context
*c
, const pa_source_info
*i
, int eol
, void *userdata
);
289 /** Get information about a source by its name */
290 pa_operation
* pa_context_get_source_info_by_name(pa_context
*c
, const char *name
, pa_source_info_cb_t cb
, void *userdata
);
292 /** Get information about a source by its index */
293 pa_operation
* pa_context_get_source_info_by_index(pa_context
*c
, uint32_t idx
, pa_source_info_cb_t cb
, void *userdata
);
295 /** Get the complete source list */
296 pa_operation
* pa_context_get_source_info_list(pa_context
*c
, pa_source_info_cb_t cb
, void *userdata
);
298 /** Set the volume of a source device specified by its index */
299 pa_operation
* pa_context_set_source_volume_by_index(pa_context
*c
, uint32_t idx
, const pa_cvolume
*volume
, pa_context_success_cb_t cb
, void *userdata
);
301 /** Set the volume of a source device specified by its name */
302 pa_operation
* pa_context_set_source_volume_by_name(pa_context
*c
, const char *name
, const pa_cvolume
*volume
, pa_context_success_cb_t cb
, void *userdata
);
304 /** Set the mute switch of a source device specified by its index */
305 pa_operation
* pa_context_set_source_mute_by_index(pa_context
*c
, uint32_t idx
, int mute
, pa_context_success_cb_t cb
, void *userdata
);
307 /** Set the mute switch of a source device specified by its name */
308 pa_operation
* pa_context_set_source_mute_by_name(pa_context
*c
, const char *name
, int mute
, pa_context_success_cb_t cb
, void *userdata
);
310 /** Change the profile of a source. \since 0.9.16 */
311 pa_operation
* pa_context_set_source_port_by_index(pa_context
*c
, uint32_t idx
, const char*port
, pa_context_success_cb_t cb
, void *userdata
);
313 /** Change the profile of a source. \since 0.9.15 */
314 pa_operation
* pa_context_set_source_port_by_name(pa_context
*c
, const char*name
, const char*port
, pa_context_success_cb_t cb
, void *userdata
);
318 /** @{ \name Server */
320 /** Server information. Please note that this structure can be
321 * extended as part of evolutionary API updates at any time in any new
323 typedef struct pa_server_info
{
324 const char *user_name
; /**< User name of the daemon process */
325 const char *host_name
; /**< Host name the daemon is running on */
326 const char *server_version
; /**< Version string of the daemon */
327 const char *server_name
; /**< Server package name (usually "pulseaudio") */
328 pa_sample_spec sample_spec
; /**< Default sample specification */
329 const char *default_sink_name
; /**< Name of default sink. */
330 const char *default_source_name
; /**< Name of default sink. */
331 uint32_t cookie
; /**< A random cookie for identifying this instance of PulseAudio. */
332 pa_channel_map channel_map
; /**< Default channel map. \since 0.9.15 */
335 /** Callback prototype for pa_context_get_server_info() */
336 typedef void (*pa_server_info_cb_t
) (pa_context
*c
, const pa_server_info
*i
, void *userdata
);
338 /** Get some information about the server */
339 pa_operation
* pa_context_get_server_info(pa_context
*c
, pa_server_info_cb_t cb
, void *userdata
);
343 /** @{ \name Modules */
345 /** Stores information about modules. Please note that this structure
346 * can be extended as part of evolutionary API updates at any time in
347 * any new release. */
348 typedef struct pa_module_info
{
349 uint32_t index
; /**< Index of the module */
350 const char*name
, /**< Name of the module */
351 *argument
; /**< Argument string of the module */
352 uint32_t n_used
; /**< Usage counter or PA_INVALID_INDEX */
353 /** \cond fulldocs */
354 int auto_unload
; /**< \deprecated Non-zero if this is an autoloaded module */
356 pa_proplist
*proplist
; /**< Property list \since 0.9.15 */
359 /** Callback prototype for pa_context_get_module_info() and friends*/
360 typedef void (*pa_module_info_cb_t
) (pa_context
*c
, const pa_module_info
*i
, int eol
, void *userdata
);
362 /** Get some information about a module by its index */
363 pa_operation
* pa_context_get_module_info(pa_context
*c
, uint32_t idx
, pa_module_info_cb_t cb
, void *userdata
);
365 /** Get the complete list of currently loaded modules */
366 pa_operation
* pa_context_get_module_info_list(pa_context
*c
, pa_module_info_cb_t cb
, void *userdata
);
368 /** Callback prototype for pa_context_load_module() */
369 typedef void (*pa_context_index_cb_t
)(pa_context
*c
, uint32_t idx
, void *userdata
);
371 /** Load a module. */
372 pa_operation
* pa_context_load_module(pa_context
*c
, const char*name
, const char *argument
, pa_context_index_cb_t cb
, void *userdata
);
374 /** Unload a module. */
375 pa_operation
* pa_context_unload_module(pa_context
*c
, uint32_t idx
, pa_context_success_cb_t cb
, void *userdata
);
379 /** @{ \name Clients */
381 /** Stores information about clients. Please note that this structure
382 * can be extended as part of evolutionary API updates at any time in
383 * any new release. */
384 typedef struct pa_client_info
{
385 uint32_t index
; /**< Index of this client */
386 const char *name
; /**< Name of this client */
387 uint32_t owner_module
; /**< Index of the owning module, or PA_INVALID_INDEX */
388 const char *driver
; /**< Driver name */
389 pa_proplist
*proplist
; /**< Property list \since 0.9.11 */
392 /** Callback prototype for pa_context_get_client_info() and friends*/
393 typedef void (*pa_client_info_cb_t
) (pa_context
*c
, const pa_client_info
*i
, int eol
, void *userdata
);
395 /** Get information about a client by its index */
396 pa_operation
* pa_context_get_client_info(pa_context
*c
, uint32_t idx
, pa_client_info_cb_t cb
, void *userdata
);
398 /** Get the complete client list */
399 pa_operation
* pa_context_get_client_info_list(pa_context
*c
, pa_client_info_cb_t cb
, void *userdata
);
401 /** Kill a client. */
402 pa_operation
* pa_context_kill_client(pa_context
*c
, uint32_t idx
, pa_context_success_cb_t cb
, void *userdata
);
406 /** @{ \name Cards */
408 /** Stores information about a specific profile of a card. Please
409 * note that this structure can be extended as part of evolutionary
410 * API updates at any time in any new release. \since 0.9.15 */
411 typedef struct pa_card_profile_info
{
412 const char *name
; /**< Name of this profile */
413 const char *description
; /**< Description of this profile */
414 uint32_t n_sinks
; /**< Number of sinks this profile would create */
415 uint32_t n_sources
; /**< Number of sources this profile would create */
416 uint32_t priority
; /**< The higher this value is the more useful this profile is as a default */
417 } pa_card_profile_info
;
419 /** Stores information about cards. Please note that this structure
420 * can be extended as part of evolutionary API updates at any time in
421 * any new release. \since 0.9.15 */
422 typedef struct pa_card_info
{
423 uint32_t index
; /**< Index of this card */
424 const char *name
; /**< Name of this card */
425 uint32_t owner_module
; /**< Index of the owning module, or PA_INVALID_INDEX */
426 const char *driver
; /**< Driver name */
427 uint32_t n_profiles
; /**< Number of entries in profile array */
428 pa_card_profile_info
* profiles
; /**< Array of available profile, or NULL. Array is terminated by an entry with name set to NULL. Number of entries is stored in n_profiles */
429 pa_card_profile_info
* active_profile
; /**< Pointer to active profile in the array, or NULL */
430 pa_proplist
*proplist
; /**< Property list */
433 /** Callback prototype for pa_context_get_card_info() and friends \since 0.9.15 */
434 typedef void (*pa_card_info_cb_t
) (pa_context
*c
, const pa_card_info
*i
, int eol
, void *userdata
);
436 /** Get information about a card by its index \since 0.9.15 */
437 pa_operation
* pa_context_get_card_info_by_index(pa_context
*c
, uint32_t idx
, pa_card_info_cb_t cb
, void *userdata
);
439 /** Get information about a card by its name \since 0.9.15 */
440 pa_operation
* pa_context_get_card_info_by_name(pa_context
*c
, const char *name
, pa_card_info_cb_t cb
, void *userdata
);
442 /** Get the complete card list \since 0.9.15 */
443 pa_operation
* pa_context_get_card_info_list(pa_context
*c
, pa_card_info_cb_t cb
, void *userdata
);
445 /** Change the profile of a card. \since 0.9.15 */
446 pa_operation
* pa_context_set_card_profile_by_index(pa_context
*c
, uint32_t idx
, const char*profile
, pa_context_success_cb_t cb
, void *userdata
);
448 /** Change the profile of a card. \since 0.9.15 */
449 pa_operation
* pa_context_set_card_profile_by_name(pa_context
*c
, const char*name
, const char*profile
, pa_context_success_cb_t cb
, void *userdata
);
453 /** @{ \name Sink Inputs */
455 /** Stores information about sink inputs. Please note that this structure
456 * can be extended as part of evolutionary API updates at any time in
457 * any new release. */
458 typedef struct pa_sink_input_info
{
459 uint32_t index
; /**< Index of the sink input */
460 const char *name
; /**< Name of the sink input */
461 uint32_t owner_module
; /**< Index of the module this sink input belongs to, or PA_INVALID_INDEX when it does not belong to any module */
462 uint32_t client
; /**< Index of the client this sink input belongs to, or PA_INVALID_INDEX when it does not belong to any client */
463 uint32_t sink
; /**< Index of the connected sink */
464 pa_sample_spec sample_spec
; /**< The sample specification of the sink input */
465 pa_channel_map channel_map
; /**< Channel map */
466 pa_cvolume volume
; /**< The volume of this sink input */
467 pa_usec_t buffer_usec
; /**< Latency due to buffering in sink input, see pa_latency_info for details */
468 pa_usec_t sink_usec
; /**< Latency of the sink device, see pa_latency_info for details */
469 const char *resample_method
; /**< The resampling method used by this sink input. */
470 const char *driver
; /**< Driver name */
471 int mute
; /**< Stream muted \since 0.9.7 */
472 pa_proplist
*proplist
; /**< Property list \since 0.9.11 */
473 } pa_sink_input_info
;
475 /** Callback prototype for pa_context_get_sink_input_info() and friends*/
476 typedef void (*pa_sink_input_info_cb_t
) (pa_context
*c
, const pa_sink_input_info
*i
, int eol
, void *userdata
);
478 /** Get some information about a sink input by its index */
479 pa_operation
* pa_context_get_sink_input_info(pa_context
*c
, uint32_t idx
, pa_sink_input_info_cb_t cb
, void *userdata
);
481 /** Get the complete sink input list */
482 pa_operation
* pa_context_get_sink_input_info_list(pa_context
*c
, pa_sink_input_info_cb_t cb
, void *userdata
);
484 /** Move the specified sink input to a different sink. \since 0.9.5 */
485 pa_operation
* pa_context_move_sink_input_by_name(pa_context
*c
, uint32_t idx
, const char *sink_name
, pa_context_success_cb_t cb
, void* userdata
);
487 /** Move the specified sink input to a different sink. \since 0.9.5 */
488 pa_operation
* pa_context_move_sink_input_by_index(pa_context
*c
, uint32_t idx
, uint32_t sink_idx
, pa_context_success_cb_t cb
, void* userdata
);
490 /** Set the volume of a sink input stream */
491 pa_operation
* pa_context_set_sink_input_volume(pa_context
*c
, uint32_t idx
, const pa_cvolume
*volume
, pa_context_success_cb_t cb
, void *userdata
);
493 /** Set the mute switch of a sink input stream \since 0.9.7 */
494 pa_operation
* pa_context_set_sink_input_mute(pa_context
*c
, uint32_t idx
, int mute
, pa_context_success_cb_t cb
, void *userdata
);
496 /** Kill a sink input. */
497 pa_operation
* pa_context_kill_sink_input(pa_context
*c
, uint32_t idx
, pa_context_success_cb_t cb
, void *userdata
);
501 /** @{ \name Source Outputs */
503 /** Stores information about source outputs. Please note that this structure
504 * can be extended as part of evolutionary API updates at any time in
505 * any new release. */
506 typedef struct pa_source_output_info
{
507 uint32_t index
; /**< Index of the sink input */
508 const char *name
; /**< Name of the sink input */
509 uint32_t owner_module
; /**< Index of the module this sink input belongs to, or PA_INVALID_INDEX when it does not belong to any module */
510 uint32_t client
; /**< Index of the client this sink input belongs to, or PA_INVALID_INDEX when it does not belong to any client */
511 uint32_t source
; /**< Index of the connected source */
512 pa_sample_spec sample_spec
; /**< The sample specification of the source output */
513 pa_channel_map channel_map
; /**< Channel map */
514 pa_usec_t buffer_usec
; /**< Latency due to buffering in the source output, see pa_latency_info for details. */
515 pa_usec_t source_usec
; /**< Latency of the source device, see pa_latency_info for details. */
516 const char *resample_method
; /**< The resampling method used by this source output. */
517 const char *driver
; /**< Driver name */
518 pa_proplist
*proplist
; /**< Property list \since 0.9.11 */
519 } pa_source_output_info
;
521 /** Callback prototype for pa_context_get_source_output_info() and friends*/
522 typedef void (*pa_source_output_info_cb_t
) (pa_context
*c
, const pa_source_output_info
*i
, int eol
, void *userdata
);
524 /** Get information about a source output by its index */
525 pa_operation
* pa_context_get_source_output_info(pa_context
*c
, uint32_t idx
, pa_source_output_info_cb_t cb
, void *userdata
);
527 /** Get the complete list of source outputs */
528 pa_operation
* pa_context_get_source_output_info_list(pa_context
*c
, pa_source_output_info_cb_t cb
, void *userdata
);
530 /** Move the specified source output to a different source. \since 0.9.5 */
531 pa_operation
* pa_context_move_source_output_by_name(pa_context
*c
, uint32_t idx
, const char *source_name
, pa_context_success_cb_t cb
, void* userdata
);
533 /** Move the specified source output to a different source. \since 0.9.5 */
534 pa_operation
* pa_context_move_source_output_by_index(pa_context
*c
, uint32_t idx
, uint32_t source_idx
, pa_context_success_cb_t cb
, void* userdata
);
536 /** Suspend/Resume a source. \since 0.9.7 */
537 pa_operation
* pa_context_suspend_source_by_name(pa_context
*c
, const char *source_name
, int suspend
, pa_context_success_cb_t cb
, void* userdata
);
539 /** Suspend/Resume a source. If idx is PA_INVALID_INDEX all sources will be suspended. \since 0.9.7 */
540 pa_operation
* pa_context_suspend_source_by_index(pa_context
*c
, uint32_t idx
, int suspend
, pa_context_success_cb_t cb
, void* userdata
);
542 /** Kill a source output. */
543 pa_operation
* pa_context_kill_source_output(pa_context
*c
, uint32_t idx
, pa_context_success_cb_t cb
, void *userdata
);
547 /** @{ \name Statistics */
549 /** Memory block statistics. Please note that this structure
550 * can be extended as part of evolutionary API updates at any time in
551 * any new release. */
552 typedef struct pa_stat_info
{
553 uint32_t memblock_total
; /**< Currently allocated memory blocks */
554 uint32_t memblock_total_size
; /**< Current total size of allocated memory blocks */
555 uint32_t memblock_allocated
; /**< Allocated memory blocks during the whole lifetime of the daemon */
556 uint32_t memblock_allocated_size
; /**< Total size of all memory blocks allocated during the whole lifetime of the daemon */
557 uint32_t scache_size
; /**< Total size of all sample cache entries. */
560 /** Callback prototype for pa_context_stat() */
561 typedef void (*pa_stat_info_cb_t
) (pa_context
*c
, const pa_stat_info
*i
, void *userdata
);
563 /** Get daemon memory block statistics */
564 pa_operation
* pa_context_stat(pa_context
*c
, pa_stat_info_cb_t cb
, void *userdata
);
568 /** @{ \name Cached Samples */
570 /** Stores information about sample cache entries. Please note that this structure
571 * can be extended as part of evolutionary API updates at any time in
572 * any new release. */
573 typedef struct pa_sample_info
{
574 uint32_t index
; /**< Index of this entry */
575 const char *name
; /**< Name of this entry */
576 pa_cvolume volume
; /**< Default volume of this entry */
577 pa_sample_spec sample_spec
; /**< Sample specification of the sample */
578 pa_channel_map channel_map
; /**< The channel map */
579 pa_usec_t duration
; /**< Duration of this entry */
580 uint32_t bytes
; /**< Length of this sample in bytes. */
581 int lazy
; /**< Non-zero when this is a lazy cache entry. */
582 const char *filename
; /**< In case this is a lazy cache entry, the filename for the sound file to be loaded on demand. */
583 pa_proplist
*proplist
; /**< Property list for this sample. \since 0.9.11 */
586 /** Callback prototype for pa_context_get_sample_info_by_name() and friends */
587 typedef void (*pa_sample_info_cb_t
)(pa_context
*c
, const pa_sample_info
*i
, int eol
, void *userdata
);
589 /** Get information about a sample by its name */
590 pa_operation
* pa_context_get_sample_info_by_name(pa_context
*c
, const char *name
, pa_sample_info_cb_t cb
, void *userdata
);
592 /** Get information about a sample by its index */
593 pa_operation
* pa_context_get_sample_info_by_index(pa_context
*c
, uint32_t idx
, pa_sample_info_cb_t cb
, void *userdata
);
595 /** Get the complete list of samples stored in the daemon. */
596 pa_operation
* pa_context_get_sample_info_list(pa_context
*c
, pa_sample_info_cb_t cb
, void *userdata
);
600 /** \cond fulldocs */
602 /** @{ \name Autoload Entries */
604 /** \deprecated Type of an autoload entry. */
605 typedef enum pa_autoload_type
{
606 PA_AUTOLOAD_SINK
= 0,
607 PA_AUTOLOAD_SOURCE
= 1
608 } pa_autoload_type_t
;
610 /** \deprecated Stores information about autoload entries. Please note that this structure
611 * can be extended as part of evolutionary API updates at any time in
612 * any new release. */
613 typedef struct pa_autoload_info
{
614 uint32_t index
; /**< Index of this autoload entry */
615 const char *name
; /**< Name of the sink or source */
616 pa_autoload_type_t type
; /**< Type of the autoload entry */
617 const char *module
; /**< Module name to load */
618 const char *argument
; /**< Argument string for module */
621 /** \deprecated Callback prototype for pa_context_get_autoload_info_by_name() and friends */
622 typedef void (*pa_autoload_info_cb_t
)(pa_context
*c
, const pa_autoload_info
*i
, int eol
, void *userdata
);
624 /** \deprecated Get info about a specific autoload entry. */
625 pa_operation
* pa_context_get_autoload_info_by_name(pa_context
*c
, const char *name
, pa_autoload_type_t type
, pa_autoload_info_cb_t cb
, void *userdata
) PA_GCC_DEPRECATED
;
627 /** \deprecated Get info about a specific autoload entry. */
628 pa_operation
* pa_context_get_autoload_info_by_index(pa_context
*c
, uint32_t idx
, pa_autoload_info_cb_t cb
, void *userdata
) PA_GCC_DEPRECATED
;
630 /** \deprecated Get the complete list of autoload entries. */
631 pa_operation
* pa_context_get_autoload_info_list(pa_context
*c
, pa_autoload_info_cb_t cb
, void *userdata
) PA_GCC_DEPRECATED
;
633 /** \deprecated Add a new autoload entry. */
634 pa_operation
* pa_context_add_autoload(pa_context
*c
, const char *name
, pa_autoload_type_t type
, const char *module
, const char*argument
, pa_context_index_cb_t
, void* userdata
) PA_GCC_DEPRECATED
;
636 /** \deprecated Remove an autoload entry. */
637 pa_operation
* pa_context_remove_autoload_by_name(pa_context
*c
, const char *name
, pa_autoload_type_t type
, pa_context_success_cb_t cb
, void* userdata
) PA_GCC_DEPRECATED
;
639 /** \deprecated Remove an autoload entry. */
640 pa_operation
* pa_context_remove_autoload_by_index(pa_context
*c
, uint32_t idx
, pa_context_success_cb_t cb
, void* userdata
) PA_GCC_DEPRECATED
;