Is_Pixelclock - THORLABS DCU223x Operation Manual And Sdk

DCx Cameras

4.3.69 is_PixelClock

USB 2.0
USB 3.0
Syntax
INT is_PixelClock(HIDS hCam, UINT nCommand, void* pParam, UINT cbSizeOfParam)
Description
The function returns the adjustable pixel clock range sets the piel clock. Due to an excessive pixel clock for USB
cameras, images may get lost during the transfer. If you change the pixel clock on-the-fly, the current image
capturing process will be aborted.
The pixel clock limit values can vary, depending on the camera model and operating mode. For detailed
information on the pixel clock range of a specific camera model, please refer to the
chapter.
The nCommand input parameter is used to select the function mode. The pParam input parameter depends on the
selected function mode. If you select functions for setting or returning a value, pParam contains a pointer to a
variable of the UINT type. The size of the memory area to which pParam refers is specified in the
cbSizeOfParam input parameter.
Note
Note: The following functions are obsolete by the is_PixelClock() function:
is_SetPixelClock()
is_GetPixelClockRange()
See also: Obsolete functions
Input parameter
hCam
nCommand
IS_PIXELCLOCK_CMD_GET_NUMBER
IS_PIXELCLOCK_CMD_GET_LIST
IS_PIXELCLOCK_CMD_GET_RANGE
IS_PIXELCLOCK_CMD_GET_DEFAULT
IS_PIXELCLOCK_CMD_GET
IS_PIXELCLOCK_CMD_SET
pParam
cbSizeOfParam
Return values
IS_INVALID_MODE
IS_INVALID_PARAMETER
IS_NO_SUCCESS
IS_NOT_SUPPORTED
IS_SUCCESS
294
USB 2.0
USB 3.0
379
Camera handle
Returns the number of discrete pixel clock which are
supported by the camera
Returns the list with discrete pixel clocks.
Returns the range for the pixel clock
Returns the default pixel clock
Returns the current set pixel clock in MHz
)
Sets the pixel clock in MHz
Pointer to a function parameter, whose function depends
on nCommand.
Size (in bytes) of the memory area to which pParam
refers.
Camera is in standby mode, function not allowed
One of the submitted parameters is outside the valid
range or is not supported for this sensor or is not
available in this mode.
General error message
The camera model used here does not support this
function or setting.
Function executed successfully
Camera and sensor data
(Example 1 ).
295
(Example 2
(Example 4 )
295
(Example 3
(Example 4 )
295
© 2013 Thorlabs GmbH
460
)
295
295