Data Structures
struct	peak_message_data_remote_device
	peak message data for remote device messages. More...
struct	peak_message_data_remote_device_error
	peak message data for remote device error messages. More...
struct	peak_message_data_remote_device_dropped
	peak message data for remote device dropped messages. More...
struct	peak_message_data_remote_device_frame
	peak message data for remote device frame messages. More...
struct	peak_message_data_remote_device_temperature
	peak message data for remote device temperature messages. More...
struct	peak_message_data_autofocus
	peak message data for auto focus data messages. More...
struct	peak_message_data_device_found
	peak message data for camera manager device found messages. More...
struct	peak_message_data_device_lost
	peak message data for camera manager device lost messages. More...
struct	peak_message_data_device_reconnected
	peak message data for camera manager device reconnected messages. More...
struct	peak_message_data_device_disconnected
	peak message data for camera manager device disconnected messages. More...
struct	peak_message_data_firmware_update
	Message data containing information about the current state of a firmware update. More...

Enumerations
enum	peak_message_data_type { PEAK_MESSAGE_DATA_TYPE_INVALID , PEAK_MESSAGE_DATA_TYPE_NO_DATA , PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE , PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_ERROR , PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_DROPPED , PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_FRAME , PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_TEMPERATURE , PEAK_MESSAGE_DATA_TYPE_AUTOFOCUS_DATA , PEAK_MESSAGE_DATA_TYPE_DEVICE_FOUND , PEAK_MESSAGE_DATA_TYPE_DEVICE_LOST , PEAK_MESSAGE_DATA_TYPE_DEVICE_RECONNECTED , PEAK_MESSAGE_DATA_TYPE_DEVICE_DISCONNECTED , PEAK_MESSAGE_DATA_TYPE_FIRMWARE_UPDATE }
	peak message data types valid message data types More...

Functions
peak_status	peak_Message_Data_Type_Get (peak_message_handle hMessage, peak_message_data_type *messageType)
	Get the message data type.
peak_status	peak_Message_Data_RemoteDevice_Get (peak_message_handle hMessage, peak_message_data_remote_device *message)
	Get the message data for remote device types.
peak_status	peak_Message_Data_RemoteDeviceError_Get (peak_message_handle hMessage, peak_message_data_remote_device_error *message)
	Get the message data for remote device error types.
peak_status	peak_Message_Data_RemoteDeviceDropped_Get (peak_message_handle hMessage, peak_message_data_remote_device_dropped *message)
	Get the message data for remote device dropped types.
peak_status	peak_Message_Data_RemoteDeviceFrame_Get (peak_message_handle hMessage, peak_message_data_remote_device_frame *message)
	Get the message data for remote device frame types.
peak_status	peak_Message_Data_RemoteDeviceTemperature_Get (peak_message_handle hMessage, peak_message_data_remote_device_temperature *message)
	Get the message data for remote device temperature types.
peak_status	peak_Message_Data_AutoFocusData_Get (peak_message_handle hMessage, peak_message_data_autofocus *message)
	Get the message data for auto focus data types.
peak_status	peak_Message_Data_DeviceFound_Get (peak_message_handle hMessage, peak_message_data_device_found *message)
	Get the message data for camera manager device found data types.
peak_status	peak_Message_Data_DeviceLost_Get (peak_message_handle hMessage, peak_message_data_device_lost *message)
	Get the message data for camera manager device lost data types.
peak_status	peak_Message_Data_DeviceReconnected_Get (peak_message_handle hMessage, peak_message_data_device_reconnected *message)
	Get the message data for camera manager device reconnected data types.
peak_status	peak_Message_Data_DeviceDisconnected_Get (peak_message_handle hMessage, peak_message_data_device_disconnected *message)
	Get the message data for camera manager device disconnected data types.
peak_status	peak_Message_Data_FirmwareUpdate_Get (peak_message_handle hMessage, peak_message_data_firmware_update *message)
	Get the message data for firmware update data types.

