|
|
|
Aravis Reference Manual | |
|---|---|---|---|---|
| Top | Description | Object Hierarchy | ||||
void (*ArvFrameCallback) (ArvBuffer *buffer); enum ArvBufferStatus; ArvBuffer; ArvBuffer * arv_buffer_new (size_t size,void *preallocated); ArvBuffer * arv_buffer_new_full (size_t size,void *preallocated,void *user_data,GDestroyNotify user_data_destroy_func);
ArvBuffer provides a class for the instantiation of buffers used for the storage of the separate images of the video stream. The actual data space may either be allocated by ArvBuffer during an object instatiation, of preallocated. ArvBuffer also allows the transmission of image metadata, such as offsets and size of the transmitted region of interrest, pixel format and time stamp.
typedef enum {
ARV_BUFFER_STATUS_SUCCESS,
ARV_BUFFER_STATUS_CLEARED,
ARV_BUFFER_STATUS_TIMEOUT,
ARV_BUFFER_STATUS_MISSING_PACKETS,
ARV_BUFFER_STATUS_WRONG_PACKET_ID,
ARV_BUFFER_STATUS_SIZE_MISMATCH,
ARV_BUFFER_STATUS_FILLING,
ARV_BUFFER_STATUS_ABORTED
} ArvBufferStatus;
| the buffer contains a valid image | |
| the buffer is cleared | |
| timeout was reached before all packets are received | |
| stream has missing packets | |
| stream has packet with wrong id | |
| the received image didn't fit in the buffer data space | |
| the image is currently being filled | |
| the filling was aborted before completion |
ArvBuffer * arv_buffer_new (size_t size,void *preallocated);
Creates a new buffer for the storage of the video stream images. The data space can be either preallocated, and the caller is responsible for it's deallocation, or allocated by this function. If it is the case, data memory will be freed when the buffer is destroyed.
|
payload size |
|
preallocated memory buffer. [allow-none][transfer none] |
ArvBuffer * arv_buffer_new_full (size_t size,void *preallocated,void *user_data,GDestroyNotify user_data_destroy_func);
Creates a new buffer for the storage of the video stream images. The data space can be either preallocated, and the caller is responsible for it's deallocation, or allocated by this function. If it is the case, data memory will be freed when the buffer is destroyed.
If user_data_destroy_func is non NULL, it will be called in order to destroy
user_data when the buffer is destroyed.
|
payload size |
|
preallocated memory buffer. [transfer none][allow-none] |
|
a pointer to user data associated to this buffer. [transfer none] |
|
an optional user data destroy callback |