ArvCamera

ArvCamera — Class for generic camera control

Functions

#define ARAVIS_CHECK_VERSION()
ArvAuto arv_auto_from_string ()
const char * arv_auto_to_string ()
ArvCamera * arv_camera_new ()
ArvStream * arv_camera_create_stream ()
ArvDevice * arv_camera_get_device ()
const char * arv_camera_get_vendor_name ()
const char * arv_camera_get_model_name ()
const char * arv_camera_get_device_id ()
void arv_camera_get_sensor_size ()
void arv_camera_set_region ()
void arv_camera_get_region ()
void arv_camera_get_x_offset_bounds ()
void arv_camera_get_y_offset_bounds ()
void arv_camera_get_height_bounds ()
void arv_camera_get_width_bounds ()
void arv_camera_set_binning ()
void arv_camera_get_binning ()
void arv_camera_get_x_binning_bounds ()
void arv_camera_get_y_binning_bounds ()
gboolean arv_camera_is_binning_available ()
void arv_camera_set_pixel_format ()
ArvPixelFormat arv_camera_get_pixel_format ()
const char * arv_camera_get_pixel_format_as_string ()
void arv_camera_set_pixel_format_from_string ()
gint64 * arv_camera_get_available_pixel_formats ()
const char ** arv_camera_get_available_pixel_formats_as_display_names ()
const char ** arv_camera_get_available_pixel_formats_as_strings ()
void arv_camera_start_acquisition ()
void arv_camera_stop_acquisition ()
void arv_camera_abort_acquisition ()
ArvBuffer * arv_camera_acquisition ()
void arv_camera_set_acquisition_mode ()
ArvAcquisitionMode arv_camera_get_acquisition_mode ()
void arv_camera_set_frame_count ()
gint64 arv_camera_get_frame_count ()
void arv_camera_get_frame_count_bounds ()
gboolean arv_camera_is_frame_rate_available ()
void arv_camera_set_frame_rate ()
double arv_camera_get_frame_rate ()
void arv_camera_get_frame_rate_bounds ()
void arv_camera_set_trigger ()
void arv_camera_set_trigger_source ()
const char * arv_camera_get_trigger_source ()
const char ** arv_camera_get_available_trigger_sources ()
const char ** arv_camera_get_available_triggers ()
void arv_camera_clear_triggers ()
void arv_camera_software_trigger ()
gboolean arv_camera_is_exposure_time_available ()
gboolean arv_camera_is_exposure_auto_available ()
void arv_camera_set_exposure_time ()
double arv_camera_get_exposure_time ()
void arv_camera_get_exposure_time_bounds ()
void arv_camera_set_exposure_time_auto ()
ArvAuto arv_camera_get_exposure_time_auto ()
gboolean arv_camera_is_gain_available ()
gboolean arv_camera_is_gain_auto_available ()
void arv_camera_set_gain ()
double arv_camera_get_gain ()
void arv_camera_get_gain_bounds ()
void arv_camera_set_gain_auto ()
ArvAuto arv_camera_get_gain_auto ()
guint arv_camera_get_payload ()
gboolean arv_camera_is_gv_device ()
gint arv_camera_gv_get_n_stream_channels ()
void arv_camera_gv_select_stream_channel ()
int arv_camera_gv_get_current_stream_channel ()
gint64 arv_camera_gv_get_packet_delay ()
void arv_camera_gv_set_packet_delay ()
guint arv_camera_gv_get_packet_size ()
void arv_camera_gv_set_packet_size ()
guint arv_camera_gv_auto_packet_size ()
void arv_camera_gv_set_stream_options ()
gboolean arv_camera_is_uv_device ()
guint arv_camera_uv_get_bandwidth ()
void arv_camera_uv_get_bandwidth_bounds ()
gboolean arv_camera_uv_is_bandwidth_control_available ()
void arv_camera_uv_set_bandwidth ()
gboolean arv_camera_get_chunk_mode ()
gboolean arv_camera_get_chunk_state ()
void arv_camera_set_chunk_mode ()
void arv_camera_set_chunk_state ()
void arv_camera_set_chunks ()
ArvChunkParser * arv_camera_create_chunk_parser ()
const char * arv_acquisition_mode_to_string ()
ArvAcquisitionMode arv_acquisition_mode_from_string ()

Properties

ArvDevice * device Read / Write / Construct Only

Types and Values

Object Hierarchy

    GObject
    ╰── ArvCamera

Description

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.