Detailed Description

Definitions on Queue Message Data.

Enumeration Type Documentation

◆ peak_message_data_type

enum peak_message_data_type

peak message data types valid message data types

Enumerator
PEAK_MESSAGE_DATA_TYPE_INVALID	Invalid message data type.
PEAK_MESSAGE_DATA_TYPE_NO_DATA	No data message data type.
PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE	Remote device message data type.
PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_ERROR	Remote device error message data type.
PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_DROPPED	Remote device dropped message data type.
PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_FRAME	Remote device frame message data type.
PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_TEMPERATURE	Remote device temperature message data type.
PEAK_MESSAGE_DATA_TYPE_AUTOFOCUS_DATA	Autofeature auto focus data message data type.
PEAK_MESSAGE_DATA_TYPE_DEVICE_FOUND	Camera manager device found message data type.
PEAK_MESSAGE_DATA_TYPE_DEVICE_LOST	Camera manager device lost message data type.
PEAK_MESSAGE_DATA_TYPE_DEVICE_RECONNECTED	Camera manager device reconnected message data type.
PEAK_MESSAGE_DATA_TYPE_DEVICE_DISCONNECTED	Camera manager device disconnected message data type.
PEAK_MESSAGE_DATA_TYPE_FIRMWARE_UPDATE	Firmware update message data type.

Function Documentation

◆ peak_Message_Data_AutoFocusData_Get()

peak_status peak_Message_Data_AutoFocusData_Get	(	peak_message_handle	hMessage,
		peak_message_data_autofocus *	message )

Get the message data for auto focus data types.

The call is valid for PEAK_MESSAGE_DATA_TYPE_AUTOFOCUS_DATA data type. To get the data type, see peak_Message_Data_Type_Get.

Parameters

[in]	hMessage	Handle for a message instance.
[out]	message	The auto focus message data.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_HANDLE hMessage is an invalid handle.; PEAK_STATUS_INVALID_CONFIGURATION The message type does not support this call.; PEAK_STATUS_INVALID_PARAMETER message is an invalid pointer.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

Since: 1.5

◆ peak_Message_Data_DeviceDisconnected_Get()

peak_status peak_Message_Data_DeviceDisconnected_Get	(	peak_message_handle	hMessage,
		peak_message_data_device_disconnected *	message )

Get the message data for camera manager device disconnected data types.

The call is valid for PEAK_MESSAGE_DATA_TYPE_DEVICE_DISCONNECTED data type.

Parameters

[in]	hMessage	Handle for a message instance.
[out]	message	The device disconnected message data.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_HANDLE hMessage is an invalid handle.; PEAK_STATUS_INVALID_CONFIGURATION The message type does not support this call.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

Since: 1.6

◆ peak_Message_Data_DeviceFound_Get()

peak_status peak_Message_Data_DeviceFound_Get	(	peak_message_handle	hMessage,
		peak_message_data_device_found *	message )

Get the message data for camera manager device found data types.

The call is valid for PEAK_MESSAGE_DATA_TYPE_DEVICE_FOUND data type. To get the data type, see peak_Message_Data_Type_Get.

Parameters

[in]	hMessage	Handle for a message instance.
[out]	message	The device found message data.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_HANDLE hMessage is an invalid handle.; PEAK_STATUS_INVALID_CONFIGURATION The message type does not support this call.; PEAK_STATUS_INVALID_PARAMETER message is an invalid pointer.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

Since: 1.5

◆ peak_Message_Data_DeviceLost_Get()

peak_status peak_Message_Data_DeviceLost_Get	(	peak_message_handle	hMessage,
		peak_message_data_device_lost *	message )

Get the message data for camera manager device lost data types.

The call is valid for PEAK_MESSAGE_DATA_TYPE_DEVICE_LOST data type. To get the data type, see peak_Message_Data_Type_Get.

Parameters

