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