GEV_STATUS GevGetPayloadParameters

(GEV_CAMERA_HANDLE handle, PUINT64 payload_size,
 PUINT32 format);

Description

Gets the values for the mandatory GigE Vision features “PayloadSize” and “PixelFormat” from the attached camera for the purposes of being able to determine the memory allocation requirements for any subsequent frame/data  acquisition operations.

Parameters

payload_size

The returned size (in bytes) of the payload that will be sent from the device. This includes image data, metadata (chunks), etc.

format

The returned enumerated value for the payload format. The value depends on the camera/device model and mode of operation. See the “Supported Pixel Formats” section.

Return Value

GEV_STATUS

Possible values are:

GEVLIB_OK
GEVLIB_ERROR_INVALID_HANDLE
GEVLIB_ERROR_NULL_PTR
GEVLIB_ERROR_SOFTWARE

Related Topics

Member Function Descriptions