[in]	hMessage	Handle for a message instance.
[out]	message	The device lost message data.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_HANDLE hMessage is an invalid handle.; PEAK_STATUS_INVALID_CONFIGURATION The message type does not support this call.; PEAK_STATUS_INVALID_PARAMETER message is an invalid pointer.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

Since: 1.5

◆ peak_Message_Data_DeviceReconnected_Get()

peak_status peak_Message_Data_DeviceReconnected_Get	(	peak_message_handle	hMessage,
		peak_message_data_device_reconnected *	message )

Get the message data for camera manager device reconnected data types.

The call is valid for PEAK_MESSAGE_DATA_TYPE_DEVICE_RECONNECTED data type.

Parameters

[in]	hMessage	Handle for a message instance.
[out]	message	The device reconnected message data.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_HANDLE hMessage is an invalid handle.; PEAK_STATUS_INVALID_CONFIGURATION The message type does not support this call.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

Since: 1.5

◆ peak_Message_Data_FirmwareUpdate_Get()

peak_status peak_Message_Data_FirmwareUpdate_Get	(	peak_message_handle	hMessage,
		peak_message_data_firmware_update *	message )

Get the message data for firmware update data types.

The call is valid for PEAK_MESSAGE_DATA_TYPE_FIRMWARE_UPDATE data type.

Parameters

[in]	hMessage	Handle for a message instance.
[out]	message	The firmware update message data.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_HANDLE hMessage is an invalid handle.; PEAK_STATUS_INVALID_CONFIGURATION The message type does not support this call.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

Since: 1.9

◆ peak_Message_Data_RemoteDevice_Get()

peak_status peak_Message_Data_RemoteDevice_Get	(	peak_message_handle	hMessage,
		peak_message_data_remote_device *	message )

Get the message data for remote device types.

The call is valid for all device data types. These are:

PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE
PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_ERROR
PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_DROPPED
PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_FRAME
PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_TEMPERATURE

To get the data type, see peak_Message_Data_Type_Get.

Parameters

[in]	hMessage	Handle for a message instance.
[out]	message	The remote device message data.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_HANDLE hMessage is an invalid handle.; PEAK_STATUS_INVALID_CONFIGURATION The type does not support this call.; PEAK_STATUS_INVALID_PARAMETER message is an invalid pointer.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

Since: 1.5

◆ peak_Message_Data_RemoteDeviceDropped_Get()

peak_status peak_Message_Data_RemoteDeviceDropped_Get	(	peak_message_handle	hMessage,
		peak_message_data_remote_device_dropped *	message )

Get the message data for remote device dropped types.

The call is valid for PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_DROPPED data type. To get the data type, see peak_Message_Data_Type_Get.

Parameters

[in]	hMessage	Handle for a message instance.
[out]	message	The remote device message data.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_HANDLE hMessage is an invalid handle.; PEAK_STATUS_INVALID_CONFIGURATION The type does not support this call.; PEAK_STATUS_INVALID_PARAMETER message is an invalid pointer.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

Since: 1.5

◆ peak_Message_Data_RemoteDeviceError_Get()

peak_status peak_Message_Data_RemoteDeviceError_Get	(	peak_message_handle	hMessage,
		peak_message_data_remote_device_error *	message )

Get the message data for remote device error types.

The call is valid for PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_ERROR data type. To get the data type, see peak_Message_Data_Type_Get.

Parameters

[in]	hMessage	Handle for a message instance.
[out]	message	The remote device message data.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_HANDLE hMessage is an invalid handle.; PEAK_STATUS_INVALID_CONFIGURATION The type does not support this call.; PEAK_STATUS_INVALID_PARAMETER message is an invalid pointer.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

Since: 1.5

◆ peak_Message_Data_RemoteDeviceFrame_Get()

peak_status peak_Message_Data_RemoteDeviceFrame_Get	(	peak_message_handle	hMessage,
		peak_message_data_remote_device_frame *	message )

Get the message data for remote device frame types.

