OpenNI 1.5.4: XnUSB.h File Reference

OpenNI

previous page next page
Classes | Typedefs | Enumerations | Functions
XnUSB.h File Reference
#include "XnOS.h"

Go to the source code of this file.

Classes

struct  XnUSBEventArgs

Typedefs

typedef XnChar XnUSBConnectionString [XN_FILE_MAX_PATH]
typedef XnUSBDeviceHandle * XN_USB_DEV_HANDLE
typedef XnUSBEndPointHandle * XN_USB_EP_HANDLE
typedef XnBool(* XnUSBReadCallbackFunctionPtr )(XnUChar *pBuffer, XnUInt32 nBufferSize, void *pCallbackData)
typedef XnBool(* XnUSBEventCallbackFunctionPtr )(XnUSBEventType USBEventType, XnChar *cpDevPath, void *pCallbackData)
typedef struct XnUSBEventArgs XnUSBEventArgs
typedef void(* XnUSBDeviceCallbackFunctionPtr )(XnUSBEventArgs *pArgs, void *pCookie)

Enumerations

enum  XnUSBDeviceSpeed { XN_USB_DEVICE_LOW_SPEED = 0, XN_USB_DEVICE_FULL_SPEED, XN_USB_DEVICE_HIGH_SPEED }
enum  XnUSBEndPointType { XN_USB_EP_BULK = 0, XN_USB_EP_ISOCHRONOUS, XN_USB_EP_INTERRUPT }
enum  XnUSBDirectionType { XN_USB_DIRECTION_IN = 0, XN_USB_DIRECTION_OUT }
enum  XnUSBControlType { XN_USB_CONTROL_TYPE_STANDARD = 0, XN_USB_CONTROL_TYPE_CLASS, XN_USB_CONTROL_TYPE_VENDOR }
enum  XnUSBEventType { XN_USB_EVENT_DEVICE_CONNECT = 0, XN_USB_EVENT_DEVICE_DISCONNECT }

Functions

