Back to Adaptive Vision Library website
You are here: Start » Function Reference » GigE Vision » GigEVision_TryReceiveImage
GigEVision_TryReceiveImage
Receives next frame from video stream.
Syntax
C++
C#
bool avl::GigEVision_TryReceiveImage ( GigEHandle inDeviceHandle, int inTimeout, avl::Image& outImage, atl::Optional<atl::uint64&> outFrameId = atl::NIL, atl::Optional<atl::uint64&> outTimestamp = atl::NIL )
Parameters
Name | Type | Default | Description | |
---|---|---|---|---|
inDeviceHandle | GigEHandle | Handle of an opened device that is streaming video. | ||
inTimeout | int | Maximum time in milliseconds that the function is allowed to wait for the next complete frame. This parameter overrides the global frame timeout configuration. | ||
outImage | Image& | Image buffer that will receive a new frame. | ||
outFrameId | Optional<uint64&> | NIL | Frame block Id set by device | |
outTimestamp | Optional<uint64&> | NIL | Frame capture timestamp set by device (when supported) |
Description
This function is a close equivalent of GigEVision_ReceiveImage, that gives additional control over frame timeout situation.
See GigEVision_ReceiveImage definition for more information.
Return Value
true
when new frame is successfully received and stored into outImage, false
when timeout occurs or device is not streaming.
Exceptions
This function will throw an exception in the following situations:
- Device handle is invalid.
- Connection with device is lost.
- Device sends image in pixel format that cannot be converted.
- Device streams in a mode that does not transport images or the library is unable to read the image from stream.