PulseAudio  1.1
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 
194 PA_C_DECL_BEGIN
195 
201 typedef struct pa_sink_port_info {
202  const char *name;
203  const char *description;
204  uint32_t priority;
205 } pa_sink_port_info;
206 
210 typedef struct pa_sink_info {
211  const char *name;
212  uint32_t index;
213  const char *description;
214  pa_sample_spec sample_spec;
215  pa_channel_map channel_map;
216  uint32_t owner_module;
217  pa_cvolume volume;
218  int mute;
219  uint32_t monitor_source;
220  const char *monitor_source_name;
221  pa_usec_t latency;
222  const char *driver;
223  pa_sink_flags_t flags;
224  pa_proplist *proplist;
225  pa_usec_t configured_latency;
226  pa_volume_t base_volume;
227  pa_sink_state_t state;
228  uint32_t n_volume_steps;
229  uint32_t card;
230  uint32_t n_ports;
231  pa_sink_port_info** ports;
232  pa_sink_port_info* active_port;
233  uint8_t n_formats;
234  pa_format_info **formats;
235 } pa_sink_info;
236 
238 typedef void (*pa_sink_info_cb_t)(pa_context *c, const pa_sink_info *i, int eol, void *userdata);
239 
241 pa_operation* pa_context_get_sink_info_by_name(pa_context *c, const char *name, pa_sink_info_cb_t cb, void *userdata);
242 
244 pa_operation* pa_context_get_sink_info_by_index(pa_context *c, uint32_t idx, pa_sink_info_cb_t cb, void *userdata);
245 
247 pa_operation* pa_context_get_sink_info_list(pa_context *c, pa_sink_info_cb_t cb, void *userdata);
248 
250 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);
251 
253 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);
254 
256 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);
257 
259 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);
260 
262 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);
263 
265 pa_operation* pa_context_suspend_sink_by_index(pa_context *c, uint32_t idx, int suspend, pa_context_success_cb_t cb, void* userdata);
266 
268 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);
269 
271 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);
272 
280 typedef struct pa_source_port_info {
281  const char *name;
282  const char *description;
283  uint32_t priority;
284 } pa_source_port_info;
285 
289 typedef struct pa_source_info {
290  const char *name;
291  uint32_t index;
292  const char *description;
293  pa_sample_spec sample_spec;
294  pa_channel_map channel_map;
295  uint32_t owner_module;
296  pa_cvolume volume;
297  int mute;
298  uint32_t monitor_of_sink;
299  const char *monitor_of_sink_name;
300  pa_usec_t latency;
301  const char *driver;
302  pa_source_flags_t flags;
303  pa_proplist *proplist;
304  pa_usec_t configured_latency;
305  pa_volume_t base_volume;
306  pa_source_state_t state;
307  uint32_t n_volume_steps;
308  uint32_t card;
309  uint32_t n_ports;
310  pa_source_port_info** ports;
311  pa_source_port_info* active_port;
312  uint8_t n_formats;
313  pa_format_info **formats;
314 } pa_source_info;
315 
317 typedef void (*pa_source_info_cb_t)(pa_context *c, const pa_source_info *i, int eol, void *userdata);
318 
320 pa_operation* pa_context_get_source_info_by_name(pa_context *c, const char *name, pa_source_info_cb_t cb, void *userdata);
321 
323 pa_operation* pa_context_get_source_info_by_index(pa_context *c, uint32_t idx, pa_source_info_cb_t cb, void *userdata);
324 
326 pa_operation* pa_context_get_source_info_list(pa_context *c, pa_source_info_cb_t cb, void *userdata);
327 
329 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);
330 
332 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);
333 
335 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);
336 
338 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);
339 
341 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);
342 
344 pa_operation* pa_context_suspend_source_by_index(pa_context *c, uint32_t idx, int suspend, pa_context_success_cb_t cb, void* userdata);
345 
347 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);
348 
350 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);
351 
359 typedef struct pa_server_info {
360  const char *user_name;
361  const char *host_name;
362  const char *server_version;
363  const char *server_name;
364  pa_sample_spec sample_spec;
365  const char *default_sink_name;
366  const char *default_source_name;
367  uint32_t cookie;
368  pa_channel_map channel_map;
369 } pa_server_info;
370 
372 typedef void (*pa_server_info_cb_t) (pa_context *c, const pa_server_info*i, void *userdata);
373 
375 pa_operation* pa_context_get_server_info(pa_context *c, pa_server_info_cb_t cb, void *userdata);
376 
384 typedef struct pa_module_info {
385  uint32_t index;
386  const char*name,
387  *argument;
388  uint32_t n_used;
390  int auto_unload;
392  pa_proplist *proplist;
393 } pa_module_info;
394 
396 typedef void (*pa_module_info_cb_t) (pa_context *c, const pa_module_info*i, int eol, void *userdata);
397 
399 pa_operation* pa_context_get_module_info(pa_context *c, uint32_t idx, pa_module_info_cb_t cb, void *userdata);
400 
402 pa_operation* pa_context_get_module_info_list(pa_context *c, pa_module_info_cb_t cb, void *userdata);
403 
405 typedef void (*pa_context_index_cb_t)(pa_context *c, uint32_t idx, void *userdata);
406 
408 pa_operation* pa_context_load_module(pa_context *c, const char*name, const char *argument, pa_context_index_cb_t cb, void *userdata);
409 
411 pa_operation* pa_context_unload_module(pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata);
412 
420 typedef struct pa_client_info {
421  uint32_t index;
422  const char *name;
423  uint32_t owner_module;
424  const char *driver;
425  pa_proplist *proplist;
426 } pa_client_info;
427 
429 typedef void (*pa_client_info_cb_t) (pa_context *c, const pa_client_info*i, int eol, void *userdata);
430 
432 pa_operation* pa_context_get_client_info(pa_context *c, uint32_t idx, pa_client_info_cb_t cb, void *userdata);
433 
435 pa_operation* pa_context_get_client_info_list(pa_context *c, pa_client_info_cb_t cb, void *userdata);
436 
438 pa_operation* pa_context_kill_client(pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata);
439 
447 typedef struct pa_card_profile_info {
448  const char *name;
449  const char *description;
450  uint32_t n_sinks;
451  uint32_t n_sources;
452  uint32_t priority;
453 } pa_card_profile_info;
454 
458 typedef struct pa_card_info {
459  uint32_t index;
460  const char *name;
461  uint32_t owner_module;
462  const char *driver;
463  uint32_t n_profiles;
464  pa_card_profile_info* profiles;
465  pa_card_profile_info* active_profile;
466  pa_proplist *proplist;
467 } pa_card_info;
468 
470 typedef void (*pa_card_info_cb_t) (pa_context *c, const pa_card_info*i, int eol, void *userdata);
471 
473 pa_operation* pa_context_get_card_info_by_index(pa_context *c, uint32_t idx, pa_card_info_cb_t cb, void *userdata);
474 
476 pa_operation* pa_context_get_card_info_by_name(pa_context *c, const char *name, pa_card_info_cb_t cb, void *userdata);
477 
479 pa_operation* pa_context_get_card_info_list(pa_context *c, pa_card_info_cb_t cb, void *userdata);
480 
482 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);
483 
485 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);
486 
494 typedef struct pa_sink_input_info {
495  uint32_t index;
496  const char *name;
497  uint32_t owner_module;
498  uint32_t client;
499  uint32_t sink;
500  pa_sample_spec sample_spec;
501  pa_channel_map channel_map;
502  pa_cvolume volume;
503  pa_usec_t buffer_usec;
504  pa_usec_t sink_usec;
505  const char *resample_method;
506  const char *driver;
507  int mute;
508  pa_proplist *proplist;
509  int corked;
510  int has_volume;
511  int volume_writable;
512  pa_format_info *format;
513 } pa_sink_input_info;
514 
516 typedef void (*pa_sink_input_info_cb_t) (pa_context *c, const pa_sink_input_info *i, int eol, void *userdata);
517 
519 pa_operation* pa_context_get_sink_input_info(pa_context *c, uint32_t idx, pa_sink_input_info_cb_t cb, void *userdata);
520 
522 pa_operation* pa_context_get_sink_input_info_list(pa_context *c, pa_sink_input_info_cb_t cb, void *userdata);
523 
525 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);
526 
528 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);
529 
531 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);
532 
534 pa_operation* pa_context_set_sink_input_mute(pa_context *c, uint32_t idx, int mute, pa_context_success_cb_t cb, void *userdata);
535 
537 pa_operation* pa_context_kill_sink_input(pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata);
538 
546 typedef struct pa_source_output_info {
547  uint32_t index;
548  const char *name;
549  uint32_t owner_module;
550  uint32_t client;
551  uint32_t source;
552  pa_sample_spec sample_spec;
553  pa_channel_map channel_map;
554  pa_usec_t buffer_usec;
555  pa_usec_t source_usec;
556  const char *resample_method;
557  const char *driver;
558  pa_proplist *proplist;
559  int corked;
560  pa_cvolume volume;
561  int mute;
562  int has_volume;
563  int volume_writable;
564  pa_format_info *format;
565 } pa_source_output_info;
566 
568 typedef void (*pa_source_output_info_cb_t) (pa_context *c, const pa_source_output_info *i, int eol, void *userdata);
569 
571 pa_operation* pa_context_get_source_output_info(pa_context *c, uint32_t idx, pa_source_output_info_cb_t cb, void *userdata);
572 
574 pa_operation* pa_context_get_source_output_info_list(pa_context *c, pa_source_output_info_cb_t cb, void *userdata);
575 
577 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);
578 
580 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);
581 
583 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);
584 
586 pa_operation* pa_context_set_source_output_mute(pa_context *c, uint32_t idx, int mute, pa_context_success_cb_t cb, void *userdata);
587 
589 pa_operation* pa_context_kill_source_output(pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata);
590 
598 typedef struct pa_stat_info {
599  uint32_t memblock_total;
600  uint32_t memblock_total_size;
601  uint32_t memblock_allocated;
602  uint32_t memblock_allocated_size;
603  uint32_t scache_size;
604 } pa_stat_info;
605 
607 typedef void (*pa_stat_info_cb_t) (pa_context *c, const pa_stat_info *i, void *userdata);
608 
610 pa_operation* pa_context_stat(pa_context *c, pa_stat_info_cb_t cb, void *userdata);
611 
619 typedef struct pa_sample_info {
620  uint32_t index;
621  const char *name;
622  pa_cvolume volume;
623  pa_sample_spec sample_spec;
624  pa_channel_map channel_map;
625  pa_usec_t duration;
626  uint32_t bytes;
627  int lazy;
628  const char *filename;
629  pa_proplist *proplist;
630 } pa_sample_info;
631 
633 typedef void (*pa_sample_info_cb_t)(pa_context *c, const pa_sample_info *i, int eol, void *userdata);
634 
636 pa_operation* pa_context_get_sample_info_by_name(pa_context *c, const char *name, pa_sample_info_cb_t cb, void *userdata);
637 
639 pa_operation* pa_context_get_sample_info_by_index(pa_context *c, uint32_t idx, pa_sample_info_cb_t cb, void *userdata);
640 
642 pa_operation* pa_context_get_sample_info_list(pa_context *c, pa_sample_info_cb_t cb, void *userdata);
643 
651 typedef enum pa_autoload_type {
652  PA_AUTOLOAD_SINK = 0,
653  PA_AUTOLOAD_SOURCE = 1
654 } pa_autoload_type_t;
655 
659 typedef struct pa_autoload_info {
660  uint32_t index;
661  const char *name;
662  pa_autoload_type_t type;
663  const char *module;
664  const char *argument;
665 } pa_autoload_info;
666 
668 typedef void (*pa_autoload_info_cb_t)(pa_context *c, const pa_autoload_info *i, int eol, void *userdata);
669 
671 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;
672 
674 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;
675 
677 pa_operation* pa_context_get_autoload_info_list(pa_context *c, pa_autoload_info_cb_t cb, void *userdata) PA_GCC_DEPRECATED;
678 
680 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;
681 
683 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;
684 
686 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;
687 
692 PA_C_DECL_END
693 
694 #endif