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.1 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 #include <pulse/version.h>
  36
  37 /** \page introspect Server Query and Control
  38  *
  39  * \section overv_sec Overview
  40  *
  41  * Sometimes it is necessary to query and modify global settings in the
  42  * server. For this, PulseAudio has the introspection API. It can list sinks,
  43  * sources, samples and other aspects of the server. It can also modify the
  44  * attributes of the server that will affect operations on a global level,
  45  * and not just the application's context.
  46  *
  47  * \section query_sec Querying
  48  *
  49  * All querying is done through callbacks. This design is necessary to
  50  * maintain an asynchronous design. The client will request the information
  51  * and some time later, the server will respond with the desired data.
  52  *
  53  * Some objects can have multiple entries at the server. When requesting all
  54  * of these at once, the callback will be called multiple times, once for
  55  * each object. When the list has been exhausted, the callback will be called
  56  * without an information structure and the eol parameter set to a positive
  57  * value.
  58  *
  59  * Note that even if a single object is requested, and not the entire list,
  60  * the terminating call will still be made.
  61  *
  62  * If an error occurs, the callback will be called without and information
  63  * structure and eol set to a negative value..
  64  *
  65  * Data members in the information structures are only valid during the
  66  * duration of the callback. If they are required after the callback is
  67  * finished, a deep copy must be performed.
  68  *
  69  * \subsection server_subsec Server Information
  70  *
  71  * The server can be queried about its name, the environment it's running on
  72  * and the currently active global defaults. Calling
  73  * pa_context_get_server_info() will get access to a pa_server_info structure
  74  * containing all of these.
  75  *
  76  * \subsection memstat_subsec Memory Usage
  77  *
  78  * Statistics about memory usage can be fetched using pa_context_stat(),
  79  * giving a pa_stat_info structure.
  80  *
  81  * \subsection sinksrc_subsec Sinks and Sources
  82  *
  83  * The server can have an arbitrary number of sinks and sources. Each sink
  84  * and source have both an index and a name associated with it. As such
  85  * there are three ways to get access to them:
  86  *
  87  * \li By index - pa_context_get_sink_info_by_index() /
  88  *                pa_context_get_source_info_by_index()
  89  * \li By name - pa_context_get_sink_info_by_name() /
  90  *               pa_context_get_source_info_by_name()
  91  * \li All - pa_context_get_sink_info_list() /
  92  *           pa_context_get_source_info_list()
  93  *
  94  * All three method use the same callback and will provide a pa_sink_info or
  95  * pa_source_info structure.
  96  *
  97  * \subsection siso_subsec Sink Inputs and Source Outputs
  98  *
  99  * Sink inputs and source outputs are the representations of the client ends
 100  * of streams inside the server. I.e. they connect a client stream to one of
 101  * the global sinks or sources.
 102  *
 103  * Sink inputs and source outputs only have an index to identify them. As
 104  * such, there are only two ways to get information about them:
 105  *
 106  * \li By index - pa_context_get_sink_input_info() /
 107  *                pa_context_get_source_output_info()
 108  * \li All - pa_context_get_sink_input_info_list() /
 109  *           pa_context_get_source_output_info_list()
 110  *
 111  * The structure returned is the pa_sink_input_info or pa_source_output_info
 112  * structure.
 113  *
 114  * \subsection samples_subsec Samples
 115  *
 116  * The list of cached samples can be retrieved from the server. Three methods
 117  * exist for querying the sample cache list:
 118  *
 119  * \li By index - pa_context_get_sample_info_by_index()
 120  * \li By name - pa_context_get_sample_info_by_name()
 121  * \li All - pa_context_get_sample_info_list()
 122  *
 123  * Note that this only retrieves information about the sample, not the sample
 124  * data itself.
 125  *
 126  * \subsection module_subsec Driver Modules
 127  *
 128  * PulseAudio driver modules are identified by index and are retrieved using either
 129  * pa_context_get_module_info() or pa_context_get_module_info_list(). The
 130  * information structure is called pa_module_info.
 131  *
 132  * \subsection client_subsec Clients
 133  *
 134  * PulseAudio clients are also identified by index and are retrieved using
 135  * either pa_context_get_client_info() or pa_context_get_client_info_list().
 136  * The information structure is called pa_client_info.
 137  *
 138  * \section ctrl_sec Control
 139  *
 140  * Some parts of the server are only possible to read, but most can also be
 141  * modified in different ways. Note that these changes will affect all
 142  * connected clients and not just the one issuing the request.
 143  *
 144  * \subsection sinksrc_subsec Sinks and Sources
 145  *
 146  * The most common change one would want to do to sinks and sources is to
 147  * modify the volume of the audio. Identical to how sinks and sources can
 148  * be queried, there are two ways of identifying them:
 149  *
 150  * \li By index - pa_context_set_sink_volume_by_index() /
 151  *                pa_context_set_source_volume_by_index()
 152  * \li By name - pa_context_set_sink_volume_by_name() /
 153  *               pa_context_set_source_volume_by_name()
 154  *
 155  * It is also possible to mute a sink or source:
 156  *
 157  * \li By index - pa_context_set_sink_mute_by_index() /
 158  *                pa_context_set_source_mute_by_index()
 159  * \li By name - pa_context_set_sink_mute_by_name() /
 160  *               pa_context_set_source_mute_by_name()
 161  *
 162  * \subsection siso_subsec Sink Inputs and Source Outputs
 163  *
 164  * If an application desires to modify the volume of just a single stream
 165  * (commonly one of its own streams), this can be done by setting the volume
 166  * of its associated sink input, using pa_context_set_sink_input_volume().
 167  *
 168  * There is no support for modifying the volume of source outputs.
 169  *
 170  * It is also possible to remove sink inputs and source outputs, terminating
 171  * the streams associated with them:
 172  *
 173  * \li Sink input - pa_context_kill_sink_input()
 174  * \li Source output - pa_context_kill_source_output()
 175  *
 176  * \subsection module_subsec Modules
 177  *
 178  * Server modules can be remotely loaded and unloaded using
 179  * pa_context_load_module() and pa_context_unload_module().
 180  *
 181  * \subsection client_subsec Clients
 182  *
 183  * The only operation supported on clients, is the possibility of kicking
 184  * them off the server using pa_context_kill_client().
 185  */
 186
 187 /** \file
 188  *
 189  * Routines for daemon introspection.
 190  */
 191
 192 PA_C_DECL_BEGIN
 193
 194 /** @{ \name Sinks */
 195
 196 /** Stores information about sinks. Please note that this structure
 197  * can be extended as part of evolutionary API updates at any time in
 198  * any new release. */
 199 typedef struct pa_sink_info {
 200     const char *name;                  /**< Name of the sink */
 201     uint32_t index;                    /**< Index of the sink */
 202     const char *description;           /**< Description of this sink */
 203     pa_sample_spec sample_spec;        /**< Sample spec of this sink */
 204     pa_channel_map channel_map;        /**< Channel map */
 205     uint32_t owner_module;             /**< Index of the owning module of this sink, or PA_INVALID_INDEX */
 206     pa_cvolume volume;                 /**< Volume of the sink */
 207     int mute;                          /**< Mute switch of the sink */
 208     uint32_t monitor_source;           /**< Index of the monitor source connected to this sink */
 209     const char *monitor_source_name;   /**< The name of the monitor source */
 210     pa_usec_t latency;                 /**< Length of queued audio in the output buffer. */
 211     const char *driver;                /**< Driver name. */
 212     pa_sink_flags_t flags;             /**< Flags */
 213     pa_proplist *proplist;             /**< Property list \since 0.9.11 */
 214     pa_usec_t configured_latency;      /**< The latency this device has been configured to. \since 0.9.11 */
 215     pa_volume_t base_volume;           /**< Some kind of "base" volume that refers to unamplified/unattenuated volume in the context of the output device. \since 0.9.15 */
 216     pa_sink_state_t state;             /**< State \since 0.9.15 */
 217     uint32_t n_volume_steps;           /**< Number of volume steps for sinks which do not support arbitrary volumes. \since 0.9.15 */
 218     uint32_t card;                     /**< Card index, or PA_INVALID_INDEX. \since 0.9.15 */
 219 } pa_sink_info;
 220
 221 /** Callback prototype for pa_context_get_sink_info_by_name() and friends */
 222 typedef void (*pa_sink_info_cb_t)(pa_context *c, const pa_sink_info *i, int eol, void *userdata);
 223
 224 /** Get information about a sink by its name */
 225 pa_operation* pa_context_get_sink_info_by_name(pa_context *c, const char *name, pa_sink_info_cb_t cb, void *userdata);
 226
 227 /** Get information about a sink by its index */
 228 pa_operation* pa_context_get_sink_info_by_index(pa_context *c, uint32_t idx, pa_sink_info_cb_t cb, void *userdata);
 229
 230 /** Get the complete sink list */
 231 pa_operation* pa_context_get_sink_info_list(pa_context *c, pa_sink_info_cb_t cb, void *userdata);
 232
 233 /** Set the volume of a sink device specified by its index */
 234 pa_operation* pa_context_set_sink_volume_by_index(pa_context *c, uint32_t idx, const pa_cvolume *volume, pa_context_success_cb_t cb, void *userdata);
 235
 236 /** Set the volume of a sink device specified by its name */
 237 pa_operation* pa_context_set_sink_volume_by_name(pa_context *c, const char *name, const pa_cvolume *volume, pa_context_success_cb_t cb, void *userdata);
 238
 239 /** Set the mute switch of a sink device specified by its index */
 240 pa_operation* pa_context_set_sink_mute_by_index(pa_context *c, uint32_t idx, int mute, pa_context_success_cb_t cb, void *userdata);
 241
 242 /** Set the mute switch of a sink device specified by its name */
 243 pa_operation* pa_context_set_sink_mute_by_name(pa_context *c, const char *name, int mute, pa_context_success_cb_t cb, void *userdata);
 244
 245 /** Suspend/Resume a sink. \since 0.9.7 */
 246 pa_operation* pa_context_suspend_sink_by_name(pa_context *c, const char *sink_name, int suspend, pa_context_success_cb_t cb, void* userdata);
 247
 248 /** Suspend/Resume a sink. If idx is PA_INVALID_INDEX all sinks will be suspended. \since 0.9.7 */
 249 pa_operation* pa_context_suspend_sink_by_index(pa_context *c, uint32_t idx, int suspend,  pa_context_success_cb_t cb, void* userdata);
 250
 251 /** @} */
 252
 253 /** @{ \name Sources */
 254
 255 /** Stores information about sources. Please note that this structure
 256  * can be extended as part of evolutionary API updates at any time in
 257  * any new release. */
 258 typedef struct pa_source_info {
 259     const char *name;                   /**< Name of the source */
 260     uint32_t index;                     /**< Index of the source */
 261     const char *description;            /**< Description of this source */
 262     pa_sample_spec sample_spec;         /**< Sample spec of this source */
 263     pa_channel_map channel_map;         /**< Channel map */
 264     uint32_t owner_module;              /**< Owning module index, or PA_INVALID_INDEX */
 265     pa_cvolume volume;                  /**< Volume of the source */
 266     int mute;                           /**< Mute switch of the sink */
 267     uint32_t monitor_of_sink;           /**< If this is a monitor source the index of the owning sink, otherwise PA_INVALID_INDEX */
 268     const char *monitor_of_sink_name;   /**< Name of the owning sink, or PA_INVALID_INDEX */
 269     pa_usec_t latency;                  /**< Length of filled record buffer of this source. */
 270     const char *driver;                 /**< Driver name */
 271     pa_source_flags_t flags;            /**< Flags */
 272     pa_proplist *proplist;              /**< Property list \since 0.9.11 */
 273     pa_usec_t configured_latency;       /**< The latency this device has been configured to. \since 0.9.11 */
 274     pa_volume_t base_volume;            /**< Some kind of "base" volume that refers to unamplified/unattenuated volume in the context of the input device. \since 0.9.15 */
 275     pa_source_state_t state;            /**< State \since 0.9.15 */
 276     uint32_t n_volume_steps;            /**< Number of volume steps for sources which do not support arbitrary volumes. \since 0.9.15 */
 277     uint32_t card;                      /**< Card index, or PA_INVALID_INDEX. \since 0.9.15 */
 278 } pa_source_info;
 279
 280 /** Callback prototype for pa_context_get_source_info_by_name() and friends */
 281 typedef void (*pa_source_info_cb_t)(pa_context *c, const pa_source_info *i, int eol, void *userdata);
 282
 283 /** Get information about a source by its name */
 284 pa_operation* pa_context_get_source_info_by_name(pa_context *c, const char *name, pa_source_info_cb_t cb, void *userdata);
 285
 286 /** Get information about a source by its index */
 287 pa_operation* pa_context_get_source_info_by_index(pa_context *c, uint32_t idx, pa_source_info_cb_t cb, void *userdata);
 288
 289 /** Get the complete source list */
 290 pa_operation* pa_context_get_source_info_list(pa_context *c, pa_source_info_cb_t cb, void *userdata);
 291
 292 /** Set the volume of a source device specified by its index */
 293 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);
 294
 295 /** Set the volume of a source device specified by its name */
 296 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);
 297
 298 /** Set the mute switch of a source device specified by its index */
 299 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);
 300
 301 /** Set the mute switch of a source device specified by its name */
 302 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);
 303
 304 /** @} */
 305
 306 /** @{ \name Server */
 307
 308 /** Server information. Please note that this structure can be
 309  * extended as part of evolutionary API updates at any time in any new
 310  * release. */
 311 typedef struct pa_server_info {
 312     const char *user_name;              /**< User name of the daemon process */
 313     const char *host_name;              /**< Host name the daemon is running on */
 314     const char *server_version;         /**< Version string of the daemon */
 315     const char *server_name;            /**< Server package name (usually "pulseaudio") */
 316     pa_sample_spec sample_spec;         /**< Default sample specification */
 317     const char *default_sink_name;      /**< Name of default sink. */
 318     const char *default_source_name;    /**< Name of default sink. */
 319     uint32_t cookie;                    /**< A random cookie for identifying this instance of PulseAudio. */
 320     pa_channel_map channel_map;         /**< Default channel map. \since 0.9.15 */
 321 } pa_server_info;
 322
 323 /** Callback prototype for pa_context_get_server_info() */
 324 typedef void (*pa_server_info_cb_t) (pa_context *c, const pa_server_info*i, void *userdata);
 325
 326 /** Get some information about the server */
 327 pa_operation* pa_context_get_server_info(pa_context *c, pa_server_info_cb_t cb, void *userdata);
 328
 329 /** @} */
 330
 331 /** @{ \name Modules */
 332
 333 /** Stores information about modules. Please note that this structure
 334  * can be extended as part of evolutionary API updates at any time in
 335  * any new release. */
 336 typedef struct pa_module_info {
 337     uint32_t index;                     /**< Index of the module */
 338     const char*name,                    /**< Name of the module */
 339         *argument;                      /**< Argument string of the module */
 340     uint32_t n_used;                    /**< Usage counter or PA_INVALID_INDEX */
 341 /** \cond fulldocs */
 342     int auto_unload;                    /**< \deprecated Non-zero if this is an autoloaded module */
 343 /** \endcond */
 344     pa_proplist *proplist;              /**< Property list \since 0.9.15 */
 345 } pa_module_info;
 346
 347 /** Callback prototype for pa_context_get_module_info() and friends*/
 348 typedef void (*pa_module_info_cb_t) (pa_context *c, const pa_module_info*i, int eol, void *userdata);
 349
 350 /** Get some information about a module by its index */
 351 pa_operation* pa_context_get_module_info(pa_context *c, uint32_t idx, pa_module_info_cb_t cb, void *userdata);
 352
 353 /** Get the complete list of currently loaded modules */
 354 pa_operation* pa_context_get_module_info_list(pa_context *c, pa_module_info_cb_t cb, void *userdata);
 355
 356 /** Callback prototype for pa_context_load_module() */
 357 typedef void (*pa_context_index_cb_t)(pa_context *c, uint32_t idx, void *userdata);
 358
 359 /** Load a module. */
 360 pa_operation* pa_context_load_module(pa_context *c, const char*name, const char *argument, pa_context_index_cb_t cb, void *userdata);
 361
 362 /** Unload a module. */
 363 pa_operation* pa_context_unload_module(pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata);
 364
 365 /** @} */
 366
 367 /** @{ \name Clients */
 368
 369 /** Stores information about clients. Please note that this structure
 370  * can be extended as part of evolutionary API updates at any time in
 371  * any new release. */
 372 typedef struct pa_client_info {
 373     uint32_t index;                      /**< Index of this client */
 374     const char *name;                    /**< Name of this client */
 375     uint32_t owner_module;               /**< Index of the owning module, or PA_INVALID_INDEX */
 376     const char *driver;                  /**< Driver name */
 377     pa_proplist *proplist;               /**< Property list \since 0.9.11 */
 378 } pa_client_info;
 379
 380 /** Callback prototype for pa_context_get_client_info() and friends*/
 381 typedef void (*pa_client_info_cb_t) (pa_context *c, const pa_client_info*i, int eol, void *userdata);
 382
 383 /** Get information about a client by its index */
 384 pa_operation* pa_context_get_client_info(pa_context *c, uint32_t idx, pa_client_info_cb_t cb, void *userdata);
 385
 386 /** Get the complete client list */
 387 pa_operation* pa_context_get_client_info_list(pa_context *c, pa_client_info_cb_t cb, void *userdata);
 388
 389 /** Kill a client. */
 390 pa_operation* pa_context_kill_client(pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata);
 391
 392 /** @} */
 393
 394 /** @{ \name Cards */
 395
 396 /** Stores information about a specific profile of a card.  Please
 397  * note that this structure can be extended as part of evolutionary
 398  * API updates at any time in any new release. \since 0.9.15 */
 399 typedef struct pa_card_profile_info {
 400     const char *name;                   /**< Name of this profile */
 401     const char *description;            /**< Description of this profile */
 402     uint32_t n_sinks;                   /**< Number of sinks this profile would create */
 403     uint32_t n_sources;                 /**< Number of sources this profile would create */
 404     uint32_t priority;                  /**< The higher this value is the more useful this profile is as a default */
 405 } pa_card_profile_info;
 406
 407 /** Stores information about cards. Please note that this structure
 408  * can be extended as part of evolutionary API updates at any time in
 409  * any new release.  \since 0.9.15 */
 410 typedef struct pa_card_info {
 411     uint32_t index;                      /**< Index of this card */
 412     const char *name;                    /**< Name of this card */
 413     uint32_t owner_module;               /**< Index of the owning module, or PA_INVALID_INDEX */
 414     const char *driver;                  /**< Driver name */
 415     uint32_t n_profiles;                 /**< Number of entries in profile array */
 416     pa_card_profile_info* profiles;      /**< Array of available profile, or NULL. Array is terminated by an entry with name set to NULL. Number of entries is stored in n_profiles */
 417     pa_card_profile_info* active_profile; /**< Pointer to active profile in the array, or NULL */
 418     pa_proplist *proplist;               /**< Property list */
 419 } pa_card_info;
 420
 421 /** Callback prototype for pa_context_get_card_info() and friends \since 0.9.15 */
 422 typedef void (*pa_card_info_cb_t) (pa_context *c, const pa_card_info*i, int eol, void *userdata);
 423
 424 /** Get information about a card by its index \since 0.9.15 */
 425 pa_operation* pa_context_get_card_info_by_index(pa_context *c, uint32_t idx, pa_card_info_cb_t cb, void *userdata);
 426
 427 /** Get information about a card by its name \since 0.9.15 */
 428 pa_operation* pa_context_get_card_info_by_name(pa_context *c, const char *name, pa_card_info_cb_t cb, void *userdata);
 429
 430 /** Get the complete card list \since 0.9.15 */
 431 pa_operation* pa_context_get_card_info_list(pa_context *c, pa_card_info_cb_t cb, void *userdata);
 432
 433 /** Change the profile of a card. \since 0.9.15 */
 434 pa_operation* pa_context_set_card_profile_by_index(pa_context *c, uint32_t idx, const char*profile, pa_context_success_cb_t cb, void *userdata);
 435
 436 /** Change the profile of a card. \since 0.9.15 */
 437 pa_operation* pa_context_set_card_profile_by_name(pa_context *c, const char*name, const char*profile, pa_context_success_cb_t cb, void *userdata);
 438
 439 /** @} */
 440
 441 /** @{ \name Sink Inputs */
 442
 443 /** Stores information about sink inputs. Please note that this structure
 444  * can be extended as part of evolutionary API updates at any time in
 445  * any new release. */
 446 typedef struct pa_sink_input_info {
 447     uint32_t index;                      /**< Index of the sink input */
 448     const char *name;                    /**< Name of the sink input */
 449     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 */
 450     uint32_t client;                     /**< Index of the client this sink input belongs to, or PA_INVALID_INDEX when it does not belong to any client */
 451     uint32_t sink;                       /**< Index of the connected sink */
 452     pa_sample_spec sample_spec;          /**< The sample specification of the sink input */
 453     pa_channel_map channel_map;          /**< Channel map */
 454     pa_cvolume volume;                   /**< The volume of this sink input */
 455     pa_usec_t buffer_usec;               /**< Latency due to buffering in sink input, see pa_latency_info for details */
 456     pa_usec_t sink_usec;                 /**< Latency of the sink device, see pa_latency_info for details */
 457     const char *resample_method;         /**< The resampling method used by this sink input. */
 458     const char *driver;                  /**< Driver name */
 459     int mute;                            /**< Stream muted \since 0.9.7 */
 460     pa_proplist *proplist;               /**< Property list \since 0.9.11 */
 461 } pa_sink_input_info;
 462
 463 /** Callback prototype for pa_context_get_sink_input_info() and friends*/
 464 typedef void (*pa_sink_input_info_cb_t) (pa_context *c, const pa_sink_input_info *i, int eol, void *userdata);
 465
 466 /** Get some information about a sink input by its index */
 467 pa_operation* pa_context_get_sink_input_info(pa_context *c, uint32_t idx, pa_sink_input_info_cb_t cb, void *userdata);
 468
 469 /** Get the complete sink input list */
 470 pa_operation* pa_context_get_sink_input_info_list(pa_context *c, pa_sink_input_info_cb_t cb, void *userdata);
 471
 472 /** Move the specified sink input to a different sink. \since 0.9.5 */
 473 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);
 474
 475 /** Move the specified sink input to a different sink. \since 0.9.5 */
 476 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);
 477
 478 /** Set the volume of a sink input stream */
 479 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);
 480
 481 /** Set the mute switch of a sink input stream \since 0.9.7 */
 482 pa_operation* pa_context_set_sink_input_mute(pa_context *c, uint32_t idx, int mute, pa_context_success_cb_t cb, void *userdata);
 483
 484 /** Kill a sink input. */
 485 pa_operation* pa_context_kill_sink_input(pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata);
 486
 487 /** @} */
 488
 489 /** @{ \name Source Outputs */
 490
 491 /** Stores information about source outputs. Please note that this structure
 492  * can be extended as part of evolutionary API updates at any time in
 493  * any new release. */
 494 typedef struct pa_source_output_info {
 495     uint32_t index;                      /**< Index of the sink input */
 496     const char *name;                    /**< Name of the sink input */
 497     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 */
 498     uint32_t client;                     /**< Index of the client this sink input belongs to, or PA_INVALID_INDEX when it does not belong to any client */
 499     uint32_t source;                     /**< Index of the connected source */
 500     pa_sample_spec sample_spec;          /**< The sample specification of the source output */
 501     pa_channel_map channel_map;          /**< Channel map */
 502     pa_usec_t buffer_usec;               /**< Latency due to buffering in the source output, see pa_latency_info for details. */
 503     pa_usec_t source_usec;               /**< Latency of the source device, see pa_latency_info for details. */
 504     const char *resample_method;         /**< The resampling method used by this source output. */
 505     const char *driver;                  /**< Driver name */
 506     pa_proplist *proplist;               /**< Property list \since 0.9.11 */
 507 } pa_source_output_info;
 508
 509 /** Callback prototype for pa_context_get_source_output_info() and friends*/
 510 typedef void (*pa_source_output_info_cb_t) (pa_context *c, const pa_source_output_info *i, int eol, void *userdata);
 511
 512 /** Get information about a source output by its index */
 513 pa_operation* pa_context_get_source_output_info(pa_context *c, uint32_t idx, pa_source_output_info_cb_t cb, void *userdata);
 514
 515 /** Get the complete list of source outputs */
 516 pa_operation* pa_context_get_source_output_info_list(pa_context *c, pa_source_output_info_cb_t cb, void *userdata);
 517
 518 /** Move the specified source output to a different source. \since 0.9.5 */
 519 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);
 520
 521 /** Move the specified source output to a different source. \since 0.9.5 */
 522 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);
 523
 524 /** Suspend/Resume a source. \since 0.9.7 */
 525 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);
 526
 527 /** Suspend/Resume a source. If idx is PA_INVALID_INDEX all sources will be suspended. \since 0.9.7 */
 528 pa_operation* pa_context_suspend_source_by_index(pa_context *c, uint32_t idx, int suspend, pa_context_success_cb_t cb, void* userdata);
 529
 530 /** Kill a source output. */
 531 pa_operation* pa_context_kill_source_output(pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata);
 532
 533 /** @} */
 534
 535 /** @{ \name Statistics */
 536
 537 /** Memory block statistics. Please note that this structure
 538  * can be extended as part of evolutionary API updates at any time in
 539  * any new release. */
 540 typedef struct pa_stat_info {
 541     uint32_t memblock_total;           /**< Currently allocated memory blocks */
 542     uint32_t memblock_total_size;      /**< Current total size of allocated memory blocks */
 543     uint32_t memblock_allocated;       /**< Allocated memory blocks during the whole lifetime of the daemon */
 544     uint32_t memblock_allocated_size;  /**< Total size of all memory blocks allocated during the whole lifetime of the daemon */
 545     uint32_t scache_size;              /**< Total size of all sample cache entries. */
 546 } pa_stat_info;
 547
 548 /** Callback prototype for pa_context_stat() */
 549 typedef void (*pa_stat_info_cb_t) (pa_context *c, const pa_stat_info *i, void *userdata);
 550
 551 /** Get daemon memory block statistics */
 552 pa_operation* pa_context_stat(pa_context *c, pa_stat_info_cb_t cb, void *userdata);
 553
 554 /** @} */
 555
 556 /** @{ \name Cached Samples */
 557
 558 /** Stores information about sample cache 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_sample_info {
 562     uint32_t index;                       /**< Index of this entry */
 563     const char *name;                     /**< Name of this entry */
 564     pa_cvolume volume;                    /**< Default volume of this entry */
 565     pa_sample_spec sample_spec;           /**< Sample specification of the sample */
 566     pa_channel_map channel_map;           /**< The channel map */
 567     pa_usec_t duration;                   /**< Duration of this entry */
 568     uint32_t bytes;                       /**< Length of this sample in bytes. */
 569     int lazy;                             /**< Non-zero when this is a lazy cache entry. */
 570     const char *filename;                 /**< In case this is a lazy cache entry, the filename for the sound file to be loaded on demand. */
 571     pa_proplist *proplist;                /**< Property list for this sample. \since 0.9.11 */
 572 } pa_sample_info;
 573
 574 /** Callback prototype for pa_context_get_sample_info_by_name() and friends */
 575 typedef void (*pa_sample_info_cb_t)(pa_context *c, const pa_sample_info *i, int eol, void *userdata);
 576
 577 /** Get information about a sample by its name */
 578 pa_operation* pa_context_get_sample_info_by_name(pa_context *c, const char *name, pa_sample_info_cb_t cb, void *userdata);
 579
 580 /** Get information about a sample by its index */
 581 pa_operation* pa_context_get_sample_info_by_index(pa_context *c, uint32_t idx, pa_sample_info_cb_t cb, void *userdata);
 582
 583 /** Get the complete list of samples stored in the daemon. */
 584 pa_operation* pa_context_get_sample_info_list(pa_context *c, pa_sample_info_cb_t cb, void *userdata);
 585
 586 /** @} */
 587
 588 /** \cond fulldocs */
 589
 590 /** @{ \name Autoload Entries */
 591
 592 /** \deprecated Type of an autoload entry. */
 593 typedef enum pa_autoload_type {
 594     PA_AUTOLOAD_SINK = 0,
 595     PA_AUTOLOAD_SOURCE = 1
 596 } pa_autoload_type_t;
 597
 598 /** \deprecated Stores information about autoload entries. Please note that this structure
 599  * can be extended as part of evolutionary API updates at any time in
 600  * any new release. */
 601 typedef struct pa_autoload_info {
 602     uint32_t index;               /**< Index of this autoload entry */
 603     const char *name;             /**< Name of the sink or source */
 604     pa_autoload_type_t type;      /**< Type of the autoload entry */
 605     const char *module;           /**< Module name to load */
 606     const char *argument;         /**< Argument string for module */
 607 } pa_autoload_info;
 608
 609 /** \deprecated Callback prototype for pa_context_get_autoload_info_by_name() and friends */
 610 typedef void (*pa_autoload_info_cb_t)(pa_context *c, const pa_autoload_info *i, int eol, void *userdata);
 611
 612 /** \deprecated Get info about a specific autoload entry. */
 613 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;
 614
 615 /** \deprecated Get info about a specific autoload entry. */
 616 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;
 617
 618 /** \deprecated Get the complete list of autoload entries. */
 619 pa_operation* pa_context_get_autoload_info_list(pa_context *c, pa_autoload_info_cb_t cb, void *userdata) PA_GCC_DEPRECATED;
 620
 621 /** \deprecated Add a new autoload entry. */
 622 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;
 623
 624 /** \deprecated Remove an autoload entry. */
 625 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;
 626
 627 /** \deprecated Remove an autoload entry. */
 628 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;
 629
 630 /** @} */
 631
 632 /** \endcond */
 633
 634 PA_C_DECL_END
 635
 636 #endif