ArvGvDevice

ArvGvDevice — GigEVision device

Functions

ArvDevice * arv_gv_device_new ()
guint64 arv_gv_device_get_timestamp_tick_frequency ()
GSocketAddress * arv_gv_device_get_device_address ()
GSocketAddress * arv_gv_device_get_interface_address ()
guint arv_gv_device_get_packet_size ()
void arv_gv_device_set_packet_size ()
void arv_gv_device_set_packet_size_adjustment ()
ArvGvStreamOption arv_gv_device_get_stream_options ()
void arv_gv_device_set_stream_options ()
guint arv_gv_device_auto_packet_size ()
gboolean arv_gv_device_take_control ()
gboolean arv_gv_device_leave_control ()
gboolean arv_gv_device_is_controller ()

Properties

GInetAddress * device-address Write / Construct Only
GInetAddress * interface-address Write / Construct Only
ArvGvPacketSizeAdjustment packet-size-adjustment Read / Write / Construct

Types and Values

  ArvGvDevice

Object Hierarchy

    GObject
    ╰── ArvDevice
        ╰── ArvGvDevice

Implemented Interfaces

ArvGvDevice implements GInitable.

Description

Functions

arv_gv_device_new ()

ArvDevice *
arv_gv_device_new (GInetAddress *interface_address,
                   GInetAddress *device_address,
                   GError **error);

Parameters

interface_address

address of the interface connected to the device

  

device_address

device address

  

error

a GError placeholder, NULL to ignore

  

Returns

a newly created ArvDevice using GigE protocol

Since: 0.8.0

arv_gv_device_get_timestamp_tick_frequency ()

guint64
arv_gv_device_get_timestamp_tick_frequency
                               (ArvGvDevice *gv_device,
                                GError **error);

arv_gv_device_get_device_address ()

GSocketAddress *
arv_gv_device_get_device_address (ArvGvDevice *device);

Parameters

device

a ArvGvDevice

  

Returns

the device IP address.

[transfer none]

Since: 0.2.0

arv_gv_device_get_interface_address ()

GSocketAddress *
arv_gv_device_get_interface_address (ArvGvDevice *device);

Parameters

device

a ArvGvDevice

  

Returns

the device host interface IP address.

[transfer none]

Since: 0.2.0

arv_gv_device_get_packet_size ()

guint
arv_gv_device_get_packet_size (ArvGvDevice *gv_device,
                               GError **error);

arv_gv_device_set_packet_size ()

void
arv_gv_device_set_packet_size (ArvGvDevice *gv_device,
                               gint packet_size,
                               GError **error);

arv_gv_device_set_packet_size_adjustment ()

void
arv_gv_device_set_packet_size_adjustment
                               (ArvGvDevice *gv_device,
                                ArvGvPacketSizeAdjustment adjustment);

Sets the option for the packet size adjustment happening at stream object creation. See arv_gv_device_auto_packet_size() for a description of the packet adjustment feature. The default behaviour is ARV_GV_PACKET_SIZE_ADJUSTEMENT_ON_FAILURE_ONCE , which means the packet size is adjusted if the current packet size check fails, and only the first time arv_device_create_stream() is successfully called during gv_device instance life.

Parameters

gv_device

a ArvGvDevice

  

adjustment

a ArvGvPacketSizeAdjustment option

  

Since: 0.8.3

arv_gv_device_get_stream_options ()

ArvGvStreamOption
arv_gv_device_get_stream_options (ArvGvDevice *gv_device);

Parameters

gv_device

a ArvGvDevice

  

Returns

options for stream creation

Since: 0.6.0

arv_gv_device_set_stream_options ()

void
arv_gv_device_set_stream_options (ArvGvDevice *gv_device,
                                  ArvGvStreamOption options);

Sets the option used during stream creation. It must be called before arv_device_create_stream().

Parameters

gv_device

a ArvGvDevice

  

options

options for stream creation

  

Since: 0.6.0

arv_gv_device_auto_packet_size ()

guint
arv_gv_device_auto_packet_size (ArvGvDevice *gv_device,
                                GError **error);

Automatically determine the biggest packet size that can be used data streaming, and set GevSCPSPacketSize value accordingly. This function relies on the GevSCPSFireTestPacket feature.

Parameters

gv_device

a ArvGvDevice

  

error

a GError placeholder, NULL to ignore

  

Returns

The automatic packet size, in bytes, or the current one if GevSCPSFireTestPacket is not supported.

Since: 0.6.0

arv_gv_device_take_control ()

gboolean
arv_gv_device_take_control (ArvGvDevice *gv_device,
                            GError **error);

Parameters

gv_device

a ArvGvDevice

  

error

a GError placeholder, NULL to ignore

  

Returns

whether the control was successfully acquired

Since: 0.8.3

arv_gv_device_leave_control ()

gboolean
arv_gv_device_leave_control (ArvGvDevice *gv_device,
                             GError **error);

Parameters

gv_device

a ArvGvDevice

  

error

a GError placeholder, NULL to ignore

  

Returns

whether the control was successfully relinquished

Since: 0.8.3

arv_gv_device_is_controller ()

gboolean
arv_gv_device_is_controller (ArvGvDevice *gv_device);

Parameters

gv_device

a ArvGvDevice

  

Returns

value indicating whether the ArvGvDevice has control access to the camera

Since: 0.8.0

Types and Values

ArvGvDevice

typedef struct _ArvGvDevice ArvGvDevice;

Property Details

The “device-address” property

  “device-address”           GInetAddress *

The device address.

Owner: ArvGvDevice

Flags: Write / Construct Only

The “interface-address” property

  “interface-address”        GInetAddress *

The address of the interface connected to the device.

Owner: ArvGvDevice

Flags: Write / Construct Only

The “packet-size-adjustment” property

  “packet-size-adjustment”   ArvGvPacketSizeAdjustment

Packet size adjustment option.

Owner: ArvGvDevice

Flags: Read / Write / Construct

Default value: ARV_GV_PACKET_SIZE_ADJUSTMENT_ON_FAILURE_ONCE

Generated by GTK-Doc V1.33.1