XN_C_API XnStatus XN_C_DECL xnUSBInit ()
XN_C_API XnStatus XN_C_DECL xnUSBShutdown ()
XN_C_API XnStatus XN_C_DECL xnUSBIsDevicePresent (XnUInt16 nVendorID, XnUInt16 nProductID, void *pExtraParam, XnBool *pbDevicePresent)
XN_C_API XnStatus XN_C_DECL xnUSBEnumerateDevices (XnUInt16 nVendorID, XnUInt16 nProductID, const XnUSBConnectionString **pastrDevicePaths, XnUInt32 *pnCount)
XN_C_API void XN_C_DECL xnUSBFreeDevicesList (const XnUSBConnectionString *astrDevicePaths)
XN_C_API XnStatus XN_C_DECL xnUSBOpenDevice (XnUInt16 nVendorID, XnUInt16 nProductID, void *pExtraParam, void *pExtraParam2, XN_USB_DEV_HANDLE *pDevHandlePtr)
XN_C_API XnStatus XN_C_DECL xnUSBOpenDeviceByPath (const XnUSBConnectionString strDevicePath, XN_USB_DEV_HANDLE *pDevHandlePtr)
XN_C_API XnStatus XN_C_DECL xnUSBCloseDevice (XN_USB_DEV_HANDLE pDevHandle)
XN_C_API XnStatus XN_C_DECL xnUSBGetDeviceSpeed (XN_USB_DEV_HANDLE pDevHandle, XnUSBDeviceSpeed *pDevSpeed)
XN_C_API XnStatus XN_C_DECL xnUSBSetConfig (XN_USB_DEV_HANDLE pDevHandle, XnUInt8 nConfig)
XN_C_API XnStatus XN_C_DECL xnUSBGetConfig (XN_USB_DEV_HANDLE pDevHandle, XnUInt8 *pnConfig)
XN_C_API XnStatus XN_C_DECL xnUSBSetInterface (XN_USB_DEV_HANDLE pDevHandle, XnUInt8 nInterface, XnUInt8 nAltInterface)
XN_C_API XnStatus XN_C_DECL xnUSBGetInterface (XN_USB_DEV_HANDLE pDevHandle, XnUInt8 *pnInterface, XnUInt8 *pnAltInterface)
XN_C_API XnStatus XN_C_DECL xnUSBOpenEndPoint (XN_USB_DEV_HANDLE pDevHandle, XnUInt16 nEndPointID, XnUSBEndPointType nEPType, XnUSBDirectionType nDirType, XN_USB_EP_HANDLE *pEPHandlePtr)
XN_C_API XnStatus XN_C_DECL xnUSBCloseEndPoint (XN_USB_EP_HANDLE pEPHandle)
XN_C_API XnStatus XN_C_DECL xnUSBGetEndPointMaxPacketSize (XN_USB_EP_HANDLE pEPHandle, XnUInt32 *pnMaxPacketSize)
XN_C_API XnStatus XN_C_DECL xnUSBAbortEndPoint (XN_USB_EP_HANDLE pEPHandle)
XN_C_API XnStatus XN_C_DECL xnUSBFlushEndPoint (XN_USB_EP_HANDLE pEPHandle)
XN_C_API XnStatus XN_C_DECL xnUSBResetEndPoint (XN_USB_EP_HANDLE pEPHandle)
XN_C_API XnStatus XN_C_DECL xnUSBSendControl (XN_USB_DEV_HANDLE pDevHandle, XnUSBControlType nType, XnUInt8 nRequest, XnUInt16 nValue, XnUInt16 nIndex, XnUChar *pBuffer, XnUInt32 nBufferSize, XnUInt32 nTimeOut)
XN_C_API XnStatus XN_C_DECL xnUSBReceiveControl (XN_USB_DEV_HANDLE pDevHandle, XnUSBControlType nType, XnUInt8 nRequest, XnUInt16 nValue, XnUInt16 nIndex, XnUChar *pBuffer, XnUInt32 nBufferSize, XnUInt32 *pnBytesReceived, XnUInt32 nTimeOut)
XN_C_API XnStatus XN_C_DECL xnUSBReadEndPoint (XN_USB_EP_HANDLE pEPHandle, XnUChar *pBuffer, XnUInt32 nBufferSize, XnUInt32 *pnBytesReceived, XnUInt32 nTimeOut)
XN_C_API XnStatus XN_C_DECL xnUSBWriteEndPoint (XN_USB_EP_HANDLE pEPHandle, XnUChar *pBuffer, XnUInt32 nBufferSize, XnUInt32 nTimeOut)
XN_C_API XnStatus XN_C_DECL xnUSBQueueReadEndPoint (XN_USB_EP_HANDLE pEPHandle, XnUChar *pBuffer, XnUInt32 nBufferSize, XnUInt32 nTimeOut)
XN_C_API XnStatus XN_C_DECL xnUSBFinishReadEndPoint (XN_USB_EP_HANDLE pEPHandle, XnUInt32 *pnBytesReceived, XnUInt32 nTimeOut)
XN_C_API XnStatus XN_C_DECL xnUSBInitReadThread (XN_USB_EP_HANDLE pEPHandle, XnUInt32 nBufferSize, XnUInt32 nNumBuffers, XnUInt32 nTimeOut, XnUSBReadCallbackFunctionPtr pCallbackFunction, void *pCallbackData)
XN_C_API XnStatus XN_C_DECL xnUSBShutdownReadThread (XN_USB_EP_HANDLE pEPHandle)
XN_C_API XnStatus XN_C_DECL xnUSBSetCallbackHandler (XnUInt16 nVendorID, XnUInt16 nProductID, void *pExtraParam, XnUSBEventCallbackFunctionPtr pCallbackFunction, void *pCallbackData)
XN_C_API XnStatus XN_C_DECL xnUSBRegisterToConnectivityEvents (XnUInt16 nVendorID, XnUInt16 nProductID, XnUSBDeviceCallbackFunctionPtr pFunc, void *pCookie, XnRegistrationHandle *phRegistration)
XN_C_API void XN_C_DECL xnUSBUnregisterFromConnectivityEvents (XnRegistrationHandle hRegistration)

Typedef Documentation

