Frame-Sync Capability

Collaboration diagram for Frame-Sync Capability:

Functions
XN_C_API XnBool	xnCanFrameSyncWith (XnNodeHandle hInstance, XnNodeHandle hOther)
	Checks if this generator can frame sync to another node.
XN_C_API XnStatus	xnFrameSyncWith (XnNodeHandle hInstance, XnNodeHandle hOther)
	Activates frame sync with the other node.
XN_C_API XnBool	xnIsFrameSyncedWith (XnNodeHandle hInstance, XnNodeHandle hOther)
	Checks if current view point is as if coming from the other node view point.
XN_C_API XnStatus	xnRegisterToFrameSyncChange (XnNodeHandle hInstance, XnStateChangedHandler handler, void *pCookie, XnCallbackHandle *phCallback)
	Registers a callback function to view point changes.
XN_C_API XnStatus	xnStopFrameSyncWith (XnNodeHandle hInstance, XnNodeHandle hOther)
	Stops frame sync with the other node.
XN_C_API void	xnUnregisterFromFrameSyncChange (XnNodeHandle hInstance, XnCallbackHandle hCallback)
	Unregisters a callback function which was registered using xnRegisterToFrameSyncChange().

---

Detailed Description

The Frame Sync capability (XN_CAPABILITY_FRAME_SYNC) allows two sensors producing frame data to synchronize their frames so that they arrive at the same time. This allows smaller latency between two maps of the same scene (for example depth and image).

---

Function Documentation

XN_C_API XnBool xnCanFrameSyncWith	(	XnNodeHandle	hInstance,
		XnNodeHandle	hOther
	)

Checks if this generator can frame sync to another node.

Parameters:

hInstance	[in] A handle to the instance.
hOther	[in] The node to be checked.

Returns:

TRUE if frame sync to node is supported, FALSE otherwise.

XN_C_API XnStatus xnFrameSyncWith	(	XnNodeHandle	hInstance,
		XnNodeHandle	hOther
	)

Activates frame sync with the other node.

Parameters:

hInstance	[in] A handle to the instance.
hOther	[in] The node to sync to.

XN_C_API XnBool xnIsFrameSyncedWith	(	XnNodeHandle	hInstance,
		XnNodeHandle	hOther
	)

Checks if current view point is as if coming from the other node view point.

Parameters:

hInstance	[in] A handle to the instance.
hOther	[in] The node to be checked.

XN_C_API XnStatus xnRegisterToFrameSyncChange	(	XnNodeHandle	hInstance,
		XnStateChangedHandler	handler,
		void *	pCookie,
		XnCallbackHandle *	phCallback
	)

Registers a callback function to view point changes.

Parameters:

hInstance	[in] A handle to the instance.
handler	[in] A pointer to a function that will be called when frame sync changes.
pCookie	[in] A user cookie that will be passed to the callback function.
phCallback	[out] Optional. Will be filled with a handle to be passed to xnUnregisterFromFrameSyncChange().

XN_C_API XnStatus xnStopFrameSyncWith	(	XnNodeHandle	hInstance,
		XnNodeHandle	hOther
	)

Stops frame sync with the other node.

Parameters:

hInstance	[in] A handle to the instance.
hOther	[in] The node to sync to.

XN_C_API void xnUnregisterFromFrameSyncChange	(	XnNodeHandle	hInstance,
		XnCallbackHandle	hCallback
	)

Unregisters a callback function which was registered using xnRegisterToFrameSyncChange().

Parameters:

hInstance	[in] A handle to the instance.
hCallback	[in] The handle to the callback returned from xnRegisterToFrameSyncChange().