Example 1. Example use of the ArvCamera API

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
#include <arv.h>
#include <stdlib.h>
#include <signal.h>
#include <stdio.h>

typedef struct {
    GMainLoop *main_loop;
    int buffer_count;
} ApplicationData;

static gboolean cancel = FALSE;

static void
set_cancel (int signal)
{
    cancel = TRUE;
}

static void
new_buffer_cb (ArvStream *stream, ApplicationData *data)
{
    ArvBuffer *buffer;

    buffer = arv_stream_try_pop_buffer (stream);
    if (buffer != NULL) {
        if (arv_buffer_get_status (buffer) == ARV_BUFFER_STATUS_SUCCESS)
            data->buffer_count++;
        /* Image processing here */
        arv_stream_push_buffer (stream, buffer);
    }
}

static gboolean
periodic_task_cb (void *abstract_data)
{
    ApplicationData *data = abstract_data;

    printf ("Frame rate = %d Hz\n", data->buffer_count);
    data->buffer_count = 0;

    if (cancel) {
        g_main_loop_quit (data->main_loop);
        return FALSE;
    }

    return TRUE;
}

static void
control_lost_cb (ArvGvDevice *gv_device)
{
    /* Control of the device is lost. Display a message and force application exit */
    printf ("Control lost\n");

    cancel = TRUE;
}

int
main (int argc, char **argv)
{
    ApplicationData data;
    ArvCamera *camera;
    ArvStream *stream;
    int i;

    data.buffer_count = 0;

    /* Mandatory glib type system initialization */
    arv_g_type_init ();

    /* Instantiation of the first available camera */
    camera = arv_camera_new (NULL);

    if (camera != NULL) {
        void (*old_sigint_handler)(int);
        gint payload;

        /* Set region of interrest to a 200x200 pixel area */
        arv_camera_set_region (camera, 0, 0, 200, 200);
        /* Set frame rate to 10 Hz */
        arv_camera_set_frame_rate (camera, 10.0);
        /* retrieve image payload (number of bytes per image) */
        payload = arv_camera_get_payload (camera);

        /* Create a new stream object */
        stream = arv_camera_create_stream (camera, NULL, NULL);
        if (stream != NULL) {
            /* Push 50 buffer in the stream input buffer queue */
            for (i = 0; i < 50; i++)
                arv_stream_push_buffer (stream, arv_buffer_new (payload, NULL));

            /* Start the video stream */
            arv_camera_start_acquisition (camera);

            /* Connect the new-buffer signal */
            g_signal_connect (stream, "new-buffer", G_CALLBACK (new_buffer_cb), &data);
            /* And enable emission of this signal (it's disabled by default for performance reason) */
            arv_stream_set_emit_signals (stream, TRUE);

            /* Connect the control-lost signal */
            g_signal_connect (arv_camera_get_device (camera), "control-lost",
                      G_CALLBACK (control_lost_cb), NULL);

            /* Install the callback for frame rate display */
            g_timeout_add_seconds (1, periodic_task_cb, &data);

            /* Create a new glib main loop */
            data.main_loop = g_main_loop_new (NULL, FALSE);

            old_sigint_handler = signal (SIGINT, set_cancel);

            /* Run the main loop */
            g_main_loop_run (data.main_loop);

            signal (SIGINT, old_sigint_handler);

            g_main_loop_unref (data.main_loop);

            /* Stop the video stream */
            arv_camera_stop_acquisition (camera);

            g_object_unref (stream);
        } else
            printf ("Can't create stream thread (check if the device is not already used)\n");

        g_object_unref (camera);
    } else
        printf ("No camera found\n");

    return 0;
}

Functions

ARAVIS_CHECK_VERSION()

#define             ARAVIS_CHECK_VERSION(major,minor,micro)

Checks the version of the Aravis library that is being compiled against.

Parameters

major

the major version to check for

 

minor

the minor version to check for

 

micro

the micro version to check for

 

Returns

TRUE if the version of the Aravis header files is the same as or newer than the passed-in version.

Since: 0.6.0


arv_auto_from_string ()

ArvAuto
arv_auto_from_string (const char *string);

arv_auto_to_string ()

const char *
arv_auto_to_string (ArvAuto value);

arv_camera_new ()

ArvCamera *
arv_camera_new (const char *name);

Creates a new ArvCamera. If name is null, it will instantiate the first available camera.

Parameters

name

name of the camera.

[allow-none]

Returns

a new ArvCamera.

