![]() |
![]() |
![]() |
Aravis Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy |
enum ArvCameraVendor; ArvCamera; ArvCamera * arv_camera_new (const char *name
); ArvStream * arv_camera_create_stream (ArvCamera *camera
,ArvStreamCallback callback
,void *user_data
); const char * arv_camera_get_vendor_name (ArvCamera *camera
); const char * arv_camera_get_model_name (ArvCamera *camera
); const char * arv_camera_get_device_id (ArvCamera *camera
); void arv_camera_get_sensor_size (ArvCamera *camera
,gint *width
,gint *height
); void arv_camera_set_region (ArvCamera *camera
,gint x
,gint y
,gint width
,gint height
); void arv_camera_get_region (ArvCamera *camera
,gint *x
,gint *y
,gint *width
,gint *height
); void arv_camera_set_binning (ArvCamera *camera
,gint dx
,gint dy
); void arv_camera_get_binning (ArvCamera *camera
,gint *dx
,gint *dy
); void arv_camera_set_pixel_format (ArvCamera *camera
,ArvPixelFormat format
); ArvPixelFormat arv_camera_get_pixel_format (ArvCamera *camera
); void arv_camera_start_acquisition (ArvCamera *camera
); void arv_camera_stop_acquisition (ArvCamera *camera
); void arv_camera_set_acquisition_mode (ArvCamera *camera
,ArvAcquisitionMode value
); ArvAcquisitionMode arv_camera_get_acquisition_mode (ArvCamera *camera
); void arv_camera_set_frame_rate (ArvCamera *camera
,double frame_rate
); double arv_camera_get_frame_rate (ArvCamera *camera
); void arv_camera_set_trigger (ArvCamera *camera
,const char *source
); void arv_camera_set_exposure_time (ArvCamera *camera
,double exposure_time_us
); double arv_camera_get_exposure_time (ArvCamera *camera
); void arv_camera_set_gain (ArvCamera *camera
,gint64 gain
); gint64 arv_camera_get_gain (ArvCamera *camera
); guint arv_camera_get_payload (ArvCamera *camera
); enum ArvAcquisitionMode; const char * arv_acquisition_mode_to_string (ArvAcquisitionMode value
); ArvAcquisitionMode arv_acquisition_mode_from_string (const char *string
);
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.
typedef enum { ARV_CAMERA_VENDOR_UNKNOWN, ARV_CAMERA_VENDOR_BASLER, ARV_CAMERA_VENDOR_PROSILICA } ArvCameraVendor;
ArvCamera * arv_camera_new (const char *name
);
Creates a new ArvCamera. If name
is null, it will instantiate the
first available camera
|
name of the camera. Return value: a new ArvCamera.. allow-none. |
ArvStream * arv_camera_create_stream (ArvCamera *camera
,ArvStreamCallback callback
,void *user_data
);
Creates a new ArvStream for video stream handling. See
arv_device_create_stream
for details regarding the callback function.
const char * arv_camera_get_vendor_name (ArvCamera *camera
);
|
a ArvCamera Return value: the camera vendor name. |
const char * arv_camera_get_model_name (ArvCamera *camera
);
|
a ArvCamera Return value: the camera model name. |
const char * arv_camera_get_device_id (ArvCamera *camera
);
|
a ArvCamera Return value: the camera device ID. |
void arv_camera_get_sensor_size (ArvCamera *camera
,gint *width
,gint *height
);
|
a ArvCamera |
|
camera sensor width placeholder |
|
camera sensor height placeholder |
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.
|
a ArvCamera |
|
x offset |
|
y_offset |
|
region width |
|
region height |
void arv_camera_get_region (ArvCamera *camera
,gint *x
,gint *y
,gint *width
,gint *height
);
Retrieves the current region of interest.
|
a ArvCamera |
|
x offset placeholder |
|
y_offset placeholder |
|
region width placeholder |
|
region height placeholder |
void arv_camera_set_binning (ArvCamera *camera
,gint dx
,gint dy
);
Defines the binning in both directions. Not all cameras support this feature.
|
a ArvCamera |
|
horizontal binning |
|
vertical binning |
void arv_camera_get_binning (ArvCamera *camera
,gint *dx
,gint *dy
);
Retrieves the binning in both directions.
|
a ArvCamera |
|
horizontal binning placeholder |
|
vertical binning placeholder |
void arv_camera_set_pixel_format (ArvCamera *camera
,ArvPixelFormat format
);
Defines the pixel format.
|
a ArvCamera |
|
pixel format |
ArvPixelFormat arv_camera_get_pixel_format (ArvCamera *camera
);
Retrieves the pixel format.
|
a ArvCamera |
void arv_camera_start_acquisition (ArvCamera *camera
);
Starts the video stream acquisition.
|
a ArvCamera |
void arv_camera_stop_acquisition (ArvCamera *camera
);
Stops the video stream acquisition.
|
a ArvCamera |
void arv_camera_set_acquisition_mode (ArvCamera *camera
,ArvAcquisitionMode value
);
ArvAcquisitionMode arv_camera_get_acquisition_mode (ArvCamera *camera
);
Retrieves the acquisition mode.
|
a ArvCamera Return value: the acquisition mode. |
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.
|
a ArvCamera |
|
frame rate, in Hz |
double arv_camera_get_frame_rate (ArvCamera *camera
);
|
a ArvCamera Return value: the actual frame rate, in Hz. |
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. The activation is set to rising edge. It can be changed by accessing the underlying device object.
|
a ArvCamera |
|
trigger source as string |
void arv_camera_set_exposure_time (ArvCamera *camera
,double exposure_time_us
);
Sets the exposure time. User should take care to set a value compatible with the desired frame rate.
|
a ArvCamera |
|
exposure time, in µs |
double arv_camera_get_exposure_time (ArvCamera *camera
);
|
a ArvCamera Return value: the current exposure time, in µs. |
void arv_camera_set_gain (ArvCamera *camera
,gint64 gain
);
Sets the gain of the ADC converter.
|
a ArvCamera |
|
gain value |
gint64 arv_camera_get_gain (ArvCamera *camera
);
|
a ArvCamera Return value: the current gain setting. |
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.
|
a ArvCamera Return value: the frame storage size, in bytes. |
typedef enum { ARV_ACQUISITION_MODE_CONTINUOUS, ARV_ACQUISITION_MODE_SINGLE_FRAME } ArvAcquisitionMode;
const char * arv_acquisition_mode_to_string (ArvAcquisitionMode value
);
ArvAcquisitionMode arv_acquisition_mode_from_string (const char *string
);