code.delx.au - pulseaudio/blob - src/pulse/ext-device-manager.h

   1 #ifndef foopulseextdevicemanagerhfoo
   2 #define foopulseextdevicemanagerhfoo
   3
   4 /***
   5   This file is part of PulseAudio.
   6
   7   Copyright 2008 Lennart Poettering
   8   Copyright 2009 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, write to the Free Software
  22   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  23   USA.
  24 ***/
  25
  26 #include <pulse/cdecl.h>
  27 #include <pulse/context.h>
  28 #include <pulse/version.h>
  29
  30 /** \file
  31  *
  32  * Routines for controlling module-device-manager
  33  */
  34
  35 PA_C_DECL_BEGIN
  36
  37 typedef struct pa_ext_device_manager_role_priority_info {
  38     const char *role;
  39     uint32_t priority;
  40 } pa_ext_device_manager_role_priority_info;
  41
  42 /** Stores information about one device in the device database that is
  43  * maintained by module-device-manager. \since 0.9.21 */
  44 typedef struct pa_ext_device_manager_info {
  45     const char *name;            /**< Identifier string of the device. A string like "sink:" or similar followed by the name of the device. */
  46     const char *description;     /**< The description of the device when it was last seen, if applicable and saved */
  47     const char *icon;            /**< The icon given to the device */
  48     uint32_t index;              /**< The device index if it is currently available or PA_INVALID_INDEX */
  49     uint32_t n_role_priorities;  /**< How many role priorities do we have? */
  50     pa_ext_device_manager_role_priority_info *role_priorities; /**< An array of role priority structures or NULL */
  51 } pa_ext_device_manager_info;
  52
  53 /** Callback prototype for pa_ext_device_manager_test(). \since 0.9.21 */
  54 typedef void (*pa_ext_device_manager_test_cb_t)(
  55         pa_context *c,
  56         uint32_t version,
  57         void *userdata);
  58
  59 /** Test if this extension module is available in the server. \since 0.9.21 */
  60 pa_operation *pa_ext_device_manager_test(
  61         pa_context *c,
  62         pa_ext_device_manager_test_cb_t cb,
  63         void *userdata);
  64
  65 /** Callback prototype for pa_ext_device_manager_read(). \since 0.9.21 */
  66 typedef void (*pa_ext_device_manager_read_cb_t)(
  67         pa_context *c,
  68         const pa_ext_device_manager_info *info,
  69         int eol,
  70         void *userdata);
  71
  72 /** Read all entries from the device database. \since 0.9.21 */
  73 pa_operation *pa_ext_device_manager_read(
  74         pa_context *c,
  75         pa_ext_device_manager_read_cb_t cb,
  76         void *userdata);
  77
  78 /** Sets the description for a device. \since 0.9.21 */
  79 pa_operation *pa_ext_device_manager_set_device_description(
  80         pa_context *c,
  81         const char* device,
  82         const char* description,
  83         pa_context_success_cb_t cb,
  84         void *userdata);
  85
  86 /** Delete entries from the device database. \since 0.9.21 */
  87 pa_operation *pa_ext_device_manager_delete(
  88         pa_context *c,
  89         const char *const s[],
  90         pa_context_success_cb_t cb,
  91         void *userdata);
  92
  93 /** Enable the role-based device-priority routing mode. \since 0.9.21 */
  94 pa_operation *pa_ext_device_manager_enable_role_device_priority_routing(
  95         pa_context *c,
  96         int enable,
  97         pa_context_success_cb_t cb,
  98         void *userdata);
  99
 100 /** Prefer a given device in the priority list. \since 0.9.21 */
 101 pa_operation *pa_ext_device_manager_reorder_devices_for_role(
 102         pa_context *c,
 103         const char* role,
 104         const char** devices,
 105         pa_context_success_cb_t cb,
 106         void *userdata);
 107
 108 /** Subscribe to changes in the device database. \since 0.9.21 */
 109 pa_operation *pa_ext_device_manager_subscribe(
 110         pa_context *c,
 111         int enable,
 112         pa_context_success_cb_t cb,
 113         void *userdata);
 114
 115 /** Callback prototype for pa_ext_device_manager_set_subscribe_cb(). \since 0.9.21 */
 116 typedef void (*pa_ext_device_manager_subscribe_cb_t)(
 117         pa_context *c,
 118         void *userdata);
 119
 120 /** Set the subscription callback that is called when
 121  * pa_ext_device_manager_subscribe() was called. \since 0.9.21 */
 122 void pa_ext_device_manager_set_subscribe_cb(
 123         pa_context *c,
 124         pa_ext_device_manager_subscribe_cb_t cb,
 125         void *userdata);
 126
 127 PA_C_DECL_END
 128
 129 #endif