prebuilt/linux-x86/toolchain/i686-linux-glibc2.7-4.4.3/sysroot/usr/include/pulse/introspect.h

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