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