browser.h File Reference

An abstract interface for Zeroconf browsing of PulseAudio servers. More...

Go to the source code of this file.

Data Structures

struct  pa_browse_info
 Information about a sink/source/server found with Zeroconf. More...

Typedefs

typedef pa_browser pa_browser
 An opaque Zeroconf service browser object.
typedef enum pa_browse_opcode pa_browse_opcode_t
 Opcodes for pa_browser_cb_t callbacks.
typedef enum pa_browse_flags pa_browse_flags_t
typedef void(*) pa_browse_cb_t (pa_browser *z, pa_browse_opcode_t c, const pa_browse_info *i, void *userdata)
 Callback prototype.
typedef void(*) pa_browser_error_cb_t (pa_browser *z, const char *error_string, void *userdata)
 Callback prototype for errors.

Enumerations

enum  pa_browse_opcode {
  PA_BROWSE_NEW_SERVER = 0,
  PA_BROWSE_NEW_SINK,
  PA_BROWSE_NEW_SOURCE,
  PA_BROWSE_REMOVE_SERVER,
  PA_BROWSE_REMOVE_SINK,
  PA_BROWSE_REMOVE_SOURCE
}
 Opcodes for pa_browser_cb_t callbacks. More...
enum  pa_browse_flags {
  PA_BROWSE_FOR_SERVERS = 1,
  PA_BROWSE_FOR_SINKS = 2,
  PA_BROWSE_FOR_SOURCES = 4
}

Functions

pa_browserpa_browser_new (pa_mainloop_api *mainloop)
 Create a new browser object on the specified main loop.
pa_browserpa_browser_new_full (pa_mainloop_api *mainloop, pa_browse_flags_t flags, const char **error_string)
 Same pa_browser_new, but pass additional flags parameter.
pa_browserpa_browser_ref (pa_browser *z)
 Increase reference counter of the specified browser object.
void pa_browser_unref (pa_browser *z)
 Decrease reference counter of the specified browser object.
void pa_browser_set_callback (pa_browser *z, pa_browse_cb_t cb, void *userdata)
 Set the callback pointer for the browser object.
void pa_browser_set_error_callback (pa_browser *z, pa_browser_error_cb_t, void *userdata)
 Set a callback function that is called whenever the browser object becomes invalid due to an error.


Detailed Description

An abstract interface for Zeroconf browsing of PulseAudio servers.


Typedef Documentation

typedef void(*) pa_browse_cb_t(pa_browser *z, pa_browse_opcode_t c, const pa_browse_info *i, void *userdata)

Callback prototype.

typedef enum pa_browse_flags pa_browse_flags_t

typedef enum pa_browse_opcode pa_browse_opcode_t

Opcodes for pa_browser_cb_t callbacks.

typedef struct pa_browser pa_browser

An opaque Zeroconf service browser object.

typedef void(*) pa_browser_error_cb_t(pa_browser *z, const char *error_string, void *userdata)

Callback prototype for errors.


Enumeration Type Documentation

enum pa_browse_flags

Enumerator:
PA_BROWSE_FOR_SERVERS  Browse for servers.
PA_BROWSE_FOR_SINKS  Browse for sinks.
PA_BROWSE_FOR_SOURCES 

enum pa_browse_opcode

Opcodes for pa_browser_cb_t callbacks.

Enumerator:
PA_BROWSE_NEW_SERVER  New server found.
PA_BROWSE_NEW_SINK  New sink found.
PA_BROWSE_NEW_SOURCE  New source found.
PA_BROWSE_REMOVE_SERVER  Server disappeared.
PA_BROWSE_REMOVE_SINK  Sink disappeared.
PA_BROWSE_REMOVE_SOURCE  Source disappeared.


Function Documentation

pa_browser* pa_browser_new ( pa_mainloop_api mainloop  ) 

Create a new browser object on the specified main loop.

pa_browser* pa_browser_new_full ( pa_mainloop_api mainloop,
pa_browse_flags_t  flags,
const char **  error_string 
)

Same pa_browser_new, but pass additional flags parameter.

pa_browser* pa_browser_ref ( pa_browser z  ) 

Increase reference counter of the specified browser object.

void pa_browser_set_callback ( pa_browser z,
pa_browse_cb_t  cb,
void *  userdata 
)

Set the callback pointer for the browser object.

void pa_browser_set_error_callback ( pa_browser z,
pa_browser_error_cb_t  ,
void *  userdata 
)

Set a callback function that is called whenever the browser object becomes invalid due to an error.

After this function has been called the browser object has become invalid and should be freed.

void pa_browser_unref ( pa_browser z  ) 

Decrease reference counter of the specified browser object.


Generated on Tue Apr 24 02:06:15 2012 for PulseAudio by  doxygen 1.4.7