| #ifndef foointrospecthfoo | |
| #define foointrospecthfoo | |
| /*** | |
| This file is part of PulseAudio. | |
| Copyright 2004-2006 Lennart Poettering | |
| Copyright 2006 Pierre Ossman <ossman@cendio.se> 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 message_subsec Messages | |
| * | |
| * Server objects like sinks, sink inputs or modules can register a message | |
| * handler to communicate with clients. A message can be sent to a named | |
| * message handler using pa_context_send_message_to_object(). | |
| * | |
| * \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 */ | |
| typedef struct pa_sink_port_info { | |
| const char *name; /**< Name of this port */ | |
| const char *description; /**< Description of this port */ | |
| uint32_t priority; /**< The higher this value is, the more useful this port is as a default. */ | |
| int available; /**< A flags (see #pa_port_available), indicating availability status of this port. \since 2.0 */ | |
| const char *availability_group; /**< An indentifier for the group of ports that share their availability status with | |
| * each other. This is meant especially for handling cases where one 3.5 mm connector | |
| * is used for headphones, headsets and microphones, and the hardware can only tell | |
| * that something was plugged in but not what exactly. In this situation the ports for | |
| * all those devices share their availability status, and PulseAudio can't tell which | |
| * one is actually plugged in, and some application may ask the user what was plugged | |
| * in. Such applications should get a list of all card ports and compare their | |
| * `availability_group` fields. Ports that have the same group are those that need | |
| * input from the user to determine which device was plugged in. The application should | |
| * then activate the user-chosen port. | |
| * | |
| * May be NULL, in which case the port is not part of any availability group. | |
| * | |
| * The group identifier must be treated as an opaque identifier. The string may look | |
| * like an ALSA control name, but applications must not assume any such relationship. | |
| * The group naming scheme can change without a warning. | |
| * | |
| * Since one group can include both input and output ports, the grouping should be done | |
| * using pa_card_port_info instead of pa_sink_port_info, but this field is duplicated | |
| * also in pa_sink_port_info (and pa_source_port_info) in case someone finds that | |
| * convenient. | |
| * | |
| * \since 14.0 */ | |
| uint32_t type; /**< Port type, see #pa_device_port_type. \since 14.0 */ | |
| } 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. */ | |
| typedef struct pa_sink_info { | |
| const char *name; /**< Name of the sink */ | |
| uint32_t index; /**< Index of the sink */ | |
| const char *description; /**< Description of this sink */ | |
| pa_sample_spec sample_spec; /**< Sample spec of this sink */ | |
| pa_channel_map channel_map; /**< Channel map */ | |
| uint32_t owner_module; /**< Index of the owning module of this sink, or PA_INVALID_INDEX. */ | |
| pa_cvolume volume; /**< Volume of the sink */ | |
| int mute; /**< Mute switch of the sink */ | |
| uint32_t monitor_source; /**< Index of the monitor source connected to this sink. */ | |
| const char *monitor_source_name; /**< The name of the monitor source. */ | |
| pa_usec_t latency; /**< Length of queued audio in the output buffer. */ | |
| const char *driver; /**< Driver name */ | |
| pa_sink_flags_t flags; /**< Flags */ | |
| pa_proplist *proplist; /**< Property list \since 0.9.11 */ | |
| pa_usec_t configured_latency; /**< The latency this device has been configured to. \since 0.9.11 */ | |
| 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 */ | |
| pa_sink_state_t state; /**< State \since 0.9.15 */ | |
| uint32_t n_volume_steps; /**< Number of volume steps for sinks which do not support arbitrary volumes. \since 0.9.15 */ | |
| uint32_t card; /**< Card index, or PA_INVALID_INDEX. \since 0.9.15 */ | |
| uint32_t n_ports; /**< Number of entries in port array \since 0.9.16 */ | |
| 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 */ | |
| pa_sink_port_info* active_port; /**< Pointer to active port in the array, or NULL. \since 0.9.16 */ | |
| uint8_t n_formats; /**< Number of formats supported by the sink. \since 1.0 */ | |
| pa_format_info **formats; /**< Array of formats supported by the sink. \since 1.0 */ | |
| } pa_sink_info; | |
| /** Callback prototype for pa_context_get_sink_info_by_name() and friends */ | |
| typedef void (*pa_sink_info_cb_t)(pa_context *c, const pa_sink_info *i, int eol, void *userdata); | |
| /** 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 */ | |
| typedef struct pa_source_port_info { | |
| const char *name; /**< Name of this port */ | |
| const char *description; /**< Description of this port */ | |
| uint32_t priority; /**< The higher this value is, the more useful this port is as a default. */ | |
| int available; /**< A flags (see #pa_port_available), indicating availability status of this port. \since 2.0 */ | |
| const char *availability_group; /**< An indentifier for the group of ports that share their availability status with | |
| * each other. This is meant especially for handling cases where one 3.5 mm connector | |
| * is used for headphones, headsets and microphones, and the hardware can only tell | |
| * that something was plugged in but not what exactly. In this situation the ports for | |
| * all those devices share their availability status, and PulseAudio can't tell which | |
| * one is actually plugged in, and some application may ask the user what was plugged | |
| * in. Such applications should get a list of all card ports and compare their | |
| * `availability_group` fields. Ports that have the same group are those that need | |
| * input from the user to determine which device was plugged in. The application should | |
| * then activate the user-chosen port. | |
| * | |
| * May be NULL, in which case the port is not part of any availability group (which is | |
| * the same as having a group with only one member). | |
| * | |
| * The group identifier must be treated as an opaque identifier. The string may look | |
| * like an ALSA control name, but applications must not assume any such relationship. | |
| * The group naming scheme can change without a warning. | |
| * | |
| * Since one group can include both input and output ports, the grouping should be done | |
| * using pa_card_port_info instead of pa_source_port_info, but this field is duplicated | |
| * also in pa_source_port_info (and pa_sink_port_info) in case someone finds that | |
| * convenient. | |
| * | |
| * \since 14.0 */ | |
| uint32_t type; /**< Port type, see #pa_device_port_type. \since 14.0 */ | |
| } 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. */ | |
| typedef struct pa_source_info { | |
| const char *name; /**< Name of the source */ | |
| uint32_t index; /**< Index of the source */ | |
| const char *description; /**< Description of this source */ | |
| pa_sample_spec sample_spec; /**< Sample spec of this source */ | |
| pa_channel_map channel_map; /**< Channel map */ | |
| uint32_t owner_module; /**< Owning module index, or PA_INVALID_INDEX. */ | |
| pa_cvolume volume; /**< Volume of the source */ | |
| int mute; /**< Mute switch of the sink */ | |
| uint32_t monitor_of_sink; /**< If this is a monitor source, the index of the owning sink, otherwise PA_INVALID_INDEX. */ | |
| const char *monitor_of_sink_name; /**< Name of the owning sink, or NULL. */ | |
| pa_usec_t latency; /**< Length of filled record buffer of this source. */ | |
| const char *driver; /**< Driver name */ | |
| pa_source_flags_t flags; /**< Flags */ | |
| pa_proplist *proplist; /**< Property list \since 0.9.11 */ | |
| pa_usec_t configured_latency; /**< The latency this device has been configured to. \since 0.9.11 */ | |
| 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 */ | |
| pa_source_state_t state; /**< State \since 0.9.15 */ | |
| uint32_t n_volume_steps; /**< Number of volume steps for sources which do not support arbitrary volumes. \since 0.9.15 */ | |
| uint32_t card; /**< Card index, or PA_INVALID_INDEX. \since 0.9.15 */ | |
| uint32_t n_ports; /**< Number of entries in port array \since 0.9.16 */ | |
| 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 */ | |
| pa_source_port_info* active_port; /**< Pointer to active port in the array, or NULL. \since 0.9.16 */ | |
| uint8_t n_formats; /**< Number of formats supported by the source. \since 1.0 */ | |
| pa_format_info **formats; /**< Array of formats supported by the source. \since 1.0 */ | |
| } pa_source_info; | |
| /** Callback prototype for pa_context_get_source_info_by_name() and friends */ | |
| typedef void (*pa_source_info_cb_t)(pa_context *c, const pa_source_info *i, int eol, void *userdata); | |
| /** 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. */ | |
| typedef struct pa_server_info { | |
| const char *user_name; /**< User name of the daemon process */ | |
| const char *host_name; /**< Host name the daemon is running on */ | |
| const char *server_version; /**< Version string of the daemon */ | |
| const char *server_name; /**< Server package name (usually "pulseaudio") */ | |
| pa_sample_spec sample_spec; /**< Default sample specification */ | |
| const char *default_sink_name; /**< Name of default sink. */ | |
| const char *default_source_name; /**< Name of default source. */ | |
| uint32_t cookie; /**< A random cookie for identifying this instance of PulseAudio. */ | |
| pa_channel_map channel_map; /**< Default channel map. \since 0.9.15 */ | |
| } pa_server_info; | |
| /** Callback prototype for pa_context_get_server_info() */ | |
| typedef void (*pa_server_info_cb_t) (pa_context *c, const pa_server_info*i, void *userdata); | |
| /** 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. */ | |
| typedef struct pa_module_info { | |
| uint32_t index; /**< Index of the module */ | |
| const char*name, /**< Name of the module */ | |
| *argument; /**< Argument string of the module */ | |
| uint32_t n_used; /**< Usage counter or PA_INVALID_INDEX */ | |
| /** \cond fulldocs */ | |
| int auto_unload; /**< \deprecated Non-zero if this is an autoloaded module. */ | |
| /** \endcond */ | |
| pa_proplist *proplist; /**< Property list \since 0.9.15 */ | |
| } pa_module_info; | |
| /** Callback prototype for pa_context_get_module_info() and friends */ | |
| typedef void (*pa_module_info_cb_t) (pa_context *c, const pa_module_info*i, int eol, void *userdata); | |
| /** 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() */ | |
| typedef void (*pa_context_index_cb_t)(pa_context *c, uint32_t idx, void *userdata); | |
| /** 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 Messages */ | |
| /** Callback prototype for pa_context_send_message_to_object() \since 15.0 */ | |
| typedef void (*pa_context_string_cb_t)(pa_context *c, int success, char *response, void *userdata); | |
| /** Send a message to an object that registered a message handler. For more information | |
| * see https://cgit.freedesktop.org/pulseaudio/pulseaudio/tree/doc/messaging_api.txt. \since 15.0 */ | |
| pa_operation* pa_context_send_message_to_object(pa_context *c, const char *recipient_name, const char *message, const char *message_parameters, pa_context_string_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. */ | |
| typedef struct pa_client_info { | |
| uint32_t index; /**< Index of this client */ | |
| const char *name; /**< Name of this client */ | |
| uint32_t owner_module; /**< Index of the owning module, or PA_INVALID_INDEX. */ | |
| const char *driver; /**< Driver name */ | |
| pa_proplist *proplist; /**< Property list \since 0.9.11 */ | |
| } pa_client_info; | |
| /** Callback prototype for pa_context_get_client_info() and friends */ | |
| typedef void (*pa_client_info_cb_t) (pa_context *c, const pa_client_info*i, int eol, void *userdata); | |
| /** 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 */ | |
| typedef struct pa_card_profile_info { | |
| const char *name; /**< Name of this profile */ | |
| const char *description; /**< Description of this profile */ | |
| uint32_t n_sinks; /**< Number of sinks this profile would create */ | |
| uint32_t n_sources; /**< Number of sources this profile would create */ | |
| uint32_t priority; /**< The higher this value is, the more useful this profile is as a default. */ | |
| } 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 */ | |
| typedef struct pa_card_profile_info2 { | |
| const char *name; /**< Name of this profile */ | |
| const char *description; /**< Description of this profile */ | |
| uint32_t n_sinks; /**< Number of sinks this profile would create */ | |
| uint32_t n_sources; /**< Number of sources this profile would create */ | |
| uint32_t priority; /**< The higher this value is, the more useful this profile is as a default. */ | |
| int available; | |
| /**< Is this profile available? If this is zero, meaning "unavailable", | |
| * then it makes no sense to try to activate this profile. If this is | |
| * non-zero, it's still not a guarantee that activating the profile will | |
| * result in anything useful, it just means that the server isn't aware of | |
| * any reason why the profile would definitely be useless. \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 */ | |
| typedef struct pa_card_port_info { | |
| const char *name; /**< Name of this port */ | |
| const char *description; /**< Description of this port */ | |
| uint32_t priority; /**< The higher this value is, the more useful this port is as a default. */ | |
| int available; /**< A #pa_port_available enum, indicating availability status of this port. */ | |
| int direction; /**< A #pa_direction enum, indicating the direction of this port. */ | |
| uint32_t n_profiles; /**< Number of entries in profile array */ | |
| pa_card_profile_info** profiles; /**< \deprecated Superseded by profiles2 */ | |
| pa_proplist *proplist; /**< Property list */ | |
| int64_t latency_offset; /**< Latency offset of the port that gets added to the sink/source latency when the port is active. \since 3.0 */ | |
| pa_card_profile_info2** profiles2; /**< Array of pointers to available profiles, or NULL. Array is terminated by an entry set to NULL. \since 5.0 */ | |
| const char *availability_group; /**< An indentifier for the group of ports that share their availability status with | |
| * each other. This is meant especially for handling cases where one 3.5 mm connector | |
| * is used for headphones, headsets and microphones, and the hardware can only tell | |
| * that something was plugged in but not what exactly. In this situation the ports for | |
| * all those devices share their availability status, and PulseAudio can't tell which | |
| * one is actually plugged in, and some application may ask the user what was plugged | |
| * in. Such applications should get a list of all card ports and compare their | |
| * `availability_group` fields. Ports that have the same group are those that need | |
| * input from the user to determine which device was plugged in. The application should | |
| * then activate the user-chosen port. | |
| * | |
| * May be NULL, in which case the port is not part of any availability group (which is | |
| * the same as having a group with only one member). | |
| * | |
| * The group identifier must be treated as an opaque identifier. The string may look | |
| * like an ALSA control name, but applications must not assume any such relationship. | |
| * The group naming scheme can change without a warning. | |
| * | |
| * \since 14.0 */ | |
| uint32_t type; /**< Port type, see #pa_device_port_type. \since 14.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 */ | |
| typedef struct pa_card_info { | |
| uint32_t index; /**< Index of this card */ | |
| const char *name; /**< Name of this card */ | |
| uint32_t owner_module; /**< Index of the owning module, or PA_INVALID_INDEX. */ | |
| const char *driver; /**< Driver name */ | |
| uint32_t n_profiles; /**< Number of entries in profile array */ | |
| pa_card_profile_info* profiles; /**< \deprecated Superseded by profiles2 */ | |
| pa_card_profile_info* active_profile; /**< \deprecated Superseded by active_profile2 */ | |
| pa_proplist *proplist; /**< Property list */ | |
| uint32_t n_ports; /**< Number of entries in port array */ | |
| pa_card_port_info **ports; /**< Array of pointers to ports, or NULL. Array is terminated by an entry set to NULL. */ | |
| pa_card_profile_info2** profiles2; /**< Array of pointers to available profiles, or NULL. Array is terminated by an entry set to NULL. \since 5.0 */ | |
| pa_card_profile_info2* active_profile2; /**< Pointer to active profile in the array, or NULL. \since 5.0 */ | |
| } pa_card_info; | |
| /** Callback prototype for pa_context_get_card_info_...() \since 0.9.15 */ | |
| typedef void (*pa_card_info_cb_t) (pa_context *c, const pa_card_info*i, int eol, void *userdata); | |
| /** 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. */ | |
| typedef struct pa_sink_input_info { | |
| uint32_t index; /**< Index of the sink input */ | |
| const char *name; /**< Name of the sink input */ | |
| 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. */ | |
| uint32_t client; /**< Index of the client this sink input belongs to, or PA_INVALID_INDEX when it does not belong to any client. */ | |
| uint32_t sink; /**< Index of the connected sink */ | |
| pa_sample_spec sample_spec; /**< The sample specification of the sink input. */ | |
| pa_channel_map channel_map; /**< Channel map */ | |
| pa_cvolume volume; /**< The volume of this sink input. */ | |
| pa_usec_t buffer_usec; /**< Latency due to buffering in sink input, see pa_timing_info for details. */ | |
| pa_usec_t sink_usec; /**< Latency of the sink device, see pa_timing_info for details. */ | |
| const char *resample_method; /**< The resampling method used by this sink input. */ | |
| const char *driver; /**< Driver name */ | |
| int mute; /**< Stream muted \since 0.9.7 */ | |
| pa_proplist *proplist; /**< Property list \since 0.9.11 */ | |
| int corked; /**< Stream corked \since 1.0 */ | |
| int has_volume; /**< Stream has volume. If not set, then the meaning of this struct's volume member is unspecified. \since 1.0 */ | |
| 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 */ | |
| pa_format_info *format; /**< Stream format information. \since 1.0 */ | |
| } pa_sink_input_info; | |
| /** Callback prototype for pa_context_get_sink_input_info() and friends */ | |
| typedef void (*pa_sink_input_info_cb_t) (pa_context *c, const pa_sink_input_info *i, int eol, void *userdata); | |
| /** 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. */ | |
| typedef struct pa_source_output_info { | |
| uint32_t index; /**< Index of the source output */ | |
| const char *name; /**< Name of the source output */ | |
| 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. */ | |
| uint32_t client; /**< Index of the client this source output belongs to, or PA_INVALID_INDEX when it does not belong to any client. */ | |
| uint32_t source; /**< Index of the connected source */ | |
| pa_sample_spec sample_spec; /**< The sample specification of the source output */ | |
| pa_channel_map channel_map; /**< Channel map */ | |
| pa_usec_t buffer_usec; /**< Latency due to buffering in the source output, see pa_timing_info for details. */ | |
| pa_usec_t source_usec; /**< Latency of the source device, see pa_timing_info for details. */ | |
| const char *resample_method; /**< The resampling method used by this source output. */ | |
| const char *driver; /**< Driver name */ | |
| pa_proplist *proplist; /**< Property list \since 0.9.11 */ | |
| int corked; /**< Stream corked \since 1.0 */ | |
| pa_cvolume volume; /**< The volume of this source output \since 1.0 */ | |
| int mute; /**< Stream muted \since 1.0 */ | |
| int has_volume; /**< Stream has volume. If not set, then the meaning of this struct's volume member is unspecified. \since 1.0 */ | |
| 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 */ | |
| pa_format_info *format; /**< Stream format information. \since 1.0 */ | |
| } pa_source_output_info; | |
| /** Callback prototype for pa_context_get_source_output_info() and friends */ | |
| typedef void (*pa_source_output_info_cb_t) (pa_context *c, const pa_source_output_info *i, int eol, void *userdata); | |
| /** 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. */ | |
| typedef struct pa_stat_info { | |
| uint32_t memblock_total; /**< Currently allocated memory blocks */ | |
| uint32_t memblock_total_size; /**< Current total size of allocated memory blocks */ | |
| uint32_t memblock_allocated; /**< Allocated memory blocks during the whole lifetime of the daemon. */ | |
| uint32_t memblock_allocated_size; /**< Total size of all memory blocks allocated during the whole lifetime of the daemon. */ | |
| uint32_t scache_size; /**< Total size of all sample cache entries. */ | |
| } pa_stat_info; | |
| /** Callback prototype for pa_context_stat() */ | |
| typedef void (*pa_stat_info_cb_t) (pa_context *c, const pa_stat_info *i, void *userdata); | |
| /** 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. */ | |
| typedef struct pa_sample_info { | |
| uint32_t index; /**< Index of this entry */ | |
| const char *name; /**< Name of this entry */ | |
| pa_cvolume volume; /**< Default volume of this entry */ | |
| pa_sample_spec sample_spec; /**< Sample specification of the sample */ | |
| pa_channel_map channel_map; /**< The channel map */ | |
| pa_usec_t duration; /**< Duration of this entry */ | |
| uint32_t bytes; /**< Length of this sample in bytes. */ | |
| int lazy; /**< Non-zero when this is a lazy cache entry. */ | |
| const char *filename; /**< In case this is a lazy cache entry, the filename for the sound file to be loaded on demand. */ | |
| pa_proplist *proplist; /**< Property list for this sample. \since 0.9.11 */ | |
| } pa_sample_info; | |
| /** Callback prototype for pa_context_get_sample_info_by_name() and friends */ | |
| typedef void (*pa_sample_info_cb_t)(pa_context *c, const pa_sample_info *i, int eol, void *userdata); | |
| /** 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. */ | |
| typedef enum pa_autoload_type { | |
| PA_AUTOLOAD_SINK = 0, | |
| PA_AUTOLOAD_SOURCE = 1 | |
| } 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. */ | |
| typedef struct pa_autoload_info { | |
| uint32_t index; /**< Index of this autoload entry */ | |
| const char *name; /**< Name of the sink or source */ | |
| pa_autoload_type_t type; /**< Type of the autoload entry */ | |
| const char *module; /**< Module name to load */ | |
| const char *argument; /**< Argument string for module */ | |
| } pa_autoload_info; | |
| /** \deprecated Callback prototype for pa_context_get_autoload_info_by_name() and friends */ | |
| typedef void (*pa_autoload_info_cb_t)(pa_context *c, const pa_autoload_info *i, int eol, void *userdata); | |
| /** \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 |