| Top | |
|
|
|
| #define | ARAVIS_VERSION |
| #define | ARAVIS_API_VERSION |
| #define | ARAVIS_MAJOR_VERSION |
| #define | ARAVIS_MICRO_VERSION |
| #define | ARAVIS_MINOR_VERSION |
| #define | ARAVIS_HAS_PACKET_SOCKET |
| #define | ARAVIS_HAS_USB |
| #define | ARAVIS_HAS_FAST_HEARTBEAT |
| enum | ArvAuto |
| ArvCamera | |
| enum | ArvGvPacketSizeAdjustment |
| enum | ArvAcquisitionMode |
| enum | ArvExposureMode |
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 132 133 134 135 136 137 138 139 140 141 142 |
#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; GError *error = NULL; int i; data.buffer_count = 0; /* Instantiation of the first available camera */ camera = arv_camera_new (NULL, &error); if (ARV_IS_CAMERA (camera)) { 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, NULL); /* Set frame rate to 10 Hz */ arv_camera_set_frame_rate (camera, 10.0, NULL); /* retrieve image payload (number of bytes per image) */ payload = arv_camera_get_payload (camera, NULL); /* Create a new stream object */ stream = arv_camera_create_stream (camera, NULL, NULL, &error); if (ARV_IS_STREAM (stream)) { /* 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, NULL); /* 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, NULL); /* Signal must be inhibited to avoid stream thread running after the last unref */ arv_stream_set_emit_signals (stream, FALSE); g_object_unref (stream); } else { printf ("Can't create stream thread%s%s\n", error != NULL ? ": " : "", error != NULL ? error->message : ""); g_clear_error (&error); } g_object_unref (camera); } else { printf ("No camera found%s%s\n", error != NULL ? ": " : "", error != NULL ? error->message : ""); g_clear_error (&error); } return 0; } |
#define ARAVIS_CHECK_VERSION(major,minor,micro)
Checks the version of the Aravis library that is being compiled against.
major |
the major version to check for |
|
minor |
the minor version to check for |
|
micro |
the micro version to check for |
TRUE if the version of the Aravis header files
is the same as or newer than the passed-in version.
Since: 0.6.0
guint
arv_get_major_version (void);
Returns the major version number of the Aravis library.
For example, in Aravis version 0.8.20 this is 0.
This function is in the library, so it represents the Aravis library
your code is running against. Contrast with the ARAVIS_MAJOR_VERSION
macro, which represents the major version of the Aravis headers you
have included when compiling your code.
Since: 0.8.20
guint
arv_get_micro_version (void);
Returns the micro version number of the Aravis library.
For example, in Aravis version 0.8.20 this is 20.
This function is in the library, so it represents the Aravis library
your code is running against. Contrast with the ARAVIS_MICRO_VERSION
macro, which represents the micro version of the Aravis headers you
have included when compiling your code.
Since: 0.8.20
guint
arv_get_minor_version (void);
Returns the minor version number of the Aravis library.
For example, in Aravis version 0.8.20 this is 8.
This function is in the library, so it represents the Aravis library
your code is running against. Contrast with the ARAVIS_MINOR_VERSION
macro, which represents the minor version of the Aravis headers you
have included when compiling your code.
Since: 0.8.20
ArvCamera * arv_camera_new (const char *name,GError **error);
Creates a new ArvCamera. If name
is null, it will instantiate the
first available camera.
If the camera is a GigEVision, name
can be either:
<vendor>-<model>-<serial>
<vendor_alias>-<serial>
<vendor>-<serial>
<user_id>
<ip_address>
<mac_address>
For example:
The Imaging Source Europe GmbH-DFK 33GX265-39020369
The Imaging Source Europe GmbH-39020369
TIS-39020369
192.168.0.2
00:07:48:af:a2:61
If the camera is a USB3Vision device, name
is either:
<vendor_alias>-<serial>
<vendor>-<serial>
Since: 0.8.0
ArvCamera * arv_camera_new_with_device (ArvDevice *device,GError **error);
Creates a new ArvCamera, using device
as its internal device object.
Since: 0.8.6
ArvStream * arv_camera_create_stream (ArvCamera *camera,ArvStreamCallback callback,void *user_data,GError **error);
Creates a new ArvStream for video stream handling. See ArvStreamCallback for details regarding the callback function.
Since: 0.2.0
ArvDevice *
arv_camera_get_device (ArvCamera *camera);
Retrieves the ArvDevice object for more complete access to camera features.
Since: 0.2.0
const char * arv_camera_get_vendor_name (ArvCamera *camera,GError **error);
Since: 0.8.0
const char * arv_camera_get_model_name (ArvCamera *camera,GError **error);
Since: 0.8.0
const char * arv_camera_get_device_serial_number (ArvCamera *camera,GError **error);
Since: 0.8.8
const char * arv_camera_get_device_id (ArvCamera *camera,GError **error);
Since: 0.8.0
void arv_camera_get_sensor_size (ArvCamera *camera,gint *width,gint *height,GError **error);
Since: 0.8.0
void arv_camera_set_region (ArvCamera *camera,gint x,gint y,gint width,gint height,GError **error);
Defines the region of interest which will be transmitted in the video
stream. Negative x
or y
values, or not strictly positive width
or height
values are ignored.
Since: 0.8.0
void arv_camera_get_region (ArvCamera *camera,gint *x,gint *y,gint *width,gint *height,GError **error);
Retrieves the current region of interest.
Since: 0.8.0
void arv_camera_get_x_offset_bounds (ArvCamera *camera,gint *min,gint *max,GError **error);
Retrieves the valid range for image horizontal offset.
Since: 0.8.0
gint arv_camera_get_x_offset_increment (ArvCamera *camera,GError **error);
Since: 0.8.0
void arv_camera_get_y_offset_bounds (ArvCamera *camera,gint *min,gint *max,GError **error);
Retrieves the valid range for image vertical offset.
Since: 0.8.0
gint arv_camera_get_y_offset_increment (ArvCamera *camera,GError **error);
Since: 0.8.0
void arv_camera_get_height_bounds (ArvCamera *camera,gint *min,gint *max,GError **error);
Retrieves the valid range for image height.
Since: 0.8.0
gint arv_camera_get_height_increment (ArvCamera *camera,GError **error);
Since: 0.8.0
void arv_camera_get_width_bounds (ArvCamera *camera,gint *min,gint *max,GError **error);
Retrieves the valid range for image width.
Since: 0.8.0
gint arv_camera_get_width_increment (ArvCamera *camera,GError **error);
Since: 0.8.0
gboolean arv_camera_is_binning_available (ArvCamera *camera,GError **error);
Since: 0.8.0
void arv_camera_set_binning (ArvCamera *camera,gint dx,gint dy,GError **error);
Defines binning in both directions. Not all cameras support this
feature. Negative dx
or dy
values are ignored.
Since: 0.8.0
void arv_camera_get_binning (ArvCamera *camera,gint *dx,gint *dy,GError **error);
Retrieves binning in both directions.
Since: 0.8.0
void arv_camera_get_x_binning_bounds (ArvCamera *camera,gint *min,gint *max,GError **error);
Retrieves the valid range for image horizontal binning.
Since: 0.8.0
gint arv_camera_get_x_binning_increment (ArvCamera *camera,GError **error);
Since: 0.8.0
void arv_camera_get_y_binning_bounds (ArvCamera *camera,gint *min,gint *max,GError **error);
Retrieves the valid range for image vertical binning.
Since: 0.8.0
gint arv_camera_get_y_binning_increment (ArvCamera *camera,GError **error);
Since: 0.8.0
void arv_camera_set_pixel_format (ArvCamera *camera,ArvPixelFormat format,GError **error);
Defines pixel format.
Since: 0.8.0
ArvPixelFormat arv_camera_get_pixel_format (ArvCamera *camera,GError **error);
Since: 0.8.0
const char * arv_camera_get_pixel_format_as_string (ArvCamera *camera,GError **error);
Retuns: pixel format as string, NULL on error.
Since: 0.8.0
void arv_camera_set_pixel_format_from_string (ArvCamera *camera,const char *format,GError **error);
Defines pixel format described by a string.
Since: 0.8.0
gint64 * arv_camera_dup_available_pixel_formats (ArvCamera *camera,guint *n_pixel_formats,GError **error);
Retrieves the list of all available pixel formats.
a newly allocated array of ArvPixelFormat, to be freed after use with
g_free().
[array length=n_pixel_formats][transfer container]
Since: 0.8.0
const char ** arv_camera_dup_available_pixel_formats_as_display_names (ArvCamera *camera,guint *n_pixel_formats,GError **error);
Retrieves the list of all available pixel formats as display names. In general, these human-readable strings cannot be used as settings.
a newly allocated array of string constants, to be freed after use with
g_free().
[array length=n_pixel_formats][transfer container]
Since: 0.8.0
const char ** arv_camera_dup_available_pixel_formats_as_strings (ArvCamera *camera,guint *n_pixel_formats,GError **error);
Retrieves the list of all available pixel formats as strings.
a newly allocated array of strings, to be freed after use with
g_free().
[array length=n_pixel_formats][transfer container]
Since: 0.8.0
void arv_camera_start_acquisition (ArvCamera *camera,GError **error);
Starts video stream acquisition.
Since: 0.8.0
void arv_camera_stop_acquisition (ArvCamera *camera,GError **error);
Stops video stream acquisition.
Since: 0.8.0
void arv_camera_abort_acquisition (ArvCamera *camera,GError **error);
Aborts video stream acquisition.
Since: 0.8.0
ArvBuffer * arv_camera_acquisition (ArvCamera *camera,guint64 timeout,GError **error);
Acquire one image buffer.
arv_camera_acquisition() sets the camera in SingleFrame acquisition mode. You may have to put back the camera in
Continuous acquisition mode for later operations, using arv_camera_set_acquisition_mode().
A new ArvBuffer, NULL on error. The returned buffer must be freed using g_object_unref().
[transfer full]
Since: 0.8.0
void arv_camera_set_acquisition_mode (ArvCamera *camera,ArvAcquisitionMode value,GError **error);
ArvAcquisitionMode arv_camera_get_acquisition_mode (ArvCamera *camera,GError **error);
Since: 0.8.0
void arv_camera_set_frame_count (ArvCamera *camera,gint64 frame_count,GError **error);
Sets the number of frames to capture in MultiFrame mode.
Since: 0.8.0
gint64 arv_camera_get_frame_count (ArvCamera *camera,GError **error);
Since: 0.8.0
void arv_camera_get_frame_count_bounds (ArvCamera *camera,gint64 *min,gint64 *max,GError **error);
Retrieves allowed range for frame count.
Since: 0.8.0
gboolean arv_camera_is_frame_rate_available (ArvCamera *camera,GError **error);
Since: 0.8.0
void arv_camera_set_frame_rate (ArvCamera *camera,double frame_rate,GError **error);
Configures a fixed frame rate mode. Once acquisition start is triggered, the video stream will be acquired with the
given frame rate. A negative or zero frame_rate
value disables the frame rate limit.
All triggers are disabled.
Since: 0.8.0
double arv_camera_get_frame_rate (ArvCamera *camera,GError **error);
Since: 0.8.0
void arv_camera_get_frame_rate_bounds (ArvCamera *camera,double *min,double *max,GError **error);
Retrieves allowed range for framerate.
Since 0.8.0
void arv_camera_set_trigger (ArvCamera *camera,const char *source,GError **error);
Configures the camera in trigger mode. Typical values for source are "Line1" or "Line2". See the camera documentation
for the allowed values. Source can also be "Software". In this case, an acquisition is triggered by a call to
arv_camera_software_trigger().
The trigger set is "FrameStart". "AcquisitionStart" is used as a fallback if "FrameStart" is not present. All other triggers are disabled. "TriggerActivation" is set to rising edge.
For an advanced trigger configuration, use the underlying ArvDevice object returned by arv_camera_get_device().
Since: 0.8.0
void arv_camera_set_trigger_source (ArvCamera *camera,const char *source,GError **error);
Sets the trigger source. This function doesn't check if the camera is configured to actually use this source as a trigger.
Since: 0.8.0
const char * arv_camera_get_trigger_source (ArvCamera *camera,GError **error);
Gets the trigger source. This function doesn't check if the camera is configured to actually use this source as a trigger.
Since: 0.8.0
const char ** arv_camera_dup_available_trigger_sources (ArvCamera *camera,guint *n_sources,GError **error);
Gets the list of all available trigger sources.
a newly allocated array of strings, which must be freed using g_free().
[array length=n_sources][transfer container]
Since: 0.8.0
const char ** arv_camera_dup_available_triggers (ArvCamera *camera,guint *n_triggers,GError **error);
Gets a list of all available triggers: FrameStart, ExposureActive, etc...
a newly allocated array of strings, which must be freed using g_free().
[array length=n_triggers][transfer container]
Since: 0.8.0
void arv_camera_clear_triggers (ArvCamera *camera,GError **error);
Disables all triggers.
Since: 0.8.0
gboolean arv_camera_is_software_trigger_supported (ArvCamera *camera,GError **error);
Since: 0.8.17
void arv_camera_software_trigger (ArvCamera *camera,GError **error);
Sends a software trigger command to camera
. The camera must be previously
configured to use a software trigger, using arv_camera_set_trigger()
Since: 0.8.0
gboolean arv_camera_is_exposure_time_available (ArvCamera *camera,GError **error);
Since: 0.8.0
gboolean arv_camera_is_exposure_auto_available (ArvCamera *camera,GError **error);
Since: 0.8.0
void arv_camera_set_exposure_time (ArvCamera *camera,double exposure_time_us,GError **error);
Sets exposure time. User should take care to set a value compatible with
the desired frame rate. Negative exposure_time_us
is ignored.
Since: 0.8.0
double arv_camera_get_exposure_time (ArvCamera *camera,GError **error);
Since: 0.8.0
void arv_camera_get_exposure_time_bounds (ArvCamera *camera,double *min,double *max,GError **error);
Retrieves exposure time bounds, in µs.
Since: 0.8.0
void arv_camera_set_exposure_time_auto (ArvCamera *camera,ArvAuto auto_mode,GError **error);
Configures automatic exposure feature.
Since: 0.8.0
ArvAuto arv_camera_get_exposure_time_auto (ArvCamera *camera,GError **error);
Since: 0.8.0
void arv_camera_set_exposure_mode (ArvCamera *camera,ArvExposureMode mode,GError **error);
gboolean arv_camera_is_gain_available (ArvCamera *camera,GError **error);
Since: 0.8.0
gboolean arv_camera_is_gain_auto_available (ArvCamera *camera,GError **error);
Since: 0.8.0
void arv_camera_set_gain (ArvCamera *camera,double gain,GError **error);
Sets the gain of the ADC converter. Negative gain
is ignored.
Since: 0.8.0
void arv_camera_get_gain_bounds (ArvCamera *camera,double *min,double *max,GError **error);
Retrieves gain bounds.
Since: 0.8.0
void arv_camera_set_gain_auto (ArvCamera *camera,ArvAuto auto_mode,GError **error);
Configures automatic gain feature.
Since: 0.8.0
ArvAuto arv_camera_get_gain_auto (ArvCamera *camera,GError **error);
Since: 0.8.0
gboolean arv_camera_is_black_level_available (ArvCamera *camera,GError **error);
Since: 0.8.19
double arv_camera_get_black_level (ArvCamera *camera,GError **error);
Since: 0.8.19
void arv_camera_set_black_level (ArvCamera *camera,double blacklevel,GError **error);
Since: 0.8.19
void arv_camera_get_black_level_bounds (ArvCamera *camera,double *min,double *max,GError **error);
Retrieves blacklevel bounds.
Since: 0.8.19
gboolean arv_camera_is_black_level_auto_available (ArvCamera *camera,GError **error);
Since: 0.8.19
ArvAuto arv_camera_get_black_level_auto (ArvCamera *camera,GError **error);
Since: 0.8.19
void arv_camera_set_black_level_auto (ArvCamera *camera,ArvAuto auto_mode,GError **error);
Configures automatic black level feature.
Since: 0.8.19
guint arv_camera_get_payload (ArvCamera *camera,GError **error);
Retrieves the size needed for the storage of an image. This value is used for the creation of the stream buffers.
Since: 0.8.0
gboolean arv_camera_is_feature_available (ArvCamera *camera,const char *feature,GError **error);
Return: TRUE if feature is available, FALSE if not or on error.
Since: 0.8.0
void arv_camera_execute_command (ArvCamera *camera,const char *feature,GError **error);
Execute a Genicam command.
Since: 0.8.0
gboolean arv_camera_is_enumeration_entry_available (ArvCamera *camera,const char *feature,const char *entry,GError **error);
Since: 0.8.17
gint64 * arv_camera_dup_available_enumerations (ArvCamera *camera,const char *feature,guint *n_values,GError **error);
Get all the available values of feature
, as 64 bit integers.
a newly created array of integers, which must freed after use using g_free, or NULL on error.
[array length=n_values][transfer container]
Since: 0.8.0
const char ** arv_camera_dup_available_enumerations_as_strings (ArvCamera *camera,const char *feature,guint *n_values,GError **error);
Get all the available values of feature
, as strings.
a newly created array of const strings, which must freed after use using g_free,
or NULL on error.
[array length=n_values][transfer container]
Since: 0.8.0
const char ** arv_camera_dup_available_enumerations_as_display_names (ArvCamera *camera,const char *feature,guint *n_values,GError **error);
Get display names of all the available entries of feature
.
a newly created array of const strings, to be freed after use using g_free, or
NULL on error.
[array length=n_values][transfer container]
Since: 0.8.0
gboolean arv_camera_get_boolean (ArvCamera *camera,const char *feature,GError **error);
Since: 0.8.0
double arv_camera_get_float (ArvCamera *camera,const char *feature,GError **error);
Since: 0.8.0
void arv_camera_get_float_bounds (ArvCamera *camera,const char *feature,double *min,double *max,GError **error);
Retrieves float feature bounds.
Since: 0.8.0
double arv_camera_get_float_increment (ArvCamera *camera,const char *feature,GError **error);
Since: 0.8.16
gint64 arv_camera_get_integer (ArvCamera *camera,const char *feature,GError **error);
Since: 0.8.0
void arv_camera_get_integer_bounds (ArvCamera *camera,const char *feature,gint64 *min,gint64 *max,GError **error);
Retrieves integer feature bounds.
Since: 0.8.0
gint64 arv_camera_get_integer_increment (ArvCamera *camera,const char *feature,GError **error);
Since: 0.8.0
const char * arv_camera_get_string (ArvCamera *camera,const char *feature,GError **error);
Since: 0.8.0
void arv_camera_set_boolean (ArvCamera *camera,const char *feature,gboolean value,GError **error);
Set a boolean feature value.
Since: 0.8.0
void arv_camera_set_float (ArvCamera *camera,const char *feature,double value,GError **error);
Set a float feature value.
Since: 0.8.0
void arv_camera_set_integer (ArvCamera *camera,const char *feature,gint64 value,GError **error);
Set an integer feature value.
Since: 0.8.0
void arv_camera_set_string (ArvCamera *camera,const char *feature,const char *value,GError **error);
Set an string feature value.
Since: 0.8.0
void arv_camera_set_range_check_policy (ArvCamera *camera,ArvRangeCheckPolicy policy);
Sets the feature range check policy. When enabled, before being set, the value of all nodes with an ArvGcFloat or ArvGcInteger interface will be checked against their Min and Max properties.
Be aware that some camera may have wrong definition of Min and Max, as this check is defined as not mandatory in the Genicam specification. If this is the case, it will not possible to set the value of the features with faulty Min or Max definition. Range check is disabled by default.
Since: 0.8.8
void arv_camera_set_register_cache_policy (ArvCamera *camera,ArvRegisterCachePolicy policy);
Sets the Genicam register cache policy.
Be aware that some camera may have wrong Cachable properties defined in their Genicam metadata, which may lead to incorrect readouts. Using the debug cache policy, and activating genicam debug output (export ARV_DEBUG=genicam), can help you to check the cache validity. In this mode, every time the cache content is not in sync with the actual register value, a debug message is printed on the console.
Since: 0.8.8
gint arv_camera_gv_get_n_stream_channels (ArvCamera *camera,GError **error);
Since: 0.8.0
void arv_camera_gv_select_stream_channel (ArvCamera *camera,gint channel_id,GError **error);
Select the current stream channel. Negative channel_id
is ignored.
Since: 0.8.0
int arv_camera_gv_get_current_stream_channel (ArvCamera *camera,GError **error);
Since: 0.8.0
gint64 arv_camera_gv_get_packet_delay (ArvCamera *camera,GError **error);
Since: 0.8.0
void arv_camera_gv_set_packet_delay (ArvCamera *camera,gint64 delay_ns,GError **error);
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. Negative delay_ns
is ignored.
Since: 0.8.0
guint arv_camera_gv_get_packet_size (ArvCamera *camera,GError **error);
Since: 0.8.0
void arv_camera_gv_set_packet_size (ArvCamera *camera,gint packet_size,GError **error);
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).
Negative packet_size
is ignored.
Since: 0.8.0
guint arv_camera_gv_auto_packet_size (ArvCamera *camera,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. If this feature is not available, the packet size will be set to a default value (1500 bytes).
Since: 0.8.0
void arv_camera_gv_set_packet_size_adjustment (ArvCamera *camera,ArvGvPacketSizeAdjustment adjustment);
Sets the option for packet size adjustment that happens at stream object creation.
Since: 0.8.3
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().
Since: 0.6.0
void arv_camera_uv_set_usb_mode (ArvCamera *camera,ArvUvUsbMode usb_mode);
Since: 0.8.17
guint arv_camera_uv_get_bandwidth (ArvCamera *camera,GError **error);
Since: 0.8.0
void arv_camera_uv_get_bandwidth_bounds (ArvCamera *camera,guint *min,guint *max,GError **error);
Since: 0.8.0
gboolean arv_camera_uv_is_bandwidth_control_available (ArvCamera *camera,GError **error);
Since: 0.8.0
void arv_camera_uv_set_bandwidth (ArvCamera *camera,guint bandwidth,GError **error);
Set the bandwith limit or, if bandwith
is not strictly positive, disable the limit.
Since: 0.8.0
gboolean arv_camera_are_chunks_available (ArvCamera *camera,GError **error);
Since: 0.8.8
gboolean arv_camera_get_chunk_mode (ArvCamera *camera,GError **error);
Check wether chunk data mode is active. Please see arv_camera_set_chunk_mode().
Since: 0.8.0
gboolean arv_camera_get_chunk_state (ArvCamera *camera,const char *chunk,GError **error);
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().
Since: 0.8.0
void arv_camera_set_chunk_mode (ArvCamera *camera,gboolean is_active,GError **error);
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.
Since: 0.8.0
void arv_camera_set_chunk_state (ArvCamera *camera,const char *chunk,gboolean is_enabled,GError **error);
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().
Since: 0.8.0
void arv_camera_set_chunks (ArvCamera *camera,const char *chunk_list,GError **error);
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.
Since: 0.8.0
ArvChunkParser *
arv_camera_create_chunk_parser (ArvCamera *camera);
Creates a new ArvChunkParser object, used for the extraction of chunk data from ArvBuffer.
Since: 0.4.0
const char *
arv_acquisition_mode_to_string (ArvAcquisitionMode value);
ArvAcquisitionMode
arv_acquisition_mode_from_string (const char *string);
ArvExposureMode
arv_exposure_mode_from_string (const char *string);
#define ARAVIS_API_VERSION "0.8"
The version of the Aravis library API.
Since: 0.8.20
#define ARAVIS_MAJOR_VERSION 0
The major version of the Aravis library.
Since: 0.6.0
#define ARAVIS_MICRO_VERSION 20
The micor version of the Aravis library.
Since: 0.6.0
#define ARAVIS_MINOR_VERSION 8
The minor version of the Aravis library.
Since: 0.6.0
#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
#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
#define ARAVIS_HAS_FAST_HEARTBEAT 0
ARAVIS_HAS_FAST_HEARTBEAT is defined as 1 if aravis is compiled with fast hearbeat option, 0 if not.
Since: 0.8.0
|
never adjust packet size |
||
|
adjust packet size if test packet check fails the with current packet size, only on the first stream creation |
||
|
adjust packet size if test packet check fails with current packet size |
||
|
adjust packet size on the first stream creation |
||
|
always adjust the stream packet size |
||
|
default adjustment, which is ON_FAILURE_ONCE (Since 0.8.8) |
|
disables the Exposure and let the shutter open. |
||
|
timed exposure. The exposure duration time is set using the ExposureTime or ExposureAuto features and the exposure starts with the FrameStart or LineStart. |
||
|
uses the width of the current Frame or Line trigger signal(s) pulse to control the exposure duration. Note that if the Frame or Line TriggerActivation is RisingEdge or LevelHigh, the exposure duration will be the time the trigger stays High. If TriggerActivation is FallingEdge or LevelLow, the exposure time will last as long as the trigger stays Low. |
||
|
uses one or more trigger signal(s) to control the exposure duration independently from the current Frame or Line triggers. See ExposureStart, ExposureEnd and ExposureActive of the TriggerSelector feature. |
“device” property“device” ArvDevice *
Internal device object
Owner: ArvCamera
Flags: Read / Write / Construct Only
Stability Level: Private