PulseAudio  16.0
ext-device-manager.h File Reference

Routines for controlling module-device-manager. More...

Go to the source code of this file.

Data Structures

struct  pa_ext_device_manager_role_priority_info
 
struct  pa_ext_device_manager_info
 Stores information about one device in the device database that is maintained by module-device-manager. More...
 

Typedefs

typedef struct pa_ext_device_manager_role_priority_info pa_ext_device_manager_role_priority_info
 
typedef struct pa_ext_device_manager_info pa_ext_device_manager_info
 Stores information about one device in the device database that is maintained by module-device-manager. More...
 
typedef void(* pa_ext_device_manager_test_cb_t) (pa_context *c, uint32_t version, void *userdata)
 Callback prototype for pa_ext_device_manager_test(). More...
 
typedef void(* pa_ext_device_manager_read_cb_t) (pa_context *c, const pa_ext_device_manager_info *info, int eol, void *userdata)
 Callback prototype for pa_ext_device_manager_read(). More...
 
typedef void(* pa_ext_device_manager_subscribe_cb_t) (pa_context *c, void *userdata)
 Callback prototype for pa_ext_device_manager_set_subscribe_cb(). More...
 

Functions

pa_operationpa_ext_device_manager_test (pa_context *c, pa_ext_device_manager_test_cb_t cb, void *userdata)
 Test if this extension module is available in the server. More...
 
pa_operationpa_ext_device_manager_read (pa_context *c, pa_ext_device_manager_read_cb_t cb, void *userdata)
 Read all entries from the device database. More...
 
pa_operationpa_ext_device_manager_set_device_description (pa_context *c, const char *device, const char *description, pa_context_success_cb_t cb, void *userdata)
 Sets the description for a device. More...
 
pa_operationpa_ext_device_manager_delete (pa_context *c, const char *const s[], pa_context_success_cb_t cb, void *userdata)
 Delete entries from the device database. More...
 
pa_operationpa_ext_device_manager_enable_role_device_priority_routing (pa_context *c, int enable, pa_context_success_cb_t cb, void *userdata)
 Enable the role-based device-priority routing mode. More...
 
pa_operationpa_ext_device_manager_reorder_devices_for_role (pa_context *c, const char *role, const char **devices, pa_context_success_cb_t cb, void *userdata)
 Prefer a given device in the priority list. More...
 
pa_operationpa_ext_device_manager_subscribe (pa_context *c, int enable, pa_context_success_cb_t cb, void *userdata)
 Subscribe to changes in the device database. More...
 
void pa_ext_device_manager_set_subscribe_cb (pa_context *c, pa_ext_device_manager_subscribe_cb_t cb, void *userdata)
 Set the subscription callback that is called when pa_ext_device_manager_subscribe() was called. More...
 

Detailed Description

Routines for controlling module-device-manager.

Typedef Documentation

◆ pa_ext_device_manager_info

Stores information about one device in the device database that is maintained by module-device-manager.

Since
0.9.21

◆ pa_ext_device_manager_read_cb_t

typedef void(* pa_ext_device_manager_read_cb_t) (pa_context *c, const pa_ext_device_manager_info *info, int eol, void *userdata)

Callback prototype for pa_ext_device_manager_read().

Since
0.9.21

◆ pa_ext_device_manager_role_priority_info

◆ pa_ext_device_manager_subscribe_cb_t

typedef void(* pa_ext_device_manager_subscribe_cb_t) (pa_context *c, void *userdata)

Callback prototype for pa_ext_device_manager_set_subscribe_cb().

Since
0.9.21

◆ pa_ext_device_manager_test_cb_t

typedef void(* pa_ext_device_manager_test_cb_t) (pa_context *c, uint32_t version, void *userdata)

Callback prototype for pa_ext_device_manager_test().

Since
0.9.21

Function Documentation

◆ pa_ext_device_manager_delete()

pa_operation* pa_ext_device_manager_delete ( pa_context c,
const char *const  s[],
pa_context_success_cb_t  cb,
void *  userdata 
)

Delete entries from the device database.

Since
0.9.21

◆ pa_ext_device_manager_enable_role_device_priority_routing()

pa_operation* pa_ext_device_manager_enable_role_device_priority_routing ( pa_context c,
int  enable,
pa_context_success_cb_t  cb,
void *  userdata 
)

Enable the role-based device-priority routing mode.

Since
0.9.21

◆ pa_ext_device_manager_read()

pa_operation* pa_ext_device_manager_read ( pa_context c,
pa_ext_device_manager_read_cb_t  cb,
void *  userdata 
)

Read all entries from the device database.

Since
0.9.21

◆ pa_ext_device_manager_reorder_devices_for_role()

pa_operation* pa_ext_device_manager_reorder_devices_for_role ( pa_context c,
const char *  role,
const char **  devices,
pa_context_success_cb_t  cb,
void *  userdata 
)

Prefer a given device in the priority list.

Since
0.9.21

◆ pa_ext_device_manager_set_device_description()

pa_operation* pa_ext_device_manager_set_device_description ( pa_context c,
const char *  device,
const char *  description,
pa_context_success_cb_t  cb,
void *  userdata 
)

Sets the description for a device.

Since
0.9.21

◆ pa_ext_device_manager_set_subscribe_cb()

void pa_ext_device_manager_set_subscribe_cb ( pa_context c,
pa_ext_device_manager_subscribe_cb_t  cb,
void *  userdata 
)

Set the subscription callback that is called when pa_ext_device_manager_subscribe() was called.

Since
0.9.21

◆ pa_ext_device_manager_subscribe()

pa_operation* pa_ext_device_manager_subscribe ( pa_context c,
int  enable,
pa_context_success_cb_t  cb,
void *  userdata 
)

Subscribe to changes in the device database.

Since
0.9.21

◆ pa_ext_device_manager_test()

pa_operation* pa_ext_device_manager_test ( pa_context c,
pa_ext_device_manager_test_cb_t  cb,
void *  userdata 
)

Test if this extension module is available in the server.

Since
0.9.21