SetOptimalCameraTiming

Syntax

LONG SetOptimalCameraTiming (LONG Mode, LONG Timeout,
LONG* pMaxPxlClk, DOUBLE* pMaxFrameRate)

Description

Using SetOptimalCameraTiming(), you can determine the highest possible pixel clock frequency for the current configuration. This function sets the pixel clock for which no transfer errors will occur during the Timeout period. Moreover, it returns the highest frame rate available for this pixel clock frequency. SetOptimalCameraTiming() can only be executed in free-run mode (StartLiveVideo()). If the return value is ≠ IS_SUCCESS, no clock setting will be made.

Achtung

Changes to the image geometry or pixel clock affect the value ranges of the frame rate and exposure time. After executing SetOptimalCameraTiming, calling the following functions is recommended in order to keep the defined camera settings:

•SetExposureTime()

•SetFrameRate()

•If you are using the uEye's flash function: SetFlashStrobe()

Achtung

When you are using a USB uEye XS camera model, the pixel clock is selected automatically based on the resolution. You cannot change this setting.

Hinweis

The function should be executed in a separate thread and run in the background to allow for the computational load caused by additional color conversions, etc. Otherwise, it will not able to return the optimum values.

Parameters

Mode
IS_BEST_PCLK_RUN_ONCE	The function makes one attempt to determine the optimum pixel clock and returns immediately.
Timeout [4000...20000]	Sets the period (in milliseconds) during which no transfer error may occur. The adjustable range is between 4 and 20 seconds. The higher the value you set for this parameter, the more stable the determined pixel clock value will be. This, in turn, increases the runtime of the function correspondingly.
pMaxPxlClk	Returns the maximum pixel clock frequency (in MHz).
pMaxFrameRate	Returns the maximum frame rate (in fps).

Return values

IS_SUCCESS	Function executed successfully
IS_NO_SUCCESS	General error message
IS_AUTO_EXPOSURE_RUNNING	Automatic exposure is active.
IS_INVALID_PARAMETER	The Timeout input parameter is not correct.
IS_TRIGGER_ACTIVATED	The camera is operating in trigger mode.

Related functions

•SetPixelClock()

•SetFrameRate()

Suggestion for improvement? Send us your short Feedback on this chapter. Thank you very much!

For technical questions please contact you local distributor or use the support form on our website.

Home > Function descriptions >	History back Previous chapter Next chapter Print
SetOptimalCameraTiming