Pixel clock

Functions
peak_access_status	peak_PixelClock_GetAccessStatus (peak_camera_handle hCam)
	Query the pixel clock access status.
peak_bool	peak_PixelClock_HasRange (peak_camera_handle hCam)
	Check whether the valid values for the pixel clock feature are organized as a range.
peak_status	peak_PixelClock_GetRange (peak_camera_handle hCam, double *minPixelClock_MHz, double *maxPixelClock_MHz, double *incPixelClock_MHz)
	Get the current range of valid pixel clock values.
peak_status	peak_PixelClock_GetList (peak_camera_handle hCam, double *pixelClockList, size_t *pixelClockCount)
	Get the list of currently selectable pixel clock values.
peak_status	peak_PixelClock_Set (peak_camera_handle hCam, double pixelClock_MHz)
	Set the pixel clock.
peak_status	peak_PixelClock_Get (peak_camera_handle hCam, double *pixelClock_MHz)
	Get the pixel clock.

Detailed Description

Pixel clock related functions and types.

Function Documentation

peak_PixelClock_Get()

peak_status peak_PixelClock_Get	(	peak_camera_handle	hCam,
		double *	pixelClock_MHz
	)

Get the pixel clock.

Reads the current pixel clock.

Parameters

[in]	hCam	The camera handle.
[out]	pixelClock_MHz	The pixel clock in megahertz.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The pixel clock control is not available for read access. Check the access status via peak_PixelClock_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER pixelClock_MHz is an invalid pointer.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

peak_PixelClock_GetAccessStatus()

peak_access_status peak_PixelClock_GetAccessStatus

(

peak_camera_handle

hCam

)

Query the pixel clock access status.

Provides the current access status for the pixel clock control.

This function implements the Access Status Query principle.

Parameters

[in]

hCam

The camera handle.

Returns

PEAK_ACCESS_READWRITE The pixel clock control is readable and writeable.

PEAK_ACCESS_READONLY The pixel clock control is readable only.

PEAK_ACCESS_GFA_LOCK The pixel clock control is not accessible because the GFA write access is enabled.

PEAK_ACCESS_NONE The pixel clock control is not accessible.

PEAK_ACCESS_NOT_SUPPORTED The pixel clock control is not supported.

PEAK_ACCESS_INVALID The function failed. Call peak_Library_GetLastError to get the error code and description.

If the function indicates an error by returning PEAK_ACCESS_INVALID, these are the possible errors:

• PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.
• PEAK_STATUS_NOT_INITIALIZED The library is not initialized.
• PEAK_STATUS_ERROR An unexpected internal error occurred.

peak_PixelClock_GetList()

peak_status peak_PixelClock_GetList	(	peak_camera_handle	hCam,
		double *	pixelClockList,
		size_t *	pixelClockCount
	)

Get the list of currently selectable pixel clock values.

Queries the list of currently selectable pixel clock values.

The list of selectable pixel clock values may depend on the camera configuration and the camera status.

This function implements the Two Staged Data Query principle.

Parameters

[in]	hCam	The camera handle.
[out]	pixelClockList	Pointer to a user allocated array buffer to receive the pixel clock list. If this parameter is NULL, pixelClockCount will contain the current number of pixel formats. The required size of pixelClockList in bytes is pixelClockCount x sizeof(uint32_t).
[in,out]	pixelClockCount	pixelClockList equal NULL: out: minimal number of pixel clocks pixelClockList must be large enough to hold pixelClockList unequal NULL: in: number of pixel clocks pixelClockList can hold out: number of pixel clocks filled by the function

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_NO_DATA The valid values for the pixel clock feature are organized as range rather than as a list.
Use peak_PixelClock_GetRange to query the valid pixel clock values.

PEAK_STATUS_BUFFER_TOO_SMALL pixelClockList is not NULL and the value of *pixelClockCount is too small to receive the expected amount of data.

PEAK_STATUS_ACCESS_DENIED The pixel clock feature is not accessible. Check the access status via peak_PixelClock_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER pixelClockCount is an invalid pointer.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Note

Consider that the pixel clock list might change between the size query call and the list query call.
This may be the case if the camera configuration or the camera status have changed in the time between the two function calls.

peak_PixelClock_GetRange()

peak_status peak_PixelClock_GetRange	(	peak_camera_handle	hCam,
		double *	minPixelClock_MHz,
		double *	maxPixelClock_MHz,
		double *	incPixelClock_MHz
	)

Get the current range of valid pixel clock values.

Queries the current range of valid values for the pixel clock control.

The range of valid pixel clock values may depend on the camera configuration and the camera status.

Parameters

[in]	hCam	The camera handle.
[out]	minPixelClock_MHz	The minimum pixel clock in megahertz.
[out]	maxPixelClock_MHz	The maximum pixel clock in megahertz.
[out]	incPixelClock_MHz	The pixel clock increment in megahertz.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_NO_DATA The valid values for the pixelclock feature are organized as list rather than as a range.
Use peak_PixelClock_GetList to query the valid pixelclock values.

PEAK_STATUS_ACCESS_DENIED The pixel clock control is not accessible. Check the access status via peak_PixelClock_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER At least one of minPixelClock_MHz, maxPixelClock_MHz, and incPixelClock_MHz is an invalid pointer.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

peak_PixelClock_HasRange()

peak_bool peak_PixelClock_HasRange

(

peak_camera_handle

hCam

)

Check whether the valid values for the pixel clock feature are organized as a range.

Checks whether the valid values for the pixel clock feature are organized as a range or as a list.

This function implements the Valid Values Organization Query principle.

Parameters

[in]

hCam

The camera handle.

Returns

PEAK_TRUE The valid values are organized as a range. Use peak_PixelClock_GetRange.

PEAK_FALSE The valid values are organized as a list. Use peak_PixelClock_GetList.

peak_PixelClock_Set()

peak_status peak_PixelClock_Set	(	peak_camera_handle	hCam,
		double	pixelClock_MHz
	)

Set the pixel clock.

Writes the desired pixel clock.

Parameters

[in]	hCam	The camera handle.
[in]	pixelClock_MHz	The pixel clock to set in megahertz.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_VALUE_ADJUSTED Value was automatically adjusted.

PEAK_STATUS_OUT_OF_RANGE pixelClock_MHz is out of range. Check the range of valid values via peak_PixelClock_GetRange or peak_PixelClock_GetList.

PEAK_STATUS_ACCESS_DENIED The pixel clock control is not available for write access. Check the access status via peak_PixelClock_GetAccessStatus.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.