Functions to set the flash timing parameters. More...

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.
peak_access_status	peak_Flash_EndDelay_GetAccessStatus (peak_camera_handle hCam)
	Query the flash end delay property access status.
peak_status	peak_Flash_EndDelay_GetRange (peak_camera_handle hCam, double minFlashEndDelay_us, double maxFlashEndDelay_us, double *incFlashEndDelay_us)
	Get the current range of valid flash end delay values.
peak_status	peak_Flash_EndDelay_Set (peak_camera_handle hCam, double flashEndDelay_us)
	Set the flash end delay.
peak_status	peak_Flash_EndDelay_Get (peak_camera_handle hCam, double *flashEndDelay_us)
	Get the flash end delay.
peak_access_status	peak_Flash_Duration_GetAccessStatus (peak_camera_handle hCam)
	Query the flash duration property access status.
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.
peak_status	peak_Flash_Duration_Set (peak_camera_handle hCam, double flashDuration_us)
	Set the flash duration.
peak_status	peak_Flash_Duration_Get (peak_camera_handle hCam, double *flashDuration_us)
	Get the flash duration.

Detailed Description

Functions to set the flash timing parameters.

Contains the functions to control the flash configuration options flash duration flash start delay flash end delay.

The flash duration is the time the flash is on. It is based on the flash reference in the peak_flash_mode set by peak_Flash_Mode_Set. The duration can be lengthened or shortened at the beginning using the flash start delay, and at the end using the flash end delay. Changing the flash mode will reset both the flash start and end delays. On some cameras, the flash duration can also be manually set via peak_Flash_Duration_Set.

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.

Since: 1.0

◆ 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.

Since: 1.0

◆ 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.

Since: 1.0

◆ 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.

Since: 1.0

◆ peak_Flash_EndDelay_Get()

peak_status peak_Flash_EndDelay_Get	(	peak_camera_handle	hCam,
		double *	flashEndDelay_us )

Get the flash end delay.

Reads the current flash end delay.

Parameters

[in]	hCam	The camera handle.
[out]	flashEndDelay_us	The flash end delay in microseconds.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_ACCESS_DENIED The flash end delay property is not available for read access. Check the access status of the flash end delay via peak_Flash_EndDelay_GetAccessStatus.; PEAK_STATUS_INVALID_PARAMETER flashEndDelay_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.

Since: 1.0

◆ peak_Flash_EndDelay_GetAccessStatus()

peak_access_status peak_Flash_EndDelay_GetAccessStatus ( peak_camera_handle hCam )

Query the flash end delay property access status.

Provides the current access status for the flash end 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 end delay property is readable and writeable.; PEAK_ACCESS_READONLY The flash end delay property is readable only.; PEAK_ACCESS_GFA_LOCK The flash end delay property is not accessible because the GFA write access is enabled.; PEAK_ACCESS_NONE The flash end delay property is not accessible.; PEAK_ACCESS_NOT_SUPPORTED The flash end 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.

Since: 1.0

◆ peak_Flash_EndDelay_GetRange()

peak_status peak_Flash_EndDelay_GetRange	(	peak_camera_handle	hCam,
		double *	minFlashEndDelay_us,
		double *	maxFlashEndDelay_us,
		double *	incFlashEndDelay_us )

Get the current range of valid flash end delay values.

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

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

Parameters

[in]	hCam	The camera handle.
[out]	minFlashEndDelay_us	The minimum flash end delay value in microseconds.
[out]	maxFlashEndDelay_us	The maximum flash end delay value in microseconds.
[out]	incFlashEndDelay_us	The flash end delay value increment in microseconds.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_ACCESS_DENIED The flash end delay property is not accessible. Check the access status of the flash end delay via peak_Flash_EndDelay_GetAccessStatus.; PEAK_STATUS_INVALID_PARAMETER At least one of minFlashEndDelay_us, maxFlashEndDelay_us, and incFlashEndDelay_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.

Since: 1.0

◆ peak_Flash_EndDelay_Set()

peak_status peak_Flash_EndDelay_Set	(	peak_camera_handle	hCam,
		double	flashEndDelay_us )

Set the flash end delay.

Writes the desired flash end delay.

Parameters

[in]	hCam	The camera handle.
[in]	flashEndDelay_us	The flash end delay in microseconds to set.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_OUT_OF_RANGE flashEndDelay_us is out of range. Check the range of valid values via peak_Flash_EndDelay_GetRange.; PEAK_STATUS_ACCESS_DENIED The flash end delay property is not available for write access. or the flash feature is not supported. Check the access status of the flash end delay via peak_Flash_EndDelay_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.

Since: 1.0

◆ 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.

Since: 1.0

◆ 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.

Since: 1.0

◆ 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.

Since: 1.0

◆ 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.

Since: 1.0