Flash start delay property

Functions
peak_access_status	peak_Flash_StartDelay_GetAccessStatus (peak_camera_handle hCam)
	Query the flash start delay property access status.
peak_status	peak_Flash_StartDelay_GetRange (peak_camera_handle hCam, double *minFlashStartDelay_us, double *maxFlashStartDelay_us, double *incFlashStartDelay_us)
	Get the current range of valid flash start delay values.
peak_status	peak_Flash_StartDelay_Set (peak_camera_handle hCam, double flashStartDelay_us)
	Set the flash start delay.
peak_status	peak_Flash_StartDelay_Get (peak_camera_handle hCam, double *flashStartDelay_us)
	Get the flash start delay.

Detailed Description

Flash start delay property related functions.

Function Documentation

peak_Flash_StartDelay_Get()

peak_status peak_Flash_StartDelay_Get	(	peak_camera_handle	hCam,
		double *	flashStartDelay_us
	)

Get the flash start delay.

Reads the current flash start delay.

Parameters

[in]	hCam	The camera handle.
[out]	flashStartDelay_us	The flash start delay in microseconds.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The flash start delay property is not available for read access. Check the access status of the flash start delay via peak_Flash_StartDelay_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER flashStartDelay_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_StartDelay_GetAccessStatus()

peak_access_status peak_Flash_StartDelay_GetAccessStatus

(

peak_camera_handle

hCam

)

Query the flash start delay property access status.

Provides the current access status for the flash start delay 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 start delay property is readable and writeable.

PEAK_ACCESS_READONLY The flash start delay property is readable only.

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

PEAK_ACCESS_NONE The flash start delay property is not accessible.

PEAK_ACCESS_NOT_SUPPORTED The flash start delay 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_StartDelay_GetRange()

peak_status peak_Flash_StartDelay_GetRange	(	peak_camera_handle	hCam,
		double *	minFlashStartDelay_us,
		double *	maxFlashStartDelay_us,
		double *	incFlashStartDelay_us
	)

Get the current range of valid flash start delay values.

Queries the current range of valid values for the flash start delay for the configured flash mode.

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

Parameters

[in]	hCam	The camera handle.
[out]	minFlashStartDelay_us	The minimum flash start delay value in microseconds.
[out]	maxFlashStartDelay_us	The maximum flash start delay value in microseconds.
[out]	incFlashStartDelay_us	The flash start delay value increment in microseconds.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The flash start delay property is not accessible. Check the access status of the flash start delay via peak_Flash_StartDelay_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER At least one of minFlashStartDelay_us, maxFlashStartDelay_us, and incFlashStartDelay_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_StartDelay_Set()

peak_status peak_Flash_StartDelay_Set	(	peak_camera_handle	hCam,
		double	flashStartDelay_us
	)

Set the flash start delay.

Writes the desired flash start delay.

Parameters

[in]	hCam	The camera handle.
[in]	flashStartDelay_us	The flash start delay in microseconds to set.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_OUT_OF_RANGE flashStartDelay_us is out of range. Check the range of valid values via peak_Flash_StartDelay_GetRange.

PEAK_STATUS_ACCESS_DENIED The flash start delay property is not available for write access. Check the access status of the flash start delay via peak_Flash_StartDelay_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.