PulseAudio  5.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, write to the Free Software
22  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
23  USA.
24 ***/
25 
26 #include <inttypes.h>
27 
28 #include <pulse/operation.h>
29 #include <pulse/context.h>
30 #include <pulse/cdecl.h>
31 #include <pulse/gccmacro.h>
32 #include <pulse/channelmap.h>
33 #include <pulse/volume.h>
34 #include <pulse/proplist.h>
35 #include <pulse/format.h>
36 #include <pulse/version.h>
37 
222 PA_C_DECL_BEGIN
223 
229 typedef struct pa_sink_port_info {
230  const char *name;
231  const char *description;
232  uint32_t priority;
233  int available;
235 
239 typedef struct pa_sink_info {
240  const char *name;
241  uint32_t index;
242  const char *description;
245  uint32_t owner_module;
247  int mute;
248  uint32_t monitor_source;
249  const char *monitor_source_name;
251  const char *driver;
257  uint32_t n_volume_steps;
258  uint32_t card;
259  uint32_t n_ports;
262  uint8_t n_formats;
264 } pa_sink_info;
265 
267 typedef void (*pa_sink_info_cb_t)(pa_context *c, const pa_sink_info *i, int eol, void *userdata);
268 
270 pa_operation* pa_context_get_sink_info_by_name(pa_context *c, const char *name, pa_sink_info_cb_t cb, void *userdata);
271 
273 pa_operation* pa_context_get_sink_info_by_index(pa_context *c, uint32_t idx, pa_sink_info_cb_t cb, void *userdata);
274 
277 
279 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);
280 
282 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);
283 
285 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);
286 
288 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);
289 
291 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);
292 
294 pa_operation* pa_context_suspend_sink_by_index(pa_context *c, uint32_t idx, int suspend, pa_context_success_cb_t cb, void* userdata);
295 
297 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);
298 
300 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);
301 
309 typedef struct pa_source_port_info {
310  const char *name;
311  const char *description;
312  uint32_t priority;
313  int available;
315 
319 typedef struct pa_source_info {
320  const char *name;
321  uint32_t index;
322  const char *description;
325  uint32_t owner_module;
327  int mute;
328  uint32_t monitor_of_sink;
329  const char *monitor_of_sink_name;
331  const char *driver;
337  uint32_t n_volume_steps;
338  uint32_t card;
339  uint32_t n_ports;
342  uint8_t n_formats;
345 
347 typedef void (*pa_source_info_cb_t)(pa_context *c, const pa_source_info *i, int eol, void *userdata);
348 
350 pa_operation* pa_context_get_source_info_by_name(pa_context *c, const char *name, pa_source_info_cb_t cb, void *userdata);
351 
354 
357 
359 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);
360 
362 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);
363 
365 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);
366 
368 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);
369 
371 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);
372 
374 pa_operation* pa_context_suspend_source_by_index(pa_context *c, uint32_t idx, int suspend, pa_context_success_cb_t cb, void* userdata);
375 
377 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);
378 
380 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);
381 
389 typedef struct pa_server_info {
390  const char *user_name;
391  const char *host_name;
392  const char *server_version;
393  const char *server_name;
395  const char *default_sink_name;
396  const char *default_source_name;
397  uint32_t cookie;
400 
402 typedef void (*pa_server_info_cb_t) (pa_context *c, const pa_server_info*i, void *userdata);
403 
406 
414 typedef struct pa_module_info {
415  uint32_t index;
416  const char*name,
417  *argument;
418  uint32_t n_used;
420  int auto_unload;
424 
426 typedef void (*pa_module_info_cb_t) (pa_context *c, const pa_module_info*i, int eol, void *userdata);
427 
429 pa_operation* pa_context_get_module_info(pa_context *c, uint32_t idx, pa_module_info_cb_t cb, void *userdata);
430 
433 
435 typedef void (*pa_context_index_cb_t)(pa_context *c, uint32_t idx, void *userdata);
436 
438 pa_operation* pa_context_load_module(pa_context *c, const char*name, const char *argument, pa_context_index_cb_t cb, void *userdata);
439 
441 pa_operation* pa_context_unload_module(pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata);
442 
450 typedef struct pa_client_info {
451  uint32_t index;
452  const char *name;
453  uint32_t owner_module;
454  const char *driver;
457 
459 typedef void (*pa_client_info_cb_t) (pa_context *c, const pa_client_info*i, int eol, void *userdata);
460 
462 pa_operation* pa_context_get_client_info(pa_context *c, uint32_t idx, pa_client_info_cb_t cb, void *userdata);
463 
466 
468 pa_operation* pa_context_kill_client(pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata);
469 
475 typedef struct pa_card_profile_info {
476  const char *name;
477  const char *description;
478  uint32_t n_sinks;
479  uint32_t n_sources;
480  uint32_t priority;
482 
486 typedef struct pa_card_profile_info2 {
487  const char *name;
488  const char *description;
489  uint32_t n_sinks;
490  uint32_t n_sources;
491  uint32_t priority;
499 
503 typedef struct pa_card_port_info {
504  const char *name;
505  const char *description;
506  uint32_t priority;
507  int available;
508  int direction;
509  uint32_t n_profiles;
512  int64_t latency_offset;
515 
519 typedef struct pa_card_info {
520  uint32_t index;
521  const char *name;
522  uint32_t owner_module;
523  const char *driver;
524  uint32_t n_profiles;
528  uint32_t n_ports;
532 } pa_card_info;
533 
535 typedef void (*pa_card_info_cb_t) (pa_context *c, const pa_card_info*i, int eol, void *userdata);
536 
538 pa_operation* pa_context_get_card_info_by_index(pa_context *c, uint32_t idx, pa_card_info_cb_t cb, void *userdata);
539 
541 pa_operation* pa_context_get_card_info_by_name(pa_context *c, const char *name, pa_card_info_cb_t cb, void *userdata);
542 
545 
547 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);
548 
550 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);
551 
553 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);
554 
562 typedef struct pa_sink_input_info {
563  uint32_t index;
564  const char *name;
565  uint32_t owner_module;
566  uint32_t client;
567  uint32_t sink;
573  const char *resample_method;
574  const char *driver;
575  int mute;
577  int corked;
582 
584 typedef void (*pa_sink_input_info_cb_t) (pa_context *c, const pa_sink_input_info *i, int eol, void *userdata);
585 
588 
591 
593 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);
594 
596 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);
597 
599 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);
600 
602 pa_operation* pa_context_set_sink_input_mute(pa_context *c, uint32_t idx, int mute, pa_context_success_cb_t cb, void *userdata);
603 
605 pa_operation* pa_context_kill_sink_input(pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata);
606 
614 typedef struct pa_source_output_info {
615  uint32_t index;
616  const char *name;
617  uint32_t owner_module;
618  uint32_t client;
619  uint32_t source;
624  const char *resample_method;
625  const char *driver;
627  int corked;
629  int mute;
634 
636 typedef void (*pa_source_output_info_cb_t) (pa_context *c, const pa_source_output_info *i, int eol, void *userdata);
637 
640 
643 
645 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);
646 
648 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);
649 
651 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);
652 
654 pa_operation* pa_context_set_source_output_mute(pa_context *c, uint32_t idx, int mute, pa_context_success_cb_t cb, void *userdata);
655 
658 
666 typedef struct pa_stat_info {
667  uint32_t memblock_total;
671  uint32_t scache_size;
672 } pa_stat_info;
673 
675 typedef void (*pa_stat_info_cb_t) (pa_context *c, const pa_stat_info *i, void *userdata);
676 
679 
687 typedef struct pa_sample_info {
688  uint32_t index;
689  const char *name;
694  uint32_t bytes;
695  int lazy;
696  const char *filename;
699 
701 typedef void (*pa_sample_info_cb_t)(pa_context *c, const pa_sample_info *i, int eol, void *userdata);
702 
704 pa_operation* pa_context_get_sample_info_by_name(pa_context *c, const char *name, pa_sample_info_cb_t cb, void *userdata);
705 
708 
711 
719 typedef enum pa_autoload_type {
720  PA_AUTOLOAD_SINK = 0,
721  PA_AUTOLOAD_SOURCE = 1
722 } pa_autoload_type_t;
723 
727 typedef struct pa_autoload_info {
728  uint32_t index;
729  const char *name;
730  pa_autoload_type_t type;
731  const char *module;
732  const char *argument;
733 } pa_autoload_info;
734 
736 typedef void (*pa_autoload_info_cb_t)(pa_context *c, const pa_autoload_info *i, int eol, void *userdata);
737 
739 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;
740 
742 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;
743 
745 pa_operation* pa_context_get_autoload_info_list(pa_context *c, pa_autoload_info_cb_t cb, void *userdata) PA_GCC_DEPRECATED;
746 
748 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;
749 
751 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;
752 
754 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;
755 
760 PA_C_DECL_END
761 
762 #endif
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.
struct pa_context pa_context
An opaque connection context to a daemon.
Definition: context.h:156
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_sample_spec sample_spec
The sample specification of the source output.
Definition: introspect.h:620
const char * server_version
Version string of the daemon.
Definition: introspect.h:392
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.
Stores information about sources.
Definition: introspect.h:319
uint32_t cookie
A random cookie for identifying this instance of PulseAudio.
Definition: introspect.h:397
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.
const char * user_name
User name of the daemon process.
Definition: introspect.h:390
const char * description
Description of this profile.
Definition: introspect.h:488
A sample format and attribute specification.
Definition: sample.h:250
enum pa_sink_state pa_sink_state_t
Sink state.
pa_usec_t configured_latency
The latency this device has been configured to.
Definition: introspect.h:334
uint32_t n_used
Usage counter or PA_INVALID_INDEX.
Definition: introspect.h:418
pa_cvolume volume
Default volume of this entry.
Definition: introspect.h:690
struct pa_card_profile_info pa_card_profile_info
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.
const char * name
Name of this card.
Definition: introspect.h:521
Connection contexts for asynchronous communication with a server.
Stores information about source outputs.
Definition: introspect.h:614
pa_sink_port_info * active_port
Pointer to active port in the array, or NULL.
Definition: introspect.h:261
const char * monitor_of_sink_name
Name of the owning sink, or PA_INVALID_INDEX.
Definition: introspect.h:329
int available
A pa_port_available enum, indicating availability status of this port.
Definition: introspect.h:507
const char * name
Name of this profile.
Definition: introspect.h:476
uint32_t sink
Index of the connected sink.
Definition: introspect.h:567
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:335
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_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_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.
uint32_t owner_module
Index of the owning module of this sink, or PA_INVALID_INDEX.
Definition: introspect.h:245
Constants and routines for volume handling.
uint32_t n_sources
Number of sources this profile would create.
Definition: introspect.h:479
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_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.
uint32_t n_ports
Number of entries in port array.
Definition: introspect.h:528
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_sink_port_info ** ports
Array of available ports, or NULL.
Definition: introspect.h:260
const char * description
Description of this sink.
Definition: introspect.h:242
const char * driver
Driver name.
Definition: introspect.h:523
int volume_writable
The volume can be set.
Definition: introspect.h:631
uint32_t memblock_allocated_size
Total size of all memory blocks allocated during the whole lifetime of the daemon.
Definition: introspect.h:670
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.
Definition: introspect.h:475
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.
enum pa_source_flags pa_source_flags_t
Special source flags.
struct pa_card_info pa_card_info
Stores information about cards.
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_kill_client(pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata)
Kill a client.
const char * driver
Driver name.
Definition: introspect.h:251
pa_proplist * proplist
Property list.
Definition: introspect.h:422
Stores information about a specific profile of a card.
Definition: introspect.h:486
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.
uint32_t index
Index of the sink.
Definition: introspect.h:241
A structure encapsulating a per-channel volume.
Definition: volume.h:150
pa_channel_map channel_map
Channel map.
Definition: introspect.h:621
const char * resample_method
The resampling method used by this sink input.
Definition: introspect.h:573
uint32_t index
Index of the source output.
Definition: introspect.h:615
enum pa_source_state pa_source_state_t
Source state.
uint32_t index
Index of this card.
Definition: introspect.h:520
struct pa_card_port_info pa_card_port_info
Stores information about a specific port of a card.
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_get_sink_input_info_list(pa_context *c, pa_sink_input_info_cb_t cb, void *userdata)
Get the complete sink input list.
pa_usec_t latency
Length of queued audio in the output buffer.
Definition: introspect.h:250
int volume_writable
The volume can be set.
Definition: introspect.h:579
struct pa_sink_input_info pa_sink_input_info
Stores information about sink inputs.
const char * default_source_name
Name of default source.
Definition: introspect.h:396
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:402
uint32_t index
Index of this client.
Definition: introspect.h:451
int available
A flags (see pa_port_available), indicating availability status of this port.
Definition: introspect.h:233
struct pa_source_port_info pa_source_port_info
Stores information about a specific port of a source.
struct pa_operation pa_operation
An asynchronous operation object.
Definition: operation.h:35
int mute
Mute switch of the sink.
Definition: introspect.h:247
const char * description
Description of this source.
Definition: introspect.h:322
uint32_t source
Index of the connected source.
Definition: introspect.h:619
Server information.
Definition: introspect.h:389
pa_cvolume volume
Volume of the sink.
Definition: introspect.h:246
uint32_t memblock_allocated
Allocated memory blocks during the whole lifetime of the daemon.
Definition: introspect.h:669
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:347
const char * name
Name of this entry.
Definition: introspect.h:689
pa_channel_map channel_map
The channel map.
Definition: introspect.h:692
uint32_t priority
The higher this value is, the more useful this profile is as a default.
Definition: introspect.h:491
const char * monitor_source_name
The name of the monitor source.
Definition: introspect.h:249
uint32_t priority
The higher this value is, the more useful this port is as a default.
Definition: introspect.h:506
const char * server_name
Server package name (usually "pulseaudio")
Definition: introspect.h:393
pa_sample_spec sample_spec
The sample specification of the sink input.
Definition: introspect.h:568
pa_channel_map channel_map
Default channel map.
Definition: introspect.h:398
uint32_t n_volume_steps
Number of volume steps for sources which do not support arbitrary volumes.
Definition: introspect.h:337
uint32_t n_profiles
Number of entries in profile array.
Definition: introspect.h:509
uint32_t owner_module
Index of the owning module, or PA_INVALID_INDEX.
Definition: introspect.h:522
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:565
#define PA_GCC_DEPRECATED
This function is deprecated.
Definition: gccmacro.h:93
uint64_t pa_usec_t
Type for usec specifications (unsigned).
Definition: sample.h:262
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_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.
Stores information about a specific port of a source.
Definition: introspect.h:309
Utility functions for handling a stream or sink format.
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.
int available
Is this profile available? If this is zero, meaning "unavailable", then it makes no sense to try to a...
Definition: introspect.h:492
struct pa_sink_port_info pa_sink_port_info
Stores information about a specific port of a sink.
pa_operation * pa_context_get_client_info_list(pa_context *c, pa_client_info_cb_t cb, void *userdata)
Get the complete client list.
void(* pa_context_success_cb_t)(pa_context *c, int success, void *userdata)
A generic callback for operation completion.
Definition: context.h:162
int has_volume
Stream has volume.
Definition: introspect.h:630
const char * driver
Driver name.
Definition: introspect.h:574
pa_channel_map channel_map
Channel map.
Definition: introspect.h:569
uint32_t scache_size
Total size of all sample cache entries.
Definition: introspect.h:671
int corked
Stream corked.
Definition: introspect.h:627
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:675
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.
uint32_t owner_module
Index of the owning module, or PA_INVALID_INDEX.
Definition: introspect.h:453
struct pa_module_info pa_module_info
Stores information about modules.
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:459
Constants and routines for channel mapping handling.
pa_card_port_info ** ports
Array of pointers to ports, or NULL.
Definition: introspect.h:529
uint32_t monitor_source
Index of the monitor source connected to this sink.
Definition: introspect.h:248
uint32_t owner_module
Owning module index, or PA_INVALID_INDEX.
Definition: introspect.h:325
Stores information about sample cache entries.
Definition: introspect.h:687
pa_usec_t duration
Duration of this entry.
Definition: introspect.h:693
const char * host_name
Host name the daemon is running on.
Definition: introspect.h:391
enum pa_sink_flags pa_sink_flags_t
Special sink flags.
const char * description
Description of this port.
Definition: introspect.h:311
uint32_t memblock_total_size
Current total size of allocated memory blocks.
Definition: introspect.h:668
Stores information about sinks.
Definition: introspect.h:239
const char * resample_method
The resampling method used by this source output.
Definition: introspect.h:624
int available
A flags (see pa_port_available), indicating availability status of this port.
Definition: introspect.h:313
const char * name
Name of this port.
Definition: introspect.h:504
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.
uint32_t n_volume_steps
Number of volume steps for sinks which do not support arbitrary volumes.
Definition: introspect.h:257
const char * name
Name of the source output.
Definition: introspect.h:616
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:267
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_usec_t buffer_usec
Latency due to buffering in the source output, see pa_timing_info for details.
Definition: introspect.h:622
uint32_t n_profiles
Number of entries in profile array.
Definition: introspect.h:524
Stores information about a specific port of a sink.
Definition: introspect.h:229
pa_source_flags_t flags
Flags.
Definition: introspect.h:332
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:566
struct pa_source_info pa_source_info
Stores information about sources.
int corked
Stream corked.
Definition: introspect.h:577
pa_usec_t buffer_usec
Latency due to buffering in sink input, see pa_timing_info for details.
Definition: introspect.h:571
pa_card_profile_info2 * active_profile2
Pointer to active profile in the array, or NULL.
Definition: introspect.h:531
pa_card_profile_info * active_profile
Definition: introspect.h:526
pa_cvolume volume
The volume of this source output.
Definition: introspect.h:628
GCC attribute macros.
int mute
Stream muted.
Definition: introspect.h:575
struct pa_stat_info pa_stat_info
Memory block statistics.
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_usec_t latency
Length of filled record buffer of this source.
Definition: introspect.h:330
pa_sample_spec sample_spec
Sample spec of this sink.
Definition: introspect.h:243
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.
Memory block statistics.
Definition: introspect.h:666
pa_sample_spec sample_spec
Sample spec of this source.
Definition: introspect.h:323
pa_channel_map channel_map
Channel map.
Definition: introspect.h:324
pa_sample_spec sample_spec
Default sample specification.
Definition: introspect.h:394
uint32_t memblock_total
Currently allocated memory blocks.
Definition: introspect.h:667
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_proplist * proplist
Property list.
Definition: introspect.h:333
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_proplist * proplist
Property list.
Definition: introspect.h:576
const char * description
Description of this port.
Definition: introspect.h:505
struct pa_server_info pa_server_info
Server information.
pa_operation * pa_context_get_source_info_list(pa_context *c, pa_source_info_cb_t cb, void *userdata)
Get the complete source list.
const char * name
Name of this port.
Definition: introspect.h:310
pa_format_info * format
Stream format information.
Definition: introspect.h:580
int lazy
Non-zero when this is a lazy cache entry.
Definition: introspect.h:695
uint8_t n_formats
Number of formats supported by the sink.
Definition: introspect.h:262
pa_usec_t source_usec
Latency of the source device, see pa_timing_info for details.
Definition: introspect.h:623
Stores information about clients.
Definition: introspect.h:450
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.
uint32_t n_ports
Number of entries in port array.
Definition: introspect.h:339
pa_cvolume volume
Volume of the source.
Definition: introspect.h:326
const char * default_sink_name
Name of default sink.
Definition: introspect.h:395
pa_source_port_info * active_port
Pointer to active port in the array, or NULL.
Definition: introspect.h:341
uint32_t priority
The higher this value is, the more useful this port is as a default.
Definition: introspect.h:312
pa_proplist * proplist
Property list.
Definition: introspect.h:455
const char * driver
Driver name.
Definition: introspect.h:625
uint32_t n_sinks
Number of sinks this profile would create.
Definition: introspect.h:478
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_channel_map channel_map
Channel map.
Definition: introspect.h:244
Define header version.
Stores information about cards.
Definition: introspect.h:519
int has_volume
Stream has volume.
Definition: introspect.h:578
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:636
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:255
pa_proplist * proplist
Property list.
Definition: introspect.h:253
Asynchronous operations.
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.
Stores information about sink inputs.
Definition: introspect.h:562
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.
const char * description
Description of this profile.
Definition: introspect.h:477
pa_proplist * proplist
Property list.
Definition: introspect.h:511
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.
const char * driver
Driver name.
Definition: introspect.h:331
Stores information about modules.
Definition: introspect.h:414
pa_sink_state_t state
State.
Definition: introspect.h:256
pa_source_state_t state
State.
Definition: introspect.h:336
struct pa_card_profile_info2 pa_card_profile_info2
Stores information about a specific profile of a card.
pa_source_port_info ** ports
Array of available ports, or NULL.
Definition: introspect.h:340
uint32_t index
Index of the sink input.
Definition: introspect.h:563
pa_sink_flags_t flags
Flags.
Definition: introspect.h:252
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_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_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.
const char * name
Name of this profile.
Definition: introspect.h:487
pa_proplist * proplist
Property list.
Definition: introspect.h:626
uint8_t n_formats
Number of formats supported by the source.
Definition: introspect.h:342
int mute
Mute switch of the sink.
Definition: introspect.h:327
uint32_t card
Card index, or PA_INVALID_INDEX.
Definition: introspect.h:258
const char * name
Name of the sink.
Definition: introspect.h:240
uint32_t n_sinks
Number of sinks this profile would create.
Definition: introspect.h:489
uint32_t n_sources
Number of sources this profile would create.
Definition: introspect.h:490
const char * name
Name of the source.
Definition: introspect.h:320
pa_sample_spec sample_spec
Sample specification of the sample.
Definition: introspect.h:691
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:696
uint32_t card
Card index, or PA_INVALID_INDEX.
Definition: introspect.h:338
uint32_t priority
The higher this value is, the more useful this profile is as a default.
Definition: introspect.h:480
const char * name
Name of the module.
Definition: introspect.h:416
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.
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:535
int direction
A pa_direction enum, indicating the direction of this port.
Definition: introspect.h:508
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_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_card_profile_info2 ** profiles2
Array of pointers to available profiles, or NULL.
Definition: introspect.h:530
uint32_t pa_volume_t
Volume specification: PA_VOLUME_MUTED: silence; < PA_VOLUME_NORM: decreased volume; PA_VOLUME_NORM: n...
Definition: volume.h:122
const char * name
Name of this port.
Definition: introspect.h:230
const char * name
Name of the sink input.
Definition: introspect.h:564
uint32_t index
Index of this entry.
Definition: introspect.h:688
const char * argument
Argument string of the module.
Definition: introspect.h:416
Represents the format of data provided in a stream or processed by a sink.
Definition: format.h:87
pa_card_profile_info * profiles
Definition: introspect.h:525
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:426
A channel map which can be used to attach labels to specific channels of a stream.
Definition: channelmap.h:264
uint32_t index
Index of the source.
Definition: introspect.h:321
pa_proplist * proplist
Property list for this sample.
Definition: introspect.h:697
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.
const char * name
Name of this client.
Definition: introspect.h:452
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.
struct pa_proplist pa_proplist
A property list object.
Definition: proplist.h:274
pa_format_info ** formats
Array of formats supported by the sink.
Definition: introspect.h:263
uint32_t bytes
Length of this sample in bytes.
Definition: introspect.h:694
struct pa_sample_info pa_sample_info
Stores information about sample cache entries.
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_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.
int mute
Stream muted.
Definition: introspect.h:629
pa_format_info ** formats
Array of formats supported by the source.
Definition: introspect.h:343
pa_cvolume volume
The volume of this sink input.
Definition: introspect.h:570
pa_operation * pa_context_get_card_info_list(pa_context *c, pa_card_info_cb_t cb, void *userdata)
Get the complete card list.
uint32_t n_ports
Number of entries in port array.
Definition: introspect.h:259
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:618
pa_operation * pa_context_stat(pa_context *c, pa_stat_info_cb_t cb, void *userdata)
Get daemon memory block statistics.
const char * driver
Driver name.
Definition: introspect.h:454
pa_usec_t sink_usec
Latency of the sink device, see pa_timing_info for details.
Definition: introspect.h:572
uint32_t monitor_of_sink
If this is a monitor source, the index of the owning sink, otherwise PA_INVALID_INDEX.
Definition: introspect.h:328
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.
Property list constants and functions.
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:584
struct pa_source_output_info pa_source_output_info
Stores information about source outputs.
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.
void(* pa_context_index_cb_t)(pa_context *c, uint32_t idx, void *userdata)
Callback prototype for pa_context_load_module()
Definition: introspect.h:435
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.
struct pa_sink_info pa_sink_info
Stores information about sinks.
pa_card_profile_info ** profiles
Definition: introspect.h:510
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:617
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.
struct pa_client_info pa_client_info
Stores information about clients.
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:701
pa_usec_t configured_latency
The latency this device has been configured to.
Definition: introspect.h:254
Stores information about a specific port of a card.
Definition: introspect.h:503
pa_operation * pa_context_unload_module(pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata)
Unload a module.
pa_format_info * format
Stream format information.
Definition: introspect.h:632
pa_card_profile_info2 ** profiles2
Array of pointers to available profiles, or NULL.
Definition: introspect.h:513
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_sink_info_list(pa_context *c, pa_sink_info_cb_t cb, void *userdata)
Get the complete sink list.
uint32_t index
Index of the module.
Definition: introspect.h:415
uint32_t priority
The higher this value is, the more useful this port is as a default.
Definition: introspect.h:232
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:512
pa_proplist * proplist
Property list.
Definition: introspect.h:527
const char * description
Description of this port.
Definition: introspect.h:231