src/pulse/introspect.h

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