Enumerations
enum	peak_io_channel { PEAK_IO_CHANNEL_INVALID, PEAK_IO_CHANNEL_NONE, PEAK_IO_CHANNEL_SOFTWARE, PEAK_IO_CHANNEL_TRIGGER_INPUT, PEAK_IO_CHANNEL_FLASH_OUTPUT, PEAK_IO_CHANNEL_GPIO_1, PEAK_IO_CHANNEL_GPIO_2 }
	peak IO channel More...

Functions
peak_access_status	peak_IOChannel_GetAccessStatus (peak_camera_handle hCam, peak_io_channel ioChannel)
	Query the io channel access status. More...

peak_status	peak_IOChannel_GetList (peak_camera_handle hCam, peak_io_channel ioChannelList, size_t ioChannelCount)
	Get the list of supported io channels. More...

peak_access_status	peak_IOChannel_Level_GetAccessStatus (peak_camera_handle hCam, peak_io_channel ioChannel)
	Query the io channel level property access status. More...

peak_bool	peak_IOChannel_Level_IsHigh (peak_camera_handle hCam, peak_io_channel ioChannel)
	Get the level of the io channel. More...

peak_access_status	peak_IOChannel_Inverter_GetAccessStatus (peak_camera_handle hCam, peak_io_channel ioChannel)
	Query the io channel inverter property access status. More...

peak_status	peak_IOChannel_Inverter_Enable (peak_camera_handle hCam, peak_io_channel ioChannel, peak_bool enabled)
	Enable/Disable the io channel inverter property. More...

peak_bool	peak_IOChannel_Inverter_IsEnabled (peak_camera_handle hCam, peak_io_channel ioChannel)
	Get the enabled status of the io channel inverter property. More...

peak_access_status	peak_IOChannel_NoiseFilter_GetAccessStatus (peak_camera_handle hCam, peak_io_channel ioChannel)
	Query the io channel noise filter property access status. More...

peak_status	peak_IOChannel_NoiseFilter_Enable (peak_camera_handle hCam, peak_io_channel ioChannel, peak_bool enabled)
	Enable/Disable the io channel noise filter property. More...

peak_bool	peak_IOChannel_NoiseFilter_IsEnabled (peak_camera_handle hCam, peak_io_channel ioChannel)
	Get the enabled status of the io channel noise filter property. More...

peak_status	peak_IOChannel_NoiseFilter_Duration_GetRange (peak_camera_handle hCam, peak_io_channel ioChannel, double minNoiseFilterDuration_us, double maxNoiseFilterDuration_us, double *incNoiseFilterDuration_us)
	Get the current range of valid io channel noise filter duration values. More...

peak_status	peak_IOChannel_NoiseFilter_Duration_Set (peak_camera_handle hCam, peak_io_channel ioChannel, double noiseFilterDuration_us)
	Set the io channel noise filter duration. More...

peak_status	peak_IOChannel_NoiseFilter_Duration_Get (peak_camera_handle hCam, peak_io_channel ioChannel, double *noiseFilterDuration_us)
	Get the io channel noise filter duration. More...

Detailed Description

IO channel related functions and types.

Enumeration Type Documentation

◆ peak_io_channel

enum peak_io_channel

peak IO channel

The io channel specifies the channel at which a certain signal or event is received or transmitted. It is used for several features like trigger and flash.

Not all channels are applicable for all features.

Enumerator
PEAK_IO_CHANNEL_INVALID	Invalid io channel. Use this value for the initialization of variables of type peak_io_channel;.
PEAK_IO_CHANNEL_NONE	None. No channel configured.
PEAK_IO_CHANNEL_SOFTWARE	Software. The signal or event is initiated by a software function.
PEAK_IO_CHANNEL_TRIGGER_INPUT	Trigger input pin. The signal or event is initiated by an electrical signal at the cameras trigger connector.
PEAK_IO_CHANNEL_FLASH_OUTPUT	Flash output pin. The signal or event is initiated by an electrical signal at the cameras flash connector.
PEAK_IO_CHANNEL_GPIO_1	GPIO 1 pin. The signal or event is initiated by an electrical signal at the cameras GPIO 1 connector.
PEAK_IO_CHANNEL_GPIO_2	GPIO 2 pin. The signal or event is initiated by an electrical signal at the cameras GPIO 2 connector.

