Back to Adaptive Vision Library website
You are here: Start » Function Reference » Hikvision » Hikvision_GrabImage
Captures an image from a Hikvision device.
Syntax
bool avl::Hikvision_GrabImage ( Hikvision_State& ioState, atl::Optional<const atl::String&> inDeviceID, int inInputQueueSize, avl::HikvisionPixelFormat::Type inPixelFormat, atl::Optional<const avl::Box&> inRoi, atl::Optional<float> inFrameRate, bool inFrameRateAuto, atl::Optional<float> inExposureTime, bool inExposureTimeAuto, atl::Optional<float> inGain, bool inGainAuto, avl::Image& outImage, atl::Conditional<int>& outFrameID )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
ioState | Hikvision_State& | Object used to maintain state of the function. | |||
![]() |
inDeviceID | Optional<const String&> | NIL | Camera serial number or name, Auto = first camera | |
![]() |
inInputQueueSize | int | 1 - ![]() |
8 | Sets size of image queue (on acquisition start) |
![]() |
inPixelFormat | HikvisionPixelFormat::Type | Image pixel format (set on acquisiton start) | ||
![]() |
inRoi | Optional<const Box&> | NIL | Region of interest, Auto = full frame (set on acquisiton start) | |
![]() |
inFrameRate | Optional<float> | 0.0 - ![]() |
NIL | Sets the frame rate limit |
![]() |
inFrameRateAuto | bool | True | True if frame rate is not limited | |
![]() |
inExposureTime | Optional<float> | 0.0 - ![]() |
10000.0f | Sets the target exposure time in microseconds |
![]() |
inExposureTimeAuto | bool | True if using automatic exposure time | ||
![]() |
inGain | Optional<float> | 0.0 - ![]() |
0.0f | Sets gain in dB |
![]() |
inGainAuto | bool | True if using automatic gain | ||
![]() |
outImage | Image& | Captured frame | ||
![]() |
outFrameID | Conditional<int>& | Captured frame ID |
Multithreaded environment
This function is not guaranteed to be thread-safe. When used in multithreaded environment, it has to be manually synchronized.