PulseAudio: introspect.h File Reference (original) (raw)

Routines for daemon introspection. More...

Go to the source code of this file.

Data Structures
struct pa_sink_port_info
Stores information about a specific port of a sink. More...
struct pa_sink_info
Stores information about sinks. More...
struct pa_source_port_info
Stores information about a specific port of a source. 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
struct pa_card_profile_info2
Stores information about a specific profile of a card. More...
struct pa_card_port_info
Stores information about a specific port 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 struct pa_sink_port_info pa_sink_port_info
Stores information about a specific port of a sink. More...
typedef struct pa_sink_info pa_sink_info
Stores information about sinks. More...
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. More...
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. More...
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. More...
pa_operation * pa_context_get_sink_info_list (pa_context *c, pa_sink_info_cb_t cb, void *userdata)
Get the complete sink list. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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)
Change the profile of a sink. More...
Sources
typedef struct pa_source_port_info pa_source_port_info
Stores information about a specific port of a source. More...
typedef struct pa_source_info pa_source_info
Stores information about sources. More...
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. More...
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. More...
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. More...
pa_operation * pa_context_get_source_info_list (pa_context *c, pa_source_info_cb_t cb, void *userdata)
Get the complete source list. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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)
Change the profile of a source. More...
Server
typedef struct pa_server_info pa_server_info
Server information. More...
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() More...
pa_operation * pa_context_get_server_info (pa_context *c, pa_server_info_cb_t cb, void *userdata)
Get some information about the server. More...
Modules
typedef struct pa_module_info pa_module_info
Stores information about modules. More...
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. More...
typedef void(* pa_context_index_cb_t) (pa_context *c, uint32_t idx, void *userdata)
Callback prototype for pa_context_load_module() More...
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. More...
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. More...
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. More...
pa_operation * pa_context_unload_module (pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata)
Unload a module. More...
Messages
typedef void(* pa_context_string_cb_t) (pa_context *c, int success, char *response, void *userdata)
Callback prototype for pa_context_send_message_to_object() More...
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)
Send a message to an object that registered a message handler. More...
Clients
typedef struct pa_client_info pa_client_info
Stores information about clients. More...
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. More...
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. More...
pa_operation * pa_context_get_client_info_list (pa_context *c, pa_client_info_cb_t cb, void *userdata)
Get the complete client list. More...
pa_operation * pa_context_kill_client (pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata)
Kill a client. More...
Cards
typedef struct pa_card_profile_info pa_card_profile_info
typedef struct pa_card_profile_info2 pa_card_profile_info2
Stores information about a specific profile of a card. More...
typedef struct pa_card_port_info pa_card_port_info
Stores information about a specific port of a card. More...
typedef struct pa_card_info pa_card_info
Stores information about cards. More...
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_...() More...
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. More...
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. More...
pa_operation * pa_context_get_card_info_list (pa_context *c, pa_card_info_cb_t cb, void *userdata)
Get the complete card list. More...
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. More...
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. More...
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)
Set the latency offset of a port. More...
Sink Inputs
typedef struct pa_sink_input_info pa_sink_input_info
Stores information about sink inputs. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
Source Outputs
typedef struct pa_source_output_info pa_source_output_info
Stores information about source outputs. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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 volume of a source output stream. More...
pa_operation * pa_context_set_source_output_mute (pa_context *c, uint32_t idx, int mute, pa_context_success_cb_t cb, void *userdata)
Set the mute switch of a source output stream. More...
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. More...
Statistics
typedef struct pa_stat_info pa_stat_info
Memory block statistics. More...
typedef void(* pa_stat_info_cb_t) (pa_context *c, const pa_stat_info *i, void *userdata)
Callback prototype for pa_context_stat() More...
pa_operation * pa_context_stat (pa_context *c, pa_stat_info_cb_t cb, void *userdata)
Get daemon memory block statistics. More...
Cached Samples
typedef struct pa_sample_info pa_sample_info
Stores information about sample cache entries. More...
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. More...
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. More...
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. More...
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. More...

Routines for daemon introspection.

See also Server Query and Control

pa_card_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_cb_t

Callback prototype for pa_context_get_card_info_...()

Since

0.9.15

pa_card_port_info

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_profile_info

pa_card_profile_info2

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_client_info

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_cb_t

pa_context_index_cb_t

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

pa_context_string_cb_t

typedef void(* pa_context_string_cb_t) (pa_context *c, int success, char *response, void *userdata)

pa_module_info

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_cb_t

