Flash duration property

Functions
peak_access_status	peak_Flash_Duration_GetAccessStatus (peak_camera_handle hCam)
	Query the flash duration property access status. More...
peak_status	peak_Flash_Duration_GetRange (peak_camera_handle hCam, double *minFlashDuration_us, double *maxFlashDuration_us, double *incFlashDuration_us)
	Get the current range of valid flash duration values. More...
peak_status	peak_Flash_Duration_Set (peak_camera_handle hCam, double flashDuration_us)
	Set the flash duration. More...
peak_status	peak_Flash_Duration_Get (peak_camera_handle hCam, double *flashDuration_us)
	Get the flash duration. More...

Detailed Description

Flash end duration property related functions.

Function Documentation

peak_Flash_Duration_Get()

peak_status peak_Flash_Duration_Get	(	peak_camera_handle	hCam,
		double *	flashDuration_us
	)

Get the flash duration.

Reads the current flash duration.

Parameters

[in]	hCam	The camera handle.
[out]	flashDuration_us	The flash duration in microseconds.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The flash duration property is not available for read access. Check the access status of the flash duration via peak_Flash_Duration_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER flashDuration_us 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_Flash_Duration_GetAccessStatus()

peak_access_status peak_Flash_Duration_GetAccessStatus

(

peak_camera_handle

hCam

)

Query the flash duration property access status.

Provides the current access status for the flash duration property for the configured flash mode.

This function implements the Access Status Query principle.

Parameters

[in]

hCam

The camera handle.

Returns

PEAK_ACCESS_READWRITE The flash duration property is readable and writeable.

PEAK_ACCESS_READONLY The flash duration property is readable only.

PEAK_ACCESS_GFA_LOCK The flash duration property is not accessible because the GFA write access is enabled.

PEAK_ACCESS_NONE The flash duration property is not accessible.

PEAK_ACCESS_NOT_SUPPORTED The flash duration property 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_ACCESS_DENIED The flash feature is not accessible. Check the access status of the flash feature via peak_Flash_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.

peak_Flash_Duration_GetRange()

peak_status peak_Flash_Duration_GetRange	(	peak_camera_handle	hCam,
		double *	minFlashDuration_us,
		double *	maxFlashDuration_us,
		double *	incFlashDuration_us
	)

Get the current range of valid flash duration values.

Queries the current range of valid values for the flash duration for the current flash mode.

The range of valid flash duration values may depend on the flash mode, the camera configuration, and the camera status.

Parameters

[in]	hCam	The camera handle.
[out]	minFlashDuration_us	The minimum flash duration value in microseconds.
[out]	maxFlashDuration_us	The maximum flash duration value in microseconds.
[out]	incFlashDuration_us	The flash duration value increment in microseconds.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The flash duration property is not accessible. Check the access status of the flash duration via peak_Flash_Duration_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER At least one of minFlashDuration_us, maxFlashDuration_us, and incFlashDuration_us 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_Flash_Duration_Set()

peak_status peak_Flash_Duration_Set	(	peak_camera_handle	hCam,
		double	flashDuration_us
	)

Set the flash duration.

Writes the desired flash duration.

Parameters

[in]	hCam	The camera handle.
[in]	flashDuration_us	The flash duration in microseconds to set.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_OUT_OF_RANGE flashDuration_us is out of range. Check the range of valid values via peak_Flash_Duration_GetRange.

PEAK_STATUS_ACCESS_DENIED The flash duration property is not available for write access. Check the access status via peak_Flash_Duration_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.