#ifndef foointrospecthfoo #define foointrospecthfoo /*** This file is part of PulseAudio. Copyright 2004-2006 Lennart Poettering Copyright 2006 Pierre Ossman <[email protected]> for Cendio AB PulseAudio is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. PulseAudio is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with PulseAudio; if not, see <http://www.gnu.org/licenses/>. ***/ #include <inttypes.h> #include <pulse/operation.h> #include <pulse/context.h> #include <pulse/cdecl.h> #include <pulse/gccmacro.h> #include <pulse/channelmap.h> #include <pulse/volume.h> #include <pulse/proplist.h> #include <pulse/format.h> #include <pulse/version.h> /** \page introspect Server Query and Control * * \section overv_sec Overview * * Sometimes it is necessary to query and modify global settings in the * server. For this, PulseAudio has the introspection API. It can list sinks, * sources, samples and other aspects of the server. It can also modify the * attributes of the server that will affect operations on a global level, * and not just the application's context. * * \section query_sec Querying * * All querying is done through callbacks. This approach is necessary to * maintain an asynchronous design. The client will request the information * and some time later, the server will respond with the desired data. * * Some objects can have multiple instances on the server. When requesting all * of these at once, the callback will be called multiple times, once for * each object. When the list has been exhausted, the callback will be called * without an information structure and the eol parameter set to a positive * value. * * Note that even if a single object is requested, and not the entire list, * the terminating call will still be made. * * If an error occurs, the callback will be invoked without an information * structure and eol set to a negative value.. * * Data members in the information structures are only valid during the * duration of the callback. If they are required after the callback is * finished, a deep copy of the information structure must be performed. * * \subsection server_subsec Server Information * * The server can be queried about its name, the environment it's running on * and the currently active global defaults. Calling * pa_context_get_server_info() provides access to a pa_server_info structure * containing all of these. * * \subsection memstat_subsec Memory Usage * * Statistics about memory usage can be fetched using pa_context_stat(), * giving a pa_stat_info structure. * * \subsection sinksrc_subsec Sinks and Sources * * The server can have an arbitrary number of sinks and sources. Each sink * and source have both an index and a name associated with it. As such, * there are three ways to get access to them: * * \li By index - pa_context_get_sink_info_by_index() / * pa_context_get_source_info_by_index() * \li By name - pa_context_get_sink_info_by_name() / * pa_context_get_source_info_by_name() * \li All - pa_context_get_sink_info_list() / * pa_context_get_source_info_list() * * All three method use the same callback and will provide a pa_sink_info or * pa_source_info structure. * * \subsection siso_subsec Sink Inputs and Source Outputs * * Sink inputs and source outputs are the representations of the client ends * of streams inside the server. I.e. they connect a client stream to one of * the global sinks or sources. * * Sink inputs and source outputs only have an index to identify them. As * such, there are only two ways to get information about them: * * \li By index - pa_context_get_sink_input_info() / * pa_context_get_source_output_info() * \li All - pa_context_get_sink_input_info_list() / * pa_context_get_source_output_info_list() * * The structure returned is the pa_sink_input_info or pa_source_output_info * structure. * * \subsection samples_subsec Samples * * The list of cached samples can be retrieved from the server. Three methods * exist for querying the sample cache list: * * \li By index - pa_context_get_sample_info_by_index() * \li By name - pa_context_get_sample_info_by_name() * \li All - pa_context_get_sample_info_list() * * Note that this only retrieves information about the sample, not the sample * data itself. * * \subsection module_subsec Driver Modules * * PulseAudio driver modules are identified by index and are retrieved using either * pa_context_get_module_info() or pa_context_get_module_info_list(). The * information structure is called pa_module_info. * * \subsection client_subsec Clients * * PulseAudio clients are also identified by index and are retrieved using * either pa_context_get_client_info() or pa_context_get_client_info_list(). * The information structure is called pa_client_info. * * \section ctrl_sec Control * * Some parts of the server are only possible to read, but most can also be * modified in different ways. Note that these changes will affect all * connected clients and not just the one issuing the request. * * \subsection sinksrc_subsec Sinks and Sources * * The most common change one would want to apply to sinks and sources is to * modify the volume of the audio. Identically to how sinks and sources can * be queried, there are two ways of identifying them: * * \li By index - pa_context_set_sink_volume_by_index() / * pa_context_set_source_volume_by_index() * \li By name - pa_context_set_sink_volume_by_name() / * pa_context_set_source_volume_by_name() * * It is also possible to mute a sink or source: * * \li By index - pa_context_set_sink_mute_by_index() / * pa_context_set_source_mute_by_index() * \li By name - pa_context_set_sink_mute_by_name() / * pa_context_set_source_mute_by_name() * * \subsection siso_subsec Sink Inputs and Source Outputs * * If an application desires to modify the volume of just a single stream * (commonly one of its own streams), this can be done by setting the volume * of its associated sink input or source output, using * pa_context_set_sink_input_volume() or pa_context_set_source_output_volume(). * * It is also possible to remove sink inputs and source outputs, terminating * the streams associated with them: * * \li Sink input - pa_context_kill_sink_input() * \li Source output - pa_context_kill_source_output() * * It is strongly recommended that all volume changes are done as a direct * result of user input. With automated requests, such as those resulting * from misguided attempts of crossfading, PulseAudio can store the stream * volume at an inappropriate moment and restore it later. Besides, such * attempts lead to OSD popups in some desktop environments. * * As a special case of the general rule above, it is recommended that your * application leaves the task of saving and restoring the volume of its * streams to PulseAudio and does not attempt to do it by itself. PulseAudio * really knows better about events such as stream moving or headphone * plugging that would make the volume stored by the application inapplicable * to the new configuration. * * Another important case where setting a sink input volume may be a bad idea * is related to interpreters that interpret potentially untrusted scripts. * PulseAudio relies on your application not making malicious requests (such * as repeatedly setting the volume to 100%). Thus, script interpreters that * represent a security boundary must sandbox volume-changing requests coming * from their scripts. In the worst case, it may be necessary to apply the * script-requested volume to the script-produced sounds by altering the * samples in the script interpreter and not touching the sink or sink input * volume as seen by PulseAudio. * * If an application changes any volume, it should also listen to changes of * the same volume originating from outside the application (e.g., from the * system mixer application) and update its user interface accordingly. Use * \ref subscribe to get such notifications. * * \subsection module_subsec Modules * * Server modules can be remotely loaded and unloaded using * pa_context_load_module() and pa_context_unload_module(). * * \subsection client_subsec Clients * * The only operation supported on clients is the possibility of kicking * them off the server using pa_context_kill_client(). */ /** \file * * Routines for daemon introspection. * * See also \subpage introspect */ PA_C_DECL_BEGIN /** @{ \name Sinks */ /** Stores information about a specific port of a sink. Please * note that this structure can be extended as part of evolutionary * API updates at any time in any new release. \since 0.9.16 */ pa_sink_port_info; /** Stores information about sinks. Please note that this structure * can be extended as part of evolutionary API updates at any time in * any new release. */ pa_sink_info; /** Callback prototype for pa_context_get_sink_info_by_name() and friends */ pa_sink_info_cb_t; /** Get information about a sink by its name */ pa_operation* pa_context_get_sink_info_by_name(pa_context *c, const char *name, pa_sink_info_cb_t cb, void *userdata); /** Get information about a sink by its index */ pa_operation* pa_context_get_sink_info_by_index(pa_context *c, uint32_t idx, pa_sink_info_cb_t cb, void *userdata); /** Get the complete sink list */ pa_operation* pa_context_get_sink_info_list(pa_context *c, pa_sink_info_cb_t cb, void *userdata); /** Set the volume of a sink device specified by its index */ 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); /** Set the volume of a sink device specified by its name */ 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); /** Set the mute switch of a sink device specified by its index */ 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); /** Set the mute switch of a sink device specified by its name */ 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); /** Suspend/Resume a sink. \since 0.9.7 */ 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); /** Suspend/Resume a sink. If idx is PA_INVALID_INDEX all sinks will be suspended. \since 0.9.7 */ pa_operation* pa_context_suspend_sink_by_index(pa_context *c, uint32_t idx, int suspend, pa_context_success_cb_t cb, void* userdata); /** Change the profile of a sink. \since 0.9.16 */ 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); /** Change the profile of a sink. \since 0.9.15 */ 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); /** @} */ /** @{ \name Sources */ /** Stores information about a specific port of a source. Please * note that this structure can be extended as part of evolutionary * API updates at any time in any new release. \since 0.9.16 */ pa_source_port_info; /** Stores information about sources. Please note that this structure * can be extended as part of evolutionary API updates at any time in * any new release. */ pa_source_info; /** Callback prototype for pa_context_get_source_info_by_name() and friends */ pa_source_info_cb_t; /** Get information about a source by its name */ pa_operation* pa_context_get_source_info_by_name(pa_context *c, const char *name, pa_source_info_cb_t cb, void *userdata); /** Get information about a source by its index */ pa_operation* pa_context_get_source_info_by_index(pa_context *c, uint32_t idx, pa_source_info_cb_t cb, void *userdata); /** Get the complete source list */ pa_operation* pa_context_get_source_info_list(pa_context *c, pa_source_info_cb_t cb, void *userdata); /** Set the volume of a source device specified by its index */ 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); /** Set the volume of a source device specified by its name */ 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); /** Set the mute switch of a source device specified by its index */ 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); /** Set the mute switch of a source device specified by its name */ 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); /** Suspend/Resume a source. \since 0.9.7 */ 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); /** Suspend/Resume a source. If idx is PA_INVALID_INDEX, all sources will be suspended. \since 0.9.7 */ pa_operation* pa_context_suspend_source_by_index(pa_context *c, uint32_t idx, int suspend, pa_context_success_cb_t cb, void* userdata); /** Change the profile of a source. \since 0.9.16 */ 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); /** Change the profile of a source. \since 0.9.15 */ 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); /** @} */ /** @{ \name Server */ /** Server information. Please note that this structure can be * extended as part of evolutionary API updates at any time in any new * release. */ pa_server_info; /** Callback prototype for pa_context_get_server_info() */ pa_server_info_cb_t; /** Get some information about the server */ pa_operation* pa_context_get_server_info(pa_context *c, pa_server_info_cb_t cb, void *userdata); /** @} */ /** @{ \name Modules */ /** Stores information about modules. Please note that this structure * can be extended as part of evolutionary API updates at any time in * any new release. */ pa_module_info; /** Callback prototype for pa_context_get_module_info() and friends */ pa_module_info_cb_t; /** Get some information about a module by its index */ pa_operation* pa_context_get_module_info(pa_context *c, uint32_t idx, pa_module_info_cb_t cb, void *userdata); /** Get the complete list of currently loaded modules */ pa_operation* pa_context_get_module_info_list(pa_context *c, pa_module_info_cb_t cb, void *userdata); /** Callback prototype for pa_context_load_module() */ pa_context_index_cb_t; /** Load a module. */ pa_operation* pa_context_load_module(pa_context *c, const char*name, const char *argument, pa_context_index_cb_t cb, void *userdata); /** Unload a module. */ pa_operation* pa_context_unload_module(pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata); /** @} */ /** @{ \name Clients */ /** Stores information about clients. Please note that this structure * can be extended as part of evolutionary API updates at any time in * any new release. */ pa_client_info; /** Callback prototype for pa_context_get_client_info() and friends */ pa_client_info_cb_t; /** Get information about a client by its index */ pa_operation* pa_context_get_client_info(pa_context *c, uint32_t idx, pa_client_info_cb_t cb, void *userdata); /** Get the complete client list */ pa_operation* pa_context_get_client_info_list(pa_context *c, pa_client_info_cb_t cb, void *userdata); /** Kill a client. */ pa_operation* pa_context_kill_client(pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata); /** @} */ /** @{ \name Cards */ /** \deprecated Superseded by pa_card_profile_info2 \since 0.9.15 */ pa_card_profile_info; /** Stores information about a specific profile of a card. Please * note that this structure can be extended as part of evolutionary * API updates at any time in any new release. \since 5.0 */ pa_card_profile_info2; /** Stores information about a specific port of a card. Please * note that this structure can be extended as part of evolutionary * API updates at any time in any new release. \since 2.0 */ pa_card_port_info; /** Stores information about cards. Please note that this structure * can be extended as part of evolutionary API updates at any time in * any new release. \since 0.9.15 */ pa_card_info; /** Callback prototype for pa_context_get_card_info_...() \since 0.9.15 */ pa_card_info_cb_t; /** Get information about a card by its index \since 0.9.15 */ pa_operation* pa_context_get_card_info_by_index(pa_context *c, uint32_t idx, pa_card_info_cb_t cb, void *userdata); /** Get information about a card by its name \since 0.9.15 */ pa_operation* pa_context_get_card_info_by_name(pa_context *c, const char *name, pa_card_info_cb_t cb, void *userdata); /** Get the complete card list \since 0.9.15 */ pa_operation* pa_context_get_card_info_list(pa_context *c, pa_card_info_cb_t cb, void *userdata); /** Change the profile of a card. \since 0.9.15 */ 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); /** Change the profile of a card. \since 0.9.15 */ 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); /** Set the latency offset of a port. \since 3.0 */ pa_operation* pa_context_set_port_latency_offset(pa_context *c, const char *card_name, const char *port_name, int64_t offset, pa_context_success_cb_t cb, void *userdata); /** @} */ /** @{ \name Sink Inputs */ /** Stores information about sink inputs. Please note that this structure * can be extended as part of evolutionary API updates at any time in * any new release. */ pa_sink_input_info; /** Callback prototype for pa_context_get_sink_input_info() and friends */ pa_sink_input_info_cb_t; /** Get some information about a sink input by its index */ pa_operation* pa_context_get_sink_input_info(pa_context *c, uint32_t idx, pa_sink_input_info_cb_t cb, void *userdata); /** Get the complete sink input list */ pa_operation* pa_context_get_sink_input_info_list(pa_context *c, pa_sink_input_info_cb_t cb, void *userdata); /** Move the specified sink input to a different sink. \since 0.9.5 */ 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); /** Move the specified sink input to a different sink. \since 0.9.5 */ 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); /** Set the volume of a sink input stream */ 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); /** Set the mute switch of a sink input stream \since 0.9.7 */ pa_operation* pa_context_set_sink_input_mute(pa_context *c, uint32_t idx, int mute, pa_context_success_cb_t cb, void *userdata); /** Kill a sink input. */ pa_operation* pa_context_kill_sink_input(pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata); /** @} */ /** @{ \name Source Outputs */ /** Stores information about source outputs. Please note that this structure * can be extended as part of evolutionary API updates at any time in * any new release. */ pa_source_output_info; /** Callback prototype for pa_context_get_source_output_info() and friends */ pa_source_output_info_cb_t; /** Get information about a source output by its index */ pa_operation* pa_context_get_source_output_info(pa_context *c, uint32_t idx, pa_source_output_info_cb_t cb, void *userdata); /** Get the complete list of source outputs */ pa_operation* pa_context_get_source_output_info_list(pa_context *c, pa_source_output_info_cb_t cb, void *userdata); /** Move the specified source output to a different source. \since 0.9.5 */ 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); /** Move the specified source output to a different source. \since 0.9.5 */ 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); /** Set the volume of a source output stream \since 1.0 */ 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); /** Set the mute switch of a source output stream \since 1.0 */ pa_operation* pa_context_set_source_output_mute(pa_context *c, uint32_t idx, int mute, pa_context_success_cb_t cb, void *userdata); /** Kill a source output. */ pa_operation* pa_context_kill_source_output(pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata); /** @} */ /** @{ \name Statistics */ /** Memory block statistics. Please note that this structure * can be extended as part of evolutionary API updates at any time in * any new release. */ pa_stat_info; /** Callback prototype for pa_context_stat() */ pa_stat_info_cb_t; /** Get daemon memory block statistics */ pa_operation* pa_context_stat(pa_context *c, pa_stat_info_cb_t cb, void *userdata); /** @} */ /** @{ \name Cached Samples */ /** Stores information about sample cache entries. Please note that this structure * can be extended as part of evolutionary API updates at any time in * any new release. */ pa_sample_info; /** Callback prototype for pa_context_get_sample_info_by_name() and friends */ pa_sample_info_cb_t; /** Get information about a sample by its name */ pa_operation* pa_context_get_sample_info_by_name(pa_context *c, const char *name, pa_sample_info_cb_t cb, void *userdata); /** Get information about a sample by its index */ pa_operation* pa_context_get_sample_info_by_index(pa_context *c, uint32_t idx, pa_sample_info_cb_t cb, void *userdata); /** Get the complete list of samples stored in the daemon. */ pa_operation* pa_context_get_sample_info_list(pa_context *c, pa_sample_info_cb_t cb, void *userdata); /** @} */ /** \cond fulldocs */ /** @{ \name Autoload Entries */ /** \deprecated Type of an autoload entry. */ pa_autoload_type_t; /** \deprecated Stores information about autoload entries. Please note that this structure * can be extended as part of evolutionary API updates at any time in * any new release. */ pa_autoload_info; /** \deprecated Callback prototype for pa_context_get_autoload_info_by_name() and friends */ pa_autoload_info_cb_t; /** \deprecated Get info about a specific autoload entry. */ 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; /** \deprecated Get info about a specific autoload entry. */ 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; /** \deprecated Get the complete list of autoload entries. */ pa_operation* pa_context_get_autoload_info_list(pa_context *c, pa_autoload_info_cb_t cb, void *userdata) PA_GCC_DEPRECATED; /** \deprecated Add a new autoload entry. */ 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; /** \deprecated Remove an autoload entry. */ 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; /** \deprecated Remove an autoload entry. */ 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; /** @} */ /** \endcond */ PA_C_DECL_END #endif
Codebase Browser
godot