code.delx.au - pulseaudio/blob - src/pulse/subscribe.h

   1 #ifndef foosubscribehfoo
   2 #define foosubscribehfoo
   3
   4 /* $Id$ */
   5
   6 /***
   7   This file is part of PulseAudio.
   8
   9   PulseAudio is free software; you can redistribute it and/or modify
  10   it under the terms of the GNU Lesser General Public License as published
  11   by the Free Software Foundation; either version 2 of the License,
  12   or (at your option) any later version.
  13
  14   PulseAudio is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public License
  20   along with PulseAudio; if not, write to the Free Software
  21   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  22   USA.
  23 ***/
  24
  25 #include <inttypes.h>
  26
  27 #include <pulse/def.h>
  28 #include <pulse/context.h>
  29 #include <pulse/cdecl.h>
  30
  31 /** \page subscribe Event Subscription
  32  *
  33  * \section overv_sec Overview
  34  *
  35  * The application can be notified, asynchronously, whenever the internal
  36  * layout of the server changes. Possible notifications are desribed in the
  37  * \ref pa_subscription_event_type and \ref pa_subscription_mask
  38  * enumerations.
  39  *
  40  * The application sets the notification mask using pa_context_subscribe()
  41  * and the function that will be called whenever a notification occurs using
  42  * pa_context_set_subscribe_callback().
  43  */
  44
  45 /** \file
  46  * Daemon introspection event subscription subsystem. */
  47
  48 PA_C_DECL_BEGIN
  49
  50 /** Subscription event callback prototype */
  51 typedef void (*pa_context_subscribe_cb_t)(pa_context *c, pa_subscription_event_type_t t, uint32_t idx, void *userdata);
  52
  53 /** Enable event notification */
  54 pa_operation* pa_context_subscribe(pa_context *c, pa_subscription_mask_t m, pa_context_success_cb_t cb, void *userdata);
  55
  56 /** Set the context specific call back function that is called whenever the state of the daemon changes */
  57 void pa_context_set_subscribe_callback(pa_context *c, pa_context_subscribe_cb_t cb, void *userdata);
  58
  59 PA_C_DECL_END
  60
  61 #endif