Flash

Modules
	Flash start delay property
	Flash end delay property
	Flash duration property

Data Structures
struct	peak_flash_mode
	peak Flash mode More...

Macros
#define	PEAK_FLASH_MODE_EXPOSURE_ACTIVE
	peak Flash mode preset: Exposure active on flash output More...
#define	PEAK_FLASH_MODE_ACQUISITION_ACTIVE
	peak Flash mode preset: Acquisition active on flash output More...
#define	PEAK_FLASH_MODE_GLOBAL_START_WINDOW
	peak Flash mode preset: Global start window on flash output More...

Enumerations
enum	peak_flash_reference { PEAK_FLASH_REFERENCE_INVALID, PEAK_FLASH_REFERENCE_EXPOSURE_ACTIVE, PEAK_FLASH_REFERENCE_GLOBAL_START_WINDOW, PEAK_FLASH_REFERENCE_ACQUISITION_ACTIVE }
	peak Flash reference More...

Functions
peak_access_status	peak_Flash_GetAccessStatus (peak_camera_handle hCam)
	Query the flash feature access status. More...
peak_status	peak_Flash_Enable (peak_camera_handle hCam, peak_bool enabled)
	Enable/Disable the flash. More...
peak_bool	peak_Flash_IsEnabled (peak_camera_handle hCam)
	Get the enabled status of the flash. More...
peak_access_status	peak_Flash_Mode_GetAccessStatus (peak_camera_handle hCam, peak_flash_mode flashMode)
	Query the flash mode access status. More...
peak_status	peak_Flash_Mode_Set (peak_camera_handle hCam, peak_flash_mode flashMode)
	Set the flash mode. More...
peak_status	peak_Flash_Mode_Get (peak_camera_handle hCam, peak_flash_mode *flashMode)
	Get the flash mode. More...

Detailed Description

Flash related functions and types.

Macro Definition Documentation

PEAK_FLASH_MODE_ACQUISITION_ACTIVE

#define PEAK_FLASH_MODE_ACQUISITION_ACTIVE

peak Flash mode preset: Acquisition active on flash output

Initialize a peak_flash_mode with this preset and pass it to peak_Flash_Mode_Set to configure a flash signal for the acquisition duration.
See the following example code.

const peak_flash_mode flashMode = PEAK_FLASH_MODE_ACQUISITION_ACTIVE;
peak_status status = peak_Flash_Mode_Set(cameraHandle, flashMode);

PEAK_FLASH_MODE_EXPOSURE_ACTIVE

#define PEAK_FLASH_MODE_EXPOSURE_ACTIVE

peak Flash mode preset: Exposure active on flash output

Initialize a peak_flash_mode with this preset and pass it to peak_Flash_Mode_Set to configure a flash signal for the exposure time.
See the following example code.

const peak_flash_mode flashMode = PEAK_FLASH_MODE_EXPOSURE_ACTIVE;
peak_status status = peak_Flash_Mode_Set(cameraHandle, flashMode);

Note

This is the default flash mode which is configured until peak_Flash_Mode_Set has been called.

PEAK_FLASH_MODE_GLOBAL_START_WINDOW

#define PEAK_FLASH_MODE_GLOBAL_START_WINDOW

peak Flash mode preset: Global start window on flash output

Initialize a peak_flash_mode with this preset and pass it to peak_Flash_Mode_Set to configure a flash signal for the global start window duration.
See the following example code.

const peak_flash_mode flashMode = FLASH_GLOBAL_START_WINDOW_ON_FLASH_OUTPUT;
peak_status status = peak_Flash_Mode_Set(cameraHandle, flashMode);

Enumeration Type Documentation

peak_flash_reference

enum peak_flash_reference

peak Flash reference

The flash reference specifies which operation is represented by the flash signal.

