You are here: Start » Filter Reference » Allied Vision Technologies » PvAPI_GrabImage_Deprecated
PvAPI_GrabImage_Deprecated
Captures a frame from Allied Vision cameras using PvAPI.
| Name | Type | Range | Description | |
|---|---|---|---|---|
 |
inDeviceID | String* | IP address, camera name, model name, part number or serial number of device to be opened | |
|
inAoi | Box* | Required fragment of image to stream | |
|
inPixelFormat | PvAPIPixelFormat | Requested pixel format | |
|
inTimeout | Integer* | Maximum wait time for camera frame | |
|
inGain | Integer* | 0 - + |
Gain |
|
inFrameRate | Integer* | 1 - + |
Frame rate |
|
inExposureTime | Integer* | 0 - + |
Camera frame exposition time |
|
inWhiteBalanceRed | Integer* | White balance red parameter | |
|
inWhiteBalanceBlue | Integer* | White balance blue parameter | |
 |
outImage | Image | Captured frame | |
Remarks
Camera driver software
This filter is intended to cooperate with camera using its vendor SDK. To be able to connect with camera it is required to install PvAPI SDK software with camera dedicated drivers.
PvAPI SDK can be downloaded from following website: www.alliedvisiontec.com.
Recommended PvAPI SDK version for Adaptive Vision Studio usage is 1.2.6.
Camera identification
When there is only one camera connected with computer field inDeviceID can be set to Auto. In this situation first available camera will be found and connected.
inDeviceID field can be used to pick one of multiple cameras connected to computer. CameraID can be set to:
- Serial number - camera's serial number.
- Part number - manufacturer's part number.
- Camera name - human-friendly camera name.
- Model name - name of the camera part
Complexity Level
This filter is available on Basic Complexity Level.
