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 positive
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 a negative value..
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 client_subsec Clients
133 * PulseAudio clients are also identified by index and are retrieved using
134 * either pa_context_get_client_info() or pa_context_get_client_info_list().
135 * The information structure is called pa_client_info.
137 * \section ctrl_sec Control
139 * Some parts of the server are only possible to read, but most can also be
140 * modified in different ways. Note that these changes will affect all
141 * connected clients and not just the one issuing the request.
143 * \subsection sinksrc_subsec Sinks and Sources
145 * The most common change one would want to do to sinks and sources is to
146 * modify the volume of the audio. Identical to how sinks and sources can
147 * be queried, there are two ways of identifying them:
149 * \li By index - pa_context_set_sink_volume_by_index() /
150 * pa_context_set_source_volume_by_index()
151 * \li By name - pa_context_set_sink_volume_by_name() /
152 * pa_context_set_source_volume_by_name()
154 * It is also possible to mute a sink or source:
156 * \li By index - pa_context_set_sink_mute_by_index() /
157 * pa_context_set_source_mute_by_index()
158 * \li By name - pa_context_set_sink_mute_by_name() /
159 * pa_context_set_source_mute_by_name()
161 * \subsection siso_subsec Sink Inputs and Source Outputs
163 * If an application desires to modify the volume of just a single stream
164 * (commonly one of its own streams), this can be done by setting the volume
165 * of its associated sink input, using pa_context_set_sink_input_volume().
167 * There is no support for modifying the volume of source outputs.
169 * It is also possible to remove sink inputs and source outputs, terminating
170 * the streams associated with them:
172 * \li Sink input - pa_context_kill_sink_input()
173 * \li Source output - pa_context_kill_source_output()
175 * \subsection module_subsec Modules
177 * Server modules can be remotely loaded and unloaded using
178 * pa_context_load_module() and pa_context_unload_module().
180 * \subsection client_subsec Clients
182 * The only operation supported on clients, is the possibility of kicking
183 * them off the server using pa_context_kill_client().
188 * Routines for daemon introspection.
193 /** @{ \name Sinks */
195 /** Stores information about sinks. Please note that this structure
196 * can be extended as part of evolutionary API updates at any time in
197 * any new release. */
198 typedef struct pa_sink_info
{
199 const char *name
; /**< Name of the sink */
200 uint32_t index
; /**< Index of the sink */
201 const char *description
; /**< Description of this sink */
202 pa_sample_spec sample_spec
; /**< Sample spec of this sink */
203 pa_channel_map channel_map
; /**< Channel map */
204 uint32_t owner_module
; /**< Index of the owning module of this sink, or PA_INVALID_INDEX */
205 pa_cvolume volume
; /**< Volume of the sink */
206 int mute
; /**< Mute switch of the sink */
207 uint32_t monitor_source
; /**< Index of the monitor source connected to this sink */
208 const char *monitor_source_name
; /**< The name of the monitor source */
209 pa_usec_t latency
; /**< Length of queued audio in the output buffer. */
210 const char *driver
; /**< Driver name. */
211 pa_sink_flags_t flags
; /**< Flags */
212 pa_proplist
*proplist
; /**< Property list \since 0.9.11 */
213 pa_usec_t configured_latency
; /**< The latency this device has been configured to. \since 0.9.11 */
214 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.14 */
217 /** Callback prototype for pa_context_get_sink_info_by_name() and friends */
218 typedef void (*pa_sink_info_cb_t
)(pa_context
*c
, const pa_sink_info
*i
, int eol
, void *userdata
);
220 /** Get information about a sink by its name */
221 pa_operation
* pa_context_get_sink_info_by_name(pa_context
*c
, const char *name
, pa_sink_info_cb_t cb
, void *userdata
);
223 /** Get information about a sink by its index */
224 pa_operation
* pa_context_get_sink_info_by_index(pa_context
*c
, uint32_t id
, pa_sink_info_cb_t cb
, void *userdata
);
226 /** Get the complete sink list */
227 pa_operation
* pa_context_get_sink_info_list(pa_context
*c
, pa_sink_info_cb_t cb
, void *userdata
);
229 /** Set the volume of a sink device specified by its index */
230 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
);
232 /** Set the volume of a sink device specified by its name */
233 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
);
235 /** Set the mute switch of a sink device specified by its index */
236 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
);
238 /** Set the mute switch of a sink device specified by its name */
239 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
);
241 /** Suspend/Resume a sink. \since 0.9.7 */
242 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
);
244 /** Suspend/Resume a sink. If idx is PA_INVALID_INDEX all sinks will be suspended. \since 0.9.7 */
245 pa_operation
* pa_context_suspend_sink_by_index(pa_context
*c
, uint32_t idx
, int suspend
, pa_context_success_cb_t cb
, void* userdata
);
249 /** @{ \name Sources */
251 /** Stores information about sources. Please note that this structure
252 * can be extended as part of evolutionary API updates at any time in
253 * any new release. */
254 typedef struct pa_source_info
{
255 const char *name
; /**< Name of the source */
256 uint32_t index
; /**< Index of the source */
257 const char *description
; /**< Description of this source */
258 pa_sample_spec sample_spec
; /**< Sample spec of this source */
259 pa_channel_map channel_map
; /**< Channel map */
260 uint32_t owner_module
; /**< Owning module index, or PA_INVALID_INDEX */
261 pa_cvolume volume
; /**< Volume of the source */
262 int mute
; /**< Mute switch of the sink */
263 uint32_t monitor_of_sink
; /**< If this is a monitor source the index of the owning sink, otherwise PA_INVALID_INDEX */
264 const char *monitor_of_sink_name
; /**< Name of the owning sink, or PA_INVALID_INDEX */
265 pa_usec_t latency
; /**< Length of filled record buffer of this source. */
266 const char *driver
; /**< Driver name */
267 pa_source_flags_t flags
; /**< Flags */
268 pa_proplist
*proplist
; /**< Property list \since 0.9.11 */
269 pa_usec_t configured_latency
; /**< The latency this device has been configured to. \since 0.9.11 */
270 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.14 */
273 /** Callback prototype for pa_context_get_source_info_by_name() and friends */
274 typedef void (*pa_source_info_cb_t
)(pa_context
*c
, const pa_source_info
*i
, int eol
, void *userdata
);
276 /** Get information about a source by its name */
277 pa_operation
* pa_context_get_source_info_by_name(pa_context
*c
, const char *name
, pa_source_info_cb_t cb
, void *userdata
);
279 /** Get information about a source by its index */
280 pa_operation
* pa_context_get_source_info_by_index(pa_context
*c
, uint32_t id
, pa_source_info_cb_t cb
, void *userdata
);
282 /** Get the complete source list */
283 pa_operation
* pa_context_get_source_info_list(pa_context
*c
, pa_source_info_cb_t cb
, void *userdata
);
285 /** Set the volume of a source device specified by its index */
286 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
);
288 /** Set the volume of a source device specified by its name */
289 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
);
291 /** Set the mute switch of a source device specified by its index */
292 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
);
294 /** Set the mute switch of a source device specified by its name */
295 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
);
299 /** @{ \name Server */
301 /** Server information. Please note that this structure can be
302 * extended as part of evolutionary API updates at any time in any new
304 typedef struct pa_server_info
{
305 const char *user_name
; /**< User name of the daemon process */
306 const char *host_name
; /**< Host name the daemon is running on */
307 const char *server_version
; /**< Version string of the daemon */
308 const char *server_name
; /**< Server package name (usually "pulseaudio") */
309 pa_sample_spec sample_spec
; /**< Default sample specification */
310 const char *default_sink_name
; /**< Name of default sink. */
311 const char *default_source_name
; /**< Name of default sink. */
312 uint32_t cookie
; /**< A random cookie for identifying this instance of PulseAudio. */
315 /** Callback prototype for pa_context_get_server_info() */
316 typedef void (*pa_server_info_cb_t
) (pa_context
*c
, const pa_server_info
*i
, void *userdata
);
318 /** Get some information about the server */
319 pa_operation
* pa_context_get_server_info(pa_context
*c
, pa_server_info_cb_t cb
, void *userdata
);
323 /** @{ \name Modules */
325 /** Stores information about modules. Please note that this structure
326 * can be extended as part of evolutionary API updates at any time in
327 * any new release. */
328 typedef struct pa_module_info
{
329 uint32_t index
; /**< Index of the module */
330 const char*name
, /**< Name of the module */
331 *argument
; /**< Argument string of the module */
332 uint32_t n_used
; /**< Usage counter or PA_INVALID_INDEX */
333 /** \cond fulldocs */
334 int auto_unload
; /**< \deprecated Non-zero if this is an autoloaded module */
338 /** Callback prototype for pa_context_get_module_info() and firends*/
339 typedef void (*pa_module_info_cb_t
) (pa_context
*c
, const pa_module_info
*i
, int eol
, void *userdata
);
341 /** Get some information about a module by its index */
342 pa_operation
* pa_context_get_module_info(pa_context
*c
, uint32_t idx
, pa_module_info_cb_t cb
, void *userdata
);
344 /** Get the complete list of currently loaded modules */
345 pa_operation
* pa_context_get_module_info_list(pa_context
*c
, pa_module_info_cb_t cb
, void *userdata
);
347 /** Callback prototype for pa_context_load_module() */
348 typedef void (*pa_context_index_cb_t
)(pa_context
*c
, uint32_t idx
, void *userdata
);
350 /** Load a module. */
351 pa_operation
* pa_context_load_module(pa_context
*c
, const char*name
, const char *argument
, pa_context_index_cb_t cb
, void *userdata
);
353 /** Unload a module. */
354 pa_operation
* pa_context_unload_module(pa_context
*c
, uint32_t idx
, pa_context_success_cb_t cb
, void *userdata
);
358 /** @{ \name Clients */
360 /** Stores information about clients. Please note that this structure
361 * can be extended as part of evolutionary API updates at any time in
362 * any new release. */
363 typedef struct pa_client_info
{
364 uint32_t index
; /**< Index of this client */
365 const char *name
; /**< Name of this client */
366 uint32_t owner_module
; /**< Index of the owning module, or PA_INVALID_INDEX */
367 const char *driver
; /**< Driver name */
368 pa_proplist
*proplist
; /**< Property list \since 0.9.11 */
371 /** Callback prototype for pa_context_get_client_info() and firends*/
372 typedef void (*pa_client_info_cb_t
) (pa_context
*c
, const pa_client_info
*i
, int eol
, void *userdata
);
374 /** Get information about a client by its index */
375 pa_operation
* pa_context_get_client_info(pa_context
*c
, uint32_t idx
, pa_client_info_cb_t cb
, void *userdata
);
377 /** Get the complete client list */
378 pa_operation
* pa_context_get_client_info_list(pa_context
*c
, pa_client_info_cb_t cb
, void *userdata
);
380 /** Kill a client. */
381 pa_operation
* pa_context_kill_client(pa_context
*c
, uint32_t idx
, pa_context_success_cb_t cb
, void *userdata
);
385 /** @{ \name Sink Inputs */
387 /** Stores information about sink inputs. Please note that this structure
388 * can be extended as part of evolutionary API updates at any time in
389 * any new release. */
390 typedef struct pa_sink_input_info
{
391 uint32_t index
; /**< Index of the sink input */
392 const char *name
; /**< Name of the sink input */
393 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 */
394 uint32_t client
; /**< Index of the client this sink input belongs to, or PA_INVALID_INDEX when it does not belong to any client */
395 uint32_t sink
; /**< Index of the connected sink */
396 pa_sample_spec sample_spec
; /**< The sample specification of the sink input */
397 pa_channel_map channel_map
; /**< Channel map */
398 pa_cvolume volume
; /**< The volume of this sink input */
399 pa_usec_t buffer_usec
; /**< Latency due to buffering in sink input, see pa_latency_info for details */
400 pa_usec_t sink_usec
; /**< Latency of the sink device, see pa_latency_info for details */
401 const char *resample_method
; /**< Thre resampling method used by this sink input. */
402 const char *driver
; /**< Driver name */
403 int mute
; /**< Stream muted \since 0.9.7 */
404 pa_proplist
*proplist
; /**< Property list \since 0.9.11 */
405 } pa_sink_input_info
;
407 /** Callback prototype for pa_context_get_sink_input_info() and firends*/
408 typedef void (*pa_sink_input_info_cb_t
) (pa_context
*c
, const pa_sink_input_info
*i
, int eol
, void *userdata
);
410 /** Get some information about a sink input by its index */
411 pa_operation
* pa_context_get_sink_input_info(pa_context
*c
, uint32_t idx
, pa_sink_input_info_cb_t cb
, void *userdata
);
413 /** Get the complete sink input list */
414 pa_operation
* pa_context_get_sink_input_info_list(pa_context
*c
, pa_sink_input_info_cb_t cb
, void *userdata
);
416 /** Move the specified sink input to a different sink. \since 0.9.5 */
417 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
);
419 /** Move the specified sink input to a different sink. \since 0.9.5 */
420 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
);
422 /** Set the volume of a sink input stream */
423 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
);
425 /** Set the mute switch of a sink input stream \since 0.9.7 */
426 pa_operation
* pa_context_set_sink_input_mute(pa_context
*c
, uint32_t idx
, int mute
, pa_context_success_cb_t cb
, void *userdata
);
428 /** Kill a sink input. */
429 pa_operation
* pa_context_kill_sink_input(pa_context
*c
, uint32_t idx
, pa_context_success_cb_t cb
, void *userdata
);
433 /** @{ \name Source Outputs */
435 /** Stores information about source outputs. Please note that this structure
436 * can be extended as part of evolutionary API updates at any time in
437 * any new release. */
438 typedef struct pa_source_output_info
{
439 uint32_t index
; /**< Index of the sink input */
440 const char *name
; /**< Name of the sink input */
441 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 */
442 uint32_t client
; /**< Index of the client this sink input belongs to, or PA_INVALID_INDEX when it does not belong to any client */
443 uint32_t source
; /**< Index of the connected source */
444 pa_sample_spec sample_spec
; /**< The sample specification of the source output */
445 pa_channel_map channel_map
; /**< Channel map */
446 pa_usec_t buffer_usec
; /**< Latency due to buffering in the source output, see pa_latency_info for details. */
447 pa_usec_t source_usec
; /**< Latency of the source device, see pa_latency_info for details. */
448 const char *resample_method
; /**< Thre resampling method used by this source output. */
449 const char *driver
; /**< Driver name */
450 pa_proplist
*proplist
; /**< Property list \since 0.9.11 */
451 } pa_source_output_info
;
453 /** Callback prototype for pa_context_get_source_output_info() and firends*/
454 typedef void (*pa_source_output_info_cb_t
) (pa_context
*c
, const pa_source_output_info
*i
, int eol
, void *userdata
);
456 /** Get information about a source output by its index */
457 pa_operation
* pa_context_get_source_output_info(pa_context
*c
, uint32_t idx
, pa_source_output_info_cb_t cb
, void *userdata
);
459 /** Get the complete list of source outputs */
460 pa_operation
* pa_context_get_source_output_info_list(pa_context
*c
, pa_source_output_info_cb_t cb
, void *userdata
);
462 /** Move the specified source output to a different source. \since 0.9.5 */
463 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
);
465 /** Move the specified source output to a different source. \since 0.9.5 */
466 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
);
468 /** Suspend/Resume a source. \since 0.9.7 */
469 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
);
471 /** Suspend/Resume a source. If idx is PA_INVALID_INDEX all sources will be suspended. \since 0.9.7 */
472 pa_operation
* pa_context_suspend_source_by_index(pa_context
*c
, uint32_t idx
, int suspend
, pa_context_success_cb_t cb
, void* userdata
);
474 /** Kill a source output. */
475 pa_operation
* pa_context_kill_source_output(pa_context
*c
, uint32_t idx
, pa_context_success_cb_t cb
, void *userdata
);
479 /** @{ \name Statistics */
481 /** Memory block statistics. Please note that this structure
482 * can be extended as part of evolutionary API updates at any time in
483 * any new release. */
484 typedef struct pa_stat_info
{
485 uint32_t memblock_total
; /**< Currently allocated memory blocks */
486 uint32_t memblock_total_size
; /**< Currentl total size of allocated memory blocks */
487 uint32_t memblock_allocated
; /**< Allocated memory blocks during the whole lifetime of the daemon */
488 uint32_t memblock_allocated_size
; /**< Total size of all memory blocks allocated during the whole lifetime of the daemon */
489 uint32_t scache_size
; /**< Total size of all sample cache entries. */
492 /** Callback prototype for pa_context_stat() */
493 typedef void (*pa_stat_info_cb_t
) (pa_context
*c
, const pa_stat_info
*i
, void *userdata
);
495 /** Get daemon memory block statistics */
496 pa_operation
* pa_context_stat(pa_context
*c
, pa_stat_info_cb_t cb
, void *userdata
);
500 /** @{ \name Cached Samples */
502 /** Stores information about sample cache entries. 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_sample_info
{
506 uint32_t index
; /**< Index of this entry */
507 const char *name
; /**< Name of this entry */
508 pa_cvolume volume
; /**< Default volume of this entry */
509 pa_sample_spec sample_spec
; /**< Sample specification of the sample */
510 pa_channel_map channel_map
; /**< The channel map */
511 pa_usec_t duration
; /**< Duration of this entry */
512 uint32_t bytes
; /**< Length of this sample in bytes. */
513 int lazy
; /**< Non-zero when this is a lazy cache entry. */
514 const char *filename
; /**< In case this is a lazy cache entry, the filename for the sound file to be loaded on demand. */
515 pa_proplist
*proplist
; /**< Property list for this sample. \since 0.9.11 */
518 /** Callback prototype for pa_context_get_sample_info_by_name() and firends */
519 typedef void (*pa_sample_info_cb_t
)(pa_context
*c
, const pa_sample_info
*i
, int eol
, void *userdata
);
521 /** Get information about a sample by its name */
522 pa_operation
* pa_context_get_sample_info_by_name(pa_context
*c
, const char *name
, pa_sample_info_cb_t cb
, void *userdata
);
524 /** Get information about a sample by its index */
525 pa_operation
* pa_context_get_sample_info_by_index(pa_context
*c
, uint32_t idx
, pa_sample_info_cb_t cb
, void *userdata
);
527 /** Get the complete list of samples stored in the daemon. */
528 pa_operation
* pa_context_get_sample_info_list(pa_context
*c
, pa_sample_info_cb_t cb
, void *userdata
);
532 /** \cond fulldocs */
534 /** @{ \name Autoload Entries */
536 /** \deprecated Type of an autoload entry. */
537 typedef enum pa_autoload_type
{
538 PA_AUTOLOAD_SINK
= 0,
539 PA_AUTOLOAD_SOURCE
= 1
540 } pa_autoload_type_t
;
542 /** \deprecated Stores information about autoload entries. Please note that this structure
543 * can be extended as part of evolutionary API updates at any time in
544 * any new release. */
545 typedef struct pa_autoload_info
{
546 uint32_t index
; /**< Index of this autoload entry */
547 const char *name
; /**< Name of the sink or source */
548 pa_autoload_type_t type
; /**< Type of the autoload entry */
549 const char *module
; /**< Module name to load */
550 const char *argument
; /**< Argument string for module */
553 /** \deprecated Callback prototype for pa_context_get_autoload_info_by_name() and firends */
554 typedef void (*pa_autoload_info_cb_t
)(pa_context
*c
, const pa_autoload_info
*i
, int eol
, void *userdata
);
556 /** \deprecated Get info about a specific autoload entry. */
557 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
;
559 /** \deprecated Get info about a specific autoload entry. */
560 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
;
562 /** \deprecated Get the complete list of autoload entries. */
563 pa_operation
* pa_context_get_autoload_info_list(pa_context
*c
, pa_autoload_info_cb_t cb
, void *userdata
) PA_GCC_DEPRECATED
;
565 /** \deprecated Add a new autoload entry. */
566 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
;
568 /** \deprecated Remove an autoload entry. */
569 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
;
571 /** \deprecated Remove an autoload entry. */
572 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
;