introspect.h File Reference

Routines for daemon introspection. More...

Go to the source code of this file.

Data Structures
struct	pa_sink_info
	Stores information about sinks. More...
struct	pa_source_info
	Stores information about sources. More...
struct	pa_server_info
	Server information. More...
struct	pa_module_info
	Stores information about modules. More...
struct	pa_client_info
	Stores information about clients. More...
struct	pa_card_profile_info
	Stores information about a specific profile of a card. More...
struct	pa_card_info
	Stores information about cards. More...
struct	pa_sink_input_info
	Stores information about sink inputs. More...
struct	pa_source_output_info
	Stores information about source outputs. More...
struct	pa_stat_info
	Memory block statistics. More...
struct	pa_sample_info
	Stores information about sample cache entries. More...
Sinks
typedef void(*	pa_sink_info_cb_t )(pa_context *c, const pa_sink_info *i, int eol, void *userdata)
	Callback prototype for pa_context_get_sink_info_by_name() and friends.
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 name.
pa_operation *	pa_context_get_sink_info_by_index (pa_context *c, uint32_t idx, pa_sink_info_cb_t cb, void *userdata)
	Get information about a sink by its index.
pa_operation *	pa_context_get_sink_info_list (pa_context *c, pa_sink_info_cb_t cb, void *userdata)
	Get the complete sink list.
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 index.
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 volume of a sink device specified by its name.
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 index.
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)
	Set the mute switch of a sink device specified by its name.
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.
pa_operation *	pa_context_suspend_sink_by_index (pa_context *c, uint32_t idx, int suspend, pa_context_success_cb_t cb, void *userdata)
	Suspend/Resume a sink.
Sources
typedef void(*	pa_source_info_cb_t )(pa_context *c, const pa_source_info *i, int eol, void *userdata)
	Callback prototype for pa_context_get_source_info_by_name() and friends.
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 name.
pa_operation *	pa_context_get_source_info_by_index (pa_context *c, uint32_t idx, pa_source_info_cb_t cb, void *userdata)
	Get information about a source by its index.
pa_operation *	pa_context_get_source_info_list (pa_context *c, pa_source_info_cb_t cb, void *userdata)
	Get the complete source list.
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 index.
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 volume of a source device specified by its name.
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 index.
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)
	Set the mute switch of a source device specified by its name.
Server
typedef void(*	pa_server_info_cb_t )(pa_context *c, const pa_server_info *i, void *userdata)
	Callback prototype for pa_context_get_server_info().
pa_operation *	pa_context_get_server_info (pa_context *c, pa_server_info_cb_t cb, void *userdata)
	Get some information about the server.
Modules
typedef void(*	pa_module_info_cb_t )(pa_context *c, const pa_module_info *i, int eol, void *userdata)
	Callback prototype for pa_context_get_module_info() and friends.
typedef void(*	pa_context_index_cb_t )(pa_context *c, uint32_t idx, void *userdata)
	Callback prototype for pa_context_load_module().
pa_operation *	pa_context_get_module_info (pa_context *c, uint32_t idx, pa_module_info_cb_t cb, void *userdata)
	Get some information about a module by its index.
pa_operation *	pa_context_get_module_info_list (pa_context *c, pa_module_info_cb_t cb, void *userdata)
	Get the complete list of currently loaded modules.
pa_operation *	pa_context_load_module (pa_context *c, const char *name, const char *argument, pa_context_index_cb_t cb, void *userdata)
	Load a module.
pa_operation *	pa_context_unload_module (pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata)
	Unload a module.
Clients
typedef void(*	pa_client_info_cb_t )(pa_context *c, const pa_client_info *i, int eol, void *userdata)
	Callback prototype for pa_context_get_client_info() and friends.
pa_operation *	pa_context_get_client_info (pa_context *c, uint32_t idx, pa_client_info_cb_t cb, void *userdata)
	Get information about a client by its index.
pa_operation *	pa_context_get_client_info_list (pa_context *c, pa_client_info_cb_t cb, void *userdata)
	Get the complete client list.
pa_operation *	pa_context_kill_client (pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata)
	Kill a client.
Cards
typedef void(*	pa_card_info_cb_t )(pa_context *c, const pa_card_info *i, int eol, void *userdata)
	Callback prototype for pa_context_get_card_info() and friends.
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 index.
pa_operation *	pa_context_get_card_info_by_name (pa_context *c, const char *name, pa_card_info_cb_t cb, void *userdata)
	Get information about a card by its name.
pa_operation *	pa_context_get_card_info_list (pa_context *c, pa_card_info_cb_t cb, void *userdata)
	Get the complete card list.
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.
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)
	Change the profile of a card.
Sink Inputs
typedef void(*	pa_sink_input_info_cb_t )(pa_context *c, const pa_sink_input_info *i, int eol, void *userdata)
	Callback prototype for pa_context_get_sink_input_info() and friends.
pa_operation *	pa_context_get_sink_input_info (pa_context *c, uint32_t idx, pa_sink_input_info_cb_t cb, void *userdata)
	Get some information about a sink input by its index.
