spice_usb_device_manager_get ()

SpiceUsbDeviceManager *
spice_usb_device_manager_get (SpiceSession *session,
                              GError **err);

Gets the SpiceUsbDeviceManager associated with the passed in SpiceSession. A new SpiceUsbDeviceManager instance will be created the first time this function is called for a certain SpiceSession.

Note that this function returns a weak reference, which should not be used after the SpiceSession itself has been unref-ed by the caller.

spice_usb_device_manager_get_devices ()

GPtrArray *
spice_usb_device_manager_get_devices (SpiceUsbDeviceManager *manager);

Finds devices associated with the manager

spice_usb_device_manager_get_devices_with_filter ()

GPtrArray *
spice_usb_device_manager_get_devices_with_filter
                               (SpiceUsbDeviceManager *manager,
                                const gchar *filter);

Finds devices associated with the manager complying with the filter

Since 0.20

spice_usb_device_manager_is_device_connected ()

gboolean
spice_usb_device_manager_is_device_connected
                               (SpiceUsbDeviceManager *manager,
                                SpiceUsbDevice *device);

Finds if the device is connected.

spice_usb_device_manager_disconnect_device ()

void
spice_usb_device_manager_disconnect_device
                               (SpiceUsbDeviceManager *manager,
                                SpiceUsbDevice *device);

Disconnects the device .

spice_usb_device_manager_can_redirect_device ()

gboolean
spice_usb_device_manager_can_redirect_device
                               (SpiceUsbDeviceManager *self,
                                SpiceUsbDevice *device,
                                GError **err);

Checks whether it is possible to redirect the device .

spice_usb_device_manager_connect_device_async ()

void
spice_usb_device_manager_connect_device_async
                               (SpiceUsbDeviceManager *self,
                                SpiceUsbDevice *device,
                                GCancellable *cancellable,
                                GAsyncReadyCallback callback,
                                gpointer user_data);

Asynchronously connects the device . When completed, callback will be called. Then it is possible to call spice_usb_device_manager_connect_device_finish() to get the result of the operation.

spice_usb_device_manager_connect_device_finish ()

gboolean
spice_usb_device_manager_connect_device_finish
                               (SpiceUsbDeviceManager *self,
                                GAsyncResult *res,
                                GError **err);

Finishes an async operation. See spice_usb_device_manager_connect_device_async().

spice_usb_device_get_description ()

gchar *
spice_usb_device_get_description (SpiceUsbDevice *device,
                                  const gchar *format);

Get a string describing the device which is suitable as a description of the device for the end user. The returned string should be freed with g_free() when no longer needed.

The format positional parameters are the following:

(the default format string is "%s %s %s at %d-%d")

spice_usb_device_get_libusb_device ()

gconstpointer
spice_usb_device_get_libusb_device (const SpiceUsbDevice *device);

Finds the libusb_device associated with the device .

Since 0.27

struct SpiceUsbDeviceManager

struct SpiceUsbDeviceManager;

The SpiceUsbDeviceManager struct is opaque and should not be accessed directly.

struct SpiceUsbDeviceManagerClass

struct SpiceUsbDeviceManagerClass {
    GObjectClass parent_class;

    /* signals */
    void (*device_added) (SpiceUsbDeviceManager *manager,
                          SpiceUsbDevice *device);
    void (*device_removed) (SpiceUsbDeviceManager *manager,
                            SpiceUsbDevice *device);
    void (*auto_connect_failed) (SpiceUsbDeviceManager *manager,
                                 SpiceUsbDevice *device, GError *error);
    void (*device_error) (SpiceUsbDeviceManager *manager,
                          SpiceUsbDevice *device, GError *error);
};

Class structure for SpiceUsbDeviceManager.

SpiceUsbDevice

typedef struct _SpiceUsbDevice SpiceUsbDevice;

The SpiceUsbDevice struct is opaque and cannot be accessed directly.

The “auto-connect” property

  “auto-connect”             gboolean

Set this to TRUE to automatically redirect newly plugged in device.

Note when SpiceGtkSession's auto-usbredir property is TRUE, this property is controlled by SpiceGtkSession.

Flags: Read / Write

Default value: FALSE

The “auto-connect-filter” property

  “auto-connect-filter”      gchar *

Set a string specifying a filter to use to determine which USB devices to autoconnect when plugged in, a filter consists of one or more rules. Where each rule has the form of:

class ,vendor ,product ,version ,allow

Use -1 for class /vendor /product /version to accept any value.

And the rules themselves are concatenated like this:

rule1 |rule2 |rule3

The default setting filters out HID (class 0x03) USB devices from auto connect and auto connects anything else. Note the explicit allow rule at the end, this is necessary since by default all devices without a matching filter rule will not auto-connect.

Filter strings in this format can be easily created with the RHEV-M USB filter editor tool.

Flags: Read / Write / Construct

Default value: "0x03,-1,-1,-1,0|-1,-1,-1,-1,1"

The “redirect-on-connect” property

  “redirect-on-connect”      gchar *

Set a string specifying a filter selecting USB devices to automatically redirect after a Spice connection has been established.

See “auto-connect-filter” for the filter string format.

Flags: Read / Write

Default value: NULL

The “session” property

  “session”                  SpiceSession *

SpiceSession this SpiceUsbDeviceManager is associated with

Flags: Read / Write / Construct Only

The “auto-connect-failed” signal

void
user_function (SpiceUsbDeviceManager *manager,
               SpiceUsbDevice        *device,
               GError                *error,
               gpointer               user_data)

The “auto-connect-failed” signal is emitted whenever the auto-connect property is true, and a newly plugged in device could not be auto-connected.

Flags: Run First

The “device-added” signal

void
user_function (SpiceUsbDeviceManager *manager,
               SpiceUsbDevice        *device,
               gpointer               user_data)

The “device-added” signal is emitted whenever a new USB device has been plugged in.

Flags: Run First

The “device-error” signal

void
user_function (SpiceUsbDeviceManager *manager,
               SpiceUsbDevice        *device,
               GError                *error,
               gpointer               user_data)

The “device-error” signal is emitted whenever an error happens which causes a device to no longer be available to the guest.

Flags: Run First

The “device-removed” signal

void
user_function (SpiceUsbDeviceManager *manager,
               SpiceUsbDevice        *device,
               gpointer               user_data)

The “device-removed” signal is emitted whenever an USB device has been removed.

Flags: Run First