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