pa_operation *	pa_context_get_sink_input_info_list (pa_context *c, pa_sink_input_info_cb_t cb, void *userdata)
	Get the complete sink input list.
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.
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)
	Move the specified sink input to a different sink.
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 volume of a sink input stream.
pa_operation *	pa_context_set_sink_input_mute (pa_context *c, uint32_t idx, int mute, pa_context_success_cb_t cb, void *userdata)
	Set the mute switch of a sink input stream.
pa_operation *	pa_context_kill_sink_input (pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata)
	Kill a sink input.
Source Outputs
typedef void(*	pa_source_output_info_cb_t )(pa_context *c, const pa_source_output_info *i, int eol, void *userdata)
	Callback prototype for pa_context_get_source_output_info() and friends.
pa_operation *	pa_context_get_source_output_info (pa_context *c, uint32_t idx, pa_source_output_info_cb_t cb, void *userdata)
	Get information about a source output by its index.
pa_operation *	pa_context_get_source_output_info_list (pa_context *c, pa_source_output_info_cb_t cb, void *userdata)
	Get the complete list of source outputs.
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.
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)
	Move the specified source output to a different source.
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.
pa_operation *	pa_context_suspend_source_by_index (pa_context *c, uint32_t idx, int suspend, pa_context_success_cb_t cb, void *userdata)
	Suspend/Resume a source.
pa_operation *	pa_context_kill_source_output (pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata)
	Kill a source output.
Statistics
typedef void(*	pa_stat_info_cb_t )(pa_context *c, const pa_stat_info *i, void *userdata)
	Callback prototype for pa_context_stat().
pa_operation *	pa_context_stat (pa_context *c, pa_stat_info_cb_t cb, void *userdata)
	Get daemon memory block statistics.
Cached Samples
typedef void(*	pa_sample_info_cb_t )(pa_context *c, const pa_sample_info *i, int eol, void *userdata)
	Callback prototype for pa_context_get_sample_info_by_name() and friends.
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 name.
pa_operation *	pa_context_get_sample_info_by_index (pa_context *c, uint32_t idx, pa_sample_info_cb_t cb, void *userdata)
	Get information about a sample by its index.
pa_operation *	pa_context_get_sample_info_list (pa_context *c, pa_sample_info_cb_t cb, void *userdata)
	Get the complete list of samples stored in the daemon.

---

Detailed Description

Routines for daemon introspection.

---

Typedef Documentation

typedef void(* pa_card_info_cb_t)(pa_context *c, const pa_card_info *i, int eol, void *userdata)

Callback prototype for pa_context_get_card_info() and friends.

Since:

0.9.15

typedef void(* pa_client_info_cb_t)(pa_context *c, const pa_client_info *i, int eol, void *userdata)

Callback prototype for pa_context_get_client_info() and friends.

typedef void(* pa_context_index_cb_t)(pa_context *c, uint32_t idx, void *userdata)

Callback prototype for pa_context_load_module().

typedef void(* pa_module_info_cb_t)(pa_context *c, const pa_module_info *i, int eol, void *userdata)

Callback prototype for pa_context_get_module_info() and friends.

typedef void(* pa_sample_info_cb_t)(pa_context *c, const pa_sample_info *i, int eol, void *userdata)

Callback prototype for pa_context_get_sample_info_by_name() and friends.

typedef void(* pa_server_info_cb_t)(pa_context *c, const pa_server_info *i, void *userdata)

Callback prototype for pa_context_get_server_info().

typedef void(* pa_sink_info_cb_t)(pa_context *c, const pa_sink_info *i, int eol, void *userdata)

Callback prototype for pa_context_get_sink_info_by_name() and friends.

typedef void(* pa_sink_input_info_cb_t)(pa_context *c, const pa_sink_input_info *i, int eol, void *userdata)

Callback prototype for pa_context_get_sink_input_info() and friends.

typedef void(* pa_source_info_cb_t)(pa_context *c, const pa_source_info *i, int eol, void *userdata)

Callback prototype for pa_context_get_source_info_by_name() and friends.

typedef void(* pa_source_output_info_cb_t)(pa_context *c, const pa_source_output_info *i, int eol, void *userdata)

Callback prototype for pa_context_get_source_output_info() and friends.

typedef void(* pa_stat_info_cb_t)(pa_context *c, const pa_stat_info *i, void *userdata)

Callback prototype for pa_context_stat().

---

Function Documentation

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 index.

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 information about a card by its name.

Since:

0.9.15

pa_operation* pa_context_get_card_info_list	(	pa_context *	c,
		pa_card_info_cb_t	cb,
		void *	userdata
	)

Get the complete card list.

Since:

0.9.15

pa_operation* pa_context_get_client_info	(	pa_context *	c,
		uint32_t	idx,
		pa_client_info_cb_t	cb,
		void *	userdata
	)

Get information about a client by its index.

pa_operation* pa_context_get_client_info_list	(	pa_context *	c,
		pa_client_info_cb_t	cb,
		void *	userdata
	)