pa_sample_info

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_cb_t

pa_server_info

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_cb_t

pa_sink_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_cb_t

pa_sink_input_info

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_cb_t

pa_sink_port_info

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_source_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_cb_t

pa_source_output_info

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_cb_t

pa_source_port_info

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_stat_info

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_cb_t

pa_context_get_card_info_by_index()

Get information about a card by its index.

Since

0.9.15

pa_context_get_card_info_by_name()

Get information about a card by its name.

Since

0.9.15

pa_context_get_card_info_list()

Get the complete card list.

Since

0.9.15

pa_context_get_client_info()

Get information about a client by its index.

pa_context_get_client_info_list()

Get the complete client list.

pa_context_get_module_info()

Get some information about a module by its index.

pa_context_get_module_info_list()

Get the complete list of currently loaded modules.

pa_context_get_sample_info_by_index()

Get information about a sample by its index.

pa_context_get_sample_info_by_name()

Get information about a sample by its name.

pa_context_get_sample_info_list()

Get the complete list of samples stored in the daemon.

pa_context_get_server_info()

Get some information about the server.

pa_context_get_sink_info_by_index()

Get information about a sink by its index.

pa_context_get_sink_info_by_name()

Get information about a sink by its name.

pa_context_get_sink_info_list()

Get the complete sink list.

pa_context_get_sink_input_info()

Get some information about a sink input by its index.

pa_context_get_sink_input_info_list()

Get the complete sink input list.

pa_context_get_source_info_by_index()

Get information about a source by its index.

pa_context_get_source_info_by_name()

Get information about a source by its name.

pa_context_get_source_info_list()

Get the complete source list.

pa_context_get_source_output_info()

Get information about a source output by its index.

pa_context_get_source_output_info_list()

Get the complete list of source outputs.

pa_context_kill_client()

pa_context_kill_sink_input()

pa_context_kill_source_output()

pa_context_load_module()

pa_context_move_sink_input_by_index()

Move the specified sink input to a different sink.

Since

0.9.5

pa_context_move_sink_input_by_name()

Move the specified sink input to a different sink.

Since

0.9.5

pa_context_move_source_output_by_index()

Move the specified source output to a different source.

Since

0.9.5

pa_context_move_source_output_by_name()

Move the specified source output to a different source.

Since

0.9.5

pa_context_send_message_to_object()

pa_context_set_card_profile_by_index()

Change the profile of a card.

Since

0.9.15

pa_context_set_card_profile_by_name()

Change the profile of a card.

Since

0.9.15

pa_context_set_port_latency_offset()

Set the latency offset of a port.

Since

3.0

pa_context_set_sink_input_mute()

Set the mute switch of a sink input stream.

Since

0.9.7

pa_context_set_sink_input_volume()

Set the volume of a sink input stream.

pa_context_set_sink_mute_by_index()

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

pa_context_set_sink_mute_by_name()

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

pa_context_set_sink_port_by_index()

Change the profile of a sink.

Since

0.9.16

pa_context_set_sink_port_by_name()

Change the profile of a sink.

Since

0.9.15

pa_context_set_sink_volume_by_index()

Set the volume of a sink device specified by its index.

pa_context_set_sink_volume_by_name()

Set the volume of a sink device specified by its name.

pa_context_set_source_mute_by_index()

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

pa_context_set_source_mute_by_name()

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

pa_context_set_source_output_mute()

Set the mute switch of a source output stream.

Since

1.0

pa_context_set_source_output_volume()

Set the volume of a source output stream.

Since

1.0

pa_context_set_source_port_by_index()

Change the profile of a source.

Since

0.9.16

pa_context_set_source_port_by_name()

Change the profile of a source.

Since

0.9.15

pa_context_set_source_volume_by_index()

Set the volume of a source device specified by its index.

pa_context_set_source_volume_by_name()

Set the volume of a source device specified by its name.

pa_context_stat()

Get daemon memory block statistics.

pa_context_suspend_sink_by_index()

Suspend/Resume a sink.

If idx is PA_INVALID_INDEX all sinks will be suspended.

Since

0.9.7

pa_context_suspend_sink_by_name()

Suspend/Resume a sink.

Since

0.9.7

pa_context_suspend_source_by_index()

Suspend/Resume a source.

If idx is PA_INVALID_INDEX, all sources will be suspended.

Since

0.9.7

pa_context_suspend_source_by_name()

Suspend/Resume a source.

Since

0.9.7

pa_context_unload_module()