### Class

# Aravis Buffer

#### 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 instantiation, of pre-allocated. `ArvBuffer` also allows the transmission of image metadata, such as offsets and size of the transmitted region of interest, 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.

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.

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.

since: 0.2.0

#### Instance methods

###### arv_buffer_find_component

Search for the part corresponding to `component_id`.

since: 0.8.25

###### arv_buffer_get_chunk_data

Chunk data accessor.

since: 0.4.0

###### arv_buffer_get_data

Buffer data accessor.

since: 0.4.0

###### arv_buffer_get_frame_id

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

since: 0.8.0

###### arv_buffer_get_gendc_data

GenDC Data accessor.

since: 0.8.31

###### arv_buffer_get_gendc_descriptor

GenDC Descriptor accessor.

since: 0.8.31

###### arv_buffer_get_image_data

No description available.

since: 0.8.25

###### arv_buffer_get_image_height

Gets the image width.

since: 0.4.0

###### arv_buffer_get_image_padding

Gets the image padding.

since: 0.8.23

###### arv_buffer_get_image_pixel_format

Gets the image pixel format.

since: 0.4.0

###### arv_buffer_get_image_region

Gets the image region.

since: 0.4.0

###### arv_buffer_get_image_width

Gets the image width.

since: 0.4.0

###### arv_buffer_get_image_x

Gets the image x offset.

since: 0.4.0

###### arv_buffer_get_image_y

Gets the image y offset.

since: 0.4.0

###### arv_buffer_get_n_parts

No description available.

since: 0.8.23

###### arv_buffer_get_part_component_id

No description available.

since: 0.8.25

###### arv_buffer_get_part_data

No description available.

since: 0.8.23

###### arv_buffer_get_part_data_type

No description available.

since: 0.8.23

###### arv_buffer_get_part_height

Gets the part height.

since: 0.8.23

###### arv_buffer_get_part_padding

Gets the part padding.

since: 0.8.23

###### arv_buffer_get_part_pixel_format

Gets the part pixel format.

since: 0.8.23

###### arv_buffer_get_part_region

Gets the part region.

since: 0.8.23

###### arv_buffer_get_part_width

Gets the part width.

since: 0.8.23

###### arv_buffer_get_part_x

Gets the part x offset.

since: 0.8.23

###### arv_buffer_get_part_y

Gets the part y_offset.

since: 0.8.23

###### arv_buffer_get_payload_type

Gets the buffer payload type.

since: 0.4.0

###### arv_buffer_get_status

Gets the buffer acquisition status.

since: 0.4.0

###### arv_buffer_get_system_timestamp

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

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().

since: 0.4.0

###### arv_buffer_get_user_data

Gets a pointer to user data set by arv_buffer_new_full.

since: 0.4.0

###### arv_buffer_has_chunks

No description available.

since: 0.8.0

###### arv_buffer_has_gendc

No description available.

since: 0.8.31

###### arv_buffer_set_frame_id

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

since: 0.8.3

###### arv_buffer_set_system_timestamp

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

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.

since: 0.4.0

##### Methods inherited from GObject (43)

Please see GObject for a full list of methods.

#### Signals

##### Signals inherited from GObject (1)

###### GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

#### Class structure

    struct AravisBufferClass {
      GObjectClass parent_class;

    }

No description available.

###### Class members

`parent_class: GObjectClass`

  No description available.