Get the complete client list.

pa_operation* pa_context_get_module_info	(	pa_context *	c,
		uint32_t	idx,
		pa_module_info_cb_t	cb,
		void *	userdata
	)

Get some information about a module by its index.

pa_operation* pa_context_get_module_info_list	(	pa_context *	c,
		pa_module_info_cb_t	cb,
		void *	userdata
	)

Get the complete list of currently loaded modules.

pa_operation* pa_context_get_sample_info_by_index	(	pa_context *	c,
		uint32_t	idx,
		pa_sample_info_cb_t	cb,
		void *	userdata
	)

Get information about a sample by its index.

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 name.

pa_operation* pa_context_get_sample_info_list	(	pa_context *	c,
		pa_sample_info_cb_t	cb,
		void *	userdata
	)

Get the complete list of samples stored in the daemon.

pa_operation* pa_context_get_server_info	(	pa_context *	c,
		pa_server_info_cb_t	cb,
		void *	userdata
	)

Get some information about the server.

pa_operation* pa_context_get_sink_info_by_index	(	pa_context *	c,
		uint32_t	idx,
		pa_sink_info_cb_t	cb,
		void *	userdata
	)

Get information about a sink by its index.

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 name.

pa_operation* pa_context_get_sink_info_list	(	pa_context *	c,
		pa_sink_info_cb_t	cb,
		void *	userdata
	)

Get the complete sink list.

pa_operation* pa_context_get_sink_input_info	(	pa_context *	c,
		uint32_t	idx,
		pa_sink_input_info_cb_t	cb,
		void *	userdata
	)

Get some information about a sink input by its index.

pa_operation* pa_context_get_sink_input_info_list	(	pa_context *	c,
		pa_sink_input_info_cb_t	cb,
		void *	userdata
	)

Get the complete sink input list.

pa_operation* pa_context_get_source_info_by_index	(	pa_context *	c,
		uint32_t	idx,
		pa_source_info_cb_t	cb,
		void *	userdata
	)

Get information about a source by its index.

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 name.

pa_operation* pa_context_get_source_info_list	(	pa_context *	c,
		pa_source_info_cb_t	cb,
		void *	userdata
	)

Get the complete source list.

pa_operation* pa_context_get_source_output_info	(	pa_context *	c,
		uint32_t	idx,
		pa_source_output_info_cb_t	cb,
		void *	userdata
	)

Get information about a source output by its index.

pa_operation* pa_context_get_source_output_info_list	(	pa_context *	c,
		pa_source_output_info_cb_t	cb,
		void *	userdata
	)

Get the complete list of source outputs.

pa_operation* pa_context_kill_client	(	pa_context *	c,
		uint32_t	idx,
		pa_context_success_cb_t	cb,
		void *	userdata
	)

Kill a client.

pa_operation* pa_context_kill_sink_input	(	pa_context *	c,
		uint32_t	idx,
		pa_context_success_cb_t	cb,
		void *	userdata
	)

Kill a sink input.

pa_operation* pa_context_kill_source_output	(	pa_context *	c,
		uint32_t	idx,
		pa_context_success_cb_t	cb,
		void *	userdata
	)

Kill a source output.

pa_operation* pa_context_load_module	(	pa_context *	c,
		const char *	name,
		const char *	argument,
		pa_context_index_cb_t	cb,
		void *	userdata
	)

Load a module.

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
	)

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_source_output_by_index	(	pa_context *	c,
		uint32_t	idx,
		uint32_t	source_idx,
		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_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_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
	)

Change the profile of a card.

Since:

0.9.15

pa_operation* pa_context_set_sink_input_mute	(	pa_context *	c,
		uint32_t	idx,
		int	mute,
		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_volume	(	pa_context *	c,
		uint32_t	idx,
		const pa_cvolume *	volume,
		pa_context_success_cb_t	cb,
		void *	userdata
	)

Set the volume of a sink input stream.

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 index.

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
	)

Set the mute switch of a sink device specified by its name.

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 index.

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 volume of a sink device specified by its name.

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 index.

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
	)

Set the mute switch of a source device specified by its name.

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 index.

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 volume of a source device specified by its name.

pa_operation* pa_context_stat	(	pa_context *	c,
		pa_stat_info_cb_t	cb,
		void *	userdata
	)

Get daemon memory block statistics.

pa_operation* pa_context_suspend_sink_by_index	(	pa_context *	c,
		uint32_t	idx,
		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_name	(	pa_context *	c,
		const char *	sink_name,
		int	suspend,
		pa_context_success_cb_t	cb,
		void *	userdata
	)

Suspend/Resume a sink.

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
	)

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_name	(	pa_context *	c,
		const char *	source_name,
		int	suspend,
		pa_context_success_cb_t	cb,
		void *	userdata
	)

Suspend/Resume a source.

Since:

0.9.7

pa_operation* pa_context_unload_module	(	pa_context *	c,
		uint32_t	idx,
		pa_context_success_cb_t	cb,
		void *	userdata
	)

Unload a module.