The functions in this section allow for the retrieval of device event data. More...

Functions
SPINNAKERC_API	spinDeviceEventGetId (spinDeviceEventData hDeviceEventData, uint64_t *pEventId)
	Retrieves the event ID of a device event. More...

SPINNAKERC_API	spinDeviceEventGetPayloadData (spinDeviceEventData hDeviceEventData, const uint8_t pBuf, size_t pBufSize)
	Retrieves the payload data of a device event. More...

SPINNAKERC_API	spinDeviceEventGetPayloadDataSize (spinDeviceEventData hDeviceEventData, size_t *pBufSize)
	Retrieves the payload data size of a device event. More...

SPINNAKERC_API	spinDeviceEventGetName (spinDeviceEventData hDeviceEventData, char pBuf, size_t pBufLen)
	Retrieves the event name of a device event. More...

Detailed Description

The functions in this section allow for the retrieval of device event data.

Function Documentation

SPINNAKERC_API spinDeviceEventGetId	(	spinDeviceEventData	hDeviceEventData,
		uint64_t *	pEventId
	)

Retrieves the event ID of a device event.

Parameters

hDeviceEventData	The log event data received from the log event
pEventId	The unsigned integer pointer in which the event ID is returned

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

SPINNAKERC_API spinDeviceEventGetName	(	spinDeviceEventData	hDeviceEventData,
		char *	pBuf,
		size_t *	pBufLen
	)

Retrieves the event name of a device event.

Parameters

hDeviceEventData	The log event data received from the log event
pBuf	The c-string character buffer in which the name of the device event is returned
pBufLen	The unsigned integer pointer in which the length of the c-string is returned; the input value is the maximum length

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

SPINNAKERC_API spinDeviceEventGetPayloadData	(	spinDeviceEventData	hDeviceEventData,
		const uint8_t *	pBuf,
		size_t *	pBufSize
	)

Retrieves the payload data of a device event.

Parameters

hDeviceEventData	The log event data received from the log event
pBuf	The unsigned integer pointer in which the event payload is returned
pBufSize	The unsigned integer pointer in which the size of the payload is returned

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

SPINNAKERC_API spinDeviceEventGetPayloadDataSize	(	spinDeviceEventData	hDeviceEventData,
		size_t *	pBufSize
	)

Retrieves the payload data size of a device event.

Parameters

hDeviceEventData	The log event data received from the log event
pBufSize	The unsigned integer pointer in which the size of the payload is returned

Returns: spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error