ArvInterface

ArvInterface — Abstract base class for camera discovery

Functions

Types and Values

Object Hierarchy

    GObject
    ╰── ArvInterface
        ├── ArvFakeInterface
        ╰── ArvGvInterface

Description

ArvCamera is an abstract base class for camera discovery. It maintains a list of the available devices and help to instantiate the corresponding ArvDevice object. If 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().

Functions

arv_get_device_id ()

const char *
arv_get_device_id (unsigned int index);

arv_get_interface_id ()

const char *
arv_get_interface_id (unsigned int index);

arv_disable_interface ()

void
arv_disable_interface (const char *interface_id);

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

Parameters

interface_id

name of the interface

 

arv_enable_interface ()

void
arv_enable_interface (const char *interface_id);

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

Parameters

interface_id

name of the interface

 

arv_get_n_devices ()

unsigned int
arv_get_n_devices (void);

arv_get_n_interfaces ()

unsigned int
arv_get_n_interfaces (void);

arv_update_device_list ()

void
arv_update_device_list (void);

arv_open_device ()

ArvDevice *
arv_open_device (const char *device_id);

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

Parameters

device_id

a device identifier string.

[allow-none]

Returns

a new ArvDevice instance.

[transfer full]


arv_shutdown ()

void
arv_shutdown (void);

arv_interface_update_device_list ()

void
arv_interface_update_device_list (ArvInterface *interface);

Updates the internal list of available devices. This may change the connection between a list index and a device ID.

Parameters

interface

a ArvInterface

 

Since: 0.2.0


arv_interface_get_device_id ()

const char *
arv_interface_get_device_id (ArvInterface *interface,
                             unsigned int index);

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

Parameters

interface

a ArvInterface

 

index

device index

 

Returns

a unique device id

Since: 0.2.0


arv_interface_get_device_physical_id ()

const char *
arv_interface_get_device_physical_id (ArvInterface *interface,
                                      unsigned int index);

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.

Prior to this call the arv_interface_update_device_list function must be called.

Parameters

interface

a ArvInterface

 

index

device index

 

Returns

a physical device id

Since: 0.2.0


arv_interface_get_device_address ()

const char *
arv_interface_get_device_address (ArvInterface *interface,
                                  unsigned int index);

queries the device address (IP address in the case of an ethernet camera). Useful for constructing manual connections to devices using arv_gv_device_new

Prior to this call the arv_interface_update_device_list function must be called.

Parameters

interface

a ArvInterface

 

index

device index

 

Returns

the device address.

[transfer none]

Since: 0.2.0


arv_interface_get_n_devices ()

unsigned int
arv_interface_get_n_devices (ArvInterface *interface);

Queries the number of available devices on this interface. Prior to this call the arv_interface_update_device_list function must be called. The list content will not change until the next call of the update function.

Parameters

interface

a ArvInterface

 

Returns

the number of available devices

Since: 0.2.0


arv_interface_open_device ()

ArvDevice *
arv_interface_open_device (ArvInterface *interface,
                           const char *device_id);

Creates a new ArvDevice object corresponding to the given device id string. The first available device is returned if device_id is null.

Parameters

interface

a ArvInterface

 

device_id

device unique id.

[allow-none]

Returns

a new ArvDevice.

[transfer full]

Since: 0.2.0

Types and Values

ArvInterface

typedef struct _ArvInterface ArvInterface;