Since: 0.2.0


arv_camera_create_stream ()

ArvStream *
arv_camera_create_stream (ArvCamera *camera,
                          ArvStreamCallback callback,
                          void *user_data);

Creates a new ArvStream for video stream handling. See ArvStreamCallback for details regarding the callback function.

Parameters

camera

a ArvCamera

 

callback

a frame processing callback.

[scope call][allow-none]

user_data

user data for callback .

[closure][allow-none]

Returns

a new ArvStream.

[transfer full]

Since: 0.2.0


arv_camera_get_device ()

ArvDevice *
arv_camera_get_device (ArvCamera *camera);

Retrieves the ArvDevice object for more complete access to camera features.

Parameters

camera

a ArvCamera

 

Returns

underlying device object.

[transfer none]

Since: 0.2.0


arv_camera_get_vendor_name ()

const char *
arv_camera_get_vendor_name (ArvCamera *camera);

Parameters

camera

a ArvCamera

 

Returns

the camera vendor name.

Since: 0.2.0


arv_camera_get_model_name ()

const char *
arv_camera_get_model_name (ArvCamera *camera);

Parameters

camera

a ArvCamera

 

Returns

the camera model name.

Since: 0.2.0


arv_camera_get_device_id ()

const char *
arv_camera_get_device_id (ArvCamera *camera);

Parameters

camera

a ArvCamera

 

Returns

the camera device ID.

Since: 0.2.0


arv_camera_get_sensor_size ()

void
arv_camera_get_sensor_size (ArvCamera *camera,
                            gint *width,
                            gint *height);

Parameters

camera

a ArvCamera

 

width

camera sensor width.

[out]

height

camera sensor height.

[out]

Since: 0.2.0


arv_camera_set_region ()

void
arv_camera_set_region (ArvCamera *camera,
                       gint x,
                       gint y,
                       gint width,
                       gint height);

Defines the region of interest which will be transmitted in the video stream.

Parameters

camera

a ArvCamera

 

x

x offset

 

y

y_offset

 

width

region width

 

height

region height

 

Since: 0.2.0


arv_camera_get_region ()

void
arv_camera_get_region (ArvCamera *camera,
                       gint *x,
                       gint *y,
                       gint *width,
                       gint *height);

Retrieves the current region of interest.

Parameters

camera

a ArvCamera

 

x

x offset.

[out]

y

y_offset.

[out]

width

region width.

[out]

height

region height.

[out]

Since: 0.2.0


arv_camera_get_x_offset_bounds ()

void
arv_camera_get_x_offset_bounds (ArvCamera *camera,
                                gint *min,
                                gint *max);

Retrieves the valid range for image horizontal offset.

Parameters

camera

a ArvCamera

 

min

minimum offset.

[out]

max

maximum offset.

[out]

Since: 0.6.0


arv_camera_get_y_offset_bounds ()

void
arv_camera_get_y_offset_bounds (ArvCamera *camera,
                                gint *min,
                                gint *max);

Retrieves the valid range for image vertical offset.

Parameters

camera

a ArvCamera

 

min

minimum offset.

[out]

max

maximum offset.

[out]

Since: 0.6.0


arv_camera_get_height_bounds ()

void
arv_camera_get_height_bounds (ArvCamera *camera,
                              gint *min,
                              gint *max);

Retrieves the valid range for image height.

Parameters

camera

a ArvCamera

 

min

minimum height.

[out]

max

maximum height.

[out]

Since: 0.6.0


arv_camera_get_width_bounds ()

void
arv_camera_get_width_bounds (ArvCamera *camera,
                             gint *min,
                             gint *max);

Retrieves the valid range for image width.

Parameters

camera

a ArvCamera

 

min

minimum width.

[out]

max

maximum width.

[out]

Since: 0.6.0


arv_camera_set_binning ()

void
arv_camera_set_binning (ArvCamera *camera,
                        gint dx,
                        gint dy);

Defines binning in both directions. Not all cameras support this feature.

Parameters

camera

a ArvCamera

 

dx

horizontal binning

 

dy

vertical binning

 

Since: 0.6.0


arv_camera_get_binning ()

void
arv_camera_get_binning (ArvCamera *camera,
                        gint *dx,
                        gint *dy);

Retrieves binning in both directions.

Parameters

camera

a ArvCamera

 

dx

horizontal binning placeholder.

[out]

dy

vertical binning placeholder.

[out]

Since: 0.2.0


arv_camera_get_x_binning_bounds ()

