1 #ifndef foointrospecthfoo
2 #define foointrospecthfoo
7 This file is part of PulseAudio.
9 Copyright 2004-2006 Lennart Poettering
10 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
12 PulseAudio is free software; you can redistribute it and/or modify
13 it under the terms of the GNU Lesser General Public License as published
14 by the Free Software Foundation; either version 2 of the License,
15 or (at your option) any later version.
17 PulseAudio is distributed in the hope that it will be useful, but
18 WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 General Public License for more details.
22 You should have received a copy of the GNU Lesser General Public License
23 along with PulseAudio; if not, write to the Free Software
24 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
30 #include <pulse/operation.h>
31 #include <pulse/context.h>
32 #include <pulse/cdecl.h>
33 #include <pulse/gccmacro.h>
34 #include <pulse/channelmap.h>
35 #include <pulse/volume.h>
36 #include <pulse/proplist.h>
38 /** \page introspect Server Query and Control
40 * \section overv_sec Overview
42 * Sometimes it is necessary to query and modify global settings in the
43 * server. For this, PulseAudio has the introspection API. It can list sinks,
44 * sources, samples and other aspects of the server. It can also modify the
45 * attributes of the server that will affect operations on a global level,
46 * and not just the application's context.
48 * \section query_sec Querying
50 * All querying is done through callbacks. This design is necessary to
51 * maintain an asynchronous design. The client will request the information
52 * and some time later, the server will respond with the desired data.
54 * Some objects can have multiple entries at the server. When requesting all
55 * of these at once, the callback will be called multiple times, once for
56 * each object. When the list has been exhausted, the callback will be called
57 * without an information structure and the eol parameter set to a non-zero
60 * Note that even if a single object is requested, and not the entire list,
61 * the terminating call will still be made.
63 * If an error occurs, the callback will be called without and information
64 * structure and eol set to zero.
66 * Data members in the information structures are only valid during the
67 * duration of the callback. If they are required after the callback is
68 * finished, a deep copy must be performed.
70 * \subsection server_subsec Server Information
72 * The server can be queried about its name, the environment it's running on
73 * and the currently active global defaults. Calling
74 * pa_context_get_server_info() will get access to a pa_server_info structure
75 * containing all of these.
77 * \subsection memstat_subsec Memory Usage
79 * Statistics about memory usage can be fetched using pa_context_stat(),
80 * giving a pa_stat_info structure.
82 * \subsection sinksrc_subsec Sinks and Sources
84 * The server can have an arbitrary number of sinks and sources. Each sink
85 * and source have both an index and a name associated with it. As such
86 * there are three ways to get access to them:
88 * \li By index - pa_context_get_sink_info_by_index() /
89 * pa_context_get_source_info_by_index()
90 * \li By name - pa_context_get_sink_info_by_name() /
91 * pa_context_get_source_info_by_name()
92 * \li All - pa_context_get_sink_info_list() /
93 * pa_context_get_source_info_list()
95 * All three method use the same callback and will provide a pa_sink_info or
96 * pa_source_info structure.
98 * \subsection siso_subsec Sink Inputs and Source Outputs
100 * Sink inputs and source outputs are the representations of the client ends
101 * of streams inside the server. I.e. they connect a client stream to one of
102 * the global sinks or sources.
104 * Sink inputs and source outputs only have an index to identify them. As
105 * such, there are only two ways to get information about them:
107 * \li By index - pa_context_get_sink_input_info() /
108 * pa_context_get_source_output_info()
109 * \li All - pa_context_get_sink_input_info_list() /
110 * pa_context_get_source_output_info_list()
112 * The structure returned is the pa_sink_input_info or pa_source_output_info
115 * \subsection samples_subsec Samples
117 * The list of cached samples can be retrieved from the server. Three methods
118 * exist for querying the sample cache list:
120 * \li By index - pa_context_get_sample_info_by_index()
121 * \li By name - pa_context_get_sample_info_by_name()
122 * \li All - pa_context_get_sample_info_list()
124 * Note that this only retrieves information about the sample, not the sample
127 * \subsection module_subsec Driver Modules
129 * PulseAudio driver modules are identified by index and are retrieved using either
130 * pa_context_get_module_info() or pa_context_get_module_info_list(). The
131 * information structure is called pa_module_info.
133 * \subsection autoload_subsec Autoload Entries
135 * Modules can be autoloaded as a result of a client requesting a certain
136 * sink or source. 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().
198 * \subsection client_subsec Clients
200 * The only operation supported on clients, is the possibility of kicking
201 * them off the server using pa_context_kill_client().
206 * Routines for daemon introspection.
211 #define PA_PORT_DIGITAL "spdif"
212 #define PA_PORT_ANALOG_STEREO "analog-stereo"
213 #define PA_PORT_ANALOG_5_1 "analog-5-1"
214 #define PA_PORT_ANALOG_4_0 "analog-4-0"
216 /** @{ \name Sinks */
218 /** Stores information about sinks. Please note that this structure
219 * can be extended as part of evolutionary API updates at any time in
220 * any new release. */
221 typedef struct pa_sink_info
{
222 const char *name
; /**< Name of the sink */
223 uint32_t index
; /**< Index of the sink */
224 const char *description
; /**< Description of this sink */
225 pa_sample_spec sample_spec
; /**< Sample spec of this sink */
226 pa_channel_map channel_map
; /**< Channel map */
227 uint32_t owner_module
; /**< Index of the owning module of this sink, or PA_INVALID_INDEX */
228 pa_cvolume volume
; /**< Volume of the sink */
229 int mute
; /**< Mute switch of the sink */
230 uint32_t monitor_source
; /**< Index of the monitor source connected to this sink */
231 const char *monitor_source_name
; /**< The name of the monitor source */
232 pa_usec_t latency
; /**< Length of queued audio in the output buffer. */
233 const char *driver
; /**< Driver name. */
234 pa_sink_flags_t flags
; /**< Flags */
235 pa_proplist
*proplist
; /**< Property list \since 0.9.11 */
236 pa_usec_t configured_latency
; /**< The latency this device has been configured to. \since 0.9.11 */
239 /** Callback prototype for pa_context_get_sink_info_by_name() and friends */
240 typedef void (*pa_sink_info_cb_t
)(pa_context
*c
, const pa_sink_info
*i
, int eol
, void *userdata
);
242 /** Get information about a sink by its name */
243 pa_operation
* pa_context_get_sink_info_by_name(pa_context
*c
, const char *name
, pa_sink_info_cb_t cb
, void *userdata
);
245 /** Get information about a sink by its index */
246 pa_operation
* pa_context_get_sink_info_by_index(pa_context
*c
, uint32_t id
, pa_sink_info_cb_t cb
, void *userdata
);
248 /** Get the complete sink list */
249 pa_operation
* pa_context_get_sink_info_list(pa_context
*c
, pa_sink_info_cb_t cb
, void *userdata
);
251 /** Set the volume of a sink device specified by its index */
252 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
);
254 /** Set the volume of a sink device specified by its name */
255 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
);
257 /** Set the mute switch of a sink device specified by its index */
258 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
);
260 /** Set the mute switch of a sink device specified by its name */
261 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
);
263 /** Suspend/Resume a sink. \since 0.9.7 */
264 pa_operation
* pa_context_suspend_sink_by_name(pa_context
*c
, char *sink_name
, int suspend
, pa_context_success_cb_t cb
, void* userdata
);
266 /** Suspend/Resume a sink. If idx is PA_INVALID_INDEX all sinks will be suspended. \since 0.9.7 */
267 pa_operation
* pa_context_suspend_sink_by_index(pa_context
*c
, uint32_t idx
, int suspend
, pa_context_success_cb_t cb
, void* userdata
);
271 /** @{ \name Sources */
273 /** Stores information about sources. Please note that this structure
274 * can be extended as part of evolutionary API updates at any time in
275 * any new release. */
276 typedef struct pa_source_info
{
277 const char *name
; /**< Name of the source */
278 uint32_t index
; /**< Index of the source */
279 const char *description
; /**< Description of this source */
280 pa_sample_spec sample_spec
; /**< Sample spec of this source */
281 pa_channel_map channel_map
; /**< Channel map */
282 uint32_t owner_module
; /**< Owning module index, or PA_INVALID_INDEX */
283 pa_cvolume volume
; /**< Volume of the source */
284 int mute
; /**< Mute switch of the sink */
285 uint32_t monitor_of_sink
; /**< If this is a monitor source the index of the owning sink, otherwise PA_INVALID_INDEX */
286 const char *monitor_of_sink_name
; /**< Name of the owning sink, or PA_INVALID_INDEX */
287 pa_usec_t latency
; /**< Length of filled record buffer of this source. */
288 const char *driver
; /**< Driver name */
289 pa_source_flags_t flags
; /**< Flags */
290 pa_proplist
*proplist
; /**< Property list \since 0.9.11 */
291 pa_usec_t configured_latency
; /**< The latency this device has been configured to. \since 0.9.11 */
294 /** Callback prototype for pa_context_get_source_info_by_name() and friends */
295 typedef void (*pa_source_info_cb_t
)(pa_context
*c
, const pa_source_info
*i
, int eol
, void *userdata
);
297 /** Get information about a source by its name */
298 pa_operation
* pa_context_get_source_info_by_name(pa_context
*c
, const char *name
, pa_source_info_cb_t cb
, void *userdata
);
300 /** Get information about a source by its index */
301 pa_operation
* pa_context_get_source_info_by_index(pa_context
*c
, uint32_t id
, pa_source_info_cb_t cb
, void *userdata
);
303 /** Get the complete source list */
304 pa_operation
* pa_context_get_source_info_list(pa_context
*c
, pa_source_info_cb_t cb
, void *userdata
);
306 /** Set the volume of a source device specified by its index */
307 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
);
309 /** Set the volume of a source device specified by its name */
310 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
);
312 /** Set the mute switch of a source device specified by its index */
313 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
);
315 /** Set the mute switch of a source device specified by its name */
316 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
);
320 /** @{ \name Server */
322 /** Server information. Please note that this structure can be
323 * extended as part of evolutionary API updates at any time in any new
325 typedef struct pa_server_info
{
326 const char *user_name
; /**< User name of the daemon process */
327 const char *host_name
; /**< Host name the daemon is running on */
328 const char *server_version
; /**< Version string of the daemon */
329 const char *server_name
; /**< Server package name (usually "pulseaudio") */
330 pa_sample_spec sample_spec
; /**< Default sample specification */
331 const char *default_sink_name
; /**< Name of default sink. */
332 const char *default_source_name
; /**< Name of default sink. */
333 uint32_t cookie
; /**< A random cookie for identifying this instance of PulseAudio. */
336 /** Callback prototype for pa_context_get_server_info() */
337 typedef void (*pa_server_info_cb_t
) (pa_context
*c
, const pa_server_info
*i
, void *userdata
);
339 /** Get some information about the server */
340 pa_operation
* pa_context_get_server_info(pa_context
*c
, pa_server_info_cb_t cb
, void *userdata
);
344 /** @{ \name Modules */
346 /** Stores information about modules. Please note that this structure
347 * can be extended as part of evolutionary API updates at any time in
348 * any new release. */
349 typedef struct pa_module_info
{
350 uint32_t index
; /**< Index of the module */
351 const char*name
, /**< Name of the module */
352 *argument
; /**< Argument string of the module */
353 uint32_t n_used
; /**< Usage counter or PA_INVALID_INDEX */
354 int auto_unload
; /**< Non-zero if this is an autoloaded module */
357 /** Callback prototype for pa_context_get_module_info() and firends*/
358 typedef void (*pa_module_info_cb_t
) (pa_context
*c
, const pa_module_info
*i
, int eol
, void *userdata
);
360 /** Get some information about a module by its index */
361 pa_operation
* pa_context_get_module_info(pa_context
*c
, uint32_t idx
, pa_module_info_cb_t cb
, void *userdata
);
363 /** Get the complete list of currently loaded modules */
364 pa_operation
* pa_context_get_module_info_list(pa_context
*c
, pa_module_info_cb_t cb
, void *userdata
);
366 /** Callback prototype for pa_context_load_module() */
367 typedef void (*pa_context_index_cb_t
)(pa_context
*c
, uint32_t idx
, void *userdata
);
369 /** Load a module. */
370 pa_operation
* pa_context_load_module(pa_context
*c
, const char*name
, const char *argument
, pa_context_index_cb_t cb
, void *userdata
);
372 /** Unload a module. */
373 pa_operation
* pa_context_unload_module(pa_context
*c
, uint32_t idx
, pa_context_success_cb_t cb
, void *userdata
);
377 /** @{ \name Clients */
379 /** Stores information about clients. Please note that this structure
380 * can be extended as part of evolutionary API updates at any time in
381 * any new release. */
382 typedef struct pa_client_info
{
383 uint32_t index
; /**< Index of this client */
384 const char *name
; /**< Name of this client */
385 uint32_t owner_module
; /**< Index of the owning module, or PA_INVALID_INDEX */
386 const char *driver
; /**< Driver name */
387 pa_proplist
*proplist
; /**< Property list \since 0.9.11 */
390 /** Callback prototype for pa_context_get_client_info() and firends*/
391 typedef void (*pa_client_info_cb_t
) (pa_context
*c
, const pa_client_info
*i
, int eol
, void *userdata
);
393 /** Get information about a client by its index */
394 pa_operation
* pa_context_get_client_info(pa_context
*c
, uint32_t idx
, pa_client_info_cb_t cb
, void *userdata
);
396 /** Get the complete client list */
397 pa_operation
* pa_context_get_client_info_list(pa_context
*c
, pa_client_info_cb_t cb
, void *userdata
);
399 /** Kill a client. */
400 pa_operation
* pa_context_kill_client(pa_context
*c
, uint32_t idx
, pa_context_success_cb_t cb
, void *userdata
);
404 /** @{ \name Sink Inputs */
406 /** Stores information about sink inputs. Please note that this structure
407 * can be extended as part of evolutionary API updates at any time in
408 * any new release. */
409 typedef struct pa_sink_input_info
{
410 uint32_t index
; /**< Index of the sink input */
411 const char *name
; /**< Name of the sink input */
412 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 */
413 uint32_t client
; /**< Index of the client this sink input belongs to, or PA_INVALID_INDEX when it does not belong to any client */
414 uint32_t sink
; /**< Index of the connected sink */
415 pa_sample_spec sample_spec
; /**< The sample specification of the sink input */
416 pa_channel_map channel_map
; /**< Channel map */
417 pa_cvolume volume
; /**< The volume of this sink input */
418 pa_usec_t buffer_usec
; /**< Latency due to buffering in sink input, see pa_latency_info for details */
419 pa_usec_t sink_usec
; /**< Latency of the sink device, see pa_latency_info for details */
420 const char *resample_method
; /**< Thre resampling method used by this sink input. */
421 const char *driver
; /**< Driver name */
422 int mute
; /**< Stream muted \since 0.9.7 */
423 pa_proplist
*proplist
; /**< Property list \since 0.9.11 */
424 } pa_sink_input_info
;
426 /** Callback prototype for pa_context_get_sink_input_info() and firends*/
427 typedef void (*pa_sink_input_info_cb_t
) (pa_context
*c
, const pa_sink_input_info
*i
, int eol
, void *userdata
);
429 /** Get some information about a sink input by its index */
430 pa_operation
* pa_context_get_sink_input_info(pa_context
*c
, uint32_t idx
, pa_sink_input_info_cb_t cb
, void *userdata
);
432 /** Get the complete sink input list */
433 pa_operation
* pa_context_get_sink_input_info_list(pa_context
*c
, pa_sink_input_info_cb_t cb
, void *userdata
);
435 /** Move the specified sink input to a different sink. \since 0.9.5 */
436 pa_operation
* pa_context_move_sink_input_by_name(pa_context
*c
, uint32_t idx
, char *sink_name
, pa_context_success_cb_t cb
, void* userdata
);
438 /** Move the specified sink input to a different sink. \since 0.9.5 */
439 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
);
441 /** Set the volume of a sink input stream */
442 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
);
444 /** Set the mute switch of a sink input stream \since 0.9.7 */
445 pa_operation
* pa_context_set_sink_input_mute(pa_context
*c
, uint32_t idx
, int mute
, pa_context_success_cb_t cb
, void *userdata
);
447 /** Kill a sink input. */
448 pa_operation
* pa_context_kill_sink_input(pa_context
*c
, uint32_t idx
, pa_context_success_cb_t cb
, void *userdata
);
452 /** @{ \name Source Outputs */
454 /** Stores information about source outputs. Please note that this structure
455 * can be extended as part of evolutionary API updates at any time in
456 * any new release. */
457 typedef struct pa_source_output_info
{
458 uint32_t index
; /**< Index of the sink input */
459 const char *name
; /**< Name of the sink input */
460 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 */
461 uint32_t client
; /**< Index of the client this sink input belongs to, or PA_INVALID_INDEX when it does not belong to any client */
462 uint32_t source
; /**< Index of the connected source */
463 pa_sample_spec sample_spec
; /**< The sample specification of the source output */
464 pa_channel_map channel_map
; /**< Channel map */
465 pa_usec_t buffer_usec
; /**< Latency due to buffering in the source output, see pa_latency_info for details. */
466 pa_usec_t source_usec
; /**< Latency of the source device, see pa_latency_info for details. */
467 const char *resample_method
; /**< Thre resampling method used by this source output. */
468 const char *driver
; /**< Driver name */
469 pa_proplist
*proplist
; /**< Property list \since 0.9.11 */
470 } pa_source_output_info
;
472 /** Callback prototype for pa_context_get_source_output_info() and firends*/
473 typedef void (*pa_source_output_info_cb_t
) (pa_context
*c
, const pa_source_output_info
*i
, int eol
, void *userdata
);
475 /** Get information about a source output by its index */
476 pa_operation
* pa_context_get_source_output_info(pa_context
*c
, uint32_t idx
, pa_source_output_info_cb_t cb
, void *userdata
);
478 /** Get the complete list of source outputs */
479 pa_operation
* pa_context_get_source_output_info_list(pa_context
*c
, pa_source_output_info_cb_t cb
, void *userdata
);
481 /** Move the specified source output to a different source. \since 0.9.5 */
482 pa_operation
* pa_context_move_source_output_by_name(pa_context
*c
, uint32_t idx
, char *source_name
, pa_context_success_cb_t cb
, void* userdata
);
484 /** Move the specified source output to a different source. \since 0.9.5 */
485 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
);
487 /** Suspend/Resume a source. \since 0.9.7 */
488 pa_operation
* pa_context_suspend_source_by_name(pa_context
*c
, char *source_name
, int suspend
, pa_context_success_cb_t cb
, void* userdata
);
490 /** Suspend/Resume a source. If idx is PA_INVALID_INDEX all sources will be suspended. \since 0.9.7 */
491 pa_operation
* pa_context_suspend_source_by_index(pa_context
*c
, uint32_t idx
, int suspend
, pa_context_success_cb_t cb
, void* userdata
);
493 /** Kill a source output. */
494 pa_operation
* pa_context_kill_source_output(pa_context
*c
, uint32_t idx
, pa_context_success_cb_t cb
, void *userdata
);
498 /** @{ \name Statistics */
500 /** Memory block statistics. Please note that this structure
501 * can be extended as part of evolutionary API updates at any time in
502 * any new release. */
503 typedef struct pa_stat_info
{
504 uint32_t memblock_total
; /**< Currently allocated memory blocks */
505 uint32_t memblock_total_size
; /**< Currentl total size of allocated memory blocks */
506 uint32_t memblock_allocated
; /**< Allocated memory blocks during the whole lifetime of the daemon */
507 uint32_t memblock_allocated_size
; /**< Total size of all memory blocks allocated during the whole lifetime of the daemon */
508 uint32_t scache_size
; /**< Total size of all sample cache entries. */
511 /** Callback prototype for pa_context_stat() */
512 typedef void (*pa_stat_info_cb_t
) (pa_context
*c
, const pa_stat_info
*i
, void *userdata
);
514 /** Get daemon memory block statistics */
515 pa_operation
* pa_context_stat(pa_context
*c
, pa_stat_info_cb_t cb
, void *userdata
);
519 /** @{ \name Cached Samples */
521 /** Stores information about sample cache entries. Please note that this structure
522 * can be extended as part of evolutionary API updates at any time in
523 * any new release. */
524 typedef struct pa_sample_info
{
525 uint32_t index
; /**< Index of this entry */
526 const char *name
; /**< Name of this entry */
527 pa_cvolume volume
; /**< Default volume of this entry */
528 pa_sample_spec sample_spec
; /**< Sample specification of the sample */
529 pa_channel_map channel_map
; /**< The channel map */
530 pa_usec_t duration
; /**< Duration of this entry */
531 uint32_t bytes
; /**< Length of this sample in bytes. */
532 int lazy
; /**< Non-zero when this is a lazy cache entry. */
533 const char *filename
; /**< In case this is a lazy cache entry, the filename for the sound file to be loaded on demand. */
534 pa_proplist
*proplist
; /**< Property list for this sample. \since 0.9.11 */
537 /** Callback prototype for pa_context_get_sample_info_by_name() and firends */
538 typedef void (*pa_sample_info_cb_t
)(pa_context
*c
, const pa_sample_info
*i
, int eol
, void *userdata
);
540 /** Get information about a sample by its name */
541 pa_operation
* pa_context_get_sample_info_by_name(pa_context
*c
, const char *name
, pa_sample_info_cb_t cb
, void *userdata
);
543 /** Get information about a sample by its index */
544 pa_operation
* pa_context_get_sample_info_by_index(pa_context
*c
, uint32_t idx
, pa_sample_info_cb_t cb
, void *userdata
);
546 /** Get the complete list of samples stored in the daemon. */
547 pa_operation
* pa_context_get_sample_info_list(pa_context
*c
, pa_sample_info_cb_t cb
, void *userdata
);
551 /** \cond fulldocs */
553 /** @{ \name Autoload Entries */
555 /** Type of an autoload entry. */
556 typedef enum pa_autoload_type
{
557 PA_AUTOLOAD_SINK
= 0,
558 PA_AUTOLOAD_SOURCE
= 1
559 } pa_autoload_type_t
;
561 /** Stores information about autoload entries. Please note that this structure
562 * can be extended as part of evolutionary API updates at any time in
563 * any new release. */
564 typedef struct pa_autoload_info
{
565 uint32_t index
; /**< Index of this autoload entry */
566 const char *name
; /**< Name of the sink or source */
567 pa_autoload_type_t type
; /**< Type of the autoload entry */
568 const char *module
; /**< Module name to load */
569 const char *argument
; /**< Argument string for module */
572 /** Callback prototype for pa_context_get_autoload_info_by_name() and firends */
573 typedef void (*pa_autoload_info_cb_t
)(pa_context
*c
, const pa_autoload_info
*i
, int eol
, void *userdata
);
575 /** Get info about a specific autoload entry. */
576 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
;
578 /** Get info about a specific autoload entry. */
579 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
;
581 /** Get the complete list of autoload entries. */
582 pa_operation
* pa_context_get_autoload_info_list(pa_context
*c
, pa_autoload_info_cb_t cb
, void *userdata
) PA_GCC_DEPRECATED
;
584 /** Add a new autoload entry. */
585 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
;
587 /** Remove an autoload entry. */
588 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
;
590 /** Remove an autoload entry. */
591 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
;