### Class

# Aravis Camera

#### Description [src]

    class Aravis.Camera : GObject.Object
      implements Gio.Initable {
      /* No available fields */
    }

`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.

#### Ancestors

- GObject

#### Implements

- GInitable

#### Constructors

###### arv_camera_new

Creates a new `ArvCamera`. If `name` is null, it will instantiate the first available camera.

since: 0.8.0

###### arv_camera_new_with_device

Creates a new `ArvCamera`, using `device` as its internal device object.

since: 0.8.6

#### Instance methods

###### arv_camera_abort_acquisition

Aborts video stream acquisition.

since: 0.8.0

###### arv_camera_acquisition

Acquire one image buffer.

since: 0.8.0

###### arv_camera_are_chunks_available

No description available.

since: 0.8.8

###### arv_camera_clear_triggers

Disables all triggers.

since: 0.8.0

###### arv_camera_create_chunk_parser

Creates a new `ArvChunkParser` object, used for the extraction of chunk data from `ArvBuffer`.

since: 0.4.0

###### arv_camera_create_stream

Creates a new `ArvStream` for video stream reception. See `ArvStreamCallback` for details regarding the callback function.

since: 0.2.0

###### arv_camera_create_stream_full

Creates a new `ArvStream` for video stream reception. See `ArvStreamCallback` for details regarding the callback function.

since: 0.8.23

###### arv_camera_dup_available_black_levels

Retrieves the list of all available black level selectors as strings.

since: 0.8.27

###### arv_camera_dup_available_components

Retrieves the list of available components.

since: 0.8.23

###### arv_camera_dup_available_enumerations

Get all the available values of `feature`, as 64 bit integers.

since: 0.8.0

###### arv_camera_dup_available_enumerations_as_display_names

Get display names of all the available entries of `feature`.

since: 0.8.0

###### arv_camera_dup_available_enumerations_as_strings

Get all the available values of `feature`, as strings.

since: 0.8.0

###### arv_camera_dup_available_gains

Retrieves the list of all available gain selectors as strings.

since: 0.8.27

###### arv_camera_dup_available_pixel_formats

Retrieves the list of all available pixel formats.

since: 0.8.0

###### arv_camera_dup_available_pixel_formats_as_display_names

Retrieves the list of all available pixel formats as display names. In general, these human-readable strings cannot be used as settings.

since: 0.8.0

###### arv_camera_dup_available_pixel_formats_as_strings

Retrieves the list of all available pixel formats as strings.

since: 0.8.0

###### arv_camera_dup_available_trigger_sources

Gets the list of all available trigger sources.

since: 0.8.0

###### arv_camera_dup_available_triggers

Gets a list of all available triggers: FrameStart, ExposureActive, etc…

since: 0.8.0

###### arv_camera_dup_register

No description available.

since: 0.8.31

###### arv_camera_execute_command

Execute a Genicam command.

since: 0.8.0

###### arv_camera_get_acquisition_mode

No description available.

since: 0.8.0

###### arv_camera_get_binning

Retrieves binning in both directions.

since: 0.8.0

###### arv_camera_get_black_level

No description available.

since: 0.8.19

###### arv_camera_get_black_level_auto

No description available.

since: 0.8.19

###### arv_camera_get_black_level_bounds

Retrieves blacklevel bounds.

since: 0.8.19

###### arv_camera_get_boolean

No description available.

since: 0.8.0

###### arv_camera_get_boolean_gi

No description available.

since: 0.8.0

###### arv_camera_get_chunk_mode

Check wether chunk data mode is active. Please see arv_camera_set_chunk_mode().

since: 0.8.0

###### arv_camera_get_chunk_state

Gets state of chunk data. Chunk data are be embedded in `ArvBuffer` only if chunk mode is active. Please see arv_camera_set_chunk_mode().

since: 0.8.0

###### arv_camera_get_device

Retrieves the `ArvDevice` object for more complete access to camera features.

since: 0.2.0

###### arv_camera_get_device_id

No description available.

since: 0.8.0

###### arv_camera_get_device_serial_number

No description available.

since: 0.8.8

###### arv_camera_get_exposure_time

No description available.

since: 0.8.0

###### arv_camera_get_exposure_time_auto

No description available.

since: 0.8.0

###### arv_camera_get_exposure_time_bounds

Retrieves exposure time bounds, in µs.

since: 0.8.0

###### arv_camera_get_exposure_time_increment

No description available.

since: 0.8.36

###### arv_camera_get_exposure_time_representation

No description available.

since: 0.8.31

###### arv_camera_get_feature_representation

No description available.

since: 0.8.31

###### arv_camera_get_float

No description available.

since: 0.8.0

###### arv_camera_get_float_bounds

Retrieves float feature bounds.

since: 0.8.0

###### arv_camera_get_float_increment

No description available.

since: 0.8.16

###### arv_camera_get_frame_count

No description available.

since: 0.8.0

###### arv_camera_get_frame_count_bounds

Retrieves allowed range for frame count.

since: 0.8.0

###### arv_camera_get_frame_rate

No description available.

since: 0.8.0

###### arv_camera_get_frame_rate_bounds

Retrieves allowed range for framerate.

###### arv_camera_get_frame_rate_enable

No description available.

since: 0.8.31

###### arv_camera_get_gain

No description available.

since: 0.8.0

###### arv_camera_get_gain_auto

No description available.

since: 0.8.0

###### arv_camera_get_gain_bounds

Retrieves gain bounds.

since: 0.8.0

###### arv_camera_get_gain_increment

No description available.

since: 0.8.36

###### arv_camera_get_gain_representation

No description available.

since: 0.8.31

###### arv_camera_get_height_bounds

Retrieves the valid range for image height.

since: 0.8.0

###### arv_camera_get_height_increment

No description available.

since: 0.8.0

###### arv_camera_get_integer

No description available.

since: 0.8.0

###### arv_camera_get_integer_bounds

Retrieves integer feature bounds.

since: 0.8.0

###### arv_camera_get_integer_increment

No description available.

since: 0.8.0

###### arv_camera_get_model_name

No description available.

since: 0.8.0

###### arv_camera_get_payload

Retrieves the size needed for the storage of an image. This value is used for the creation of the stream buffers.

since: 0.8.0

###### arv_camera_get_pixel_format

No description available.

since: 0.8.0

###### arv_camera_get_pixel_format_as_string

since: 0.8.0

###### arv_camera_get_region

Retrieves the current region of interest.

since: 0.8.0

###### arv_camera_get_sensor_size

No description available.

since: 0.8.0

###### arv_camera_get_string

No description available.

since: 0.8.0

###### arv_camera_get_trigger_source

Gets the trigger source. This function doesn’t check if the camera is configured to actually use this source as a trigger.

since: 0.8.0

###### arv_camera_get_vendor_name

No description available.

since: 0.8.0

###### arv_camera_get_width_bounds

Retrieves the valid range for image width.

since: 0.8.0

###### arv_camera_get_width_increment

No description available.

since: 0.8.0

###### arv_camera_get_x_binning_bounds

Retrieves the valid range for image horizontal binning.

since: 0.8.0

###### arv_camera_get_x_binning_increment

No description available.

since: 0.8.0

###### arv_camera_get_x_offset_bounds

Retrieves the valid range for image horizontal offset.

since: 0.8.0

###### arv_camera_get_x_offset_increment

No description available.

since: 0.8.0

###### arv_camera_get_y_binning_bounds

Retrieves the valid range for image vertical binning.

since: 0.8.0

###### arv_camera_get_y_binning_increment

No description available.

since: 0.8.0

###### arv_camera_get_y_offset_bounds

Retrieves the valid range for image vertical offset.

since: 0.8.0

###### arv_camera_get_y_offset_increment

No description available.

since: 0.8.0

###### arv_camera_gv_auto_packet_size

Automatically determine the biggest packet size that can be used data streaming, and set GevSCPSPacketSize value accordingly. This function relies on the GevSCPSFireTestPacket feature. If this feature is not available, the packet size will be set to a default value (1500 bytes).

since: 0.8.0

###### arv_camera_gv_get_current_stream_channel

No description available.

since: 0.8.0

###### arv_camera_gv_get_ip_configuration_mode

Get the IP address configuration mode.

since: 0.8.22

###### arv_camera_gv_get_multipart

No description available.

since: 0.8.23

###### arv_camera_gv_get_n_network_interfaces

No description available.

since: 0.8.25

###### arv_camera_gv_get_n_stream_channels

No description available.

since: 0.8.0

###### arv_camera_gv_get_packet_delay

No description available.

since: 0.8.0

###### arv_camera_gv_get_packet_size

No description available.

since: 0.8.0

###### arv_camera_gv_get_persistent_ip

Get the persistent IP address setting of camera.

since: 0.8.22

###### arv_camera_gv_is_multipart_supported

No description available.

since: 0.8.23

###### arv_camera_gv_select_stream_channel

Select the current stream channel. Negative `channel_id` is ignored.

since: 0.8.0

###### arv_camera_gv_set_ip_configuration_mode

Sets the IP address configuration mode. Available modes are ARV_GV_IP_CONFIGURATION_MODE_DHCP, ARV_GV_IP_CONFIGURATION_MODE_PERSISTENT_IP, ARV_GV_IP_CONFIGURATION_MODE_LLA.

since: 0.8.22

###### arv_camera_gv_set_multipart

Control multipart payload support.

since: 0.8.23

###### arv_camera_gv_set_packet_delay

Configure the inter packet delay to insert between each packet for the current stream channel. This can be used as a crude flow-control mechanism if the application or the network infrastructure cannot keep up with the packets coming from the device. Negative `delay_ns` is ignored.

since: 0.8.0

###### arv_camera_gv_set_packet_size

Specifies the stream packet size, in bytes, to send on the selected channel for a GVSP transmitter or specifies the maximum packet size supported by a GVSP receiver.

since: 0.8.0

###### arv_camera_gv_set_packet_size_adjustment

Sets the option for packet size adjustment that happens at stream object creation.

since: 0.8.3

###### arv_camera_gv_set_persistent_ip

Sets the persistent IP address to camera.

since: 0.8.22

###### arv_camera_gv_set_persistent_ip_from_string

Sets the persistent IP address to camera.

since: 0.8.22

###### arv_camera_gv_set_stream_options

Sets the options used during stream object creation. These options mus be set before the call to arv_camera_create_stream().

since: 0.6.0

###### arv_camera_is_binning_available

No description available.

since: 0.8.0

###### arv_camera_is_black_level_auto_available

No description available.

since: 0.8.19

###### arv_camera_is_black_level_available

No description available.

since: 0.8.19

###### arv_camera_is_component_available

No description available.

since: 0.8.25

###### arv_camera_is_enumeration_entry_available

No description available.

since: 0.8.17

###### arv_camera_is_exposure_auto_available

No description available.

since: 0.8.0

###### arv_camera_is_exposure_time_available

No description available.

since: 0.8.0

###### arv_camera_is_feature_available

No description available.

since: 0.8.0

###### arv_camera_is_feature_implemented

No description available.

since: 0.8.23

###### arv_camera_is_frame_rate_available

No description available.

since: 0.8.0

###### arv_camera_is_gain_auto_available

No description available.

since: 0.8.0

###### arv_camera_is_gain_available

No description available.

since: 0.8.0

###### arv_camera_is_gv_device

No description available.

since: 0.4.0

###### arv_camera_is_region_offset_available

No description available.

since: 0.8.22

###### arv_camera_is_software_trigger_supported

No description available.

since: 0.8.17

###### arv_camera_is_uv_device

No description available.

since: 0.6.0

###### arv_camera_select_and_enable_component

Select and enable the given component.

since: 0.8.23

###### arv_camera_select_black_level

Configures Black Level Selector feature.

since: 0.8.27

###### arv_camera_select_component

Select and enable or disable the given `component`.

since: 0.8.25

###### arv_camera_select_gain

Configures Gain Selector feature.

since: 0.8.27

###### arv_camera_set_access_check_policy

Sets the feature access check policy. When enabled, before being accessed, the actual read/write access of register is checked using AccessMode properties. On some devices, it helps to avoid forbidden writes to registers that may put the device in a bad state.

since: 0.8.22

###### arv_camera_set_acquisition_mode

No description available.

###### arv_camera_set_binning

Defines binning in both directions. Not all cameras support this feature. Negative `dx` or `dy` values are ignored.

since: 0.8.0

###### arv_camera_set_black_level

No description available.

since: 0.8.19

###### arv_camera_set_black_level_auto

Configures automatic black level feature.

since: 0.8.19

###### arv_camera_set_boolean

Set a boolean feature value.

since: 0.8.0

###### arv_camera_set_chunk_mode

Controls wether chunk data mode is active. When active, chunk data are appended to image data in `ArvBuffer`. A `ArvChunkParser` must be used in order to extract chunk data.

since: 0.8.0

###### arv_camera_set_chunk_state

Sets state of a chunk data. Chunk data are be embedded in `ArvBuffer` only if chunk mode is active. Please see arv_camera_set_chunk_mode().

since: 0.8.0

###### arv_camera_set_chunks

Convenience function for enabling a set of chunk data. Chunk mode is activated, or deactivated if `chunk_list` is `NULL` or empty. All chunk data not listed are disabled.

since: 0.8.0

###### arv_camera_set_exposure_mode

No description available.

###### arv_camera_set_exposure_time

Sets exposure time. User should take care to set a value compatible with the desired frame rate. Negative `exposure_time_us` is ignored.

since: 0.8.0

###### arv_camera_set_exposure_time_auto

Configures automatic exposure feature.

since: 0.8.0

###### arv_camera_set_float

Set a float feature value.

since: 0.8.0

###### arv_camera_set_frame_count

Sets the number of frames to capture in MultiFrame mode.

since: 0.8.0

###### arv_camera_set_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 negative or zero `frame_rate` value disables the frame rate limit.

since: 0.8.0

###### arv_camera_set_frame_rate_enable

No description available.

###### arv_camera_set_gain

Sets the gain of the ADC converter. Negative `gain` is ignored.

since: 0.8.0

###### arv_camera_set_gain_auto

Configures automatic gain feature.

since: 0.8.0

###### arv_camera_set_integer

Set an integer feature value.

since: 0.8.0

###### arv_camera_set_pixel_format

Defines pixel format.

since: 0.8.0

###### arv_camera_set_pixel_format_from_string

Defines pixel format described by a string.

since: 0.8.0

###### arv_camera_set_range_check_policy

Sets the feature range check policy. When enabled, before being set, the value of all nodes with an `ArvGcFloat` or `ArvGcInteger` interface will be checked against their Min and Max properties.

since: 0.8.8

###### arv_camera_set_region

Defines the region of interest which will be transmitted in the video stream. Negative `x` or `y` values, or not strictly positive `width` or `height` values are ignored.

since: 0.8.0

###### arv_camera_set_register

Set a register content.

since: 0.8.31

###### arv_camera_set_register_cache_policy

Sets the Genicam register cache policy.

since: 0.8.8

###### arv_camera_set_string

Set an string feature value.

since: 0.8.0

###### arv_camera_set_trigger

Configures the camera in trigger mode. Typical values for source are “Line1” or “Line2”. See the camera documentation for the allowed values. Source can also be “Software”. In this case, an acquisition is triggered by a call to arv_camera_software_trigger().

since: 0.8.0

###### arv_camera_set_trigger_source

Sets the trigger source. This function doesn’t check if the camera is configured to actually use this source as a trigger.

since: 0.8.0

###### arv_camera_software_trigger

Sends a software trigger command to `camera`. The camera must be previously configured to use a software trigger, using `arv_camera_set_trigger`().

since: 0.8.0

###### arv_camera_start_acquisition

Starts video stream acquisition.

since: 0.8.0

###### arv_camera_stop_acquisition

Stops video stream acquisition.

since: 0.8.0

###### arv_camera_uv_get_bandwidth

No description available.

since: 0.8.0

###### arv_camera_uv_get_bandwidth_bounds

No description available.

since: 0.8.0

###### arv_camera_uv_is_bandwidth_control_available

No description available.

since: 0.8.0

###### arv_camera_uv_set_bandwidth

Set the bandwith limit or, if `bandwith` is not strictly positive, disable the limit.

since: 0.8.0

###### arv_camera_uv_set_usb_mode

No description available.

since: 0.8.17

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

Please see GObject for a full list of methods.

##### Methods inherited from GInitable (1)

###### g_initable_init

Initializes the object implementing the interface.

#### Properties

###### Aravis.Camera:device

Internal device object.

###### Aravis.Camera:name

Internal device name for object construction.

#### 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 AravisCameraClass {
      GObjectClass parent_class;

    }

No description available.

###### Class members

`parent_class: GObjectClass`

  No description available.