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 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>
36 /** \page introspect Server Query and Control
38 * \section overv_sec Overview
40 * Sometimes it is necessary to query and modify global settings in the
41 * server. For this, PulseAudio has the introspection API. It can list sinks,
42 * sources, samples and other aspects of the server. It can also modify the
43 * attributes of the server that will affect operations on a global level,
44 * and not just the application's context.
46 * \section query_sec Querying
48 * All querying is done through callbacks. This design is necessary to
49 * maintain an asynchronous design. The client will request the information
50 * and some time later, the server will respond with the desired data.
52 * Some objects can have multiple entries at the server. When requesting all
53 * of these at once, the callback will be called multiple times, once for
54 * each object. When the list has been exhausted, the callback will be called
55 * without an information structure and the eol parameter set to a non-zero
58 * Note that even if a single object is requested, and not the entire list,
59 * the terminating call will still be made.
61 * If an error occurs, the callback will be called without and information
62 * structure and eol set to zero.
64 * Data members in the information structures are only valid during the
65 * duration of the callback. If they are required after the callback is
66 * finished, a deep copy must be performed.
68 * \subsection server_subsec Server Information
70 * The server can be queried about its name, the environment it's running on
71 * and the currently active global defaults. Calling
72 * pa_context_get_server_info() will get access to a pa_server_info structure
73 * containing all of these.
75 * \subsection memstat_subsec Memory Usage
77 * Statistics about memory usage can be fetched using pa_context_stat(),
78 * giving a pa_stat_info structure.
80 * \subsection sinksrc_subsec Sinks and Sources
82 * The server can have an arbitrary number of sinks and sources. Each sink
83 * and source have both an index and a name associated with it. As such
84 * there are three ways to get access to them:
86 * \li By index - pa_context_get_sink_info_by_index() /
87 * pa_context_get_source_info_by_index()
88 * \li By name - pa_context_get_sink_info_by_name() /
89 * pa_context_get_source_info_by_name()
90 * \li All - pa_context_get_sink_info_list() /
91 * pa_context_get_source_info_list()
93 * All three method use the same callback and will provide a pa_sink_info or
94 * pa_source_info structure.
96 * \subsection siso_subsec Sink Inputs and Source Outputs
98 * Sink inputs and source outputs are the representations of the client ends
99 * of streams inside the server. I.e. they connect a client stream to one of
100 * the global sinks or sources.
102 * Sink inputs and source outputs only have an index to identify them. As
103 * such, there are only two ways to get information about them:
105 * \li By index - pa_context_get_sink_input_info() /
106 * pa_context_get_source_output_info()
107 * \li All - pa_context_get_sink_input_info_list() /
108 * pa_context_get_source_output_info_list()
110 * The structure returned is the pa_sink_input_info or pa_source_output_info
113 * \subsection samples_subsec Samples
115 * The list of cached samples can be retrieved from the server. Three methods
116 * exist for querying the sample cache list:
118 * \li By index - pa_context_get_sample_info_by_index()
119 * \li By name - pa_context_get_sample_info_by_name()
120 * \li All - pa_context_get_sample_info_list()
122 * Note that this only retrieves information about the sample, not the sample
125 * \subsection module_subsec Driver Modules
127 * PulseAudio driver modules are identified by index and are retrieved using either
128 * pa_context_get_module_info() or pa_context_get_module_info_list(). The
129 * information structure is called pa_module_info.
131 * \subsection autoload_subsec Autoload Entries
133 * Modules can be autoloaded as a result of a client requesting a
134 * certain sink or source. Please note that autoloading is deprecated
135 * in 0.9.11. and is likely to be removed from the API in a later
136 * version. This mapping between sink/source names and modules can be
137 * queried from the server:
139 * \li By index - pa_context_get_autoload_info_by_index()
140 * \li By sink/source name - pa_context_get_autoload_info_by_name()
141 * \li All - pa_context_get_autoload_info_list()
143 * \subsection client_subsec Clients
145 * PulseAudio clients are also identified by index and are retrieved using
146 * either pa_context_get_client_info() or pa_context_get_client_info_list().
147 * The information structure is called pa_client_info.
149 * \section ctrl_sec Control
151 * Some parts of the server are only possible to read, but most can also be
152 * modified in different ways. Note that these changes will affect all
153 * connected clients and not just the one issuing the request.
155 * \subsection sinksrc_subsec Sinks and Sources
157 * The most common change one would want to do to sinks and sources is to
158 * modify the volume of the audio. Identical to how sinks and sources can
159 * be queried, there are two ways of identifying them:
161 * \li By index - pa_context_set_sink_volume_by_index() /
162 * pa_context_set_source_volume_by_index()
163 * \li By name - pa_context_set_sink_volume_by_name() /
164 * pa_context_set_source_volume_by_name()
166 * It is also possible to mute a sink or source:
168 * \li By index - pa_context_set_sink_mute_by_index() /
169 * pa_context_set_source_mute_by_index()
170 * \li By name - pa_context_set_sink_mute_by_name() /
171 * pa_context_set_source_mute_by_name()
173 * \subsection siso_subsec Sink Inputs and Source Outputs
175 * If an application desires to modify the volume of just a single stream
176 * (commonly one of its own streams), this can be done by setting the volume
177 * of its associated sink input, using pa_context_set_sink_input_volume().
179 * There is no support for modifying the volume of source outputs.
181 * It is also possible to remove sink inputs and source outputs, terminating
182 * the streams associated with them:
184 * \li Sink input - pa_context_kill_sink_input()
185 * \li Source output - pa_context_kill_source_output()
187 * \subsection module_subsec Modules
189 * Server modules can be remotely loaded and unloaded using
190 * pa_context_load_module() and pa_context_unload_module().
192 * \subsection autoload_subsec Autoload Entries
194 * New module autoloading rules can be added, and existing can be removed
195 * using pa_context_add_autoload() and pa_context_remove_autoload_by_index()
196 * / pa_context_remove_autoload_by_name(). Please note that autoloading is deprecated
197 * in 0.9.11. and is likely to be removed from the API in a later
200 * \subsection client_subsec Clients
202 * The only operation supported on clients, is the possibility of kicking
203 * them off the server using pa_context_kill_client().
208 * Routines for daemon introspection.
213 #define PA_PORT_DIGITAL "spdif"
214 #define PA_PORT_ANALOG_STEREO "analog-stereo"
215 #define PA_PORT_ANALOG_5_1 "analog-5-1"
216 #define PA_PORT_ANALOG_4_0 "analog-4-0"
218 /** @{ \name Sinks */
220 /** Stores information about sinks. Please note that this structure
221 * can be extended as part of evolutionary API updates at any time in
222 * any new release. */
223 typedef struct pa_sink_info
{
224 const char *name
; /**< Name of the sink */
225 uint32_t index
; /**< Index of the sink */
226 const char *description
; /**< Description of this sink */
227 pa_sample_spec sample_spec
; /**< Sample spec of this sink */
228 pa_channel_map channel_map
; /**< Channel map */
229 uint32_t owner_module
; /**< Index of the owning module of this sink, or PA_INVALID_INDEX */
230 pa_cvolume volume
; /**< Volume of the sink */
231 int mute
; /**< Mute switch of the sink */
232 uint32_t monitor_source
; /**< Index of the monitor source connected to this sink */
233 const char *monitor_source_name
; /**< The name of the monitor source */
234 pa_usec_t latency
; /**< Length of queued audio in the output buffer. */
235 const char *driver
; /**< Driver name. */
236 pa_sink_flags_t flags
; /**< Flags */
237 pa_proplist
*proplist
; /**< Property list \since 0.9.11 */
238 pa_usec_t configured_latency
; /**< The latency this device has been configured to. \since 0.9.11 */
241 /** Callback prototype for pa_context_get_sink_info_by_name() and friends */
242 typedef void (*pa_sink_info_cb_t
)(pa_context
*c
, const pa_sink_info
*i
, int eol
, void *userdata
);
244 /** Get information about a sink by its name */
245 pa_operation
* pa_context_get_sink_info_by_name(pa_context
*c
, const char *name
, pa_sink_info_cb_t cb
, void *userdata
);
247 /** Get information about a sink by its index */
248 pa_operation
* pa_context_get_sink_info_by_index(pa_context
*c
, uint32_t id
, pa_sink_info_cb_t cb
, void *userdata
);
250 /** Get the complete sink list */
251 pa_operation
* pa_context_get_sink_info_list(pa_context
*c
, pa_sink_info_cb_t cb
, void *userdata
);
253 /** Set the volume of a sink device specified by its index */
254 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
);
256 /** Set the volume of a sink device specified by its name */
257 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
);
259 /** Set the mute switch of a sink device specified by its index */
260 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
);
262 /** Set the mute switch of a sink device specified by its name */
263 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
);
265 /** Suspend/Resume a sink. \since 0.9.7 */
266 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
);
268 /** Suspend/Resume a sink. If idx is PA_INVALID_INDEX all sinks will be suspended. \since 0.9.7 */
269 pa_operation
* pa_context_suspend_sink_by_index(pa_context
*c
, uint32_t idx
, int suspend
, pa_context_success_cb_t cb
, void* userdata
);
273 /** @{ \name Sources */
275 /** Stores information about sources. Please note that this structure
276 * can be extended as part of evolutionary API updates at any time in
277 * any new release. */
278 typedef struct pa_source_info
{
279 const char *name
; /**< Name of the source */
280 uint32_t index
; /**< Index of the source */
281 const char *description
; /**< Description of this source */
282 pa_sample_spec sample_spec
; /**< Sample spec of this source */
283 pa_channel_map channel_map
; /**< Channel map */
284 uint32_t owner_module
; /**< Owning module index, or PA_INVALID_INDEX */
285 pa_cvolume volume
; /**< Volume of the source */
286 int mute
; /**< Mute switch of the sink */
287 uint32_t monitor_of_sink
; /**< If this is a monitor source the index of the owning sink, otherwise PA_INVALID_INDEX */
288 const char *monitor_of_sink_name
; /**< Name of the owning sink, or PA_INVALID_INDEX */
289 pa_usec_t latency
; /**< Length of filled record buffer of this source. */
290 const char *driver
; /**< Driver name */
291 pa_source_flags_t flags
; /**< Flags */
292 pa_proplist
*proplist
; /**< Property list \since 0.9.11 */
293 pa_usec_t configured_latency
; /**< The latency this device has been configured to. \since 0.9.11 */
296 /** Callback prototype for pa_context_get_source_info_by_name() and friends */
297 typedef void (*pa_source_info_cb_t
)(pa_context
*c
, const pa_source_info
*i
, int eol
, void *userdata
);
299 /** Get information about a source by its name */
300 pa_operation
* pa_context_get_source_info_by_name(pa_context
*c
, const char *name
, pa_source_info_cb_t cb
, void *userdata
);
302 /** Get information about a source by its index */
303 pa_operation
* pa_context_get_source_info_by_index(pa_context
*c
, uint32_t id
, pa_source_info_cb_t cb
, void *userdata
);
305 /** Get the complete source list */
306 pa_operation
* pa_context_get_source_info_list(pa_context
*c
, pa_source_info_cb_t cb
, void *userdata
);
308 /** Set the volume of a source device specified by its index */
309 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
);
311 /** Set the volume of a source device specified by its name */
312 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
);
314 /** Set the mute switch of a source device specified by its index */
315 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
);
317 /** Set the mute switch of a source device specified by its name */
318 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
);
322 /** @{ \name Server */
324 /** Server information. Please note that this structure can be
325 * extended as part of evolutionary API updates at any time in any new
327 typedef struct pa_server_info
{
328 const char *user_name
; /**< User name of the daemon process */
329 const char *host_name
; /**< Host name the daemon is running on */
330 const char *server_version
; /**< Version string of the daemon */
331 const char *server_name
; /**< Server package name (usually "pulseaudio") */
332 pa_sample_spec sample_spec
; /**< Default sample specification */
333 const char *default_sink_name
; /**< Name of default sink. */
334 const char *default_source_name
; /**< Name of default sink. */
335 uint32_t cookie
; /**< A random cookie for identifying this instance of PulseAudio. */
338 /** Callback prototype for pa_context_get_server_info() */
339 typedef void (*pa_server_info_cb_t
) (pa_context
*c
, const pa_server_info
*i
, void *userdata
);
341 /** Get some information about the server */
342 pa_operation
* pa_context_get_server_info(pa_context
*c
, pa_server_info_cb_t cb
, void *userdata
);
346 /** @{ \name Modules */
348 /** Stores information about modules. Please note that this structure
349 * can be extended as part of evolutionary API updates at any time in
350 * any new release. */
351 typedef struct pa_module_info
{
352 uint32_t index
; /**< Index of the module */
353 const char*name
, /**< Name of the module */
354 *argument
; /**< Argument string of the module */
355 uint32_t n_used
; /**< Usage counter or PA_INVALID_INDEX */
356 int auto_unload
; /**< Non-zero if this is an autoloaded module */
359 /** Callback prototype for pa_context_get_module_info() and firends*/
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 firends*/
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 Sink Inputs */
408 /** Stores information about sink inputs. Please note that this structure
409 * can be extended as part of evolutionary API updates at any time in
410 * any new release. */
411 typedef struct pa_sink_input_info
{
412 uint32_t index
; /**< Index of the sink input */
413 const char *name
; /**< Name of the sink input */
414 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 */
415 uint32_t client
; /**< Index of the client this sink input belongs to, or PA_INVALID_INDEX when it does not belong to any client */
416 uint32_t sink
; /**< Index of the connected sink */
417 pa_sample_spec sample_spec
; /**< The sample specification of the sink input */
418 pa_channel_map channel_map
; /**< Channel map */
419 pa_cvolume volume
; /**< The volume of this sink input */
420 pa_usec_t buffer_usec
; /**< Latency due to buffering in sink input, see pa_latency_info for details */
421 pa_usec_t sink_usec
; /**< Latency of the sink device, see pa_latency_info for details */
422 const char *resample_method
; /**< Thre resampling method used by this sink input. */
423 const char *driver
; /**< Driver name */
424 int mute
; /**< Stream muted \since 0.9.7 */
425 pa_proplist
*proplist
; /**< Property list \since 0.9.11 */
426 } pa_sink_input_info
;
428 /** Callback prototype for pa_context_get_sink_input_info() and firends*/
429 typedef void (*pa_sink_input_info_cb_t
) (pa_context
*c
, const pa_sink_input_info
*i
, int eol
, void *userdata
);
431 /** Get some information about a sink input by its index */
432 pa_operation
* pa_context_get_sink_input_info(pa_context
*c
, uint32_t idx
, pa_sink_input_info_cb_t cb
, void *userdata
);
434 /** Get the complete sink input list */
435 pa_operation
* pa_context_get_sink_input_info_list(pa_context
*c
, pa_sink_input_info_cb_t cb
, void *userdata
);
437 /** Move the specified sink input to a different sink. \since 0.9.5 */
438 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
);
440 /** Move the specified sink input to a different sink. \since 0.9.5 */
441 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
);
443 /** Set the volume of a sink input stream */
444 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
);
446 /** Set the mute switch of a sink input stream \since 0.9.7 */
447 pa_operation
* pa_context_set_sink_input_mute(pa_context
*c
, uint32_t idx
, int mute
, pa_context_success_cb_t cb
, void *userdata
);
449 /** Kill a sink input. */
450 pa_operation
* pa_context_kill_sink_input(pa_context
*c
, uint32_t idx
, pa_context_success_cb_t cb
, void *userdata
);
454 /** @{ \name Source Outputs */
456 /** Stores information about source outputs. Please note that this structure
457 * can be extended as part of evolutionary API updates at any time in
458 * any new release. */
459 typedef struct pa_source_output_info
{
460 uint32_t index
; /**< Index of the sink input */
461 const char *name
; /**< Name of the sink input */
462 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 */
463 uint32_t client
; /**< Index of the client this sink input belongs to, or PA_INVALID_INDEX when it does not belong to any client */
464 uint32_t source
; /**< Index of the connected source */
465 pa_sample_spec sample_spec
; /**< The sample specification of the source output */
466 pa_channel_map channel_map
; /**< Channel map */
467 pa_usec_t buffer_usec
; /**< Latency due to buffering in the source output, see pa_latency_info for details. */
468 pa_usec_t source_usec
; /**< Latency of the source device, see pa_latency_info for details. */
469 const char *resample_method
; /**< Thre resampling method used by this source output. */
470 const char *driver
; /**< Driver name */
471 pa_proplist
*proplist
; /**< Property list \since 0.9.11 */
472 } pa_source_output_info
;
474 /** Callback prototype for pa_context_get_source_output_info() and firends*/
475 typedef void (*pa_source_output_info_cb_t
) (pa_context
*c
, const pa_source_output_info
*i
, int eol
, void *userdata
);
477 /** Get information about a source output by its index */
478 pa_operation
* pa_context_get_source_output_info(pa_context
*c
, uint32_t idx
, pa_source_output_info_cb_t cb
, void *userdata
);
480 /** Get the complete list of source outputs */
481 pa_operation
* pa_context_get_source_output_info_list(pa_context
*c
, pa_source_output_info_cb_t cb
, void *userdata
);
483 /** Move the specified source output to a different source. \since 0.9.5 */
484 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
);
486 /** Move the specified source output to a different source. \since 0.9.5 */
487 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
);
489 /** Suspend/Resume a source. \since 0.9.7 */
490 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
);
492 /** Suspend/Resume a source. If idx is PA_INVALID_INDEX all sources will be suspended. \since 0.9.7 */
493 pa_operation
* pa_context_suspend_source_by_index(pa_context
*c
, uint32_t idx
, int suspend
, pa_context_success_cb_t cb
, void* userdata
);
495 /** Kill a source output. */
496 pa_operation
* pa_context_kill_source_output(pa_context
*c
, uint32_t idx
, pa_context_success_cb_t cb
, void *userdata
);
500 /** @{ \name Statistics */
502 /** Memory block statistics. Please note that this structure
503 * can be extended as part of evolutionary API updates at any time in
504 * any new release. */
505 typedef struct pa_stat_info
{
506 uint32_t memblock_total
; /**< Currently allocated memory blocks */
507 uint32_t memblock_total_size
; /**< Currentl total size of allocated memory blocks */
508 uint32_t memblock_allocated
; /**< Allocated memory blocks during the whole lifetime of the daemon */
509 uint32_t memblock_allocated_size
; /**< Total size of all memory blocks allocated during the whole lifetime of the daemon */
510 uint32_t scache_size
; /**< Total size of all sample cache entries. */
513 /** Callback prototype for pa_context_stat() */
514 typedef void (*pa_stat_info_cb_t
) (pa_context
*c
, const pa_stat_info
*i
, void *userdata
);
516 /** Get daemon memory block statistics */
517 pa_operation
* pa_context_stat(pa_context
*c
, pa_stat_info_cb_t cb
, void *userdata
);
521 /** @{ \name Cached Samples */
523 /** Stores information about sample cache entries. Please note that this structure
524 * can be extended as part of evolutionary API updates at any time in
525 * any new release. */
526 typedef struct pa_sample_info
{
527 uint32_t index
; /**< Index of this entry */
528 const char *name
; /**< Name of this entry */
529 pa_cvolume volume
; /**< Default volume of this entry */
530 pa_sample_spec sample_spec
; /**< Sample specification of the sample */
531 pa_channel_map channel_map
; /**< The channel map */
532 pa_usec_t duration
; /**< Duration of this entry */
533 uint32_t bytes
; /**< Length of this sample in bytes. */
534 int lazy
; /**< Non-zero when this is a lazy cache entry. */
535 const char *filename
; /**< In case this is a lazy cache entry, the filename for the sound file to be loaded on demand. */
536 pa_proplist
*proplist
; /**< Property list for this sample. \since 0.9.11 */
539 /** Callback prototype for pa_context_get_sample_info_by_name() and firends */
540 typedef void (*pa_sample_info_cb_t
)(pa_context
*c
, const pa_sample_info
*i
, int eol
, void *userdata
);
542 /** Get information about a sample by its name */
543 pa_operation
* pa_context_get_sample_info_by_name(pa_context
*c
, const char *name
, pa_sample_info_cb_t cb
, void *userdata
);
545 /** Get information about a sample by its index */
546 pa_operation
* pa_context_get_sample_info_by_index(pa_context
*c
, uint32_t idx
, pa_sample_info_cb_t cb
, void *userdata
);
548 /** Get the complete list of samples stored in the daemon. */
549 pa_operation
* pa_context_get_sample_info_list(pa_context
*c
, pa_sample_info_cb_t cb
, void *userdata
);
553 /** \cond fulldocs */
555 /** @{ \name Autoload Entries */
557 /** Type of an autoload entry. */
558 typedef enum pa_autoload_type
{
559 PA_AUTOLOAD_SINK
= 0,
560 PA_AUTOLOAD_SOURCE
= 1
561 } pa_autoload_type_t
;
563 /** Stores information about autoload entries. Please note that this structure
564 * can be extended as part of evolutionary API updates at any time in
565 * any new release. */
566 typedef struct pa_autoload_info
{
567 uint32_t index
; /**< Index of this autoload entry */
568 const char *name
; /**< Name of the sink or source */
569 pa_autoload_type_t type
; /**< Type of the autoload entry */
570 const char *module
; /**< Module name to load */
571 const char *argument
; /**< Argument string for module */
574 /** Callback prototype for pa_context_get_autoload_info_by_name() and firends */
575 typedef void (*pa_autoload_info_cb_t
)(pa_context
*c
, const pa_autoload_info
*i
, int eol
, void *userdata
);
577 /** Get info about a specific autoload entry. */
578 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
;
580 /** Get info about a specific autoload entry. */
581 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
;
583 /** Get the complete list of autoload entries. */
584 pa_operation
* pa_context_get_autoload_info_list(pa_context
*c
, pa_autoload_info_cb_t cb
, void *userdata
) PA_GCC_DEPRECATED
;
586 /** Add a new autoload entry. */
587 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
;
589 /** Remove an autoload entry. */
590 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
;
592 /** Remove an autoload entry. */
593 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
;