code.delx.au - pulseaudio/blob - src/pulse/introspect.h

   1 #ifndef foointrospecthfoo
   2 #define foointrospecthfoo
   3
   4 /***
   5   This file is part of PulseAudio.
   6
   7   Copyright 2004-2006 Lennart Poettering
   8   Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
   9
  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.
  14
  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.
  19
  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
  23   USA.
  24 ***/
  25
  26 #include <inttypes.h>
  27
  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
  36 /** \page introspect Server Query and Control
  37  *
  38  * \section overv_sec Overview
  39  *
  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.
  45  *
  46  * \section query_sec Querying
  47  *
  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.
  51  *
  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
  56  * value.
  57  *
  58  * Note that even if a single object is requested, and not the entire list,
  59  * the terminating call will still be made.
  60  *
  61  * If an error occurs, the callback will be called without and information
  62  * structure and eol set to zero.
  63  *
  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.
  67  *
  68  * \subsection server_subsec Server Information
  69  *
  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.
  74  *
  75  * \subsection memstat_subsec Memory Usage
  76  *
  77  * Statistics about memory usage can be fetched using pa_context_stat(),
  78  * giving a pa_stat_info structure.
  79  *
  80  * \subsection sinksrc_subsec Sinks and Sources
  81  *
  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:
  85  *
  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()
  92  *
  93  * All three method use the same callback and will provide a pa_sink_info or
  94  * pa_source_info structure.
  95  *
  96  * \subsection siso_subsec Sink Inputs and Source Outputs
  97  *
  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.
 101  *
 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:
 104  *
 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()
 109  *
 110  * The structure returned is the pa_sink_input_info or pa_source_output_info
 111  * structure.
 112  *
 113  * \subsection samples_subsec Samples
 114  *
 115  * The list of cached samples can be retrieved from the server. Three methods
 116  * exist for querying the sample cache list:
 117  *
 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()
 121  *
 122  * Note that this only retrieves information about the sample, not the sample
 123  * data itself.
 124  *
 125  * \subsection module_subsec Driver Modules
 126  *
 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.
 130  *
 131  * \subsection autoload_subsec Autoload Entries
 132  *
 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:
 138  *
 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()
 142  *
 143  * \subsection client_subsec Clients
 144  *
 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.
 148  *
 149  * \section ctrl_sec Control
 150  *
 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.
 154  *
 155  * \subsection sinksrc_subsec Sinks and Sources
 156  *
 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:
 160  *
 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()
 165  *
 166  * It is also possible to mute a sink or source:
 167  *
 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()
 172  *
 173  * \subsection siso_subsec Sink Inputs and Source Outputs
 174  *
 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().
 178  *
 179  * There is no support for modifying the volume of source outputs.
 180  *
 181  * It is also possible to remove sink inputs and source outputs, terminating
 182  * the streams associated with them:
 183  *
 184  * \li Sink input - pa_context_kill_sink_input()
 185  * \li Source output - pa_context_kill_source_output()
 186  *
 187  * \subsection module_subsec Modules
 188  *
 189  * Server modules can be remotely loaded and unloaded using
 190  * pa_context_load_module() and pa_context_unload_module().
 191  *
 192  * \subsection autoload_subsec Autoload Entries
 193  *
 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
 198  * version.
 199  *
 200  * \subsection client_subsec Clients
 201  *
 202  * The only operation supported on clients, is the possibility of kicking
 203  * them off the server using pa_context_kill_client().
 204  */
 205
 206 /** \file
 207  *
 208  * Routines for daemon introspection.
 209  */
 210
 211 PA_C_DECL_BEGIN
 212
 213 /** @{ \name Sinks */
 214
 215 /** Stores information about sinks. Please note that this structure
 216  * can be extended as part of evolutionary API updates at any time in
 217  * any new release. */
 218 typedef struct pa_sink_info {
 219     const char *name;                  /**< Name of the sink */
 220     uint32_t index;                    /**< Index of the sink */
 221     const char *description;           /**< Description of this sink */
 222     pa_sample_spec sample_spec;        /**< Sample spec of this sink */
 223     pa_channel_map channel_map;        /**< Channel map */
 224     uint32_t owner_module;             /**< Index of the owning module of this sink, or PA_INVALID_INDEX */
 225     pa_cvolume volume;                 /**< Volume of the sink */
 226     int mute;                          /**< Mute switch of the sink */
 227     uint32_t monitor_source;           /**< Index of the monitor source connected to this sink */
 228     const char *monitor_source_name;   /**< The name of the monitor source */
 229     pa_usec_t latency;                 /**< Length of queued audio in the output buffer. */
 230     const char *driver;                /**< Driver name. */
 231     pa_sink_flags_t flags;             /**< Flags */
 232     pa_proplist *proplist;             /**< Property list \since 0.9.11 */
 233     pa_usec_t configured_latency;      /**< The latency this device has been configured to. \since 0.9.11 */
 234 } pa_sink_info;
 235
 236 /** Callback prototype for pa_context_get_sink_info_by_name() and friends */
 237 typedef void (*pa_sink_info_cb_t)(pa_context *c, const pa_sink_info *i, int eol, void *userdata);
 238
 239 /** Get information about a sink by its name */
 240 pa_operation* pa_context_get_sink_info_by_name(pa_context *c, const char *name, pa_sink_info_cb_t cb, void *userdata);
 241
 242 /** Get information about a sink by its index */
 243 pa_operation* pa_context_get_sink_info_by_index(pa_context *c, uint32_t id, pa_sink_info_cb_t cb, void *userdata);
 244
 245 /** Get the complete sink list */
 246 pa_operation* pa_context_get_sink_info_list(pa_context *c, pa_sink_info_cb_t cb, void *userdata);
 247
 248 /** Set the volume of a sink device specified by its index */
 249 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);
 250
 251 /** Set the volume of a sink device specified by its name */
 252 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);
 253
 254 /** Set the mute switch of a sink device specified by its index */
 255 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);
 256
 257 /** Set the mute switch of a sink device specified by its name */
 258 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);
 259
 260 /** Suspend/Resume a sink. \since 0.9.7 */
 261 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);
 262
 263 /** Suspend/Resume a sink. If idx is PA_INVALID_INDEX all sinks will be suspended. \since 0.9.7 */
 264 pa_operation* pa_context_suspend_sink_by_index(pa_context *c, uint32_t idx, int suspend,  pa_context_success_cb_t cb, void* userdata);
 265
 266 /** @} */
 267
 268 /** @{ \name Sources */
 269
 270 /** Stores information about sources. Please note that this structure
 271  * can be extended as part of evolutionary API updates at any time in
 272  * any new release. */
 273 typedef struct pa_source_info {
 274     const char *name;                   /**< Name of the source */
 275     uint32_t index;                     /**< Index of the source */
 276     const char *description;            /**< Description of this source */
 277     pa_sample_spec sample_spec;         /**< Sample spec of this source */
 278     pa_channel_map channel_map;         /**< Channel map */
 279     uint32_t owner_module;              /**< Owning module index, or PA_INVALID_INDEX */
 280     pa_cvolume volume;                  /**< Volume of the source */
 281     int mute;                           /**< Mute switch of the sink */
 282     uint32_t monitor_of_sink;           /**< If this is a monitor source the index of the owning sink, otherwise PA_INVALID_INDEX */
 283     const char *monitor_of_sink_name;   /**< Name of the owning sink, or PA_INVALID_INDEX */
 284     pa_usec_t latency;                  /**< Length of filled record buffer of this source. */
 285     const char *driver;                 /**< Driver name */
 286     pa_source_flags_t flags;            /**< Flags */
 287     pa_proplist *proplist;              /**< Property list \since 0.9.11 */
 288     pa_usec_t configured_latency;       /**< The latency this device has been configured to. \since 0.9.11 */
 289 } pa_source_info;
 290
 291 /** Callback prototype for pa_context_get_source_info_by_name() and friends */
 292 typedef void (*pa_source_info_cb_t)(pa_context *c, const pa_source_info *i, int eol, void *userdata);
 293
 294 /** Get information about a source by its name */
 295 pa_operation* pa_context_get_source_info_by_name(pa_context *c, const char *name, pa_source_info_cb_t cb, void *userdata);
 296
 297 /** Get information about a source by its index */
 298 pa_operation* pa_context_get_source_info_by_index(pa_context *c, uint32_t id, pa_source_info_cb_t cb, void *userdata);
 299
 300 /** Get the complete source list */
 301 pa_operation* pa_context_get_source_info_list(pa_context *c, pa_source_info_cb_t cb, void *userdata);
 302
 303 /** Set the volume of a source device specified by its index */
 304 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);
 305
 306 /** Set the volume of a source device specified by its name */
 307 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);
 308
 309 /** Set the mute switch of a source device specified by its index */
 310 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);
 311
 312 /** Set the mute switch of a source device specified by its name */
 313 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);
 314
 315 /** @} */
 316
 317 /** @{ \name Server */
 318
 319 /** Server information. Please note that this structure can be
 320  * extended as part of evolutionary API updates at any time in any new
 321  * release. */
 322 typedef struct pa_server_info {
 323     const char *user_name;              /**< User name of the daemon process */
 324     const char *host_name;              /**< Host name the daemon is running on */
 325     const char *server_version;         /**< Version string of the daemon */
 326     const char *server_name;            /**< Server package name (usually "pulseaudio") */
 327     pa_sample_spec sample_spec;         /**< Default sample specification */
 328     const char *default_sink_name;      /**< Name of default sink. */
 329     const char *default_source_name;    /**< Name of default sink. */
 330     uint32_t cookie;                    /**< A random cookie for identifying this instance of PulseAudio. */
 331 } pa_server_info;
 332
 333 /** Callback prototype for pa_context_get_server_info() */
 334 typedef void (*pa_server_info_cb_t) (pa_context *c, const pa_server_info*i, void *userdata);
 335
 336 /** Get some information about the server */
 337 pa_operation* pa_context_get_server_info(pa_context *c, pa_server_info_cb_t cb, void *userdata);
 338
 339 /** @} */
 340
 341 /** @{ \name Modules */
 342
 343 /** Stores information about modules. Please note that this structure
 344  * can be extended as part of evolutionary API updates at any time in
 345  * any new release. */
 346 typedef struct pa_module_info {
 347     uint32_t index;                     /**< Index of the module */
 348     const char*name,                    /**< Name of the module */
 349         *argument;                      /**< Argument string of the module */
 350     uint32_t n_used;                    /**< Usage counter or PA_INVALID_INDEX */
 351     int auto_unload;                    /**< Non-zero if this is an autoloaded module */
 352 } pa_module_info;
 353
 354 /** Callback prototype for pa_context_get_module_info() and firends*/
 355 typedef void (*pa_module_info_cb_t) (pa_context *c, const pa_module_info*i, int eol, void *userdata);
 356
 357 /** Get some information about a module by its index */
 358 pa_operation* pa_context_get_module_info(pa_context *c, uint32_t idx, pa_module_info_cb_t cb, void *userdata);
 359
 360 /** Get the complete list of currently loaded modules */
 361 pa_operation* pa_context_get_module_info_list(pa_context *c, pa_module_info_cb_t cb, void *userdata);
 362
 363 /** Callback prototype for pa_context_load_module() */
 364 typedef void (*pa_context_index_cb_t)(pa_context *c, uint32_t idx, void *userdata);
 365
 366 /** Load a module. */
 367 pa_operation* pa_context_load_module(pa_context *c, const char*name, const char *argument, pa_context_index_cb_t cb, void *userdata);
 368
 369 /** Unload a module. */
 370 pa_operation* pa_context_unload_module(pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata);
 371
 372 /** @} */
 373
 374 /** @{ \name Clients */
 375
 376 /** Stores information about clients. Please note that this structure
 377  * can be extended as part of evolutionary API updates at any time in
 378  * any new release. */
 379 typedef struct pa_client_info {
 380     uint32_t index;                      /**< Index of this client */
 381     const char *name;                    /**< Name of this client */
 382     uint32_t owner_module;               /**< Index of the owning module, or PA_INVALID_INDEX */
 383     const char *driver;                  /**< Driver name */
 384     pa_proplist *proplist;               /**< Property list \since 0.9.11 */
 385 } pa_client_info;
 386
 387 /** Callback prototype for pa_context_get_client_info() and firends*/
 388 typedef void (*pa_client_info_cb_t) (pa_context *c, const pa_client_info*i, int eol, void *userdata);
 389
 390 /** Get information about a client by its index */
 391 pa_operation* pa_context_get_client_info(pa_context *c, uint32_t idx, pa_client_info_cb_t cb, void *userdata);
 392
 393 /** Get the complete client list */
 394 pa_operation* pa_context_get_client_info_list(pa_context *c, pa_client_info_cb_t cb, void *userdata);
 395
 396 /** Kill a client. */
 397 pa_operation* pa_context_kill_client(pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata);
 398
 399 /** @} */
 400
 401 /** @{ \name Sink Inputs */
 402
 403 /** Stores information about sink inputs. Please note that this structure
 404  * can be extended as part of evolutionary API updates at any time in
 405  * any new release. */
 406 typedef struct pa_sink_input_info {
 407     uint32_t index;                      /**< Index of the sink input */
 408     const char *name;                    /**< Name of the sink input */
 409     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 */
 410     uint32_t client;                     /**< Index of the client this sink input belongs to, or PA_INVALID_INDEX when it does not belong to any client */
 411     uint32_t sink;                       /**< Index of the connected sink */
 412     pa_sample_spec sample_spec;          /**< The sample specification of the sink input */
 413     pa_channel_map channel_map;          /**< Channel map */
 414     pa_cvolume volume;                   /**< The volume of this sink input */
 415     pa_usec_t buffer_usec;               /**< Latency due to buffering in sink input, see pa_latency_info for details */
 416     pa_usec_t sink_usec;                 /**< Latency of the sink device, see pa_latency_info for details */
 417     const char *resample_method;         /**< Thre resampling method used by this sink input. */
 418     const char *driver;                  /**< Driver name */
 419     int mute;                            /**< Stream muted \since 0.9.7 */
 420     pa_proplist *proplist;               /**< Property list \since 0.9.11 */
 421 } pa_sink_input_info;
 422
 423 /** Callback prototype for pa_context_get_sink_input_info() and firends*/
 424 typedef void (*pa_sink_input_info_cb_t) (pa_context *c, const pa_sink_input_info *i, int eol, void *userdata);
 425
 426 /** Get some information about a sink input by its index */
 427 pa_operation* pa_context_get_sink_input_info(pa_context *c, uint32_t idx, pa_sink_input_info_cb_t cb, void *userdata);
 428
 429 /** Get the complete sink input list */
 430 pa_operation* pa_context_get_sink_input_info_list(pa_context *c, pa_sink_input_info_cb_t cb, void *userdata);
 431
 432 /** Move the specified sink input to a different sink. \since 0.9.5 */
 433 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);
 434
 435 /** Move the specified sink input to a different sink. \since 0.9.5 */
 436 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);
 437
 438 /** Set the volume of a sink input stream */
 439 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);
 440
 441 /** Set the mute switch of a sink input stream \since 0.9.7 */
 442 pa_operation* pa_context_set_sink_input_mute(pa_context *c, uint32_t idx, int mute, pa_context_success_cb_t cb, void *userdata);
 443
 444 /** Kill a sink input. */
 445 pa_operation* pa_context_kill_sink_input(pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata);
 446
 447 /** @} */
 448
 449 /** @{ \name Source Outputs */
 450
 451 /** Stores information about source outputs. Please note that this structure
 452  * can be extended as part of evolutionary API updates at any time in
 453  * any new release. */
 454 typedef struct pa_source_output_info {
 455     uint32_t index;                      /**< Index of the sink input */
 456     const char *name;                    /**< Name of the sink input */
 457     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 */
 458     uint32_t client;                     /**< Index of the client this sink input belongs to, or PA_INVALID_INDEX when it does not belong to any client */
 459     uint32_t source;                     /**< Index of the connected source */
 460     pa_sample_spec sample_spec;          /**< The sample specification of the source output */
 461     pa_channel_map channel_map;          /**< Channel map */
 462     pa_usec_t buffer_usec;               /**< Latency due to buffering in the source output, see pa_latency_info for details. */
 463     pa_usec_t source_usec;               /**< Latency of the source device, see pa_latency_info for details. */
 464     const char *resample_method;         /**< Thre resampling method used by this source output. */
 465     const char *driver;                  /**< Driver name */
 466     pa_proplist *proplist;               /**< Property list \since 0.9.11 */
 467 } pa_source_output_info;
 468
 469 /** Callback prototype for pa_context_get_source_output_info() and firends*/
 470 typedef void (*pa_source_output_info_cb_t) (pa_context *c, const pa_source_output_info *i, int eol, void *userdata);
 471
 472 /** Get information about a source output by its index */
 473 pa_operation* pa_context_get_source_output_info(pa_context *c, uint32_t idx, pa_source_output_info_cb_t cb, void *userdata);
 474
 475 /** Get the complete list of source outputs */
 476 pa_operation* pa_context_get_source_output_info_list(pa_context *c, pa_source_output_info_cb_t cb, void *userdata);
 477
 478 /** Move the specified source output to a different source. \since 0.9.5 */
 479 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);
 480
 481 /** Move the specified source output to a different source. \since 0.9.5 */
 482 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);
 483
 484 /** Suspend/Resume a source. \since 0.9.7 */
 485 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);
 486
 487 /** Suspend/Resume a source. If idx is PA_INVALID_INDEX all sources will be suspended. \since 0.9.7 */
 488 pa_operation* pa_context_suspend_source_by_index(pa_context *c, uint32_t idx, int suspend, pa_context_success_cb_t cb, void* userdata);
 489
 490 /** Kill a source output. */
 491 pa_operation* pa_context_kill_source_output(pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata);
 492
 493 /** @} */
 494
 495 /** @{ \name Statistics */
 496
 497 /** Memory block statistics. Please note that this structure
 498  * can be extended as part of evolutionary API updates at any time in
 499  * any new release. */
 500 typedef struct pa_stat_info {
 501     uint32_t memblock_total;           /**< Currently allocated memory blocks */
 502     uint32_t memblock_total_size;      /**< Currentl total size of allocated memory blocks */
 503     uint32_t memblock_allocated;       /**< Allocated memory blocks during the whole lifetime of the daemon */
 504     uint32_t memblock_allocated_size;  /**< Total size of all memory blocks allocated during the whole lifetime of the daemon */
 505     uint32_t scache_size;              /**< Total size of all sample cache entries. */
 506 } pa_stat_info;
 507
 508 /** Callback prototype for pa_context_stat() */
 509 typedef void (*pa_stat_info_cb_t) (pa_context *c, const pa_stat_info *i, void *userdata);
 510
 511 /** Get daemon memory block statistics */
 512 pa_operation* pa_context_stat(pa_context *c, pa_stat_info_cb_t cb, void *userdata);
 513
 514 /** @} */
 515
 516 /** @{ \name Cached Samples */
 517
 518 /** Stores information about sample cache entries. Please note that this structure
 519  * can be extended as part of evolutionary API updates at any time in
 520  * any new release. */
 521 typedef struct pa_sample_info {
 522     uint32_t index;                       /**< Index of this entry */
 523     const char *name;                     /**< Name of this entry */
 524     pa_cvolume volume;                    /**< Default volume of this entry */
 525     pa_sample_spec sample_spec;           /**< Sample specification of the sample */
 526     pa_channel_map channel_map;           /**< The channel map */
 527     pa_usec_t duration;                   /**< Duration of this entry */
 528     uint32_t bytes;                       /**< Length of this sample in bytes. */
 529     int lazy;                             /**< Non-zero when this is a lazy cache entry. */
 530     const char *filename;                 /**< In case this is a lazy cache entry, the filename for the sound file to be loaded on demand. */
 531     pa_proplist *proplist;                /**< Property list for this sample. \since 0.9.11 */
 532 } pa_sample_info;
 533
 534 /** Callback prototype for pa_context_get_sample_info_by_name() and firends */
 535 typedef void (*pa_sample_info_cb_t)(pa_context *c, const pa_sample_info *i, int eol, void *userdata);
 536
 537 /** Get information about a sample by its name */
 538 pa_operation* pa_context_get_sample_info_by_name(pa_context *c, const char *name, pa_sample_info_cb_t cb, void *userdata);
 539
 540 /** Get information about a sample by its index */
 541 pa_operation* pa_context_get_sample_info_by_index(pa_context *c, uint32_t idx, pa_sample_info_cb_t cb, void *userdata);
 542
 543 /** Get the complete list of samples stored in the daemon. */
 544 pa_operation* pa_context_get_sample_info_list(pa_context *c, pa_sample_info_cb_t cb, void *userdata);
 545
 546 /** @} */
 547
 548 /** \cond fulldocs */
 549
 550 /** @{ \name Autoload Entries */
 551
 552 /** Type of an autoload entry. */
 553 typedef enum pa_autoload_type {
 554     PA_AUTOLOAD_SINK = 0,
 555     PA_AUTOLOAD_SOURCE = 1
 556 } pa_autoload_type_t;
 557
 558 /** Stores information about autoload entries. Please note that this structure
 559  * can be extended as part of evolutionary API updates at any time in
 560  * any new release. */
 561 typedef struct pa_autoload_info {
 562     uint32_t index;               /**< Index of this autoload entry */
 563     const char *name;             /**< Name of the sink or source */
 564     pa_autoload_type_t type;   /**< Type of the autoload entry */
 565     const char *module;           /**< Module name to load */
 566     const char *argument;         /**< Argument string for module */
 567 } pa_autoload_info;
 568
 569 /** Callback prototype for pa_context_get_autoload_info_by_name() and firends */
 570 typedef void (*pa_autoload_info_cb_t)(pa_context *c, const pa_autoload_info *i, int eol, void *userdata);
 571
 572 /** Get info about a specific autoload entry. */
 573 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;
 574
 575 /** Get info about a specific autoload entry. */
 576 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;
 577
 578 /** Get the complete list of autoload entries. */
 579 pa_operation* pa_context_get_autoload_info_list(pa_context *c, pa_autoload_info_cb_t cb, void *userdata) PA_GCC_DEPRECATED;
 580
 581 /** Add a new autoload entry. */
 582 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;
 583
 584 /** Remove an autoload entry. */
 585 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;
 586
 587 /** Remove an autoload entry. */
 588 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;
 589
 590 /** @} */
 591
 592 /** \endcond */
 593
 594 PA_C_DECL_END
 595
 596 #endif