Back to Aurora Vision Studio website

You are here: Start » Filter Reference » Camera Support » Hikvision » Hikvision_GrabImage


Module: ThirdParty

Captures an image from a Hikvision device.

Name Type Range Description
Input value inDeviceID String* Camera serial number, name or IP address, Auto = first camera
Input value inInputQueueSize Integer 1 - Sets size of image queue (on acquisition start)
Input value inPixelFormat HikvisionPixelFormat Image pixel format (set on acquisition start)
Input value inRoi Box* Region of interest (set on acquisition start)
Input value inFrameRate Real* 0.0 - Sets the frame rate limit
Input value inFrameRateAuto Bool True if frame rate is not limited
Input value inExposureTime Real* 0.0 - Sets the target exposure time in microseconds
Input value inExposureTimeAuto Bool True if using automatic exposure time
Input value inGain Real* 0.0 - Sets gain in dB
Input value inGainAuto Bool True if using automatic gain
Output value outImage Image Captured frame
Output value outFrameID Integer? Captured frame ID


Camera driver software

This filter is intended to cooperate with a camera using its vendor SDK. To be able to connect to a camera, it is required to install Hikvision Machine Vision Software with camera dedicated drivers.

Hikvision Machine Vision Software can be downloaded from the following website: (registration may be required).

Add DLL path to system environment variable may be required.

Recommended Hikvision Machine Vision Software version for Aurora Vision Studio usage is 4.0.1 (DLL version

Camera identification

When there is only one camera connected to a computer, field inDeviceID can be set to Auto. In this case, first available camera will be found and connected.

inDeviceID field can be used to pick one of multiple cameras connected to computer. DeviceID can be set to:

  • Serial number - serial number of the device which can be viewed in the MVS software from Hikvision under Feature Tree / Device Control / Device Serial Number. Please note that this serial number may differ from the one printed on the device housing.
  • Camera name - user-defined ID which can be set in the MVS software from Hikvision under Feature Tree / Device Control / Device User ID.
  • IP address - ip address of the camera on the local network.
Setting bandwidth for GigEVision cameras

Bandwidth of Hikvision GigEVision cameras needs to be configured before use, otherwise packet loss and image artifacts may occur.

Open MVS software from Hikvision and connect to the camera. Open Settings / Options menu and go to Network tab. Bandwidth Control slider will be shown. To preserve new value of bandwidth after disconnecting power from the camera, you will need to save it using User Set Control parameters in Features tab.

Parallel execution

This filter cannot be placed in multiple Workers.

Complexity Level

This filter is available on Basic Complexity Level.

Filter Group

This filter is member of Hikvision_GrabImage filter group.

See Also