PulseAudio: introspect.h Source File

00001 #ifndef foointrospecthfoo
00002 #define foointrospecthfoo
00003 
00004 /***
00005   This file is part of PulseAudio.
00006 
00007   Copyright 2004-2006 Lennart Poettering
00008   Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
00009 
00010   PulseAudio is free software; you can redistribute it and/or modify
00011   it under the terms of the GNU Lesser General Public License as published
00012   by the Free Software Foundation; either version 2.1 of the License,
00013   or (at your option) any later version.
00014 
00015   PulseAudio is distributed in the hope that it will be useful, but
00016   WITHOUT ANY WARRANTY; without even the implied warranty of
00017   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
00018   General Public License for more details.
00019 
00020   You should have received a copy of the GNU Lesser General Public License
00021   along with PulseAudio; if not, write to the Free Software
00022   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023   USA.
00024 ***/
00025 
00026 #include <inttypes.h>
00027 
00028 #include <pulse/operation.h>
00029 #include <pulse/context.h>
00030 #include <pulse/cdecl.h>
00031 #include <pulse/gccmacro.h>
00032 #include <pulse/channelmap.h>
00033 #include <pulse/volume.h>
00034 #include <pulse/proplist.h>
00035 #include <pulse/version.h>
00036 
00192 PA_C_DECL_BEGIN
00193 
00199 typedef struct pa_sink_info {
00200     const char *name;                  
00201     uint32_t index;                    
00202     const char *description;           
00203     pa_sample_spec sample_spec;        
00204     pa_channel_map channel_map;        
00205     uint32_t owner_module;             
00206     pa_cvolume volume;                 
00207     int mute;                          
00208     uint32_t monitor_source;           
00209     const char *monitor_source_name;   
00210     pa_usec_t latency;                 
00211     const char *driver;                
00212     pa_sink_flags_t flags;             
00213     pa_proplist *proplist;             
00214     pa_usec_t configured_latency;      
00215     pa_volume_t base_volume;           
00216     pa_sink_state_t state;             
00217     uint32_t n_volume_steps;           
00218     uint32_t card;                     
00219 } pa_sink_info;
00220 
00222 typedef void (*pa_sink_info_cb_t)(pa_context *c, const pa_sink_info *i, int eol, void *userdata);
00223 
00225 pa_operation* pa_context_get_sink_info_by_name(pa_context *c, const char *name, pa_sink_info_cb_t cb, void *userdata);
00226 
00228 pa_operation* pa_context_get_sink_info_by_index(pa_context *c, uint32_t idx, pa_sink_info_cb_t cb, void *userdata);
00229 
00231 pa_operation* pa_context_get_sink_info_list(pa_context *c, pa_sink_info_cb_t cb, void *userdata);
00232 
00234 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);
00235 
00237 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);
00238 
00240 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);
00241 
00243 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);
00244 
00246 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);
00247 
00249 pa_operation* pa_context_suspend_sink_by_index(pa_context *c, uint32_t idx, int suspend,  pa_context_success_cb_t cb, void* userdata);
00250 
00258 typedef struct pa_source_info {
00259     const char *name;                   
00260     uint32_t index;                     
00261     const char *description;            
00262     pa_sample_spec sample_spec;         
00263     pa_channel_map channel_map;         
00264     uint32_t owner_module;              
00265     pa_cvolume volume;                  
00266     int mute;                           
00267     uint32_t monitor_of_sink;           
00268     const char *monitor_of_sink_name;   
00269     pa_usec_t latency;                  
00270     const char *driver;                 
00271     pa_source_flags_t flags;            
00272     pa_proplist *proplist;              
00273     pa_usec_t configured_latency;       
00274     pa_volume_t base_volume;            
00275     pa_source_state_t state;            
00276     uint32_t n_volume_steps;            
00277     uint32_t card;                      
00278 } pa_source_info;
00279 
00281 typedef void (*pa_source_info_cb_t)(pa_context *c, const pa_source_info *i, int eol, void *userdata);
00282 
00284 pa_operation* pa_context_get_source_info_by_name(pa_context *c, const char *name, pa_source_info_cb_t cb, void *userdata);
00285 
00287 pa_operation* pa_context_get_source_info_by_index(pa_context *c, uint32_t idx, pa_source_info_cb_t cb, void *userdata);
00288 
00290 pa_operation* pa_context_get_source_info_list(pa_context *c, pa_source_info_cb_t cb, void *userdata);
00291 
00293 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);
00294 
00296 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);
00297 
00299 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);
00300 
00302 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);
00303 
00311 typedef struct pa_server_info {
00312     const char *user_name;              
00313     const char *host_name;              
00314     const char *server_version;         
00315     const char *server_name;            
00316     pa_sample_spec sample_spec;         
00317     const char *default_sink_name;      
00318     const char *default_source_name;    
00319     uint32_t cookie;                    
00320     pa_channel_map channel_map;         
00321 } pa_server_info;
00322 
00324 typedef void (*pa_server_info_cb_t) (pa_context *c, const pa_server_info*i, void *userdata);
00325 
00327 pa_operation* pa_context_get_server_info(pa_context *c, pa_server_info_cb_t cb, void *userdata);
00328 
00336 typedef struct pa_module_info {
00337     uint32_t index;                     
00338     const char*name,                    
00339         *argument;                      
00340     uint32_t n_used;                    
00342     int auto_unload;                    
00344     pa_proplist *proplist;              
00345 } pa_module_info;
00346 
00348 typedef void (*pa_module_info_cb_t) (pa_context *c, const pa_module_info*i, int eol, void *userdata);
00349 
00351 pa_operation* pa_context_get_module_info(pa_context *c, uint32_t idx, pa_module_info_cb_t cb, void *userdata);
00352 
00354 pa_operation* pa_context_get_module_info_list(pa_context *c, pa_module_info_cb_t cb, void *userdata);
00355 
00357 typedef void (*pa_context_index_cb_t)(pa_context *c, uint32_t idx, void *userdata);
00358 
00360 pa_operation* pa_context_load_module(pa_context *c, const char*name, const char *argument, pa_context_index_cb_t cb, void *userdata);
00361 
00363 pa_operation* pa_context_unload_module(pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata);
00364 
00372 typedef struct pa_client_info {
00373     uint32_t index;                      
00374     const char *name;                    
00375     uint32_t owner_module;               
00376     const char *driver;                  
00377     pa_proplist *proplist;               
00378 } pa_client_info;
00379 
00381 typedef void (*pa_client_info_cb_t) (pa_context *c, const pa_client_info*i, int eol, void *userdata);
00382 
00384 pa_operation* pa_context_get_client_info(pa_context *c, uint32_t idx, pa_client_info_cb_t cb, void *userdata);
00385 
00387 pa_operation* pa_context_get_client_info_list(pa_context *c, pa_client_info_cb_t cb, void *userdata);
00388 
00390 pa_operation* pa_context_kill_client(pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata);
00391 
00399 typedef struct pa_card_profile_info {
00400     const char *name;                   
00401     const char *description;            
00402     uint32_t n_sinks;                   
00403     uint32_t n_sources;                 
00404     uint32_t priority;                  
00405 } pa_card_profile_info;
00406 
00410 typedef struct pa_card_info {
00411     uint32_t index;                      
00412     const char *name;                    
00413     uint32_t owner_module;               
00414     const char *driver;                  
00415     uint32_t n_profiles;                 
00416     pa_card_profile_info* profiles;      
00417     pa_card_profile_info* active_profile; 
00418     pa_proplist *proplist;               
00419 } pa_card_info;
00420 
00422 typedef void (*pa_card_info_cb_t) (pa_context *c, const pa_card_info*i, int eol, void *userdata);
00423 
00425 pa_operation* pa_context_get_card_info_by_index(pa_context *c, uint32_t idx, pa_card_info_cb_t cb, void *userdata);
00426 
00428 pa_operation* pa_context_get_card_info_by_name(pa_context *c, const char *name, pa_card_info_cb_t cb, void *userdata);
00429 
00431 pa_operation* pa_context_get_card_info_list(pa_context *c, pa_card_info_cb_t cb, void *userdata);
00432 
00434 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);
00435 
00437 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);
00438 
00446 typedef struct pa_sink_input_info {
00447     uint32_t index;                      
00448     const char *name;                    
00449     uint32_t owner_module;               
00450     uint32_t client;                     
00451     uint32_t sink;                       
00452     pa_sample_spec sample_spec;          
00453     pa_channel_map channel_map;          
00454     pa_cvolume volume;                   
00455     pa_usec_t buffer_usec;               
00456     pa_usec_t sink_usec;                 
00457     const char *resample_method;         
00458     const char *driver;                  
00459     int mute;                            
00460     pa_proplist *proplist;               
00461 } pa_sink_input_info;
00462 
00464 typedef void (*pa_sink_input_info_cb_t) (pa_context *c, const pa_sink_input_info *i, int eol, void *userdata);
00465 
00467 pa_operation* pa_context_get_sink_input_info(pa_context *c, uint32_t idx, pa_sink_input_info_cb_t cb, void *userdata);
00468 
00470 pa_operation* pa_context_get_sink_input_info_list(pa_context *c, pa_sink_input_info_cb_t cb, void *userdata);
00471 
00473 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);
00474 
00476 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);
00477 
00479 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);
00480 
00482 pa_operation* pa_context_set_sink_input_mute(pa_context *c, uint32_t idx, int mute, pa_context_success_cb_t cb, void *userdata);
00483 
00485 pa_operation* pa_context_kill_sink_input(pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata);
00486 
00494 typedef struct pa_source_output_info {
00495     uint32_t index;                      
00496     const char *name;                    
00497     uint32_t owner_module;               
00498     uint32_t client;                     
00499     uint32_t source;                     
00500     pa_sample_spec sample_spec;          
00501     pa_channel_map channel_map;          
00502     pa_usec_t buffer_usec;               
00503     pa_usec_t source_usec;               
00504     const char *resample_method;         
00505     const char *driver;                  
00506     pa_proplist *proplist;               
00507 } pa_source_output_info;
00508 
00510 typedef void (*pa_source_output_info_cb_t) (pa_context *c, const pa_source_output_info *i, int eol, void *userdata);
00511 
00513 pa_operation* pa_context_get_source_output_info(pa_context *c, uint32_t idx, pa_source_output_info_cb_t cb, void *userdata);
00514 
00516 pa_operation* pa_context_get_source_output_info_list(pa_context *c, pa_source_output_info_cb_t cb, void *userdata);
00517 
00519 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);
00520 
00522 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);
00523 
00525 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);
00526 
00528 pa_operation* pa_context_suspend_source_by_index(pa_context *c, uint32_t idx, int suspend, pa_context_success_cb_t cb, void* userdata);
00529 
00531 pa_operation* pa_context_kill_source_output(pa_context *c, uint32_t idx, pa_context_success_cb_t cb, void *userdata);
00532 
00540 typedef struct pa_stat_info {
00541     uint32_t memblock_total;           
00542     uint32_t memblock_total_size;      
00543     uint32_t memblock_allocated;       
00544     uint32_t memblock_allocated_size;  
00545     uint32_t scache_size;              
00546 } pa_stat_info;
00547 
00549 typedef void (*pa_stat_info_cb_t) (pa_context *c, const pa_stat_info *i, void *userdata);
00550 
00552 pa_operation* pa_context_stat(pa_context *c, pa_stat_info_cb_t cb, void *userdata);
00553 
00561 typedef struct pa_sample_info {
00562     uint32_t index;                       
00563     const char *name;                     
00564     pa_cvolume volume;                    
00565     pa_sample_spec sample_spec;           
00566     pa_channel_map channel_map;           
00567     pa_usec_t duration;                   
00568     uint32_t bytes;                       
00569     int lazy;                             
00570     const char *filename;                 
00571     pa_proplist *proplist;                
00572 } pa_sample_info;
00573 
00575 typedef void (*pa_sample_info_cb_t)(pa_context *c, const pa_sample_info *i, int eol, void *userdata);
00576 
00578 pa_operation* pa_context_get_sample_info_by_name(pa_context *c, const char *name, pa_sample_info_cb_t cb, void *userdata);
00579 
00581 pa_operation* pa_context_get_sample_info_by_index(pa_context *c, uint32_t idx, pa_sample_info_cb_t cb, void *userdata);
00582 
00584 pa_operation* pa_context_get_sample_info_list(pa_context *c, pa_sample_info_cb_t cb, void *userdata);
00585 
00593 typedef enum pa_autoload_type {
00594     PA_AUTOLOAD_SINK = 0,
00595     PA_AUTOLOAD_SOURCE = 1
00596 } pa_autoload_type_t;
00597 
00601 typedef struct pa_autoload_info {
00602     uint32_t index;               
00603     const char *name;             
00604     pa_autoload_type_t type;      
00605     const char *module;           
00606     const char *argument;         
00607 } pa_autoload_info;
00608 
00610 typedef void (*pa_autoload_info_cb_t)(pa_context *c, const pa_autoload_info *i, int eol, void *userdata);
00611 
00613 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;
00614 
00616 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;
00617 
00619 pa_operation* pa_context_get_autoload_info_list(pa_context *c, pa_autoload_info_cb_t cb, void *userdata) PA_GCC_DEPRECATED;
00620 
00622 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;
00623 
00625 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;
00626 
00628 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;
00629 
00634 PA_C_DECL_END
00635 
00636 #endif