void
arv_camera_get_x_binning_bounds (ArvCamera *camera,
                                 gint *min,
                                 gint *max);

Retrieves the valid range for image horizontal binning.

Parameters

camera

a ArvCamera

 

min

minimum binning.

[out]

max

maximum binning.

[out]

Since: 0.6.0


arv_camera_get_y_binning_bounds ()

void
arv_camera_get_y_binning_bounds (ArvCamera *camera,
                                 gint *min,
                                 gint *max);

Retrieves the valid range for image vertical binning.

Parameters

camera

a ArvCamera

 

min

minimum binning.

[out]

max

maximum binning.

[out]

Since: 0.6.0


arv_camera_is_binning_available ()

gboolean
arv_camera_is_binning_available (ArvCamera *camera);

Parameters

camera

a ArvCamera

 

Returns

TRUE if Binning feature is available.

Since: 0.6.0


arv_camera_set_pixel_format ()

void
arv_camera_set_pixel_format (ArvCamera *camera,
                             ArvPixelFormat format);

Defines pixel format.

Parameters

camera

a ArvCamera

 

format

pixel format

 

Since: 0.2.0


arv_camera_get_pixel_format ()

ArvPixelFormat
arv_camera_get_pixel_format (ArvCamera *camera);

Parameters

camera

a ArvCamera

 

Returns

pixel format.

Since: 0.2.0


arv_camera_get_pixel_format_as_string ()

const char *
arv_camera_get_pixel_format_as_string (ArvCamera *camera);

Retuns: pixel format as string, NULL on error.

Parameters

camera

a ArvCamera

 

Since: 0.2.0


arv_camera_set_pixel_format_from_string ()

void
arv_camera_set_pixel_format_from_string
                               (ArvCamera *camera,
                                const char *format);

Defines pixel format described by a string.

Parameters

camera

a ArvCamera

 

format

pixel format

 

Since: 0.2.0


arv_camera_get_available_pixel_formats ()

gint64 *
arv_camera_get_available_pixel_formats
                               (ArvCamera *camera,
                                guint *n_pixel_formats);

Retrieves the list of all available pixel formats.

Parameters

camera

a ArvCamera

 

n_pixel_formats

number of different pixel formats.

[out]

Returns

a newly allocated array of ArvPixelFormat.

[array length=n_pixel_formats][transfer container]

Since: 0.2.0


arv_camera_get_available_pixel_formats_as_display_names ()

const char **
arv_camera_get_available_pixel_formats_as_display_names
                               (ArvCamera *camera,
                                guint *n_pixel_formats);

Retrieves the list of all available pixel formats as display names. In general, these human-readable strings cannot be used as settings.

Parameters

camera

a ArvCamera

 

n_pixel_formats

number of different pixel formats.

[out]

Returns

a newly allocated array of string constants.

[array length=n_pixel_formats][transfer container]

Since: 0.2.0


arv_camera_get_available_pixel_formats_as_strings ()

const char **
arv_camera_get_available_pixel_formats_as_strings
                               (ArvCamera *camera,
                                guint *n_pixel_formats);

Retrieves the list of all available pixel formats as strings.

Parameters

camera

a ArvCamera

 

n_pixel_formats

number of different pixel formats.

[out]

Returns

a newly allocated array of strings.

[array length=n_pixel_formats][transfer container]

Since: 0.2.0


arv_camera_start_acquisition ()

void
arv_camera_start_acquisition (ArvCamera *camera);

Starts video stream acquisition.

Parameters

camera

a ArvCamera

 

Since: 0.2.0


arv_camera_stop_acquisition ()

void
arv_camera_stop_acquisition (ArvCamera *camera);

Stops video stream acquisition.

Parameters

camera

a ArvCamera

 

Since: 0.2.0


arv_camera_abort_acquisition ()

void
arv_camera_abort_acquisition (ArvCamera *camera);

Aborts video stream acquisition.

Parameters

camera

a ArvCamera

 

Since: 0.4.0


arv_camera_acquisition ()

ArvBuffer *
arv_camera_acquisition (ArvCamera *camera,
                        guint64 timeout);

Acquire one image buffer.

Parameters

camera

a ArvCamera

 

timeout

acquisition timeout

 

Returns

A new ArvBuffer, NULL on error. The returned buffer must be freed using g_object_unref().

[transfer full]

Since: 0.6.0


arv_camera_set_acquisition_mode ()