Enumerator
PEAK_FLASH_REFERENCE_INVALID	Invalid flash reference. Use this value for the initialization of variables of type peak_flash_reference.
PEAK_FLASH_REFERENCE_EXPOSURE_ACTIVE	Exposure active. The flash is active while the exposure is active.
PEAK_FLASH_REFERENCE_GLOBAL_START_WINDOW	Global start window. The flash is active for the length of the global start window.
PEAK_FLASH_REFERENCE_ACQUISITION_ACTIVE	Acquisition active. The flash is active while the acquisition is active.

Function Documentation

peak_Flash_Enable()

peak_status peak_Flash_Enable	(	peak_camera_handle	hCam,
		peak_bool	enabled
	)

Enable/Disable the flash.

Sets the flash to enabled or disabled.

A flash can be enabled or disabled if there is no running acquisition only.

Parameters

[in]	hCam	The camera handle.
[in]	enabled	The desired enabled status. PEAK_TRUE for enabled, PEAK_FALSE for disabled.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The flash feature is not accessible for write. Check the access status of the trigger 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_GetAccessStatus()

peak_access_status peak_Flash_GetAccessStatus

(

peak_camera_handle

hCam

)

Query the flash feature access status.

Provides the current access status for the flash feature.

This function implements the Access Status Query principle.

Parameters

[in]

hCam

The camera handle.

Returns

PEAK_ACCESS_READWRITE The flash feature is readable and writeable.

PEAK_ACCESS_READONLY The flash feature is readable only.

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

PEAK_ACCESS_NONE The flash feature is not accessible. Check for a running acquisition.

PEAK_ACCESS_NOT_SUPPORTED The flash feature 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_Flash_IsEnabled()

peak_bool peak_Flash_IsEnabled

(

peak_camera_handle

hCam

)

Get the enabled status of the flash.

Queries whether the flash is currently enabled or disabled.

This function implements the Enabled Status Query principle.

Parameters

[in]

hCam

The camera handle.

Returns

PEAK_TRUE The flash is currently enabled.

PEAK_FALSE The flash is currently disabled or the query failed.

peak_Flash_Mode_Get()

peak_status peak_Flash_Mode_Get	(	peak_camera_handle	hCam,
		peak_flash_mode *	flashMode
	)

Get the flash mode.

Reads the current flash mode.

Parameters

[in]	hCam	The camera handle.
[out]	flashMode	The flash mode.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The flash mode is not available for read access. Check the access status of the flash mode via peak_Flash_Mode_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER flashMode 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_Mode_GetAccessStatus()

peak_access_status peak_Flash_Mode_GetAccessStatus	(	peak_camera_handle	hCam,
		peak_flash_mode	flashMode
	)

Query the flash mode access status.

Provides the access status for the given flash mode.

This function implements the Access Status Query principle.

Parameters

[in]	hCam	The camera handle.
[in]	flashMode	The flash mode.

Returns

PEAK_ACCESS_READWRITE The flash mode is readable and writeable.

PEAK_ACCESS_READONLY The flash mode is readable only.

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

PEAK_ACCESS_NONE The flash mode is not accessible.

PEAK_ACCESS_NOT_SUPPORTED The flash mode 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_PARAMETER flashMode is an invalid flash mode. Check peak_flash_reference and peak_io_channel.
• 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_Mode_Set()

peak_status peak_Flash_Mode_Set	(	peak_camera_handle	hCam,
		peak_flash_mode	flashMode
	)

Set the flash mode.

Changes the flash mode.

The properties of the flash will be reset to the following default values:

• The flash start delay will be set to 0.
• The flash end delay will be set to 0.
• The flash duration will be set to default.

Parameters

[in]	hCam	The camera handle.
[in]	flashMode	The flash mode.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_OUT_OF_RANGE The flash mode is not available or not known at all.

PEAK_STATUS_ACCESS_DENIED The flash mode is not available for write access or the io channel is not available for write access. Check the access status of the flash mode via peak_Flash_Mode_GetAccessStatus. Check the access status of the io channel via peak_IOChannel_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER flashMode is an invalid flash mode. Check peak_flash_reference and peak_io_channel.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_INVALID_PARAMETER flashMode contains an invalid parameter, which can never be set.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.