The call is valid for PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_FRAME data type. To get the data type, see peak_Message_Data_Type_Get.

Parameters

[in]	hMessage	Handle for a message instance.
[out]	message	The remote device message data.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_HANDLE hMessage is an invalid handle.; PEAK_STATUS_INVALID_CONFIGURATION The type does not support this call.; PEAK_STATUS_INVALID_PARAMETER message is an invalid pointer.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

Since: 1.5

◆ peak_Message_Data_RemoteDeviceTemperature_Get()

peak_status peak_Message_Data_RemoteDeviceTemperature_Get	(	peak_message_handle	hMessage,
		peak_message_data_remote_device_temperature *	message )

Get the message data for remote device temperature types.

The call is valid for PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_TEMPERATURE data type. To get the data type, see peak_Message_Data_Type_Get.

Parameters

[in]	hMessage	Handle for a message instance.
[out]	message	The remote device message data.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_HANDLE hMessage is an invalid handle.; PEAK_STATUS_INVALID_CONFIGURATION The message type does not support this call.; PEAK_STATUS_INVALID_PARAMETER message is an invalid pointer.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

Since: 1.5

◆ peak_Message_Data_Type_Get()

peak_status peak_Message_Data_Type_Get	(	peak_message_handle	hMessage,
		peak_message_data_type *	messageType )

Get the message data type.

This is important to get the associated message data for a message. The following list describes which function should be called for each type to get the data. For the device events a call to peak_Message_Data_RemoteDevice_Get is always valid.

PEAK_MESSAGE_DATA_TYPE_NO_DATA: No data is associated with the message.
PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE: Call peak_Message_Data_RemoteDevice_Get.
PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_ERROR: Call peak_Message_Data_RemoteDeviceError_Get.
PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_DROPPED: Call peak_Message_Data_RemoteDeviceDropped_Get.
PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_FRAME: Call peak_Message_Data_RemoteDeviceFrame_Get.
PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_TEMPERATURE: Call peak_Message_Data_RemoteDeviceTemperature_Get.
PEAK_MESSAGE_DATA_TYPE_AUTOFOCUS_DATA: Call peak_Message_Data_AutoFocusData_Get.
PEAK_MESSAGE_DATA_TYPE_DEVICE_FOUND: Call peak_Message_Data_DeviceFound_Get
PEAK_MESSAGE_DATA_TYPE_DEVICE_LOST: Call peak_Message_Data_DeviceLost_Get
PEAK_MESSAGE_DATA_TYPE_DEVICE_RECONNECTED: Call peak_Message_Data_DeviceReconnected_Get
PEAK_MESSAGE_DATA_TYPE_DEVICE_DISCONNECTED: Call peak_Message_Data_DeviceDisconnected_Get

Parameters

[in]	hMessage	Handle for a message instance.
[out]	messageType	The message data type.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_INVALID_HANDLE hMessage is an invalid handle.; PEAK_STATUS_INVALID_PARAMETER messageType is an invalid pointer.; PEAK_STATUS_NOT_INITIALIZED The library is not initialized.; PEAK_STATUS_ERROR An unexpected internal error occurred.

Since: 1.5

Data Structures

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ peak_message_data_type

Function Documentation

◆ peak_Message_Data_AutoFocusData_Get()

◆ peak_Message_Data_DeviceDisconnected_Get()

◆ peak_Message_Data_DeviceFound_Get()

◆ peak_Message_Data_DeviceLost_Get()

◆ peak_Message_Data_DeviceReconnected_Get()

◆ peak_Message_Data_FirmwareUpdate_Get()

◆ peak_Message_Data_RemoteDevice_Get()

◆ peak_Message_Data_RemoteDeviceDropped_Get()

◆ peak_Message_Data_RemoteDeviceError_Get()

◆ peak_Message_Data_RemoteDeviceFrame_Get()

◆ peak_Message_Data_RemoteDeviceTemperature_Get()

◆ peak_Message_Data_Type_Get()