PulseAudio  14.0
introspect.h
Go to the documentation of this file.
1 #ifndef foointrospecthfoo
2 #define foointrospecthfoo
3 
4 /***
5  This file is part of PulseAudio.
6 
7  Copyright 2004-2006 Lennart Poettering
8  Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
9 
10  PulseAudio is free software; you can redistribute it and/or modify
11  it under the terms of the GNU Lesser General Public License as published
12  by the Free Software Foundation; either version 2.1 of the License,
13  or (at your option) any later version.
14 
15  PulseAudio is distributed in the hope that it will be useful, but
16  WITHOUT ANY WARRANTY; without even the implied warranty of
17  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18  General Public License for more details.
19 
20  You should have received a copy of the GNU Lesser General Public License
21  along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
22 ***/
23 
24 #include <inttypes.h>
25 
26 #include <pulse/operation.h>
27 #include <pulse/context.h>
28 #include <pulse/cdecl.h>
29 #include <pulse/gccmacro.h>
30 #include <pulse/channelmap.h>
31 #include <pulse/volume.h>
32 #include <pulse/proplist.h>
33 #include <pulse/format.h>
34 #include <pulse/version.h>
35 
220 PA_C_DECL_BEGIN
221 
227 typedef struct pa_sink_port_info {
228  const char *name;
229  const char *description;
230  uint32_t priority;
231  int available;
232  const char *availability_group;
255  uint32_t type;
257 
261 typedef struct pa_sink_info {
262  const char *name;
263  uint32_t index;
264  const char *description;
267  uint32_t owner_module;
269  int mute;
270  uint32_t monitor_source;
271  const char *monitor_source_name;
273  const char *driver;
279  uint32_t n_volume_steps;
280  uint32_t card;
281  uint32_t n_ports;
284  uint8_t n_formats;
287 
289 typedef void (*pa_sink_info_cb_t)(pa_context *c, const pa_sink_info *i, int eol, void *userdata);
290 
293 
296 
299 
302 
304 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);
305 
307 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);
308 
310 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);
311 
313 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);
314 
316 pa_operation* pa_context_suspend_sink_by_index(pa_context *c, uint32_t idx, int suspend, pa_context_success_cb_t cb, void* userdata);
317 
319 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);
320 
322 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);
323 
331 typedef struct pa_source_port_info {
332  const char *name;
333  const char *description;
334  uint32_t priority;
335  int available;
336  const char *availability_group;
360  uint32_t type;
362 
366 typedef struct pa_source_info {
367  const char *name;
368  uint32_t index;
369  const char *description;
372  uint32_t owner_module;
374  int mute;
375  uint32_t monitor_of_sink;
376  const char *monitor_of_sink_name;
378  const char *driver;
384  uint32_t n_volume_steps;
385  uint32_t card;
386  uint32_t n_ports;
389  uint8_t n_formats;
392 
394 typedef void (*pa_source_info_cb_t)(pa_context *c, const pa_source_info *i, int eol, void *userdata);
395 
398 
401 
404 
407 
409 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);
410 
413 
415 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);
416 
418 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);
419 
421 pa_operation* pa_context_suspend_source_by_index(pa_context *c, uint32_t idx, int suspend, pa_context_success_cb_t cb, void* userdata);
422 
424 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);
425 
427 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);
428 
436 typedef struct pa_server_info {
437  const char *user_name;
438  const char *host_name;
439  const char *server_version;
440  const char *server_name;
442  const char *default_sink_name;
443  const char *default_source_name;
444  uint32_t cookie;
447 
449 typedef void (*pa_server_info_cb_t) (pa_context *c, const pa_server_info*i, void *userdata);
450 
453 
461 typedef struct pa_module_info {
462  uint32_t index;
463  const char*name,
465  uint32_t n_used;
467  int auto_unload;
471 
473 typedef void (*pa_module_info_cb_t) (pa_context *c, const pa_module_info*i, int eol, void *userdata);
474 
477 
480 
482 typedef void (*pa_context_index_cb_t)(pa_context *c, uint32_t idx, void *userdata);
483 
485 pa_operation* pa_context_load_module(pa_context *c, const char*name, const char *argument, pa_context_index_cb_t cb, void *userdata);
486 
489 
497 typedef struct pa_client_info {
498  uint32_t index;
499  const char *name;
500  uint32_t owner_module;
501  const char *driver;
504 
506 typedef void (*pa_client_info_cb_t) (pa_context *c, const pa_client_info*i, int eol, void *userdata);
507 
510 
513 
516 
522 typedef struct pa_card_profile_info {
523  const char *name;
524  const char *description;
525  uint32_t n_sinks;
526  uint32_t n_sources;
527  uint32_t priority;
529 
533 typedef struct pa_card_profile_info2 {
534  const char *name;
535  const char *description;
536  uint32_t n_sinks;
537  uint32_t n_sources;
538  uint32_t priority;
546 
550 typedef struct pa_card_port_info {
551  const char *name;
552  const char *description;
553  uint32_t priority;
554  int available;
555  int direction;
556  uint32_t n_profiles;
559  int64_t latency_offset;
561  const char *availability_group;
580  uint32_t type;
582 
586 typedef struct pa_card_info {
587  uint32_t index;
588  const char *name;
589  uint32_t owner_module;
590  const char *driver;
591  uint32_t n_profiles;
595  uint32_t n_ports;
600 
602 typedef void (*pa_card_info_cb_t) (pa_context *c, const pa_card_info*i, int eol, void *userdata);
603 
606 
609 
612 
614 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);
615 
617 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);
618 
620 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);
621 
629 typedef struct pa_sink_input_info {
630  uint32_t index;
631  const char *name;
632  uint32_t owner_module;
633  uint32_t client;
634  uint32_t sink;
640  const char *resample_method;
641  const char *driver;
642  int mute;
644  int corked;
649 
651 typedef void (*pa_sink_input_info_cb_t) (pa_context *c, const pa_sink_input_info *i, int eol, void *userdata);
652 
655 
658 
660 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);
661 
663 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);
664 
666 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);
667 
669 pa_operation* pa_context_set_sink_input_mute(pa_context *c, uint32_t idx, int mute, pa_context_success_cb_t cb, void *userdata);
670 
673 
681 typedef struct pa_source_output_info {
682  uint32_t index;
683  const char *name;
684  uint32_t owner_module;
685  uint32_t client;
686  uint32_t source;
691  const char *resample_method;
692  const char *driver;
694  int corked;
696  int mute;
701 
703 typedef void (*pa_source_output_info_cb_t) (pa_context *c, const pa_source_output_info *i, int eol, void *userdata);
704 
707 
710 
712 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);
713 
715 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);
716 
719 
721 pa_operation* pa_context_set_source_output_mute(pa_context *c, uint32_t idx, int mute, pa_context_success_cb_t cb, void *userdata);
722 
725 
733 typedef struct pa_stat_info {
734  uint32_t memblock_total;
738  uint32_t scache_size;
740 
742 typedef void (*pa_stat_info_cb_t) (pa_context *c, const pa_stat_info *i, void *userdata);
743 
746 
754 typedef struct pa_sample_info {
755  uint32_t index;
756  const char *name;
761  uint32_t bytes;
762  int lazy;
763  const char *filename;
766 
768 typedef void (*pa_sample_info_cb_t)(pa_context *c, const pa_sample_info *i, int eol, void *userdata);
769 
772 
775 
778 
786 typedef enum pa_autoload_type {
787  PA_AUTOLOAD_SINK = 0,
788  PA_AUTOLOAD_SOURCE = 1
789 } pa_autoload_type_t;
790 
794 typedef struct pa_autoload_info {
795  uint32_t index;
796  const char *name;
797  pa_autoload_type_t type;
798  const char *module;
799  const char *argument;
800 } pa_autoload_info;
801 
803 typedef void (*pa_autoload_info_cb_t)(pa_context *c, const pa_autoload_info *i, int eol, void *userdata);
804 
806 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;
807 
809 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;
810 
812 pa_operation* pa_context_get_autoload_info_list(pa_context *c, pa_autoload_info_cb_t cb, void *userdata) PA_GCC_DEPRECATED;
813 
815 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;
816 
818 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;
819 
821 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;
822 
827 PA_C_DECL_END
828 
829 #endif
pa_card_profile_info2::n_sinks
uint32_t n_sinks
Number of sinks this profile would create.
Definition: introspect.h:536
pa_source_port_info
struct pa_source_port_info pa_source_port_info
Stores information about a specific port of a source.
pa_context_set_source_volume_by_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 volume of a source device specified by its name.
pa_sink_info::state
pa_sink_state_t state
State.
Definition: introspect.h:278
pa_context_get_source_info_by_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 information about a source by its index.
channelmap.h
Constants and routines for channel mapping handling.
pa_context
struct pa_context pa_context
An opaque connection context to a daemon.
Definition: context.h:154
pa_context_index_cb_t
void(* pa_context_index_cb_t)(pa_context *c, uint32_t idx, void *userdata)
Callback prototype for pa_context_load_module()
Definition: introspect.h:482
pa_sink_info::owner_module
uint32_t owner_module
Index of the owning module of this sink, or PA_INVALID_INDEX.
Definition: introspect.h:267
pa_sample_info::channel_map
pa_channel_map channel_map
The channel map.
Definition: introspect.h:759
pa_server_info::channel_map
pa_channel_map channel_map
Default channel map.
Definition: introspect.h:445
pa_source_port_info
Stores information about a specific port of a source.
Definition: introspect.h:331
pa_context_suspend_source_by_index
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_sink_input_info::owner_module
uint32_t owner_module
Index of the module this sink input belongs to, or PA_INVALID_INDEX when it does not belong to any mo...
Definition: introspect.h:632
pa_source_output_info::sample_spec
pa_sample_spec sample_spec
The sample specification of the source output.
Definition: introspect.h:687
pa_format_info
Represents the format of data provided in a stream or processed by a sink.
Definition: format.h:98
pa_source_info
Stores information about sources.
Definition: introspect.h:366
pa_source_info::monitor_of_sink_name
const char * monitor_of_sink_name
Name of the owning sink, or NULL.
Definition: introspect.h:376
pa_context_suspend_sink_by_index
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.
pa_context_kill_client
pa_operation * pa_context_kill_client(pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata)
Kill a client.
pa_source_info::configured_latency
pa_usec_t configured_latency
The latency this device has been configured to.
Definition: introspect.h:381
pa_sink_info::volume
pa_cvolume volume
Volume of the sink.
Definition: introspect.h:268
pa_card_port_info::availability_group
const char * availability_group
An indentifier for the group of ports that share their availability status with each other.
Definition: introspect.h:561
pa_card_info::active_profile
pa_card_profile_info * active_profile
Definition: introspect.h:593
pa_context_get_sink_info_by_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 information about a sink by its index.
pa_context_set_source_mute_by_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 index.
pa_card_port_info::direction
int direction
A pa_direction enum, indicating the direction of this port.
Definition: introspect.h:555
pa_context_suspend_sink_by_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_cvolume
A structure encapsulating a per-channel volume.
Definition: volume.h:145
pa_context_get_module_info
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_sample_info
struct pa_sample_info pa_sample_info
Stores information about sample cache entries.
pa_sample_info::proplist
pa_proplist * proplist
Property list for this sample.
Definition: introspect.h:764
pa_context_get_sample_info_by_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 information about a sample by its index.
pa_module_info_cb_t
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.
Definition: introspect.h:473
pa_card_port_info
Stores information about a specific port of a card.
Definition: introspect.h:550
pa_context_set_sink_port_by_name
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.
pa_context_get_source_info_by_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 name.
pa_source_info::base_volume
pa_volume_t base_volume
Some kind of "base" volume that refers to unamplified/unattenuated volume in the context of the input...
Definition: introspect.h:382
pa_module_info::name
const char * name
Name of the module.
Definition: introspect.h:463
pa_context_set_card_profile_by_index
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_context_set_source_port_by_index
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.
pa_card_profile_info::name
const char * name
Name of this profile.
Definition: introspect.h:523
pa_sink_input_info
Stores information about sink inputs.
Definition: introspect.h:629
operation.h
Asynchronous operations.
format.h
Utility functions for handling a stream or sink format.
pa_sink_info::active_port
pa_sink_port_info * active_port
Pointer to active port in the array, or NULL.
Definition: introspect.h:283
pa_sink_info::configured_latency
pa_usec_t configured_latency
The latency this device has been configured to.
Definition: introspect.h:276
pa_server_info::cookie
uint32_t cookie
A random cookie for identifying this instance of PulseAudio.
Definition: introspect.h:444
pa_card_port_info
struct pa_card_port_info pa_card_port_info
Stores information about a specific port of a card.
pa_card_profile_info2::available
int available
Is this profile available? If this is zero, meaning "unavailable", then it makes no sense to try to a...
Definition: introspect.h:539
pa_client_info::index
uint32_t index
Index of this client.
Definition: introspect.h:498
pa_source_output_info::format
pa_format_info * format
Stream format information.
Definition: introspect.h:699
pa_card_info::index
uint32_t index
Index of this card.
Definition: introspect.h:587
pa_card_info::proplist
pa_proplist * proplist
Property list.
Definition: introspect.h:594
pa_context_get_sink_input_info_list
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_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.
pa_stat_info::scache_size
uint32_t scache_size
Total size of all sample cache entries.
Definition: introspect.h:738
pa_source_output_info::client
uint32_t client
Index of the client this source output belongs to, or PA_INVALID_INDEX when it does not belong to any...
Definition: introspect.h:685
pa_sink_input_info::client
uint32_t client
Index of the client this sink input belongs to, or PA_INVALID_INDEX when it does not belong to any cl...
Definition: introspect.h:633
pa_source_output_info::buffer_usec
pa_usec_t buffer_usec
Latency due to buffering in the source output, see pa_timing_info for details.
Definition: introspect.h:689
pa_sink_input_info::volume
pa_cvolume volume
The volume of this sink input.
Definition: introspect.h:637
pa_card_info::profiles
pa_card_profile_info * profiles
Definition: introspect.h:592
pa_context_get_sample_info_list
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.
proplist.h
Property list constants and functions.
pa_sink_input_info::sink_usec
pa_usec_t sink_usec
Latency of the sink device, see pa_timing_info for details.
Definition: introspect.h:639
pa_stat_info_cb_t
void(* pa_stat_info_cb_t)(pa_context *c, const pa_stat_info *i, void *userdata)
Callback prototype for pa_context_stat()
Definition: introspect.h:742
pa_sink_input_info::mute
int mute
Stream muted.
Definition: introspect.h:642
pa_source_output_info::index
uint32_t index
Index of the source output.
Definition: introspect.h:682
pa_source_info
struct pa_source_info pa_source_info
Stores information about sources.
pa_sink_info::monitor_source
uint32_t monitor_source
Index of the monitor source connected to this sink.
Definition: introspect.h:270
pa_source_output_info_cb_t
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.
Definition: introspect.h:703
pa_context_move_sink_input_by_index
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_server_info::server_version
const char * server_version
Version string of the daemon.
Definition: introspect.h:439
pa_server_info::host_name
const char * host_name
Host name the daemon is running on.
Definition: introspect.h:438
pa_context_load_module
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_card_info::name
const char * name
Name of this card.
Definition: introspect.h:588
pa_source_info::description
const char * description
Description of this source.
Definition: introspect.h:369
pa_source_info::n_volume_steps
uint32_t n_volume_steps
Number of volume steps for sources which do not support arbitrary volumes.
Definition: introspect.h:384
pa_stat_info::memblock_allocated_size
uint32_t memblock_allocated_size
Total size of all memory blocks allocated during the whole lifetime of the daemon.
Definition: introspect.h:737
pa_sink_input_info::has_volume
int has_volume
Stream has volume.
Definition: introspect.h:645
pa_server_info::user_name
const char * user_name
User name of the daemon process.
Definition: introspect.h:437
pa_sink_input_info::proplist
pa_proplist * proplist
Property list.
Definition: introspect.h:643
pa_sink_info
Stores information about sinks.
Definition: introspect.h:261
pa_channel_map
A channel map which can be used to attach labels to specific channels of a stream.
Definition: channelmap.h:264
pa_module_info::n_used
uint32_t n_used
Usage counter or PA_INVALID_INDEX.
Definition: introspect.h:465
pa_sink_input_info
struct pa_sink_input_info pa_sink_input_info
Stores information about sink inputs.
pa_sink_input_info::format
pa_format_info * format
Stream format information.
Definition: introspect.h:647
pa_sink_info::monitor_source_name
const char * monitor_source_name
The name of the monitor source.
Definition: introspect.h:271
pa_context_move_source_output_by_index
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_client_info::owner_module
uint32_t owner_module
Index of the owning module, or PA_INVALID_INDEX.
Definition: introspect.h:500
pa_sink_info
struct pa_sink_info pa_sink_info
Stores information about sinks.
pa_context_set_source_mute_by_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)
Set the mute switch of a source device specified by its name.
pa_stat_info::memblock_allocated
uint32_t memblock_allocated
Allocated memory blocks during the whole lifetime of the daemon.
Definition: introspect.h:736
pa_sink_input_info::sink
uint32_t sink
Index of the connected sink.
Definition: introspect.h:634
pa_card_profile_info
struct pa_card_profile_info pa_card_profile_info
pa_sink_info::n_ports
uint32_t n_ports
Number of entries in port array.
Definition: introspect.h:281
pa_source_flags_t
enum pa_source_flags pa_source_flags_t
Special source flags.
pa_proplist
struct pa_proplist pa_proplist
A property list object.
Definition: proplist.h:272
pa_card_info::n_ports
uint32_t n_ports
Number of entries in port array.
Definition: introspect.h:595
pa_source_port_info::description
const char * description
Description of this port.
Definition: introspect.h:333
pa_sink_input_info_cb_t
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.
Definition: introspect.h:651
pa_server_info::default_source_name
const char * default_source_name
Name of default source.
Definition: introspect.h:443
pa_context_get_sink_input_info
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_context_unload_module
pa_operation * pa_context_unload_module(pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata)
Unload a module.
pa_source_output_info::volume_writable
int volume_writable
The volume can be set.
Definition: introspect.h:698
pa_card_profile_info::priority
uint32_t priority
The higher this value is, the more useful this profile is as a default.
Definition: introspect.h:527
pa_server_info_cb_t
void(* pa_server_info_cb_t)(pa_context *c, const pa_server_info *i, void *userdata)
Callback prototype for pa_context_get_server_info()
Definition: introspect.h:449
pa_sink_info::ports
pa_sink_port_info ** ports
Array of available ports, or NULL.
Definition: introspect.h:282
pa_context_move_sink_input_by_name
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_card_info::profiles2
pa_card_profile_info2 ** profiles2
Array of pointers to available profiles, or NULL.
Definition: introspect.h:597
pa_card_port_info::description
const char * description
Description of this port.
Definition: introspect.h:552
pa_context_get_card_info_by_name
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_source_port_info::available
int available
A flags (see pa_port_available), indicating availability status of this port.
Definition: introspect.h:335
pa_source_info::owner_module
uint32_t owner_module
Owning module index, or PA_INVALID_INDEX.
Definition: introspect.h:372
pa_source_port_info::availability_group
const char * availability_group
An indentifier for the group of ports that share their availability status with each other.
Definition: introspect.h:336
pa_source_output_info::name
const char * name
Name of the source output.
Definition: introspect.h:683
pa_context_get_sink_info_list
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_module_info::argument
const char * argument
Argument string of the module.
Definition: introspect.h:464
pa_source_output_info::source
uint32_t source
Index of the connected source.
Definition: introspect.h:686
pa_sink_info::description
const char * description
Description of this sink.
Definition: introspect.h:264
pa_client_info_cb_t
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.
Definition: introspect.h:506
pa_context_get_module_info_list
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_card_port_info::type
uint32_t type
Port type, see pa_device_port_type.
Definition: introspect.h:580
volume.h
Constants and routines for volume handling.
pa_sink_info::base_volume
pa_volume_t base_volume
Some kind of "base" volume that refers to unamplified/unattenuated volume in the context of the outpu...
Definition: introspect.h:277
pa_context_success_cb_t
void(* pa_context_success_cb_t)(pa_context *c, int success, void *userdata)
A generic callback for operation completion.
Definition: context.h:160
pa_source_output_info::source_usec
pa_usec_t source_usec
Latency of the source device, see pa_timing_info for details.
Definition: introspect.h:690
pa_context_set_sink_input_volume
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_card_port_info::profiles
pa_card_profile_info ** profiles
Definition: introspect.h:557
pa_server_info::server_name
const char * server_name
Server package name (usually "pulseaudio")
Definition: introspect.h:440
pa_card_port_info::available
int available
A pa_port_available enum, indicating availability status of this port.
Definition: introspect.h:554
pa_sample_info::name
const char * name
Name of this entry.
Definition: introspect.h:756
pa_card_profile_info2
struct pa_card_profile_info2 pa_card_profile_info2
Stores information about a specific profile of a card.
pa_sink_port_info::available
int available
A flags (see pa_port_available), indicating availability status of this port.
Definition: introspect.h:231
pa_sink_info::card
uint32_t card
Card index, or PA_INVALID_INDEX.
Definition: introspect.h:280
pa_sink_input_info::name
const char * name
Name of the sink input.
Definition: introspect.h:631
pa_source_info::flags
pa_source_flags_t flags
Flags.
Definition: introspect.h:379
pa_context_suspend_source_by_name
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_card_info::n_profiles
uint32_t n_profiles
Number of entries in profile array.
Definition: introspect.h:591
pa_sink_port_info::priority
uint32_t priority
The higher this value is, the more useful this port is as a default.
Definition: introspect.h:230
pa_card_profile_info::n_sources
uint32_t n_sources
Number of sources this profile would create.
Definition: introspect.h:526
pa_card_info
Stores information about cards.
Definition: introspect.h:586
pa_sink_port_info::description
const char * description
Description of this port.
Definition: introspect.h:229
pa_card_profile_info2::name
const char * name
Name of this profile.
Definition: introspect.h:534
pa_card_port_info::proplist
pa_proplist * proplist
Property list.
Definition: introspect.h:558
pa_source_info::sample_spec
pa_sample_spec sample_spec
Sample spec of this source.
Definition: introspect.h:370
pa_source_output_info::has_volume
int has_volume
Stream has volume.
Definition: introspect.h:697
gccmacro.h
GCC attribute macros.
pa_sink_info::latency
pa_usec_t latency
Length of queued audio in the output buffer.
Definition: introspect.h:272
pa_source_info::proplist
pa_proplist * proplist
Property list.
Definition: introspect.h:380
pa_source_output_info::corked
int corked
Stream corked.
Definition: introspect.h:694
pa_source_output_info::mute
int mute
Stream muted.
Definition: introspect.h:696
pa_module_info::proplist
pa_proplist * proplist
Property list.
Definition: introspect.h:469
pa_source_state_t
enum pa_source_state pa_source_state_t
Source state.
pa_sink_info::mute
int mute
Mute switch of the sink.
Definition: introspect.h:269
pa_card_info::owner_module
uint32_t owner_module
Index of the owning module, or PA_INVALID_INDEX.
Definition: introspect.h:589
pa_context_set_sink_input_mute
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_sample_info::index
uint32_t index
Index of this entry.
Definition: introspect.h:755
pa_context_set_sink_volume_by_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 index.
pa_source_info::latency
pa_usec_t latency
Length of filled record buffer of this source.
Definition: introspect.h:377
pa_card_profile_info2::n_sources
uint32_t n_sources
Number of sources this profile would create.
Definition: introspect.h:537
pa_sample_info::duration
pa_usec_t duration
Duration of this entry.
Definition: introspect.h:760
pa_stat_info::memblock_total_size
uint32_t memblock_total_size
Current total size of allocated memory blocks.
Definition: introspect.h:735
pa_sink_info::n_formats
uint8_t n_formats
Number of formats supported by the sink.
Definition: introspect.h:284
pa_context_get_card_info_by_index
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_client_info
Stores information about clients.
Definition: introspect.h:497
pa_context_kill_sink_input
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_module_info
struct pa_module_info pa_module_info
Stores information about modules.
pa_usec_t
uint64_t pa_usec_t
Type for usec specifications (unsigned).
Definition: sample.h:264
pa_source_info::channel_map
pa_channel_map channel_map
Channel map.
Definition: introspect.h:371
pa_source_port_info::type
uint32_t type
Port type, see pa_device_port_type.
Definition: introspect.h:360
pa_sink_info::formats
pa_format_info ** formats
Array of formats supported by the sink.
Definition: introspect.h:285
pa_card_info
struct pa_card_info pa_card_info
Stores information about cards.
pa_source_info::n_ports
uint32_t n_ports
Number of entries in port array.
Definition: introspect.h:386
pa_sink_port_info::name
const char * name
Name of this port.
Definition: introspect.h:228
pa_sink_input_info::volume_writable
int volume_writable
The volume can be set.
Definition: introspect.h:646
pa_card_profile_info2
Stores information about a specific profile of a card.
Definition: introspect.h:533
pa_card_port_info::priority
uint32_t priority
The higher this value is, the more useful this port is as a default.
Definition: introspect.h:553
pa_context_set_sink_volume_by_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 volume of a sink device specified by its name.
pa_client_info::proplist
pa_proplist * proplist
Property list.
Definition: introspect.h:502
pa_card_port_info::profiles2
pa_card_profile_info2 ** profiles2
Array of pointers to available profiles, or NULL.
Definition: introspect.h:560
pa_context_get_sink_info_by_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 name.
pa_sample_spec
A sample format and attribute specification.
Definition: sample.h:252
pa_source_info_cb_t
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.
Definition: introspect.h:394
pa_context_get_sample_info_by_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 name.
pa_sink_input_info::driver
const char * driver
Driver name.
Definition: introspect.h:641
pa_card_profile_info::n_sinks
uint32_t n_sinks
Number of sinks this profile would create.
Definition: introspect.h:525
pa_source_info::volume
pa_cvolume volume
Volume of the source.
Definition: introspect.h:373
pa_module_info
Stores information about modules.
Definition: introspect.h:461
pa_sample_info::sample_spec
pa_sample_spec sample_spec
Sample specification of the sample.
Definition: introspect.h:758
pa_context_set_sink_mute_by_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 index.
pa_context_set_port_latency_offset
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.
pa_source_info::active_port
pa_source_port_info * active_port
Pointer to active port in the array, or NULL.
Definition: introspect.h:388
pa_sink_input_info::sample_spec
pa_sample_spec sample_spec
The sample specification of the sink input.
Definition: introspect.h:635
pa_sample_info::filename
const char * filename
In case this is a lazy cache entry, the filename for the sound file to be loaded on demand.
Definition: introspect.h:763
pa_sink_port_info
Stores information about a specific port of a sink.
Definition: introspect.h:227
pa_source_output_info::volume
pa_cvolume volume
The volume of this source output.
Definition: introspect.h:695
pa_sink_info::sample_spec
pa_sample_spec sample_spec
Sample spec of this sink.
Definition: introspect.h:265
pa_context_set_source_volume_by_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 index.
pa_sink_info_cb_t
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.
Definition: introspect.h:289
pa_card_profile_info
Definition: introspect.h:522
pa_source_info::state
pa_source_state_t state
State.
Definition: introspect.h:383
pa_source_info::ports
pa_source_port_info ** ports
Array of available ports, or NULL.
Definition: introspect.h:387
pa_source_output_info::proplist
pa_proplist * proplist
Property list.
Definition: introspect.h:693
pa_sink_info::index
uint32_t index
Index of the sink.
Definition: introspect.h:263
pa_context_set_source_port_by_name
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.
pa_stat_info
Memory block statistics.
Definition: introspect.h:733
pa_sink_info::driver
const char * driver
Driver name.
Definition: introspect.h:273
pa_sink_input_info::channel_map
pa_channel_map channel_map
Channel map.
Definition: introspect.h:636
pa_sample_info::bytes
uint32_t bytes
Length of this sample in bytes.
Definition: introspect.h:761
pa_source_port_info::name
const char * name
Name of this port.
Definition: introspect.h:332
pa_context_set_card_profile_by_name
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.
pa_source_info::driver
const char * driver
Driver name.
Definition: introspect.h:378
pa_sample_info::lazy
int lazy
Non-zero when this is a lazy cache entry.
Definition: introspect.h:762
pa_context_kill_source_output
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_sink_input_info::buffer_usec
pa_usec_t buffer_usec
Latency due to buffering in sink input, see pa_timing_info for details.
Definition: introspect.h:638
pa_sink_state_t
enum pa_sink_state pa_sink_state_t
Sink state.
pa_context_get_client_info_list
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_sink_input_info::corked
int corked
Stream corked.
Definition: introspect.h:644
pa_client_info
struct pa_client_info pa_client_info
Stores information about clients.
pa_context_get_source_info_list
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_context_set_sink_port_by_index
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.
pa_source_info::n_formats
uint8_t n_formats
Number of formats supported by the source.
Definition: introspect.h:389
pa_source_info::mute
int mute
Mute switch of the sink.
Definition: introspect.h:374
pa_source_output_info::resample_method
const char * resample_method
The resampling method used by this source output.
Definition: introspect.h:691
pa_server_info
struct pa_server_info pa_server_info
Server information.
context.h
Connection contexts for asynchronous communication with a server.
pa_card_port_info::n_profiles
uint32_t n_profiles
Number of entries in profile array.
Definition: introspect.h:556
pa_card_profile_info::description
const char * description
Description of this profile.
Definition: introspect.h:524
pa_source_output_info::driver
const char * driver
Driver name.
Definition: introspect.h:692
pa_operation
struct pa_operation pa_operation
An asynchronous operation object.
Definition: operation.h:33
pa_context_set_sink_mute_by_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)
Set the mute switch of a sink device specified by its name.
pa_card_profile_info2::description
const char * description
Description of this profile.
Definition: introspect.h:535
pa_sink_port_info::type
uint32_t type
Port type, see pa_device_port_type.
Definition: introspect.h:255
pa_context_stat
pa_operation * pa_context_stat(pa_context *c, pa_stat_info_cb_t cb, void *userdata)
Get daemon memory block statistics.
pa_sample_info
Stores information about sample cache entries.
Definition: introspect.h:754
pa_sink_info::channel_map
pa_channel_map channel_map
Channel map.
Definition: introspect.h:266
pa_sample_info::volume
pa_cvolume volume
Default volume of this entry.
Definition: introspect.h:757
pa_source_info::name
const char * name
Name of the source.
Definition: introspect.h:367
pa_context_get_client_info
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_server_info::sample_spec
pa_sample_spec sample_spec
Default sample specification.
Definition: introspect.h:441
pa_source_info::card
uint32_t card
Card index, or PA_INVALID_INDEX.
Definition: introspect.h:385
pa_module_info::index
uint32_t index
Index of the module.
Definition: introspect.h:462
pa_context_get_source_output_info_list
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_card_info::ports
pa_card_port_info ** ports
Array of pointers to ports, or NULL.
Definition: introspect.h:596
pa_sink_flags_t
enum pa_sink_flags pa_sink_flags_t
Special sink flags.
pa_sink_input_info::resample_method
const char * resample_method
The resampling method used by this sink input.
Definition: introspect.h:640
PA_GCC_DEPRECATED
#define PA_GCC_DEPRECATED
This function is deprecated.
Definition: gccmacro.h:91
pa_context_set_source_output_mute
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.
pa_sink_info::name
const char * name
Name of the sink.
Definition: introspect.h:262
pa_source_info::formats
pa_format_info ** formats
Array of formats supported by the source.
Definition: introspect.h:390
pa_context_get_source_output_info
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_card_info::active_profile2
pa_card_profile_info2 * active_profile2
Pointer to active profile in the array, or NULL.
Definition: introspect.h:598
pa_source_output_info
Stores information about source outputs.
Definition: introspect.h:681
pa_client_info::driver
const char * driver
Driver name.
Definition: introspect.h:501
pa_context_get_card_info_list
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_server_info::default_sink_name
const char * default_sink_name
Name of default sink.
Definition: introspect.h:442
pa_source_info::index
uint32_t index
Index of the source.
Definition: introspect.h:368
pa_context_move_source_output_by_name
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_sink_info::n_volume_steps
uint32_t n_volume_steps
Number of volume steps for sinks which do not support arbitrary volumes.
Definition: introspect.h:279
pa_card_port_info::latency_offset
int64_t latency_offset
Latency offset of the port that gets added to the sink/source latency when the port is active.
Definition: introspect.h:559
pa_card_info_cb_t
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_...()
Definition: introspect.h:602
pa_sample_info_cb_t
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.
Definition: introspect.h:768
pa_source_output_info::owner_module
uint32_t owner_module
Index of the module this source output belongs to, or PA_INVALID_INDEX when it does not belong to any...
Definition: introspect.h:684
pa_source_info::monitor_of_sink
uint32_t monitor_of_sink
If this is a monitor source, the index of the owning sink, otherwise PA_INVALID_INDEX.
Definition: introspect.h:375
pa_context_set_source_output_volume
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.
pa_client_info::name
const char * name
Name of this client.
Definition: introspect.h:499
pa_source_port_info::priority
uint32_t priority
The higher this value is, the more useful this port is as a default.
Definition: introspect.h:334
pa_sink_port_info
struct pa_sink_port_info pa_sink_port_info
Stores information about a specific port of a sink.
pa_source_output_info
struct pa_source_output_info pa_source_output_info
Stores information about source outputs.
pa_stat_info::memblock_total
uint32_t memblock_total
Currently allocated memory blocks.
Definition: introspect.h:734
pa_card_profile_info2::priority
uint32_t priority
The higher this value is, the more useful this profile is as a default.
Definition: introspect.h:538
pa_sink_info::flags
pa_sink_flags_t flags
Flags.
Definition: introspect.h:274
pa_server_info
Server information.
Definition: introspect.h:436
pa_sink_port_info::availability_group
const char * availability_group
An indentifier for the group of ports that share their availability status with each other.
Definition: introspect.h:232
pa_stat_info
struct pa_stat_info pa_stat_info
Memory block statistics.
pa_volume_t
uint32_t pa_volume_t
Volume specification: PA_VOLUME_MUTED: silence; < PA_VOLUME_NORM: decreased volume; PA_VOLUME_NORM: n...
Definition: volume.h:117
pa_card_info::driver
const char * driver
Driver name.
Definition: introspect.h:590
pa_source_output_info::channel_map
pa_channel_map channel_map
Channel map.
Definition: introspect.h:688
pa_sink_info::proplist
pa_proplist * proplist
Property list.
Definition: introspect.h:275
pa_sink_input_info::index
uint32_t index
Index of the sink input.
Definition: introspect.h:630
pa_card_port_info::name
const char * name
Name of this port.
Definition: introspect.h:551