Aravis.UvDevice

g Aravis.Device Aravis.Device Aravis.UvDevice Aravis.UvDevice Aravis.Device->Aravis.UvDevice GObject.GInterface GObject.GInterface Gio.Initable Gio.Initable GObject.GInterface->Gio.Initable GObject.Object GObject.Object GObject.Object->Aravis.Device Gio.Initable->Aravis.Device

Subclasses:

None

Methods

Inherited:

Aravis.Device (33), GObject.Object (37), Gio.Initable (2)

Structs:

GObject.ObjectClass (5)

class

new (vendor, product, serial_number)

class

new_from_guid (guid)

set_usb_mode (usb_mode)

Virtual Methods

Inherited:

Aravis.Device (7), GObject.Object (7), Gio.Initable (1)

Properties

Name

Type

Flags

Short Description

guid

str

w/co

USB3 device GUID

product

str

w/co

USB3 device product string

serial-number

str

w/co

USB3 device serial number

vendor

str

w/co

USB3 device vendor string

Signals

Inherited:

Aravis.Device (1), GObject.Object (1)

Fields

Inherited:

Aravis.Device (1), GObject.Object (1)

Class Details

class Aravis.UvDevice(**kwargs)
Bases:

Aravis.Device

Abstract:

No

Structure:

Aravis.UvDeviceClass

classmethod new(vendor, product, serial_number)
Parameters:
  • vendor (str) – USB3 vendor string

  • product (str) – USB3 product string

  • serial_number (str) – device serial number

Raises:

GLib.Error

Returns:

a newly created Aravis.Device using USB3 based protocol

Return type:

Aravis.Device

New in version 0.8.0.

classmethod new_from_guid(guid)
Parameters:

guid (str) – device GUID

Raises:

GLib.Error

Returns:

a newly created Aravis.Device using USB3 based protocol

Return type:

Aravis.Device

New in version 0.8.17.

set_usb_mode(usb_mode)
Parameters:

usb_mode (Aravis.UvUsbMode) – a Aravis.UvUsbMode option

Sets the option to utilize the USB synchronous or asynchronous device I/O API. The default mode is Aravis.UvUsbMode.SYNC, which means USB bulk transfer will be synchronously executed. This mode is qualified to work, but it has the performance issue with some high framerate device. Using Aravis.UvUsbMode.ASYNC possibly improves the bandwidth.

New in version 0.8.17.

Property Details

Aravis.UvDevice.props.guid
Name:

guid

Type:

str

Default Value:

None

Flags:

WRITABLE, CONSTRUCT_ONLY

USB3 device GUID

Aravis.UvDevice.props.product
Name:

product

Type:

str

Default Value:

None

Flags:

WRITABLE, CONSTRUCT_ONLY

USB3 device product string

Aravis.UvDevice.props.serial_number
Name:

serial-number

Type:

str

Default Value:

None

Flags:

WRITABLE, CONSTRUCT_ONLY

USB3 device serial number

Aravis.UvDevice.props.vendor
Name:

vendor

Type:

str

Default Value:

None

Flags:

WRITABLE, CONSTRUCT_ONLY

USB3 device vendor string