Class
AravisCamera
Description [src]
class Aravis.Camera : GObject.Object {
parent_instance: GObject
}
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.
Constructors
arv_camera_new
Creates a new ArvCamera
. If name
is null, it will instantiate the
first available camera.
Available since: 0.8.0
arv_camera_new_with_device
Creates a new ArvCamera
, using device
as its internal device object.
Available since: 0.8.6
Instance methods
arv_camera_create_chunk_parser
Creates a new ArvChunkParser
object, used for the extraction of chunk data from ArvBuffer
.
Available since: 0.4.0
arv_camera_create_stream
Creates a new ArvStream
for video stream reception. See
ArvStreamCallback for details regarding the callback function.
Available 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.
Available since: 0.8.23
arv_camera_dup_available_black_levels
Retrieves the list of all available black level selectors as strings.
Available since: 0.8.27
arv_camera_dup_available_components
Retrieves the list of available components.
Available since: 0.8.23
arv_camera_dup_available_enumerations
Get all the available values of feature
, as 64 bit integers.
Available since: 0.8.0
arv_camera_dup_available_enumerations_as_display_names
Get display names of all the available entries of feature
.
Available since: 0.8.0
arv_camera_dup_available_enumerations_as_strings
Get all the available values of feature
, as strings.
Available since: 0.8.0
arv_camera_dup_available_gains
Retrieves the list of all available gain selectors as strings.
Available since: 0.8.27
arv_camera_dup_available_pixel_formats
Retrieves the list of all available pixel formats.
Available 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.
Available since: 0.8.0
arv_camera_dup_available_pixel_formats_as_strings
Retrieves the list of all available pixel formats as strings.
Available since: 0.8.0
arv_camera_dup_available_trigger_sources
Gets the list of all available trigger sources.
Available since: 0.8.0
arv_camera_dup_available_triggers
Gets a list of all available triggers: FrameStart, ExposureActive, etc…
Available since: 0.8.0
arv_camera_get_chunk_mode
Check wether chunk data mode is active. Please see arv_camera_set_chunk_mode()
.
Available 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()
.
Available since: 0.8.0
arv_camera_get_device
Retrieves the ArvDevice
object for more complete access to camera features.
Available since: 0.2.0
arv_camera_get_frame_rate_bounds
Retrieves allowed range for framerate.
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.
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.
Available since: 0.8.0
arv_camera_get_x_binning_bounds
Retrieves the valid range for image horizontal binning.
Available since: 0.8.0
arv_camera_get_x_offset_bounds
Retrieves the valid range for image horizontal offset.
Available since: 0.8.0
arv_camera_get_y_binning_bounds
Retrieves the valid range for image vertical binning.
Available since: 0.8.0
arv_camera_get_y_offset_bounds
Retrieves the valid range for image vertical offset.
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).
Available since: 0.8.0
arv_camera_gv_get_ip_configuration_mode
Get the IP address configuration mode.
Available since: 0.8.22
arv_camera_gv_get_persistent_ip
Get the persistent IP address setting of camera.
Available since: 0.8.22
arv_camera_gv_select_stream_channel
Select the current stream channel. Negative channel_id
is ignored.
Available 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.
Available since: 0.8.22
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.
Available 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.
Available since: 0.8.0
arv_camera_gv_set_packet_size_adjustment
Sets the option for packet size adjustment that happens at stream object creation.
Available since: 0.8.3
arv_camera_gv_set_persistent_ip_from_string
Sets the persistent IP address to camera.
Available 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()
.
Available since: 0.6.0
arv_camera_select_and_enable_component
Select and enable the given component.
Available since: 0.8.23
arv_camera_select_component
Select and enable or disable the given component
.
Available since: 0.8.25
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.
Available since: 0.8.22
arv_camera_set_acquisition_mode
arv_camera_set_binning
Defines binning in both directions. Not all cameras support this
feature. Negative dx
or dy
values are ignored.
Available 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.
Available 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()
.
Available 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.
Available since: 0.8.0
arv_camera_set_exposure_mode
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.
Available since: 0.8.0
arv_camera_set_frame_count
Sets the number of frames to capture in MultiFrame mode.
Available 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.
Available since: 0.8.0
arv_camera_set_frame_rate_enable
arv_camera_set_gain
Sets the gain of the ADC converter. Negative gain
is ignored.
Available since: 0.8.0
arv_camera_set_pixel_format_from_string
Defines pixel format described by a string.
Available 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.
Available 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.
Available 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()
.
Available 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.
Available 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
().
Available since: 0.8.0
arv_camera_uv_set_bandwidth
Set the bandwith limit or, if bandwith
is not strictly positive, disable the limit.
Available since: 0.8.0
Properties
Aravis.Camera:device
Internal device object.
Aravis.Camera:name
Internal device name for object construction.