Function Documentation

◆ peak_IOChannel_GetAccessStatus()

peak_access_status peak_IOChannel_GetAccessStatus	(	peak_camera_handle	hCam,
		peak_io_channel	ioChannel
	)

Query the io channel access status.

Provides the current access status for the specified io channel.

This function implements the Access Status Query principle.

Parameters

[in]	hCam	The camera handle.
[in]	ioChannel	The io channel.

Returns: PEAK_ACCESS_READWRITE The io channel is supported and currently available for use by trigger/flash.; PEAK_ACCESS_READONLY The io channel is supported but currently used in an enabled trigger/flash configuration.; PEAK_ACCESS_GFA_LOCK The io channel is not accessible because the GFA write access is enabled.; PEAK_ACCESS_NOT_SUPPORTED The io channel is not supported. Check the list of supported io channels via peak_IOChannel_GetList.; 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_ACCESS_DENIED The io channel feature is not supported.
PEAK_STATUS_INVALID_PARAMETER ioChannel is an invalid io channel. Check peak_io_channel.
PEAK_STATUS_NOT_INITIALIZED The library is not initialized.
PEAK_STATUS_ERROR An unexpected internal error occurred.

◆ peak_IOChannel_GetList()

peak_status peak_IOChannel_GetList	(	peak_camera_handle	hCam,
		peak_io_channel *	ioChannelList,
		size_t *	ioChannelCount
	)

Get the list of supported io channels.

Queries the list of supported io channels.

This function implements the Two Staged Data Query principle.

Parameters

[in]	hCam	The camera handle.
[out]	ioChannelList	Pointer to a user allocated array buffer to receive the io channel list. If this parameter is NULL, `ioChannelCount` will contain the current number of io channels. The required size of `ioChannelList` in bytes is `ioChannelCount` x sizeof(peak_io_channel).
[in,out]	ioChannelCount	`ioChannelList` equal NULL: out: minimal number of io channels `ioChannelList` must be large enough to hold `ioChannelList` unequal NULL: in: number of io channels `ioChannelList` can hold out: number of io channels filled by the function

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_BUFFER_TOO_SMALL ioChannelList is not NULL and the value of *ioChannelCount is too small to receive the expected amount of data.; PEAK_STATUS_ACCESS_DENIED The io channel feature is not supported or the GFA write access is enabled.; PEAK_STATUS_INVALID_PARAMETER ioChannelCount 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_IOChannel_Inverter_Enable()

peak_status peak_IOChannel_Inverter_Enable	(	peak_camera_handle	hCam,
		peak_io_channel	ioChannel,
		peak_bool	enabled
	)

Enable/Disable the io channel inverter property.

Sets the io channel inverter property to enabled or disabled.

Parameters

