src/pulse/ext-stream-restore.h

   1 #ifndef foopulseextstreamrestorehfoo
   2 #define foopulseextstreamrestorehfoo
   3
   4 /***
   5   This file is part of PulseAudio.
   6
   7   Copyright 2008 Lennart Poettering
   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 <pulse/context.h>
  26 #include <pulse/version.h>
  27
  28 /** \file
  29  *
  30  * Routines for controlling module-stream-restore
  31  */
  32
  33 PA_C_DECL_BEGIN
  34
  35 /** Stores information about one entry in the stream database that is
  36  * maintained by module-stream-restore. \since 0.9.12 */
  37 typedef struct pa_ext_stream_restore_info {
  38     const char *name;            /**< Identifier string of the stream. A string like "sink-input-by-role:" or similar followed by some arbitrary property value. */
  39     pa_channel_map channel_map;  /**< The channel map for the volume field */
  40     pa_cvolume volume;           /**< The volume of the stream when it was seen last, if applicable */
  41     const char *device;          /**< The sink/source of the stream when it was last seen */
  42     int mute;                    /**< The boolean mute state of the stream when it was last seen, if applicable */
  43 } pa_ext_stream_restore_info;
  44
  45 /** Callback prototype for pa_ext_stream_restore_test(). \since 0.9.12 */
  46 typedef void (*pa_ext_stream_restore_test_cb_t)(
  47         pa_context *c,
  48         uint32_t version,
  49         void *userdata);
  50
  51 /** Test if this extension module is available in the server. \since 0.9.12 */
  52 pa_operation *pa_ext_stream_restore_test(
  53         pa_context *c,
  54         pa_ext_stream_restore_test_cb_t cb,
  55         void *userdata);
  56
  57 /** Callback prototype for pa_ext_stream_restore_read(). \since 0.9.12 */
  58 typedef void (*pa_ext_stream_restore_read_cb_t)(
  59         pa_context *c,
  60         const pa_ext_stream_restore_info *info,
  61         int eol,
  62         void *userdata);
  63
  64 /** Read all entries from the stream database. \since 0.9.12 */
  65 pa_operation *pa_ext_stream_restore_read(
  66         pa_context *c,
  67         pa_ext_stream_restore_read_cb_t cb,
  68         void *userdata);
  69
  70 /** Store entries in the stream database. \since 0.9.12 */
  71 pa_operation *pa_ext_stream_restore_write(
  72         pa_context *c,
  73         pa_update_mode_t mode,
  74         const pa_ext_stream_restore_info data[],
  75         unsigned n,
  76         int apply_immediately,
  77         pa_context_success_cb_t cb,
  78         void *userdata);
  79
  80 /** Delete entries from the stream database. \since 0.9.12 */
  81 pa_operation *pa_ext_stream_restore_delete(
  82         pa_context *c,
  83         const char *const s[],
  84         pa_context_success_cb_t cb,
  85         void *userdata);
  86
  87 /** Subscribe to changes in the stream database. \since 0.9.12 */
  88 pa_operation *pa_ext_stream_restore_subscribe(
  89         pa_context *c,
  90         int enable,
  91         pa_context_success_cb_t cb,
  92         void *userdata);
  93
  94 /** Callback prototype for pa_ext_stream_restore_set_subscribe_cb(). \since 0.9.12 */
  95 typedef void (*pa_ext_stream_restore_subscribe_cb_t)(
  96         pa_context *c,
  97         void *userdata);
  98
  99 /** Set the subscription callback that is called when
 100  * pa_ext_stream_restore_subscribe() was called. \since 0.9.12 */
 101 void pa_ext_stream_restore_set_subscribe_cb(
 102         pa_context *c,
 103         pa_ext_stream_restore_subscribe_cb_t cb,
 104         void *userdata);
 105
 106 PA_C_DECL_END
 107
 108 #endif