Aravis – 0.8

ArvBuffer provides a class for the instantiation of buffers used for the storage of the separate images of the video stream.

ArvCamera is a class for the generic control of cameras. It hides the complexity of the genicam interface by providing a simple API, with the drawback of not exposing all the available features. See ArvDevice and ArvGc for a more advanced use of the Aravis library.

ArvChunkParser provides a class for the instantiation of chunk parsers used for the extraction of chunk data stored in the stream payload.

ArvDevice is an abstract base class for the control of cameras. It provides an easy access to the camera settings, and to its genicam interface for more advanced uses.

ArvFakeCamera is a class that simulate a real camera, which provides methods for the implementation of ArvFakeDevice and ArvFakeStream.

ArvGc implements the root document for the storage of the Genicam feature nodes. It builds the node tree by parsing an xml file in the Genicam standard format. See http://www.genicam.org.

ArvGcFeatureNode provides a base class for the implementation of the different types of Genicam feature node (Group, Integer, Float, Enumeration…).

ArvGcNode provides a base class for the implementation of the different types of Genicam nodes.

ArvGcPropertyNode provides a base class for the implementation of the different types of Genicam property nodes (Value, pValue, Endianness…).

ArvGvFakeCamera is a class that simulates a real GigEVision camera.

ArvInterface is an abstract base class for camera discovery. It maintains a list of the available devices and helps to instantiate the corresponding ArvDevice objects. If the user already knows the device id of the device, he should not worry about this class and just use arv_camera_new() or arv_open_device().

ArvStream provides an abstract base class for the implementation of video stream reception threads. The interface between the reception thread and the main thread is done using asynchronous queues, containing ArvBuffer objects.

A datatype to hold a pixel format.

since: 0.8.6

Specifies access mode for feature nodes and registers.

Specifies caching mode for register values.

Number display notations for showing numbers in user interfaces.

since: 0.8.0

Describes relationship between TO and FROM variables in Converter feature nodes.

Specifies feature node or register name space type. Standard name space features are listed in Genicam materials. Any other vendor-specific features should use custom name space type.

Number representation formats.

since: 0.8.0

Specifies signedness of integer registers. Per standard Genicam internally uses signed 64-bit signed integers for representing all integer registers. Therefore unsigned 64-bit integers are not available.

Denotes that the corresponding feature is prepared to be stored to and loaded from a file via the node tree. The idea is to persist the state of a camera by storing the features marked as Streamable and restore the state by writing those features back to the node tree.

since: 0.8.8

Specifies feature node recommended visibility in user interfaces.

since: 0.8.6

since: 0.8.0

Describes when the reason the stream callback is called. You are probably more interested in ARV_STREAM_CALLBACK_TYPE_INIT and ARV_STREAM_CALLBACK_TYPE_BUFFER_DONE.

since: 0.8.23

This is the signature of the callback passed on an ArvStream instantiation, which will be called on the stream receiving thread initialization and finalization, and on every received buffer, once when the buffer is pulled from the buffer queue, and one more when the buffer is done (successfully or not).

Configures the debug output using a configuration string consisting of a comma separated list of debug categories or category/debug level pair.

since: 0.8.8

Disable an interface by name. By default, all interfaces are enabled, except ‘Fake’.

Create a new DOM document. Currently, only qualified_name is used.

Enable an interface by name. By default, all interfaces are enabled, except ‘Fake’.

The index of a device may change after a call to arv_update_device_list().

since: 0.6.0

Queries the unique device id corresponding to index. Prior to this call the arv_update_device_list() function must be called.

since: 0.2.0

Queries the device manufacturer info.

since: 0.8.20

Queries the device model.

since: 0.6.0

Queries the physical device id corresponding to index such as the MAC address for Ethernet based devices, bus id for PCI, USB or Firewire based devices.

since: 0.2.0

The index of a device may change after a call to arv_update_device_list().

since: 0.6.0

Queries the device serial.

since: 0.6.0

Queries the device vendor.

since: 0.6.0

Retrieves the interface identifier. Possible values are ‘Fake’, ‘USB3Vision’ and ‘GigEVision’.

Retrieves the number of currently online devices. This value is valid until the next call to arv_update_device_list().

Gets the number of available interfaces, including the disabled ones.

since: 0.4.0

since: 0.4.0

Open a device corresponding to the given identifier. A NULL string makes this function return the first available device.

since: 0.8.0

Set the device specific flags.

since: 0.8.23

Frees a number of ressources allocated by Aravis that would be otherwise reported as memory leak by tools like Valgrind. The call to this function is optional if you don’t intend to check for memory leaks.

Updates the list of currently online devices.