Data Structures
struct	peak_message_data_remote_device
	peak message data for remote device messages Used if data type is PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE More...

struct	peak_message_data_remote_device_error
	peak message data for remote device error messages Used if data type is PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_ERROR More...

struct	peak_message_data_remote_device_dropped
	peak message data for remote device dropped messages Used if data type is PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_DROPPED More...

struct	peak_message_data_remote_device_frame
	peak message data for remote device frame messages Used if data type is PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_FRAME More...

struct	peak_message_data_remote_device_temperature
	peak message data for remote device temperature messages Used if data type is PEAK_MESSAGE_DATA_TYPE_REMOTE_DEVICE_TEMPERATURE More...

struct	peak_message_data_autofocus
	peak message data for auto focus data messages Used if data type is PEAK_MESSAGE_DATA_TYPE_AUTOFOCUS_DATA 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 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. More...

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

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

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

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

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

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

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.

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.

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

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.

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

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

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

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

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

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.

Data Structures

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ peak_message_data_type

Function Documentation

◆ peak_Message_Data_AutoFocusData_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()