typedef XnUSBDeviceHandle* XN_USB_DEV_HANDLE
typedef XnUSBEndPointHandle* XN_USB_EP_HANDLE
typedef XnChar XnUSBConnectionString[XN_FILE_MAX_PATH]
typedef void(* XnUSBDeviceCallbackFunctionPtr)(XnUSBEventArgs *pArgs, void *pCookie)
typedef struct XnUSBEventArgs XnUSBEventArgs
typedef XnBool(* XnUSBEventCallbackFunctionPtr)(XnUSBEventType USBEventType, XnChar *cpDevPath, void *pCallbackData)
typedef XnBool(* XnUSBReadCallbackFunctionPtr)(XnUChar *pBuffer, XnUInt32 nBufferSize, void *pCallbackData)

Enumeration Type Documentation

enum XnUSBControlType
Enumerator:
XN_USB_CONTROL_TYPE_STANDARD 
XN_USB_CONTROL_TYPE_CLASS 
XN_USB_CONTROL_TYPE_VENDOR 
enum XnUSBDeviceSpeed
Enumerator:
XN_USB_DEVICE_LOW_SPEED 
XN_USB_DEVICE_FULL_SPEED 
XN_USB_DEVICE_HIGH_SPEED 
enum XnUSBDirectionType
Enumerator:
XN_USB_DIRECTION_IN 
XN_USB_DIRECTION_OUT 
enum XnUSBEndPointType
Enumerator:
XN_USB_EP_BULK 
XN_USB_EP_ISOCHRONOUS 
XN_USB_EP_INTERRUPT 
enum XnUSBEventType
Enumerator:
XN_USB_EVENT_DEVICE_CONNECT 
XN_USB_EVENT_DEVICE_DISCONNECT 

Function Documentation

