1 #ifndef foopulseextdevicerestorehfoo 2 #define foopulseextdevicerestorehfoo 3 4 /*** 5 This file is part of PulseAudio. 6 7 Copyright 2008 Lennart Poettering 8 Copyright 2011 Colin Guthrie 9 10 PulseAudio is free software; you can redistribute it and/or modify 11 it under the terms of the GNU Lesser General Public License as published 12 by the Free Software Foundation; either version 2.1 of the License, 13 or (at your option) any later version. 14 15 PulseAudio is distributed in the hope that it will be useful, but 16 WITHOUT ANY WARRANTY; without even the implied warranty of 17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 18 General Public License for more details. 19 20 You should have received a copy of the GNU Lesser General Public License 21 along with PulseAudio; if not, see <http://www.gnu.org/licenses/>. 22 ***/ 23 24 #include <pulse/context.h> 25 #include <pulse/format.h> 26 #include <pulse/version.h> 27 28 /** \file 29 * 30 * Routines for controlling module-device-restore 31 */ 32 33 PA_C_DECL_BEGIN 34 35 /** Stores information about one device in the device database that is 36 * maintained by module-device-manager. \since 1.0 */ 37 typedef struct pa_ext_device_restore_info { 38 pa_device_type_t type; /**< Device type sink or source? */ 39 uint32_t index; /**< The device index */ 40 uint8_t n_formats; /**< How many formats do we have? */ 41 pa_format_info **formats; /**< An array of formats (may be NULL if n_formats == 0) */ 42 } pa_ext_device_restore_info; 43 44 /** Callback prototype for pa_ext_device_restore_test(). \since 1.0 */ 45 typedef void (*pa_ext_device_restore_test_cb_t)( 46 pa_context *c, 47 uint32_t version, 48 void *userdata); 49 50 /** Test if this extension module is available in the server. \since 1.0 */ 51 pa_operation *pa_ext_device_restore_test( 52 pa_context *c, 53 pa_ext_device_restore_test_cb_t cb, 54 void *userdata); 55 56 /** Subscribe to changes in the device database. \since 1.0 */ 57 pa_operation *pa_ext_device_restore_subscribe( 58 pa_context *c, 59 int enable, 60 pa_context_success_cb_t cb, 61 void *userdata); 62 63 /** Callback prototype for pa_ext_device_restore_set_subscribe_cb(). \since 1.0 */ 64 typedef void (*pa_ext_device_restore_subscribe_cb_t)( 65 pa_context *c, 66 pa_device_type_t type, 67 uint32_t idx, 68 void *userdata); 69 70 /** Set the subscription callback that is called when 71 * pa_ext_device_restore_subscribe() was called. \since 1.0 */ 72 void pa_ext_device_restore_set_subscribe_cb( 73 pa_context *c, 74 pa_ext_device_restore_subscribe_cb_t cb, 75 void *userdata); 76 77 /** Callback prototype for pa_ext_device_restore_read_formats(). \since 1.0 */ 78 typedef void (*pa_ext_device_restore_read_device_formats_cb_t)( 79 pa_context *c, 80 const pa_ext_device_restore_info *info, 81 int eol, 82 void *userdata); 83 84 /** Read the formats for all present devices from the device database. \since 1.0 */ 85 pa_operation *pa_ext_device_restore_read_formats_all( 86 pa_context *c, 87 pa_ext_device_restore_read_device_formats_cb_t cb, 88 void *userdata); 89 90 /** Read an entry from the device database. \since 1.0 */ 91 pa_operation *pa_ext_device_restore_read_formats( 92 pa_context *c, 93 pa_device_type_t type, 94 uint32_t idx, 95 pa_ext_device_restore_read_device_formats_cb_t cb, 96 void *userdata); 97 98 /** Read an entry from the device database. \since 1.0 */ 99 pa_operation *pa_ext_device_restore_save_formats( 100 pa_context *c, 101 pa_device_type_t type, 102 uint32_t idx, 103 uint8_t n_formats, 104 pa_format_info **formats, 105 pa_context_success_cb_t cb, 106 void *userdata); 107 108 PA_C_DECL_END 109 110 #endif 111