Camera settings

Enumerations
enum	peak_parameter_set {   PEAK_PARAMETER_SET_INVALID , PEAK_PARAMETER_SET_DEFAULT , PEAK_PARAMETER_SET_LINESCAN , PEAK_PARAMETER_SET_LONG_EXPOSURE ,   PEAK_PARAMETER_SET_USER_1 , PEAK_PARAMETER_SET_USER_2 }
	peak Parameter set More...

Functions
peak_access_status	peak_CameraSettings_ParameterSet_GetAccessStatus (peak_camera_handle hCam, peak_parameter_set parameterSet)
	Query the parameter set access status.
peak_status	peak_CameraSettings_ParameterSet_GetList (peak_camera_handle hCam, peak_parameter_set *parameterSetList, size_t *parameterSetCount)
	Get the list of currently usable parameter sets.
peak_status	peak_CameraSettings_ParameterSet_Store (peak_camera_handle hCam, peak_parameter_set parameterSet)
	Store the current camera configuration in a user-definable parameter set.
peak_status	peak_CameraSettings_ParameterSet_Apply (peak_camera_handle hCam, peak_parameter_set parameterSet)
	Apply the specified parameter set.
peak_access_status	peak_CameraSettings_ParameterSet_Startup_GetAccessStatus (peak_camera_handle hCam)
	Query the startup parameter set access status.
peak_status	peak_CameraSettings_ParameterSet_Startup_Set (peak_camera_handle hCam, peak_parameter_set parameterSet)
	Set the startup parameter set.
peak_status	peak_CameraSettings_ParameterSet_Startup_Get (peak_camera_handle hCam, peak_parameter_set *parameterSet)
	Get the startup parameter set.
peak_access_status	peak_CameraSettings_DiskFile_GetAccessStatus (peak_camera_handle hCam)
	Query the disk file settings access status.
peak_status	peak_CameraSettings_DiskFile_Store (peak_camera_handle hCam, const char *file)
	Store the current camera configuration to a disk file.
peak_status	peak_CameraSettings_DiskFile_Apply (peak_camera_handle hCam, const char *file)
	Apply the camera configuration from the specified disk file.

Detailed Description

Camera settings related functions and types.

Enumeration Type Documentation

peak_parameter_set

enum peak_parameter_set

peak Parameter set

A parameter set describes a specific camera configuration.
A camera may provide a number of pre-defined parameter sets that can be applied to set the camera to a basic configuration for a certain use case.
A camera may also provide a number of user-definable parameter sets that can be used to store a certain configuration in the cameras persistent memory and to restore/apply it from the cameras persistent memory. A user-definable set can be applied only if it has been stored before.
A parameter set may also be selectable to be automatically applied at the time of camera startup.

The set of supported parameter sets depends on the camera model.

Enumerator
PEAK_PARAMETER_SET_INVALID	Invalid parameter set. Use this value for the initialization of variables of type peak_parameter_set.
PEAK_PARAMETER_SET_DEFAULT	Default set. The default set can be used to set the camera to its default configuration.
PEAK_PARAMETER_SET_LINESCAN	Linescan set. The linescan set can be used to set the camera to a basic configuration for the linescan use case.
PEAK_PARAMETER_SET_LONG_EXPOSURE	Long exposure set. The long exposure set can be used to set the camera to a basic configuration for the long exposure use case.
PEAK_PARAMETER_SET_USER_1	User set 1. The user set 1 can be used to store a certain camera configuration in the cameras persistent memory and to restore it from the cameras persistent memory.
PEAK_PARAMETER_SET_USER_2	User set 2. The user set 2 can be used to store a certain camera configuration in the cameras persistent memory and to restore it from the cameras persistent memory.

Function Documentation

peak_CameraSettings_DiskFile_Apply()

peak_status peak_CameraSettings_DiskFile_Apply	(	peak_camera_handle	hCam,
		const char *	file )

Apply the camera configuration from the specified disk file.

