XnUSBDevice.h File Reference

#include "XnPlatform.h" #include "XnStatus.h"

Go to the source code of this file.

Classes
struct	XnUSBStringDescriptor
struct	XnUSBInterfaceDescriptorHolder
struct	XnUSBConfigDescriptorHolder
struct	XnUSBDeviceDescriptorHolder
Typedefs
typedef enum XnUSBDeviceConnectionState	XnUSBDeviceConnectionState
typedef struct XnUSBStringDescriptor	XnUSBStringDescriptor
typedef struct XnUSBInterfaceDescriptorHolder	XnUSBInterfaceDescriptorHolder
typedef struct XnUSBConfigDescriptorHolder	XnUSBConfigDescriptorHolder
typedef struct XnUSBDeviceDescriptorHolder	XnUSBDeviceDescriptorHolder
typedef struct XnUSBDevice	XnUSBDevice
typedef void(*	XnUSBDeviceNewControlRequestCallback )(XnUSBDevice *pDevice, void *pCookie)
typedef void(*	XnUSBDeviceConnectivityChangedCallback )(XnUSBDevice *pDevice, XnUSBDeviceConnectionState state, void *pCookie)
Enumerations
enum	XnUSBDeviceConnectionState { XN_USB_DEVICE_DISCONNECTED, XN_USB_DEVICE_CONNECTED, XN_USB_DEVICE_SUSPENDED }
Functions
XN_C_API XnStatus XN_C_DECL	xnUSBDeviceInit (const XnUSBDeviceDescriptorHolder *pDeviceDescriptor, XnUInt32 nControlMessageMaxSize, XnUSBDevice **ppDevice)
XN_C_API void XN_C_DECL	xnUSBDeviceShutdown (XnUSBDevice *pDevice)
XN_C_API XnBool XN_C_DECL	xnUSBDeviceIsControlRequestPending (XnUSBDevice *pDevice)
XN_C_API XnStatus XN_C_DECL	xnUSBDeviceReceiveControlRequest (XnUSBDevice *pDevice, XnUChar *pBuffer, XnUInt32 *pnRequestSize)
XN_C_API XnStatus XN_C_DECL	xnUSBDeviceSendControlReply (XnUSBDevice *pDevice, const XnUChar *pBuffer, XnUInt32 nReplySize)
XN_C_API XnStatus XN_C_DECL	xnUSBDeviceSetNewControlRequestCallback (XnUSBDevice *pDevice, XnUSBDeviceNewControlRequestCallback pFunc, void *pCookie)
XN_C_API XnStatus XN_C_DECL	xnUSBDeviceSetConnectivityChangedCallback (XnUSBDevice *pDevice, XnUSBDeviceConnectivityChangedCallback pFunc, void *pCookie)
XN_C_API XnStatus XN_C_DECL	xnUSBDeviceWriteEndpoint (XnUSBDevice *pDevice, XnUInt8 nAddress, const XnUChar *pData, XnUInt32 nDataSize)

---

Typedef Documentation

typedef struct XnUSBConfigDescriptorHolder XnUSBConfigDescriptorHolder

typedef struct XnUSBDevice XnUSBDevice

typedef enum XnUSBDeviceConnectionState XnUSBDeviceConnectionState

typedef void(* XnUSBDeviceConnectivityChangedCallback)(XnUSBDevice *pDevice, XnUSBDeviceConnectionState state, void *pCookie)

typedef struct XnUSBDeviceDescriptorHolder XnUSBDeviceDescriptorHolder

typedef void(* XnUSBDeviceNewControlRequestCallback)(XnUSBDevice *pDevice, void *pCookie)

typedef struct XnUSBInterfaceDescriptorHolder XnUSBInterfaceDescriptorHolder

typedef struct XnUSBStringDescriptor XnUSBStringDescriptor

---

Enumeration Type Documentation

enum XnUSBDeviceConnectionState

Enumerator:

XN_USB_DEVICE_DISCONNECTED
XN_USB_DEVICE_CONNECTED
XN_USB_DEVICE_SUSPENDED

---

Function Documentation

XN_C_API XnStatus XN_C_DECL xnUSBDeviceInit	(	const XnUSBDeviceDescriptorHolder *	pDeviceDescriptor,
		XnUInt32	nControlMessageMaxSize,
		XnUSBDevice **	ppDevice
	)

XN_C_API XnBool XN_C_DECL xnUSBDeviceIsControlRequestPending

(

XnUSBDevice *

pDevice

)

XN_C_API XnStatus XN_C_DECL xnUSBDeviceReceiveControlRequest	(	XnUSBDevice *	pDevice,
		XnUChar *	pBuffer,
		XnUInt32 *	pnRequestSize
	)

XN_C_API XnStatus XN_C_DECL xnUSBDeviceSendControlReply	(	XnUSBDevice *	pDevice,
		const XnUChar *	pBuffer,
		XnUInt32	nReplySize
	)

XN_C_API XnStatus XN_C_DECL xnUSBDeviceSetConnectivityChangedCallback	(	XnUSBDevice *	pDevice,
		XnUSBDeviceConnectivityChangedCallback	pFunc,
		void *	pCookie
	)

XN_C_API XnStatus XN_C_DECL xnUSBDeviceSetNewControlRequestCallback	(	XnUSBDevice *	pDevice,
		XnUSBDeviceNewControlRequestCallback	pFunc,
		void *	pCookie
	)

XN_C_API void XN_C_DECL xnUSBDeviceShutdown

(

XnUSBDevice *

pDevice

)

XN_C_API XnStatus XN_C_DECL xnUSBDeviceWriteEndpoint	(	XnUSBDevice *	pDevice,
		XnUInt8	nAddress,
		const XnUChar *	pData,
		XnUInt32	nDataSize
	)