void
arv_camera_set_acquisition_mode (ArvCamera *camera,
                                 ArvAcquisitionMode value);

arv_camera_get_acquisition_mode ()

ArvAcquisitionMode
arv_camera_get_acquisition_mode (ArvCamera *camera);

Parameters

camera

a ArvCamera

 

Returns

acquisition mode.

Since: 0.2.0


arv_camera_set_frame_count ()

void
arv_camera_set_frame_count (ArvCamera *camera,
                            gint64 frame_count);

Sets the number of frames to capture in MultiFrame mode.

Parameters

camera

a ArvCamera

 

frame_count

number of frames to capture in MultiFrame mode

 

Since: 0.6.0


arv_camera_get_frame_count ()

gint64
arv_camera_get_frame_count (ArvCamera *camera);

Parameters

camera

a ArvCamera

 

Returns

number of frames to capture in MultiFrame mode.

Since: 0.6.0


arv_camera_get_frame_count_bounds ()

void
arv_camera_get_frame_count_bounds (ArvCamera *camera,
                                   gint64 *min,
                                   gint64 *max);

Retrieves allowed range for frame count.

Parameters

camera

a ArvCamera

 

min

minimal possible frame count.

[out]

max

maximum possible frame count.

[out]

Since: 0.6.0


arv_camera_is_frame_rate_available ()

gboolean
arv_camera_is_frame_rate_available (ArvCamera *camera);

Parameters

camera

a ArvCamera

 

Returns

TRUE if FrameRate feature is available

Since: 0.2.0


arv_camera_set_frame_rate ()

void
arv_camera_set_frame_rate (ArvCamera *camera,
                           double frame_rate);

Configures a fixed frame rate mode. Once acquisition start is triggered, the video stream will be acquired with the given frame rate.

Parameters

camera

a ArvCamera

 

frame_rate

frame rate, in Hz

 

Since: 0.2.0


arv_camera_get_frame_rate ()

double
arv_camera_get_frame_rate (ArvCamera *camera);

Parameters

camera

a ArvCamera

 

Returns

actual frame rate, in Hz.

Since: 0.2.0


arv_camera_get_frame_rate_bounds ()

void
arv_camera_get_frame_rate_bounds (ArvCamera *camera,
                                  double *min,
                                  double *max);

Retrieves allowed range for framerate.

Since 0.2.2

Parameters

camera

a ArvCamera

 

min

minimal possible framerate.

[out]

max

maximum possible framerate.

[out]

arv_camera_set_trigger ()

void
arv_camera_set_trigger (ArvCamera *camera,
                        const char *source);

Configures the camera in trigger mode. Typical values for source are "Line1" or "Line2". See the camera documentation for the allowed values. Activation is set to rising edge. It can be changed by accessing the underlying device object.

Source can also be "Software". In this case, an acquisition is triggered by a call to arv_camera_software_trigger().

Parameters

camera

a ArvCamera

 

source

trigger source as string

 

Since: 0.2.0


arv_camera_set_trigger_source ()

void
arv_camera_set_trigger_source (ArvCamera *camera,
                               const char *source);

Sets the trigger source. This function doesn't check if the camera is configured to actually use this source as a trigger.

Parameters

camera

a ArvCamera

 

source

source name

 

Since: 0.2.0


arv_camera_get_trigger_source ()

const char *
arv_camera_get_trigger_source (ArvCamera *camera);

Gets the trigger source. This function doesn't check if the camera is configured to actually use this source as a trigger.

Parameters

camera

a ArvCamera

 

Returns

a string containing the trigger source name, NULL on error.

Since: 0.2.0


arv_camera_get_available_trigger_sources ()

const char **
arv_camera_get_available_trigger_sources
                               (ArvCamera *camera,
                                guint *n_sources);

Gets the list of all available trigger sources.

Parameters

camera

a ArvCamera

 

n_sources

number of sources.

[out]

Returns

a newly allocated array of strings, which must be freed using g_free().

[array length=n_sources][transfer container]

Since: 0.6.0


arv_camera_get_available_triggers ()

const char **
arv_camera_get_available_triggers (ArvCamera *camera,
                                   guint *n_triggers);

Gets a list of all available triggers: FrameStart, ExposureActive, etc...

Parameters

camera

a ArvCamera

 

n_triggers

number of available triggers.

[out]

Returns

a newly allocated array of strings, which must be freed using g_free().

[array length=n_triggers][transfer container]

Since: 0.6.0


arv_camera_clear_triggers ()