Reads the camera configuration from the specified disk file and applies it. If a path of an .ini file is given and the camera is either of type PEAK_CAMERA_TYPE_UEYE_ETH or PEAK_CAMERA_TYPE_UEYE_USB, the function will load a uEye parameterset file.

Parameters

[in]	hCam	The camera handle.
[in]	file	The file (path + name) as a zero-terminated string.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED Either the provided file format is not supported, or the camera configuration is not storable. check the disk file settings features access status via peak_CameraSettings_DiskFile_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER file is an invalid pointer, it is not zero-terminated, or it is not a valid and accessible file.

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_CameraSettings_DiskFile_GetAccessStatus()

peak_access_status peak_CameraSettings_DiskFile_GetAccessStatus

(

peak_camera_handle

hCam

)

Query the disk file settings access status.

Provides the current access status for the disk file settings feature.

This function implements the Access Status Query principle.

Parameters

[in]

hCam

The camera handle.

Returns

PEAK_ACCESS_READWRITE The camera settings can be stored to a disk file and applied from a disk file.

PEAK_ACCESS_WRITEONLY The camera settings can be stored to a disk file only.

PEAK_ACCESS_GFA_LOCK The camera settings can not be stored to a disk file because the GFA write access is enabled.

PEAK_ACCESS_NONE The camera settings can not be stored to a disk file nor can they be applied from a disk file.

PEAK_ACCESS_NOT_SUPPORTED The disk file settings 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.

Since

1.0

peak_CameraSettings_DiskFile_Store()

peak_status peak_CameraSettings_DiskFile_Store	(	peak_camera_handle	hCam,
		const char *	file )

Store the current camera configuration to a disk file.

Writes the current camera configuration to the specified disk file. If a path of an .ini file is given and the camera is either of type PEAK_CAMERA_TYPE_UEYE_ETH or PEAK_CAMERA_TYPE_UEYE_USB, the function will save a uEye parameterset file.

Parameters

[in]	hCam	The camera handle.
[in]	file	The file (path + name) as a zero-terminated string.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED Either the provided file format is not supported, or the camera configuration is not storable. Check the disk file settings features access status via peak_CameraSettings_DiskFile_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER file is an invalid pointer, it is not zero-terminated, or it is not a valid and accessible file.

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_CameraSettings_ParameterSet_Apply()

peak_status peak_CameraSettings_ParameterSet_Apply	(	peak_camera_handle	hCam,
		peak_parameter_set	parameterSet )

Apply the specified parameter set.

Reads the specified parameter set from the cameras persistent storage and applies it.

Parameters

[in]	hCam	The camera handle.
[out]	parameterSet	The parameter set.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The parameter set is not applicable. Check the access status via peak_CameraSettings_ParameterSet_GetAccessStatus. Check the list of currently usable parameter sets via peak_CameraSettings_ParameterSet_GetList.

PEAK_STATUS_INVALID_PARAMETER parameterSet is an invalid parameter set. Check peak_parameter_set.

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_CameraSettings_ParameterSet_GetAccessStatus()

peak_access_status peak_CameraSettings_ParameterSet_GetAccessStatus	(	peak_camera_handle	hCam,
		peak_parameter_set	parameterSet )

Query the parameter set access status.

Provides the current access status for the specified parameter set.

This function implements the Access Status Query principle.

Parameters

[in]	hCam	The camera handle.
[in]	parameterSet	The parameter set.

Returns

PEAK_ACCESS_READWRITE The parameter set can be stored and applied.

PEAK_ACCESS_READONLY The parameter set can be applied only.

PEAK_ACCESS_WRITEONLY The parameter set can be stored only.

PEAK_ACCESS_GFA_LOCK The parameter set is not accessible because the GFA write access is enabled.

PEAK_ACCESS_NONE The parameter set is not accessible.

PEAK_ACCESS_NOT_SUPPORTED The parameter set 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_PARAMETER parameterSet is an invalid parameter set. Check peak_parameter_set.
• 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_CameraSettings_ParameterSet_GetList()

