ArvFakeCamera: Aravis Reference Manual

ArvFakeCamera

ArvFakeCamera — Fake camera internals

Functions

ArvFakeCamera *	arv_fake_camera_new ()
ArvFakeCamera *	arv_fake_camera_new_full ()
gboolean	arv_fake_camera_read_memory ()
gboolean	arv_fake_camera_write_memory ()
gboolean	arv_fake_camera_read_register ()
gboolean	arv_fake_camera_write_register ()
void	arv_fake_camera_wait_for_next_frame ()
guint64	arv_fake_camera_get_sleep_time_for_next_frame ()
void	arv_fake_camera_fill_buffer ()
void	arv_fake_camera_set_inet_address ()
guint32	arv_fake_camera_get_acquisition_status ()
guint32	arv_fake_camera_get_control_channel_privilege ()
guint32	arv_fake_camera_get_heartbeat_timeout ()
size_t	arv_fake_camera_get_payload ()
GSocketAddress *	arv_fake_camera_get_stream_address ()
void	arv_fake_camera_set_control_channel_privilege ()
void	arv_fake_camera_set_fill_pattern ()
void	arv_fake_camera_set_trigger_frequency ()
const char *	arv_fake_camera_get_genicam_xml ()
void	arv_set_fake_camera_genicam_filename ()

Types and Values

ArvFakeCamera

Object Hierarchy

    GObject
    ╰── ArvFakeCamera

Description

ArvFakeCamera is a class that simulate a real camera, which provides methods for the implementation of ArvFakeDevice and ArvFakeStream.

arv-fake-gv-camera is a GV camera simulator based on this class.

Functions

arv_fake_camera_new ()

ArvFakeCamera *
arv_fake_camera_new (const char *serial_number);

arv_fake_camera_new_full ()

ArvFakeCamera *
arv_fake_camera_new_full (const char *serial_number,
                          const char *genicam_filename);

arv_fake_camera_read_memory ()

gboolean
arv_fake_camera_read_memory (ArvFakeCamera *camera,
                             guint32 address,
                             guint32 size,
                             void *buffer);

arv_fake_camera_write_memory ()

gboolean
arv_fake_camera_write_memory (ArvFakeCamera *camera,
                              guint32 address,
                              guint32 size,
                              const void *buffer);

arv_fake_camera_read_register ()

gboolean
arv_fake_camera_read_register (ArvFakeCamera *camera,
                               guint32 address,
                               guint32 *value);

Parameters

camera	a ArvFakeCamera
address	the register address
value	the register value.	[out]

Returns

true if the read succeeded, false otherwise

arv_fake_camera_write_register ()

gboolean
arv_fake_camera_write_register (ArvFakeCamera *camera,
                                guint32 address,
                                guint32 value);

arv_fake_camera_wait_for_next_frame ()

void
arv_fake_camera_wait_for_next_frame (ArvFakeCamera *camera);

arv_fake_camera_get_sleep_time_for_next_frame ()

guint64
arv_fake_camera_get_sleep_time_for_next_frame
                               (ArvFakeCamera *camera,
                                guint64 *next_timestamp_us);

Parameters

camera	a ArvFakeCamera
next_timestamp_us	the timestamp for the next frame in microseconds.	[out][optional]

Returns

the sleep time for the next frame

arv_fake_camera_fill_buffer ()

void
arv_fake_camera_fill_buffer (ArvFakeCamera *camera,
                             ArvBuffer *buffer,
                             guint32 *packet_size);

Fill a buffer with data from the fake camera.

Parameters

camera	a ArvFakeCamera
buffer	the ArvBuffer to fill
packet_size	the packet size.	[out][optional]

arv_fake_camera_set_inet_address ()

void
arv_fake_camera_set_inet_address (ArvFakeCamera *camera,
                                  GInetAddress *address);

arv_fake_camera_get_acquisition_status ()

guint32
arv_fake_camera_get_acquisition_status
                               (ArvFakeCamera *camera);

arv_fake_camera_get_control_channel_privilege ()

guint32
arv_fake_camera_get_control_channel_privilege
                               (ArvFakeCamera *camera);

arv_fake_camera_get_heartbeat_timeout ()

guint32
arv_fake_camera_get_heartbeat_timeout (ArvFakeCamera *camera);

arv_fake_camera_get_payload ()

size_t
arv_fake_camera_get_payload (ArvFakeCamera *camera);

arv_fake_camera_get_stream_address ()

GSocketAddress *
arv_fake_camera_get_stream_address (ArvFakeCamera *camera);

Parameters

camera

a ArvFakeCamera

Returns

the data stream GSocketAddress for this camera.

[transfer full]

arv_fake_camera_set_control_channel_privilege ()

void
arv_fake_camera_set_control_channel_privilege
                               (ArvFakeCamera *camera,
                                guint32 privilege);

arv_fake_camera_set_fill_pattern ()

void
arv_fake_camera_set_fill_pattern (ArvFakeCamera *camera,
                                  ArvFakeCameraFillPattern fill_pattern_callback,
                                  void *fill_pattern_data);

Sets the fill pattern callback for custom test images.

Parameters

camera	a ArvFakeCamera
fill_pattern_callback	callback for image filling.	[scope call]
fill_pattern_data	image filling user data.	[closure]

arv_fake_camera_set_trigger_frequency ()

void
arv_fake_camera_set_trigger_frequency (ArvFakeCamera *camera,
                                       double frequency);

arv_fake_camera_get_genicam_xml ()

const char *
arv_fake_camera_get_genicam_xml (ArvFakeCamera *camera,
                                 size_t *size);

Parameters

camera	a ArvFakeCamera
size	the size of the returned XML string.	[out][optional]

Returns

the genicam XML description of the camera.

[transfer none]

arv_set_fake_camera_genicam_filename ()

void
arv_set_fake_camera_genicam_filename (const char *filename);

Types and Values

ArvFakeCamera

typedef struct _ArvFakeCamera ArvFakeCamera;