XN_C_API XnStatus XN_C_DECL xnUSBAbortEndPoint ( XN_USB_EP_HANDLE  pEPHandle)
XN_C_API XnStatus XN_C_DECL xnUSBCloseDevice ( XN_USB_DEV_HANDLE  pDevHandle)
XN_C_API XnStatus XN_C_DECL xnUSBCloseEndPoint ( XN_USB_EP_HANDLE  pEPHandle)
XN_C_API XnStatus XN_C_DECL xnUSBEnumerateDevices ( XnUInt16  nVendorID,
XnUInt16  nProductID,
const XnUSBConnectionString **  pastrDevicePaths,
XnUInt32 *  pnCount 
)
XN_C_API XnStatus XN_C_DECL xnUSBFinishReadEndPoint ( XN_USB_EP_HANDLE  pEPHandle,
XnUInt32 *  pnBytesReceived,
XnUInt32  nTimeOut 
)
XN_C_API XnStatus XN_C_DECL xnUSBFlushEndPoint ( XN_USB_EP_HANDLE  pEPHandle)
XN_C_API void XN_C_DECL xnUSBFreeDevicesList ( const XnUSBConnectionString *  astrDevicePaths)
XN_C_API XnStatus XN_C_DECL xnUSBGetConfig ( XN_USB_DEV_HANDLE  pDevHandle,
XnUInt8 *  pnConfig 
)
XN_C_API XnStatus XN_C_DECL xnUSBGetDeviceSpeed ( XN_USB_DEV_HANDLE  pDevHandle,
XnUSBDeviceSpeed *  pDevSpeed 
)
XN_C_API XnStatus XN_C_DECL xnUSBGetEndPointMaxPacketSize ( XN_USB_EP_HANDLE  pEPHandle,
XnUInt32 *  pnMaxPacketSize 
)
XN_C_API XnStatus XN_C_DECL xnUSBGetInterface ( XN_USB_DEV_HANDLE  pDevHandle,
XnUInt8 *  pnInterface,
XnUInt8 *  pnAltInterface 
)
XN_C_API XnStatus XN_C_DECL xnUSBInit ( )
XN_C_API XnStatus XN_C_DECL xnUSBInitReadThread ( XN_USB_EP_HANDLE  pEPHandle,
XnUInt32  nBufferSize,
XnUInt32  nNumBuffers,
XnUInt32  nTimeOut,
XnUSBReadCallbackFunctionPtr  pCallbackFunction,
void *  pCallbackData 
)
XN_C_API XnStatus XN_C_DECL xnUSBIsDevicePresent ( XnUInt16  nVendorID,
XnUInt16  nProductID,
void *  pExtraParam,
XnBool *  pbDevicePresent 
)
XN_C_API XnStatus XN_C_DECL xnUSBOpenDevice ( XnUInt16  nVendorID,
XnUInt16  nProductID,
void *  pExtraParam,
void *  pExtraParam2,
XN_USB_DEV_HANDLE *  pDevHandlePtr 
)
XN_C_API XnStatus XN_C_DECL xnUSBOpenDeviceByPath ( const XnUSBConnectionString  strDevicePath,
XN_USB_DEV_HANDLE *  pDevHandlePtr 
)
XN_C_API XnStatus XN_C_DECL xnUSBOpenEndPoint ( XN_USB_DEV_HANDLE  pDevHandle,
XnUInt16  nEndPointID,
XnUSBEndPointType  nEPType,
XnUSBDirectionType  nDirType,
XN_USB_EP_HANDLE *  pEPHandlePtr 
)
XN_C_API XnStatus XN_C_DECL xnUSBQueueReadEndPoint ( XN_USB_EP_HANDLE  pEPHandle,
XnUChar *  pBuffer,
XnUInt32  nBufferSize,
XnUInt32  nTimeOut 
)
XN_C_API XnStatus XN_C_DECL xnUSBReadEndPoint ( XN_USB_EP_HANDLE  pEPHandle,
XnUChar *  pBuffer,
XnUInt32  nBufferSize,
XnUInt32 *  pnBytesReceived,
XnUInt32  nTimeOut 
)
XN_C_API XnStatus XN_C_DECL xnUSBReceiveControl ( XN_USB_DEV_HANDLE  pDevHandle,
XnUSBControlType  nType,
XnUInt8  nRequest,
XnUInt16  nValue,
XnUInt16  nIndex,
XnUChar *  pBuffer,
XnUInt32  nBufferSize,
XnUInt32 *  pnBytesReceived,
XnUInt32  nTimeOut 
)
XN_C_API XnStatus XN_C_DECL xnUSBRegisterToConnectivityEvents ( XnUInt16  nVendorID,
XnUInt16  nProductID,
XnUSBDeviceCallbackFunctionPtr  pFunc,
void *  pCookie,
XnRegistrationHandle *  phRegistration 
)
XN_C_API XnStatus XN_C_DECL xnUSBResetEndPoint ( XN_USB_EP_HANDLE  pEPHandle)
XN_C_API XnStatus XN_C_DECL xnUSBSendControl ( XN_USB_DEV_HANDLE  pDevHandle,
XnUSBControlType  nType,
XnUInt8  nRequest,
XnUInt16  nValue,
XnUInt16  nIndex,
XnUChar *  pBuffer,
XnUInt32  nBufferSize,
XnUInt32  nTimeOut 
)
XN_C_API XnStatus XN_C_DECL xnUSBSetCallbackHandler ( XnUInt16  nVendorID,
XnUInt16  nProductID,
void *  pExtraParam,
XnUSBEventCallbackFunctionPtr  pCallbackFunction,
void *  pCallbackData 
)
XN_C_API XnStatus XN_C_DECL xnUSBSetConfig ( XN_USB_DEV_HANDLE  pDevHandle,
XnUInt8  nConfig 
)
XN_C_API XnStatus XN_C_DECL xnUSBSetInterface ( XN_USB_DEV_HANDLE  pDevHandle,
XnUInt8  nInterface,
XnUInt8  nAltInterface 
)
XN_C_API XnStatus XN_C_DECL xnUSBShutdown ( )
XN_C_API XnStatus XN_C_DECL xnUSBShutdownReadThread ( XN_USB_EP_HANDLE  pEPHandle)
XN_C_API void XN_C_DECL xnUSBUnregisterFromConnectivityEvents ( XnRegistrationHandle  hRegistration)
XN_C_API XnStatus XN_C_DECL xnUSBWriteEndPoint ( XN_USB_EP_HANDLE  pEPHandle,
XnUChar *  pBuffer,
XnUInt32  nBufferSize,
XnUInt32  nTimeOut 
)
Generated on Wed May 16 2012 10:16:06 for OpenNI 1.5.4 by   doxygen 1.7.5.1
previous page start next page