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