[in]	hCam	The camera handle.
[in]	ioChannel	The io channel.
[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 io channel inverter property is not accessible for write. Check the access status via peak_IOChannel_Inverter_GetAccessStatus.; PEAK_STATUS_INVALID_PARAMETER ioChannel is an invalid 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_IOChannel_Inverter_GetAccessStatus()

peak_access_status peak_IOChannel_Inverter_GetAccessStatus	(	peak_camera_handle	hCam,
		peak_io_channel	ioChannel
	)

Query the io channel inverter property access status.

Provides the current access status for the inverter property for the specified io channel.

This function implements the Access Status Query principle.

Parameters

[in]	hCam	The camera handle.
[in]	ioChannel	The io channel.

Returns: PEAK_ACCESS_READWRITE The inverter property is readable and writeable for the specified io channel.; PEAK_ACCESS_READONLY The inverter property is readable only for the specified io channel.; PEAK_ACCESS_GFA_LOCK The inverter property is not accessible because the GFA write access is enabled.; PEAK_ACCESS_NONE The inverter property is not accessible for the specified io channel.; PEAK_ACCESS_NOT_SUPPORTED The inverter property is not supported for the specified io channel.; 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 specified io channel is not accessible. Check the access status of the io channel via peak_IOChannel_GetAccessStatus.
PEAK_STATUS_INVALID_PARAMETER ioChannel is an invalid 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_IOChannel_Inverter_IsEnabled()

peak_bool peak_IOChannel_Inverter_IsEnabled	(	peak_camera_handle	hCam,
		peak_io_channel	ioChannel
	)

Get the enabled status of the io channel inverter property.

Queries whether the io channel inverter property is currently enabled or disabled.

This function implements the Enabled Status Query principle.

Parameters

[in]	hCam	The camera handle.
[in]	ioChannel	The io channel.

Returns: PEAK_TRUE The io channel inverter property is currently enabled.; PEAK_FALSE The io channel inverter property is currently disabled or the query failed.

◆ peak_IOChannel_Level_GetAccessStatus()

peak_access_status peak_IOChannel_Level_GetAccessStatus	(	peak_camera_handle	hCam,
		peak_io_channel	ioChannel
	)

Query the io channel level property access status.

Provides the current access status for the level property for the specified io channel.

This function implements the Access Status Query principle.

Parameters

[in]	hCam	The camera handle.
[in]	ioChannel	The io channel.

Returns: PEAK_ACCESS_READWRITE The level property is readable and writeable for the specified io channel.; PEAK_ACCESS_READONLY The level property is readable only for the specified io channel.; PEAK_ACCESS_GFA_LOCK The level property is not accessible because the GFA write access is enabled.; PEAK_ACCESS_NONE The level property is not accessible for the specified io channel.; PEAK_ACCESS_NOT_SUPPORTED The level property is not supported for the specified io channel.; 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 specified io channel is not accessible. Check the access status of the io channel via peak_IOChannel_GetAccessStatus.
PEAK_STATUS_INVALID_PARAMETER ioChannel is an invalid io channel. Check 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_IOChannel_Level_IsHigh()

peak_bool peak_IOChannel_Level_IsHigh	(	peak_camera_handle	hCam,
		peak_io_channel	ioChannel
	)

Get the level of the io channel.

Queries whether the io channels level is currently high or low.

This function implements the Boolean Status Queries principle.

Parameters

[in]	hCam	The camera handle.
[in]	ioChannel	The io channel.

Returns: PEAK_TRUE The io channels level is currently high.; PEAK_FALSE The io channels level is currently low or the query failed.

◆ peak_IOChannel_NoiseFilter_Duration_Get()

peak_status peak_IOChannel_NoiseFilter_Duration_Get	(	peak_camera_handle	hCam,
		peak_io_channel	ioChannel,
		double *	noiseFilterDuration_us
	)

Get the io channel noise filter duration.

Reads the current io channel noise filter duration for the specified io channel.

Parameters

[in]	hCam	The camera handle.
[in]	ioChannel	The io channel.
[out]	noiseFilterDuration_us	The noise filter duration in microseconds.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_ACCESS_DENIED The noise filter duration is not accessible for read. Check the access status via peak_IOChannel_NoiseFilter_GetAccessStatus.; PEAK_STATUS_INVALID_PARAMETER noiseFilterDuration_us is an invalid pointer or ioChannel is an invalid 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_IOChannel_NoiseFilter_Duration_GetRange()

peak_status peak_IOChannel_NoiseFilter_Duration_GetRange	(	peak_camera_handle	hCam,
		peak_io_channel	ioChannel,
		double *	minNoiseFilterDuration_us,
		double *	maxNoiseFilterDuration_us,
		double *	incNoiseFilterDuration_us
	)

Get the current range of valid io channel noise filter duration values.

Queries the current range of valid values for the io channel noise filter duration for the specified io channel.

The range of valid io channel noise filter duration delay values may depend on the camera configuration and the camera status.

Parameters

[in]	hCam	The camera handle.
[in]	ioChannel	The io channel.
[out]	minNoiseFilterDuration_us	The minimum noise filter duration value in microseconds.
[out]	maxNoiseFilterDuration_us	The maximum noise filter duration value in microseconds.
[out]	incNoiseFilterDuration_us	The noise filter duration value increment in microseconds.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_ACCESS_DENIED The noise filter duration is not accessible. Check the access status via peak_IOChannel_NoiseFilter_GetAccessStatus.; PEAK_STATUS_INVALID_PARAMETER At least one of minNoiseFilterDuration_us, maxNoiseFilterDuration_us, and incNoiseFilterDuration_us is an invalid pointer or ioChannel is an invalid 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_IOChannel_NoiseFilter_Duration_Set()

peak_status peak_IOChannel_NoiseFilter_Duration_Set	(	peak_camera_handle	hCam,
		peak_io_channel	ioChannel,
		double	noiseFilterDuration_us
	)

Set the io channel noise filter duration.

Writes the desired io channel noise filter duration for the specified io channel.

Parameters

[in]	hCam	The camera handle.
[in]	ioChannel	The io channel.
[out]	noiseFilterDuration_us	The noise filter duration to set in microseconds.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_ACCESS_DENIED The noise filter duration is not accessible for write. Check the access status via peak_IOChannel_NoiseFilter_GetAccessStatus.; PEAK_STATUS_OUT_OF_RANGE noiseFilterDuration_us is out of range. Check the range of valid values via peak_IOChannel_NoiseFilter_Duration_GetRange.; PEAK_STATUS_INVALID_PARAMETER ioChannel is an invalid 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_IOChannel_NoiseFilter_Enable()

peak_status peak_IOChannel_NoiseFilter_Enable	(	peak_camera_handle	hCam,
		peak_io_channel	ioChannel,
		peak_bool	enabled
	)

Enable/Disable the io channel noise filter property.

Sets the io channel noise filter property to enabled or disabled.

Parameters

[in]	hCam	The camera handle.
[in]	ioChannel	The io channel.
[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 io channel noise filter property is not accessible for write. Check the access status via peak_IOChannel_NoiseFilter_GetAccessStatus.; PEAK_STATUS_INVALID_PARAMETER ioChannel is an invalid 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_IOChannel_NoiseFilter_GetAccessStatus()

peak_access_status peak_IOChannel_NoiseFilter_GetAccessStatus	(	peak_camera_handle	hCam,
		peak_io_channel	ioChannel
	)

Query the io channel noise filter property access status.

Provides the current access status for the noise filter property for the specified io channel.

This function implements the Access Status Query principle.

Parameters

[in]	hCam	The camera handle.
[in]	ioChannel	The io channel.

Returns: PEAK_ACCESS_READWRITE The noise filter property is readable and writeable for the specified io channel.; PEAK_ACCESS_READONLY The noise filter property is readable only for the specified io channel.; PEAK_ACCESS_GFA_LOCK The noise filter property is not accessible because the GFA write access is enabled.; PEAK_ACCESS_NONE The noise filter property is not accessible for the specified io channel.; PEAK_ACCESS_NOT_SUPPORTED The noise filter property is not supported for the specified io channel.; 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 specified io channel is not accessible. Check the access status of the io channel via peak_IOChannel_GetAccessStatus.
PEAK_STATUS_INVALID_PARAMETER ioChannel is an invalid 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_IOChannel_NoiseFilter_IsEnabled()

peak_bool peak_IOChannel_NoiseFilter_IsEnabled	(	peak_camera_handle	hCam,
		peak_io_channel	ioChannel
	)

Get the enabled status of the io channel noise filter property.

Queries whether the io channel noise filter property is currently enabled or disabled.

This function implements the Enabled Status Query principle.

Parameters

[in]	hCam	The camera handle.
[in]	ioChannel	The io channel.

Returns: PEAK_TRUE The io channel noise filter property is currently enabled.; PEAK_FALSE The io channel noise filter property is currently disabled or the query failed.

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ peak_io_channel

Function Documentation

◆ peak_IOChannel_GetAccessStatus()

◆ peak_IOChannel_GetList()

◆ peak_IOChannel_Inverter_Enable()

◆ peak_IOChannel_Inverter_GetAccessStatus()

◆ peak_IOChannel_Inverter_IsEnabled()

◆ peak_IOChannel_Level_GetAccessStatus()

◆ peak_IOChannel_Level_IsHigh()

◆ peak_IOChannel_NoiseFilter_Duration_Get()

◆ peak_IOChannel_NoiseFilter_Duration_GetRange()

◆ peak_IOChannel_NoiseFilter_Duration_Set()

◆ peak_IOChannel_NoiseFilter_Enable()

◆ peak_IOChannel_NoiseFilter_GetAccessStatus()

◆ peak_IOChannel_NoiseFilter_IsEnabled()