void
arv_camera_clear_triggers (ArvCamera *camera);

Disables all triggers.

Parameters

camera

a ArvCamera

 

Since: 0.6.0


arv_camera_software_trigger ()

void
arv_camera_software_trigger (ArvCamera *camera);

Sends a software trigger command to camera . The camera must be previously configured to use a software trigger, using arv_camera_set_trigger() .

Parameters

camera

a ArvCamera

 

Since: 0.2.0


arv_camera_is_exposure_time_available ()

gboolean
arv_camera_is_exposure_time_available (ArvCamera *camera);

Parameters

camera

a ArvCamera

 

Returns

TRUE if Exposure Time feature is available.

Since: 0.2.0


arv_camera_is_exposure_auto_available ()

gboolean
arv_camera_is_exposure_auto_available (ArvCamera *camera);

Parameters

camera

a ArvCamera

 

Returns

TRUE if Exposure Auto feature is available.

Since: 0.2.0


arv_camera_set_exposure_time ()

void
arv_camera_set_exposure_time (ArvCamera *camera,
                              double exposure_time_us);

Sets exposure time. User should take care to set a value compatible with the desired frame rate.

Parameters

camera

a ArvCamera

 

exposure_time_us

exposure time, in µs

 

Since: 0.2.0


arv_camera_get_exposure_time ()

double
arv_camera_get_exposure_time (ArvCamera *camera);

Parameters

camera

a ArvCamera

 

Returns

current exposure time, in µs.

Since: 0.2.0


arv_camera_get_exposure_time_bounds ()

void
arv_camera_get_exposure_time_bounds (ArvCamera *camera,
                                     double *min,
                                     double *max);

Retrieves exposure time bounds, in µs.

Parameters

camera

a ArvCamera

 

min

minimum exposure time.

[out]

max

maximum exposure time.

[out]

Since: 0.2.0


arv_camera_set_exposure_time_auto ()

void
arv_camera_set_exposure_time_auto (ArvCamera *camera,
                                   ArvAuto auto_mode);

Configures automatic exposure feature.

Parameters

camera

a ArvCamera

 

auto_mode

auto exposure mode selection

 

Since: 0.2.0


arv_camera_get_exposure_time_auto ()

ArvAuto
arv_camera_get_exposure_time_auto (ArvCamera *camera);

Parameters

camera

a ArvCamera

 

Returns

auto exposure mode selection

Since: 0.2.0


arv_camera_is_gain_available ()

gboolean
arv_camera_is_gain_available (ArvCamera *camera);

Parameters

camera

a ArvCamera

 

Returns

TRUE if Gain feature is available.

Since: 0.2.0


arv_camera_is_gain_auto_available ()

gboolean
arv_camera_is_gain_auto_available (ArvCamera *camera);

Parameters

camera

a ArvCamera

 

Returns

TRUE if Gain feature is available.

Since: 0.2.0


arv_camera_set_gain ()

void
arv_camera_set_gain (ArvCamera *camera,
                     double gain);

Sets the gain of the ADC converter.

Parameters

camera

a ArvCamera

 

gain

gain value

 

Since: 0.2.0


arv_camera_get_gain ()

double
arv_camera_get_gain (ArvCamera *camera);

Parameters

camera

a ArvCamera

 

Returns

the current gain setting.

Since: 0.2.0


arv_camera_get_gain_bounds ()

void
arv_camera_get_gain_bounds (ArvCamera *camera,
                            double *min,
                            double *max);

Retrieves gain bounds.

Parameters

camera

a ArvCamera

 

min

minimum gain.

[out]

max

maximum gain.

[out]

Since: 0.2.0


arv_camera_set_gain_auto ()

void
arv_camera_set_gain_auto (ArvCamera *camera,
                          ArvAuto auto_mode);

Configures automatic gain feature.

Parameters

camera

a ArvCamera

 

auto_mode

auto gain mode selection

 

Since: 0.2.0


arv_camera_get_gain_auto ()

ArvAuto
arv_camera_get_gain_auto (ArvCamera *camera);

Parameters

camera

a ArvCamera

 

Returns

auto gain mode selection

Since: 0.2.0


arv_camera_get_payload ()

guint
arv_camera_get_payload (ArvCamera *camera);

Retrieves the size needed for the storage of an image. This value is used for the creation of the stream buffers.

Parameters

camera

a ArvCamera

 

Returns

frame storage size, in bytes.

Since: 0.2.0


arv_camera_is_gv_device ()

