Class

AravisBuffer

Description [src]

final class Aravis.Buffer : GObject.Object {
  /* No available fields */
}

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.

Ancestors

  • GObject

Constructors

arv_buffer_new

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.

Available since: 0.2.0

arv_buffer_new_allocate

Creates a new buffer for the storage of the video stream images. The data space is allocated by this function, and will be freed when the buffer is destroyed.

Available since: 0.2.3

arv_buffer_new_full

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.

Available since: 0.2.0

Instance methods

arv_buffer_get_chunk_data

Chunk data accessor.

Available since: 0.4.0

arv_buffer_get_data

Buffer data accessor.

Available since: 0.4.0

arv_buffer_get_frame_id

Gets the buffer frame id. For GigEVision devices, 0 is an invalid value.

Available since: 0.8.0

arv_buffer_get_image_height

Gets the image width. This function must only be called on buffer containing a ARV_BUFFER_PAYLOAD_TYPE_IMAGE payload.

Available since: 0.4.0

arv_buffer_get_image_pixel_format

Gets the image pixel format. This function must only be called on buffer containing a ARV_BUFFER_PAYLOAD_TYPE_IMAGE payload.

Available since: 0.4.0

arv_buffer_get_image_region

Gets the image region. This function must only be called on buffer containing a ARV_BUFFER_PAYLOAD_TYPE_IMAGE payload.

Available since: 0.4.0

arv_buffer_get_image_width

Gets the image width. This function must only be called on buffer containing a ARV_BUFFER_PAYLOAD_TYPE_IMAGE payload.

Available since: 0.4.0

arv_buffer_get_image_x

Gets the image x offset. This function must only be called on buffer containing a ARV_BUFFER_PAYLOAD_TYPE_IMAGE payload.

Available since: 0.4.0

arv_buffer_get_image_y

Gets the image y offset. This function must only be called on buffer containing a ARV_BUFFER_PAYLOAD_TYPE_IMAGE payload.

Available since: 0.4.0

arv_buffer_get_payload_type

Gets the buffer payload type.

Available since: 0.4.0

arv_buffer_get_status

Gets the buffer acquisition status.

Available since: 0.4.0

arv_buffer_get_system_timestamp

Gets the system timestamp for when the frame was received. Expressed in nanoseconds.

Available since: 0.6.0

arv_buffer_get_timestamp

Gets the buffer camera timestamp, expressed as nanoseconds. Not all devices provide reliable timestamp, which means sometimes its better to rely on the buffer completion host local time, or to use arv_buffer_get_system_timestamp().

Available since: 0.4.0

arv_buffer_get_user_data

Gets a pointer to user data set by arv_buffer_new_full.

Available since: 0.4.0

arv_buffer_has_chunks
No description available.

Available since: 0.8.0

arv_buffer_set_frame_id

Sets the buffer frame id. For GigEVision devices, 0 is an invalid value.

Available since: 0.8.3

arv_buffer_set_system_timestamp

Sets the system timestamp for when the frame was received. Expressed in nanoseconds.

Available since: 0.6.0

arv_buffer_set_timestamp

Sets the buffer timestamp, which allows to override the timpestamp set by the camera, which in some case is incorrect.

Available since: 0.4.0

Class structure

struct AravisBufferClass {
  GObjectClass parent_class;
  
}
Class members
parent_class
GObjectClass
  No description available.