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 an 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  * See also \subpage introspect
 192  */
 193
 194 PA_C_DECL_BEGIN
 195
 196 /** @{ \name Sinks */
 197
 198 /** Stores information about a specific port of a sink.  Please
 199  * note that this structure can be extended as part of evolutionary
 200  * API updates at any time in any new release. \since 0.9.16 */
 201 typedef struct pa_sink_port_info {
 202     const char *name;                   /**< Name of this port */
 203     const char *description;            /**< Description of this port */
 204     uint32_t priority;                  /**< The higher this value is the more useful this port is as a default */
 205 } pa_sink_port_info;
 206
 207 /** Stores information about sinks. Please note that this structure
 208  * can be extended as part of evolutionary API updates at any time in
 209  * any new release. */
 210 typedef struct pa_sink_info {
 211     const char *name;                  /**< Name of the sink */
 212     uint32_t index;                    /**< Index of the sink */
 213     const char *description;           /**< Description of this sink */
 214     pa_sample_spec sample_spec;        /**< Sample spec of this sink */
 215     pa_channel_map channel_map;        /**< Channel map */
 216     uint32_t owner_module;             /**< Index of the owning module of this sink, or PA_INVALID_INDEX */
 217     pa_cvolume volume;                 /**< Volume of the sink */
 218     int mute;                          /**< Mute switch of the sink */
 219     uint32_t monitor_source;           /**< Index of the monitor source connected to this sink */
 220     const char *monitor_source_name;   /**< The name of the monitor source */
 221     pa_usec_t latency;                 /**< Length of queued audio in the output buffer. */
 222     const char *driver;                /**< Driver name. */
 223     pa_sink_flags_t flags;             /**< Flags */
 224     pa_proplist *proplist;             /**< Property list \since 0.9.11 */
 225     pa_usec_t configured_latency;      /**< The latency this device has been configured to. \since 0.9.11 */
 226     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 */
 227     pa_sink_state_t state;             /**< State \since 0.9.15 */
 228     uint32_t n_volume_steps;           /**< Number of volume steps for sinks which do not support arbitrary volumes. \since 0.9.15 */
 229     uint32_t card;                     /**< Card index, or PA_INVALID_INDEX. \since 0.9.15 */
 230     uint32_t n_ports;                  /**< Number of entries in port array \since 0.9.16 */
 231     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 */
 232     pa_sink_port_info* active_port;    /**< Pointer to active port in the array, or NULL \since 0.9.16 */
 233 } pa_sink_info;
 234
 235 /** Callback prototype for pa_context_get_sink_info_by_name() and friends */
 236 typedef void (*pa_sink_info_cb_t)(pa_context *c, const pa_sink_info *i, int eol, void *userdata);
 237
 238 /** Get information about a sink by its name */
 239 pa_operation* pa_context_get_sink_info_by_name(pa_context *c, const char *name, pa_sink_info_cb_t cb, void *userdata);
 240
 241 /** Get information about a sink by its index */
 242 pa_operation* pa_context_get_sink_info_by_index(pa_context *c, uint32_t idx, pa_sink_info_cb_t cb, void *userdata);
 243
 244 /** Get the complete sink list */
 245 pa_operation* pa_context_get_sink_info_list(pa_context *c, pa_sink_info_cb_t cb, void *userdata);
 246
 247 /** Set the volume of a sink device specified by its index */
 248 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);
 249
 250 /** Set the volume of a sink device specified by its name */
 251 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);
 252
 253 /** Set the mute switch of a sink device specified by its index */
 254 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);
 255
 256 /** Set the mute switch of a sink device specified by its name */
 257 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);
 258
 259 /** Suspend/Resume a sink. \since 0.9.7 */
 260 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);
 261
 262 /** Suspend/Resume a sink. If idx is PA_INVALID_INDEX all sinks will be suspended. \since 0.9.7 */
 263 pa_operation* pa_context_suspend_sink_by_index(pa_context *c, uint32_t idx, int suspend,  pa_context_success_cb_t cb, void* userdata);
 264
 265 /** Change the profile of a sink. \since 0.9.16 */
 266 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);
 267
 268 /** Change the profile of a sink. \since 0.9.15 */
 269 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);
 270
 271 /** @} */
 272
 273 /** @{ \name Sources */
 274
 275 /** Stores information about a specific port of a source.  Please
 276  * note that this structure can be extended as part of evolutionary
 277  * API updates at any time in any new release. \since 0.9.16 */
 278 typedef struct pa_source_port_info {
 279     const char *name;                   /**< Name of this port */
 280     const char *description;            /**< Description of this port */
 281     uint32_t priority;                  /**< The higher this value is the more useful this port is as a default */
 282 } pa_source_port_info;
 283
 284 /** Stores information about sources. Please note that this structure
 285  * can be extended as part of evolutionary API updates at any time in
 286  * any new release. */
 287 typedef struct pa_source_info {
 288     const char *name;                   /**< Name of the source */
 289     uint32_t index;                     /**< Index of the source */
 290     const char *description;            /**< Description of this source */
 291     pa_sample_spec sample_spec;         /**< Sample spec of this source */
 292     pa_channel_map channel_map;         /**< Channel map */
 293     uint32_t owner_module;              /**< Owning module index, or PA_INVALID_INDEX */
 294     pa_cvolume volume;                  /**< Volume of the source */
 295     int mute;                           /**< Mute switch of the sink */
 296     uint32_t monitor_of_sink;           /**< If this is a monitor source the index of the owning sink, otherwise PA_INVALID_INDEX */
 297     const char *monitor_of_sink_name;   /**< Name of the owning sink, or PA_INVALID_INDEX */
 298     pa_usec_t latency;                  /**< Length of filled record buffer of this source. */
 299     const char *driver;                 /**< Driver name */
 300     pa_source_flags_t flags;            /**< Flags */
 301     pa_proplist *proplist;              /**< Property list \since 0.9.11 */
 302     pa_usec_t configured_latency;       /**< The latency this device has been configured to. \since 0.9.11 */
 303     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 */
 304     pa_source_state_t state;            /**< State \since 0.9.15 */
 305     uint32_t n_volume_steps;            /**< Number of volume steps for sources which do not support arbitrary volumes. \since 0.9.15 */
 306     uint32_t card;                      /**< Card index, or PA_INVALID_INDEX. \since 0.9.15 */
 307     uint32_t n_ports;                   /**< Number of entries in port array \since 0.9.16 */
 308     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  */
 309     pa_source_port_info* active_port;   /**< Pointer to active port in the array, or NULL \since 0.9.16  */
 310 } pa_source_info;
 311
 312 /** Callback prototype for pa_context_get_source_info_by_name() and friends */
 313 typedef void (*pa_source_info_cb_t)(pa_context *c, const pa_source_info *i, int eol, void *userdata);
 314
 315 /** Get information about a source by its name */
 316 pa_operation* pa_context_get_source_info_by_name(pa_context *c, const char *name, pa_source_info_cb_t cb, void *userdata);
 317
 318 /** Get information about a source by its index */
 319 pa_operation* pa_context_get_source_info_by_index(pa_context *c, uint32_t idx, pa_source_info_cb_t cb, void *userdata);
 320
 321 /** Get the complete source list */
 322 pa_operation* pa_context_get_source_info_list(pa_context *c, pa_source_info_cb_t cb, void *userdata);
 323
 324 /** Set the volume of a source device specified by its index */
 325 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);
 326
 327 /** Set the volume of a source device specified by its name */
 328 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);
 329
 330 /** Set the mute switch of a source device specified by its index */
 331 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);
 332
 333 /** Set the mute switch of a source device specified by its name */
 334 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);
 335
 336 /** Suspend/Resume a source. \since 0.9.7 */
 337 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);
 338
 339 /** Suspend/Resume a source. If idx is PA_INVALID_INDEX all sources will be suspended. \since 0.9.7 */
 340 pa_operation* pa_context_suspend_source_by_index(pa_context *c, uint32_t idx, int suspend, pa_context_success_cb_t cb, void* userdata);
 341
 342 /** Change the profile of a source. \since 0.9.16 */
 343 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);
 344
 345 /** Change the profile of a source. \since 0.9.15 */
 346 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);
 347
 348 /** @} */
 349
 350 /** @{ \name Server */
 351
 352 /** Server information. Please note that this structure can be
 353  * extended as part of evolutionary API updates at any time in any new
 354  * release. */
 355 typedef struct pa_server_info {
 356     const char *user_name;              /**< User name of the daemon process */
 357     const char *host_name;              /**< Host name the daemon is running on */
 358     const char *server_version;         /**< Version string of the daemon */
 359     const char *server_name;            /**< Server package name (usually "pulseaudio") */
 360     pa_sample_spec sample_spec;         /**< Default sample specification */
 361     const char *default_sink_name;      /**< Name of default sink. */
 362     const char *default_source_name;    /**< Name of default sink. */
 363     uint32_t cookie;                    /**< A random cookie for identifying this instance of PulseAudio. */
 364     pa_channel_map channel_map;         /**< Default channel map. \since 0.9.15 */
 365 } pa_server_info;
 366
 367 /** Callback prototype for pa_context_get_server_info() */
 368 typedef void (*pa_server_info_cb_t) (pa_context *c, const pa_server_info*i, void *userdata);
 369
 370 /** Get some information about the server */
 371 pa_operation* pa_context_get_server_info(pa_context *c, pa_server_info_cb_t cb, void *userdata);
 372
 373 /** @} */
 374
 375 /** @{ \name Modules */
 376
 377 /** Stores information about modules. Please note that this structure
 378  * can be extended as part of evolutionary API updates at any time in
 379  * any new release. */
 380 typedef struct pa_module_info {
 381     uint32_t index;                     /**< Index of the module */
 382     const char*name,                    /**< Name of the module */
 383         *argument;                      /**< Argument string of the module */
 384     uint32_t n_used;                    /**< Usage counter or PA_INVALID_INDEX */
 385 /** \cond fulldocs */
 386     int auto_unload;                    /**< \deprecated Non-zero if this is an autoloaded module */
 387 /** \endcond */
 388     pa_proplist *proplist;              /**< Property list \since 0.9.15 */
 389 } pa_module_info;
 390
 391 /** Callback prototype for pa_context_get_module_info() and friends*/
 392 typedef void (*pa_module_info_cb_t) (pa_context *c, const pa_module_info*i, int eol, void *userdata);
 393
 394 /** Get some information about a module by its index */
 395 pa_operation* pa_context_get_module_info(pa_context *c, uint32_t idx, pa_module_info_cb_t cb, void *userdata);
 396
 397 /** Get the complete list of currently loaded modules */
 398 pa_operation* pa_context_get_module_info_list(pa_context *c, pa_module_info_cb_t cb, void *userdata);
 399
 400 /** Callback prototype for pa_context_load_module() */
 401 typedef void (*pa_context_index_cb_t)(pa_context *c, uint32_t idx, void *userdata);
 402
 403 /** Load a module. */
 404 pa_operation* pa_context_load_module(pa_context *c, const char*name, const char *argument, pa_context_index_cb_t cb, void *userdata);
 405
 406 /** Unload a module. */
 407 pa_operation* pa_context_unload_module(pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata);
 408
 409 /** @} */
 410
 411 /** @{ \name Clients */
 412
 413 /** Stores information about clients. Please note that this structure
 414  * can be extended as part of evolutionary API updates at any time in
 415  * any new release. */
 416 typedef struct pa_client_info {
 417     uint32_t index;                      /**< Index of this client */
 418     const char *name;                    /**< Name of this client */
 419     uint32_t owner_module;               /**< Index of the owning module, or PA_INVALID_INDEX */
 420     const char *driver;                  /**< Driver name */
 421     pa_proplist *proplist;               /**< Property list \since 0.9.11 */
 422 } pa_client_info;
 423
 424 /** Callback prototype for pa_context_get_client_info() and friends*/
 425 typedef void (*pa_client_info_cb_t) (pa_context *c, const pa_client_info*i, int eol, void *userdata);
 426
 427 /** Get information about a client by its index */
 428 pa_operation* pa_context_get_client_info(pa_context *c, uint32_t idx, pa_client_info_cb_t cb, void *userdata);
 429
 430 /** Get the complete client list */
 431 pa_operation* pa_context_get_client_info_list(pa_context *c, pa_client_info_cb_t cb, void *userdata);
 432
 433 /** Kill a client. */
 434 pa_operation* pa_context_kill_client(pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata);
 435
 436 /** @} */
 437
 438 /** @{ \name Cards */
 439
 440 /** Stores information about a specific profile of a card.  Please
 441  * note that this structure can be extended as part of evolutionary
 442  * API updates at any time in any new release. \since 0.9.15 */
 443 typedef struct pa_card_profile_info {
 444     const char *name;                   /**< Name of this profile */
 445     const char *description;            /**< Description of this profile */
 446     uint32_t n_sinks;                   /**< Number of sinks this profile would create */
 447     uint32_t n_sources;                 /**< Number of sources this profile would create */
 448     uint32_t priority;                  /**< The higher this value is the more useful this profile is as a default */
 449 } pa_card_profile_info;
 450
 451 /** Stores information about cards. Please note that this structure
 452  * can be extended as part of evolutionary API updates at any time in
 453  * any new release.  \since 0.9.15 */
 454 typedef struct pa_card_info {
 455     uint32_t index;                      /**< Index of this card */
 456     const char *name;                    /**< Name of this card */
 457     uint32_t owner_module;               /**< Index of the owning module, or PA_INVALID_INDEX */
 458     const char *driver;                  /**< Driver name */
 459     uint32_t n_profiles;                 /**< Number of entries in profile array */
 460     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 */
 461     pa_card_profile_info* active_profile; /**< Pointer to active profile in the array, or NULL */
 462     pa_proplist *proplist;               /**< Property list */
 463 } pa_card_info;
 464
 465 /** Callback prototype for pa_context_get_card_info_...() \since 0.9.15 */
 466 typedef void (*pa_card_info_cb_t) (pa_context *c, const pa_card_info*i, int eol, void *userdata);
 467
 468 /** Get information about a card by its index \since 0.9.15 */
 469 pa_operation* pa_context_get_card_info_by_index(pa_context *c, uint32_t idx, pa_card_info_cb_t cb, void *userdata);
 470
 471 /** Get information about a card by its name \since 0.9.15 */
 472 pa_operation* pa_context_get_card_info_by_name(pa_context *c, const char *name, pa_card_info_cb_t cb, void *userdata);
 473
 474 /** Get the complete card list \since 0.9.15 */
 475 pa_operation* pa_context_get_card_info_list(pa_context *c, pa_card_info_cb_t cb, void *userdata);
 476
 477 /** Change the profile of a card. \since 0.9.15 */
 478 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);
 479
 480 /** Change the profile of a card. \since 0.9.15 */
 481 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);
 482
 483 /** @} */
 484
 485 /** @{ \name Sink Inputs */
 486
 487 /** Stores information about sink inputs. Please note that this structure
 488  * can be extended as part of evolutionary API updates at any time in
 489  * any new release. */
 490 typedef struct pa_sink_input_info {
 491     uint32_t index;                      /**< Index of the sink input */
 492     const char *name;                    /**< Name of the sink input */
 493     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 */
 494     uint32_t client;                     /**< Index of the client this sink input belongs to, or PA_INVALID_INDEX when it does not belong to any client */
 495     uint32_t sink;                       /**< Index of the connected sink */
 496     pa_sample_spec sample_spec;          /**< The sample specification of the sink input */
 497     pa_channel_map channel_map;          /**< Channel map */
 498     pa_cvolume volume;                   /**< The volume of this sink input */
 499     pa_usec_t buffer_usec;               /**< Latency due to buffering in sink input, see pa_latency_info for details */
 500     pa_usec_t sink_usec;                 /**< Latency of the sink device, see pa_latency_info for details */
 501     const char *resample_method;         /**< The resampling method used by this sink input. */
 502     const char *driver;                  /**< Driver name */
 503     int mute;                            /**< Stream muted \since 0.9.7 */
 504     pa_proplist *proplist;               /**< Property list \since 0.9.11 */
 505     int corked;                          /**< Stream corked \since 1.0 */
 506     int has_volume;                      /**< Stream has volume. If not set, then the meaning of this struct's volume member is unspecified. \since 1.0 */
 507     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 */
 508 } pa_sink_input_info;
 509
 510 /** Callback prototype for pa_context_get_sink_input_info() and friends*/
 511 typedef void (*pa_sink_input_info_cb_t) (pa_context *c, const pa_sink_input_info *i, int eol, void *userdata);
 512
 513 /** Get some information about a sink input by its index */
 514 pa_operation* pa_context_get_sink_input_info(pa_context *c, uint32_t idx, pa_sink_input_info_cb_t cb, void *userdata);
 515
 516 /** Get the complete sink input list */
 517 pa_operation* pa_context_get_sink_input_info_list(pa_context *c, pa_sink_input_info_cb_t cb, void *userdata);
 518
 519 /** Move the specified sink input to a different sink. \since 0.9.5 */
 520 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);
 521
 522 /** Move the specified sink input to a different sink. \since 0.9.5 */
 523 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);
 524
 525 /** Set the volume of a sink input stream */
 526 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);
 527
 528 /** Set the mute switch of a sink input stream \since 0.9.7 */
 529 pa_operation* pa_context_set_sink_input_mute(pa_context *c, uint32_t idx, int mute, pa_context_success_cb_t cb, void *userdata);
 530
 531 /** Kill a sink input. */
 532 pa_operation* pa_context_kill_sink_input(pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata);
 533
 534 /** @} */
 535
 536 /** @{ \name Source Outputs */
 537
 538 /** Stores information about source outputs. Please note that this structure
 539  * can be extended as part of evolutionary API updates at any time in
 540  * any new release. */
 541 typedef struct pa_source_output_info {
 542     uint32_t index;                      /**< Index of the sink input */
 543     const char *name;                    /**< Name of the sink input */
 544     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 */
 545     uint32_t client;                     /**< Index of the client this sink input belongs to, or PA_INVALID_INDEX when it does not belong to any client */
 546     uint32_t source;                     /**< Index of the connected source */
 547     pa_sample_spec sample_spec;          /**< The sample specification of the source output */
 548     pa_channel_map channel_map;          /**< Channel map */
 549     pa_usec_t buffer_usec;               /**< Latency due to buffering in the source output, see pa_latency_info for details. */
 550     pa_usec_t source_usec;               /**< Latency of the source device, see pa_latency_info for details. */
 551     const char *resample_method;         /**< The resampling method used by this source output. */
 552     const char *driver;                  /**< Driver name */
 553     pa_proplist *proplist;               /**< Property list \since 0.9.11 */
 554     int corked;                          /**< Stream corked \since 1.0 */
 555 } pa_source_output_info;
 556
 557 /** Callback prototype for pa_context_get_source_output_info() and friends*/
 558 typedef void (*pa_source_output_info_cb_t) (pa_context *c, const pa_source_output_info *i, int eol, void *userdata);
 559
 560 /** Get information about a source output by its index */
 561 pa_operation* pa_context_get_source_output_info(pa_context *c, uint32_t idx, pa_source_output_info_cb_t cb, void *userdata);
 562
 563 /** Get the complete list of source outputs */
 564 pa_operation* pa_context_get_source_output_info_list(pa_context *c, pa_source_output_info_cb_t cb, void *userdata);
 565
 566 /** Move the specified source output to a different source. \since 0.9.5 */
 567 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);
 568
 569 /** Move the specified source output to a different source. \since 0.9.5 */
 570 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);
 571
 572 /** Kill a source output. */
 573 pa_operation* pa_context_kill_source_output(pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata);
 574
 575 /** @} */
 576
 577 /** @{ \name Statistics */
 578
 579 /** Memory block statistics. Please note that this structure
 580  * can be extended as part of evolutionary API updates at any time in
 581  * any new release. */
 582 typedef struct pa_stat_info {
 583     uint32_t memblock_total;           /**< Currently allocated memory blocks */
 584     uint32_t memblock_total_size;      /**< Current total size of allocated memory blocks */
 585     uint32_t memblock_allocated;       /**< Allocated memory blocks during the whole lifetime of the daemon */
 586     uint32_t memblock_allocated_size;  /**< Total size of all memory blocks allocated during the whole lifetime of the daemon */
 587     uint32_t scache_size;              /**< Total size of all sample cache entries. */
 588 } pa_stat_info;
 589
 590 /** Callback prototype for pa_context_stat() */
 591 typedef void (*pa_stat_info_cb_t) (pa_context *c, const pa_stat_info *i, void *userdata);
 592
 593 /** Get daemon memory block statistics */
 594 pa_operation* pa_context_stat(pa_context *c, pa_stat_info_cb_t cb, void *userdata);
 595
 596 /** @} */
 597
 598 /** @{ \name Cached Samples */
 599
 600 /** Stores information about sample cache entries. Please note that this structure
 601  * can be extended as part of evolutionary API updates at any time in
 602  * any new release. */
 603 typedef struct pa_sample_info {
 604     uint32_t index;                       /**< Index of this entry */
 605     const char *name;                     /**< Name of this entry */
 606     pa_cvolume volume;                    /**< Default volume of this entry */
 607     pa_sample_spec sample_spec;           /**< Sample specification of the sample */
 608     pa_channel_map channel_map;           /**< The channel map */
 609     pa_usec_t duration;                   /**< Duration of this entry */
 610     uint32_t bytes;                       /**< Length of this sample in bytes. */
 611     int lazy;                             /**< Non-zero when this is a lazy cache entry. */
 612     const char *filename;                 /**< In case this is a lazy cache entry, the filename for the sound file to be loaded on demand. */
 613     pa_proplist *proplist;                /**< Property list for this sample. \since 0.9.11 */
 614 } pa_sample_info;
 615
 616 /** Callback prototype for pa_context_get_sample_info_by_name() and friends */
 617 typedef void (*pa_sample_info_cb_t)(pa_context *c, const pa_sample_info *i, int eol, void *userdata);
 618
 619 /** Get information about a sample by its name */
 620 pa_operation* pa_context_get_sample_info_by_name(pa_context *c, const char *name, pa_sample_info_cb_t cb, void *userdata);
 621
 622 /** Get information about a sample by its index */
 623 pa_operation* pa_context_get_sample_info_by_index(pa_context *c, uint32_t idx, pa_sample_info_cb_t cb, void *userdata);
 624
 625 /** Get the complete list of samples stored in the daemon. */
 626 pa_operation* pa_context_get_sample_info_list(pa_context *c, pa_sample_info_cb_t cb, void *userdata);
 627
 628 /** @} */
 629
 630 /** \cond fulldocs */
 631
 632 /** @{ \name Autoload Entries */
 633
 634 /** \deprecated Type of an autoload entry. */
 635 typedef enum pa_autoload_type {
 636     PA_AUTOLOAD_SINK = 0,
 637     PA_AUTOLOAD_SOURCE = 1
 638 } pa_autoload_type_t;
 639
 640 /** \deprecated Stores information about autoload entries. Please note that this structure
 641  * can be extended as part of evolutionary API updates at any time in
 642  * any new release. */
 643 typedef struct pa_autoload_info {
 644     uint32_t index;               /**< Index of this autoload entry */
 645     const char *name;             /**< Name of the sink or source */
 646     pa_autoload_type_t type;      /**< Type of the autoload entry */
 647     const char *module;           /**< Module name to load */
 648     const char *argument;         /**< Argument string for module */
 649 } pa_autoload_info;
 650
 651 /** \deprecated Callback prototype for pa_context_get_autoload_info_by_name() and friends */
 652 typedef void (*pa_autoload_info_cb_t)(pa_context *c, const pa_autoload_info *i, int eol, void *userdata);
 653
 654 /** \deprecated Get info about a specific autoload entry. */
 655 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;
 656
 657 /** \deprecated Get info about a specific autoload entry. */
 658 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;
 659
 660 /** \deprecated Get the complete list of autoload entries. */
 661 pa_operation* pa_context_get_autoload_info_list(pa_context *c, pa_autoload_info_cb_t cb, void *userdata) PA_GCC_DEPRECATED;
 662
 663 /** \deprecated Add a new autoload entry. */
 664 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;
 665
 666 /** \deprecated Remove an autoload entry. */
 667 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;
 668
 669 /** \deprecated Remove an autoload entry. */
 670 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;
 671
 672 /** @} */
 673
 674 /** \endcond */
 675
 676 PA_C_DECL_END
 677
 678 #endif