gboolean
arv_camera_is_gv_device (ArvCamera *camera);

Parameters

camera

a ArvCamera

 

Returns

TRUE if camera is a GigEVision device.

Since: 0.4.0


arv_camera_gv_get_n_stream_channels ()

gint
arv_camera_gv_get_n_stream_channels (ArvCamera *camera);

Parameters

camera

a ArvCamera

 

Returns

the number of supported stream channels.

Since: 0.4.0


arv_camera_gv_select_stream_channel ()

void
arv_camera_gv_select_stream_channel (ArvCamera *camera,
                                     gint channel_id);

Select the current stream channel.

Parameters

camera

a ArvCamera

 

channel_id

id of the channel to select

 

Since: 0.4.0


arv_camera_gv_get_current_stream_channel ()

int
arv_camera_gv_get_current_stream_channel
                               (ArvCamera *camera);

Parameters

camera

a ArvCamera

 

Returns

The current stream channel id.

Since: 0.4.0


arv_camera_gv_get_packet_delay ()

gint64
arv_camera_gv_get_packet_delay (ArvCamera *camera);

Parameters

camera

a ArvCamera

 

Returns

The inter packet delay, in nanoseconds.

Since: 0.4.0


arv_camera_gv_set_packet_delay ()

void
arv_camera_gv_set_packet_delay (ArvCamera *camera,
                                gint64 delay_ns);

Configure the inter packet delay to insert between each packet for the current stream channel. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device.

Parameters

camera

a ArvCamera

 

delay_ns

inter packet delay, in nanoseconds

 

Since: 0.4.0


arv_camera_gv_get_packet_size ()

guint
arv_camera_gv_get_packet_size (ArvCamera *camera);

Parameters

camera

a ArvCamera

 

Returns

The stream packet size, in bytes.

Since: 0.4.0


arv_camera_gv_set_packet_size ()

void
arv_camera_gv_set_packet_size (ArvCamera *camera,
                               guint packet_size);

Specifies the stream packet size, in bytes, to send on the selected channel for a GVSP transmitter or specifies the maximum packet size supported by a GVSP receiver.

This does not include data leader and data trailer and the last data packet which might be of smaller size (since packet size is not necessarily a multiple of block size for stream channel).

Parameters

camera

a ArvCamera

 

packet_size

packet size, in bytes

 

Since: 0.4.0


arv_camera_gv_auto_packet_size ()

guint
arv_camera_gv_auto_packet_size (ArvCamera *camera);

Automatically determine the biggest packet size that can be used data streaming, and set GevSCPSPacketSize value accordingly. This function relies on the GevSCPSFireTestPacket feature. If this feature is not available, the packet size will be set to a default value (1500 bytes).

Parameters

camera

a ArvCamera

 

Returns

The packet size, in bytes.

Since: 0.6.0


arv_camera_gv_set_stream_options ()

void
arv_camera_gv_set_stream_options (ArvCamera *camera,
                                  ArvGvStreamOption options);

Sets the options used during stream object creation. These options mus be set before the call to arv_camera_create_stream().

Parameters

camera

a ArvCamera

 

options

option for stream creation

 

Since: 0.6.0


arv_camera_is_uv_device ()

gboolean
arv_camera_is_uv_device (ArvCamera *camera);

Parameters

camera

a ArvCamera

 

Returns

TRUE if camera is a USB3Vision device.

Since: 0.6.0


arv_camera_uv_get_bandwidth ()

guint
arv_camera_uv_get_bandwidth (ArvCamera *camera);

Parameters

camera

a ArvCamera

 

Returns

the current bandwidth limit

Since: 0.6.0


arv_camera_uv_get_bandwidth_bounds ()

void
arv_camera_uv_get_bandwidth_bounds (ArvCamera *camera,
                                    guint *min,
                                    guint *max);

Parameters

camera

a ArvCamera

 

min

minimum bandwidth.

[out]

max

maximum bandwidth.

[out]

Since: 0.6.0


arv_camera_uv_is_bandwidth_control_available ()

gboolean
arv_camera_uv_is_bandwidth_control_available
                               (ArvCamera *camera);

Parameters

camera

a ArvCamera

 

Returns

wether bandwidth limits are available on this camera

Since: 0.6.0


arv_camera_uv_set_bandwidth ()

void
arv_camera_uv_set_bandwidth (ArvCamera *camera,
                             guint bandwidth);

Parameters

camera

a ArvCamera

 

bandwidth