peak_status peak_CameraSettings_ParameterSet_GetList	(	peak_camera_handle	hCam,
		peak_parameter_set *	parameterSetList,
		size_t *	parameterSetCount )

Get the list of currently usable parameter sets.

Queries the list of currently selectable parameter sets.

The list of usable parameter sets may depend on the camera configuration and the camera status.

This function implements the Two Staged Data Query principle.

Parameters

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

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_BUFFER_TOO_SMALL parameterSetList is not NULL and the value of *parameterSetCount is too small to receive the expected amount of data.

PEAK_STATUS_ACCESS_DENIED The parameter set feature is not supported or the GFA write mode is enabled.

PEAK_STATUS_INVALID_PARAMETER parameterSetCount 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.

Note

Please consider that the parameter set list might change between the size query call and the list query call.
This may be the case if the camera configuration or the camera status have changed in the time between the two function calls.

Since

1.0

peak_CameraSettings_ParameterSet_Startup_Get()

peak_status peak_CameraSettings_ParameterSet_Startup_Get	(	peak_camera_handle	hCam,
		peak_parameter_set *	parameterSet )

Get the startup parameter set.

Queries the current startup parameter set.

Parameters

[in]	hCam	The camera handle.
[out]	parameterSet	The startup parameter set.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The startup parameter set is not available for read access. Check the access status of the startup parameter set via peak_CameraSettings_ParameterSet_Startup_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER parameterSet 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_CameraSettings_ParameterSet_Startup_GetAccessStatus()

peak_access_status peak_CameraSettings_ParameterSet_Startup_GetAccessStatus

(

peak_camera_handle

hCam

)

Query the startup parameter set access status.

Provides the current access status for the startup parameter set.

This function implements the Access Status Query principle.

Parameters

[in]

hCam

The camera handle.

Returns

PEAK_ACCESS_READWRITE The startup parameter set is readable and writeable.

PEAK_ACCESS_READONLY The startup parameter set is readable only.

PEAK_ACCESS_GFA_LOCK The startup parameter set is not accessible because the GFA write access is enabled.

PEAK_ACCESS_NONE The startup parameter set is not accessible.

PEAK_ACCESS_NOT_SUPPORTED The startup parameter set 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.

Since

1.0

peak_CameraSettings_ParameterSet_Startup_Set()

peak_status peak_CameraSettings_ParameterSet_Startup_Set	(	peak_camera_handle	hCam,
		peak_parameter_set	parameterSet )

Set the startup parameter set.

Sets the specified parameter set to be automatically applied at the time of camera startup.

Parameters

[in]	hCam	The camera handle.
[in]	parameterSet	The startup parameter set.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The startup parameter set is not accessible or the specified parameter set is not applicable. Check the access status of the startup parameter set via peak_CameraSettings_ParameterSet_Startup_GetAccessStatus. Check the access status of the specified parameter set via peak_CameraSettings_ParameterSet_GetAccessStatus. Check the list of currently usable parameter sets via peak_CameraSettings_ParameterSet_GetList.

PEAK_STATUS_INVALID_PARAMETER parameterSet is an invalid parameter set. Check peak_parameter_set.

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_CameraSettings_ParameterSet_Store()

peak_status peak_CameraSettings_ParameterSet_Store	(	peak_camera_handle	hCam,
		peak_parameter_set	parameterSet )

Store the current camera configuration in a user-definable parameter set.

Writes the current camera configuration to the specified parameter set.

Parameters

[in]	hCam	The camera handle.
[in]	parameterSet	The parameter set.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The parameter set is not storable. Check the access status via peak_CameraSettings_ParameterSet_GetAccessStatus. Check the list of currently usable parameter sets via peak_CameraSettings_ParameterSet_GetList.

PEAK_STATUS_INVALID_PARAMETER parameterSet is an invalid parameter set. Check peak_parameter_set.

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.

Note

In general only the user-definable parameter sets can be stored.

Since

1.0