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