Desired bandwith limit in megabits/sec. Set to 0 to disable limit mode.

 

Since: 0.6.0


arv_camera_get_chunk_mode ()

gboolean
arv_camera_get_chunk_mode (ArvCamera *camera);

Check wether chunk data mode is active. Please see arv_camera_set_chunk_mode().

Parameters

camera

a ArvCamera

 

Returns

TRUE if chunk data mode is active.

Since: 0.4.0


arv_camera_get_chunk_state ()

gboolean
arv_camera_get_chunk_state (ArvCamera *camera,
                            const char *chunk);

Gets state of chunk data. Chunk data are be embedded in ArvBuffer only if chunk mode is active. Please see arv_camera_set_chunk_mode().

Parameters

camera

a ArvCamera

 

chunk

chunk data name

 

Returns

TRUE if chunk is enabled.

Since: 0.4.0


arv_camera_set_chunk_mode ()

void
arv_camera_set_chunk_mode (ArvCamera *camera,
                           gboolean is_active);

Controls wether chunk data mode is active. When active, chunk data are appended to image data in ArvBuffer. A ArvChunkParser must be used in order to extract chunk data.

Parameters

camera

a ArvCamera

 

is_active

wether to enable chunk data mode

 

Since: 0.4.0


arv_camera_set_chunk_state ()

void
arv_camera_set_chunk_state (ArvCamera *camera,
                            const char *chunk,
                            gboolean is_enabled);

Sets state of a chunk data. Chunk data are be embedded in ArvBuffer only if chunk mode is active. Please see arv_camera_set_chunk_mode().

Parameters

camera

a ArvCamera

 

chunk

chunk data name

 

is_enabled

wether to enable this chunk

 

Since: 0.4.0


arv_camera_set_chunks ()

void
arv_camera_set_chunks (ArvCamera *camera,
                       const char *chunk_list);

Convenience function for enabling a set of chunk data. Chunk mode is activated, or deactivated if chunk_list is NULL or empty. All chunk data not listed are disabled.

Parameters

camera

a ArvCamera

 

chunk_list

chunk data names, as a comma or space separated list

 

Since: 0.4.0


arv_camera_create_chunk_parser ()

ArvChunkParser *
arv_camera_create_chunk_parser (ArvCamera *camera);

Creates a new ArvChunkParser object, used for the extraction of chunk data from ArvBuffer.

Parameters

camera

a ArvCamera

 

Returns

a new ArvChunkParser.

[transfer full]

Since: 0.4.0


arv_acquisition_mode_to_string ()

const char *
arv_acquisition_mode_to_string (ArvAcquisitionMode value);

arv_acquisition_mode_from_string ()

ArvAcquisitionMode
arv_acquisition_mode_from_string (const char *string);

Types and Values

ARAVIS_MAJOR_VERSION

#define ARAVIS_MAJOR_VERSION 0

The major version of the Aravis library.

Since: 0.6.0


ARAVIS_MICRO_VERSION

#define ARAVIS_MICRO_VERSION 7

The micor version of the Aravis library.

Since: 0.6.0


ARAVIS_MINOR_VERSION

#define ARAVIS_MINOR_VERSION 5

The minor version of the Aravis library.

Since: 0.6.0


ARAVIS_HAS_PACKET_SOCKET

#define ARAVIS_HAS_PACKET_SOCKET 1

ARAVIS_HAS_PACKET_SOCKET is defined as 1 if aravis is compiled with packet socket support, 0 if not.

Since: 0.6.0


ARAVIS_HAS_USB

#define ARAVIS_HAS_USB 1

ARAVIS_HAS_USB is defined as 1 if aravis is compiled with USB support, 0 if not.

Since: 0.6.0


enum ArvAuto

Members

ARV_AUTO_OFF

manual setting

 

ARV_AUTO_ONCE

automatic setting done once, then returns to manual

 

ARV_AUTO_CONTINUOUS

setting is adjusted continuously

 

ArvCamera

typedef struct _ArvCamera ArvCamera;

enum ArvAcquisitionMode

Members

ARV_ACQUISITION_MODE_CONTINUOUS

continuous acquisition

 

ARV_ACQUISITION_MODE_SINGLE_FRAME

only one frame will be acquired

 

ARV_ACQUISITION_MODE_MULTI_FRAME

multiple frames will be acquired

 

Property Details

The “device” property

  “device”                   ArvDevice *

the device associated with this camera.

Flags: Read / Write / Construct Only