xc-sdk 2018 overview - sony.co.jp · because windowsxp doesn't support .net framework 4.5....
TRANSCRIPT
XC-SDK 2018 Overview
Copyright 2017 Sony IP&S Inc.
XC-SDK 2018 Overview
The contents
1 THE OVERVIEW .......................................................................................................... 2
1.1 THE FUNCTIONAL-DESCRIPTION ...................................................................................... 2
1.2 THE COMPOSITION ......................................................................................................... 2
1.3 THE SYSTEM REQUIREMENTS .......................................................................................... 2
1.4 THE PRODUCT FORM ...................................................................................................... 2
2 THE PRODUCT STRUCTURE ...................................................................................... 4
2.1 THE DRIVER .................................................................................................................. 4
2.2 THE LIBRARY ................................................................................................................. 4
2.3 THE OTHER ................................................................................................................... 5
3 XCCAM API .................................................................................................................. 6
3.1 THE OVERVIEW OF API .................................................................................................. 6
3.2 API FOR THE C++ (FOR THE DETAILS, REFER TO EACH HELP FILE). ................................ 6
3.3 API FOR .NET FRAMEWORK ......................................................................................... 10
3.4 THE CAMERA CLASS API .............................................................................................. 13
3.5 THE API COMPARISON ................................................................................................. 15
4 THE HELP ................................................................................................................... 30
4.1 THE OVERVIEW ............................................................................................................ 30
4.2 THE CONTENTS OF THE MANUAL ................................................................................... 31
XC-SDK 2018 Overview
Sony IP&S inc. PPG PD2 DD4 section 2. It prohibits reprinting contents without notice. Page 2
1 The overview This specification is the functional-description explanation of "XC-SDK 2018" (hereinafter, it is called “this application”).
1.1 The functional-description
On Microsoft Windows OS, including the control by the GenICam library, it controls GigE Vision XCG series and USB3 Vision XCU series. And this application is composed by the driver, the library to work, and the various tools, the sample programs.
1.2 The composition
This application is composed below. The driver The library The other : The various tools, Viewer, the various documents
1.3 The system requirements
1.3.1 The compatible OS Support OS:Microsoft Windows 7 Service Pack 1/8.1/10 (64 bits of 32bit)
※ WindowsXP Then, it doesn't work. The driver of this application is .NET Framework It is created for 4.5. Because WindowsXP doesn't support .NET Framework 4.5.
1.3.2 The compatible camera All GigE Vision cameras which are made by Sony XCG series And All USB3 vision cameras which are made by Sony XCU series
1.3.3 The compatible development environment The development environment that the library supports is as the following.
Microsoft Visual Studio Doing 2008 based (.Net Framework 3.5 supports) Microsoft Visual Studio Doing 2010 based (.NET Framework 3 supports)
1.4 The product form
This application is provided with the installer and the accompanying explanation document. Setup.exe : The installer (For 32bitOS)
XC-SDK 2018 Overview
Page3 Sony IP&S㈱ Four PPG PD2-design section 2 It prohibits reprinting contents without notice.
Setup64. exe : The installer (For 64bitOS) Manual_J.pdf : The introduction manual (in Japanese) Manual_E.pdf : The introduction manual (in English)
XC-SDK 2018 Overview
Sony IP&S inc. PPG PD2 DD4 section 2. It prohibits reprinting contents without notice. Page 4
2 The product structure
2.1 The driver
This application includes the following driver. The GigE camera driver : The driver who controls GigE camera The USB camera driver : The driver who controls USB camera
2.2 The library
This application includes the following library. The API of the GenTL:GenICam transport layer XC Cam API : Three kinds of API the following of the camera control of the
application layer The API for the C++, the API which is compatible with .NET Framework, the camera class API
When installing this application, it installs the following library. GenICam library (The latest version :GenICam Standard Version 3.0.2)
XC-SDK 2018 Overview
Page5 Sony IP&S㈱ Four PPG PD2-design section 2 It prohibits reprinting contents without notice.
2.3 The other
This application includes the following tool, a sample. The utility software (The environment setting tool, the log acquisition tool) Sample Viewer The help (The API specification, the usage of the camera feature, the operation
explanation of the various tool) GenICam version 3.0.2 The sample program
User Application XC API GenAPI
XC Cam API GenICam The library
GenTL
The GigE camera driver/the USB camera driver
The cable
The cable
The GigE camera
The USB camera
XC-SDK 2018 Overview
Sony IP&S inc. PPG PD2 DD4 section 2. It prohibits reprinting contents without notice. Page 6
3 XCCam API
3.1 The overview of API
It includes the following API in this application. API for the C++ API for .NET Framework (C# and VB.net) The camera class API
3.2 API for the C++ (For the details, refer to each Help file).
3.2.1 The classification In this application, it provides six kinds of the following API.
The API : The API to acquire the control of the camera, an image
GigE Only : The GigE camera exclusive use API USB Only : The USB camera exclusive use API Color Conversion : The color change API Feature API : The API of the camera function control RegThe API : The API of the register control by the camera
3.2.2 The API list The list and the classification of the API are as the following.
The API name The API classification
The contents
XCCAM_SetCallBack The API The setting of a system call
back function
XCCAM_SetStructVersion The API The setting of a structure
definition version XCCAM_GetLastError The API The error code acquisition
XCCAM_GetList The API The connection camera list
acquisition XCCAM_Open The API The camera connecting XCCAM_Close The API The camera deactivating XCCAM_CloseAll The API The camera use master-stop
XCCAM_Camera The API The camera connect-
acknowledge
XC-SDK 2018 Overview
Page7 Sony IP&S㈱ Four PPG PD2-design section 2 It prohibits reprinting contents without notice.
XCCAM_CameraInfo The API The camera information
acquisition
XCCAM_GetNodeMap The API The node mapping
information acquisition
XCCAM_ResourceAlloc The API The communication resource
securing
XCCAM_ResourceRelease The API The communication resource
release XCCAM_ConvMode The API XCCAM_GetBMPINFO The API XCCAM_BufferConvExec The API XCCAM_ImageConvExec The API XCCAM_BufferChunkInfo The API XCCAM_ImageChunkInfo The API XCCAM_ImageStart The API The start-of-message XCCAM_ImageStop The API The communication stop
XCCAM_ImageAlloc The API The image data area
securing XCCAM_ImageFree The API The image data area release
XCCAM_ImageFreeAll The API All the image data area
opening
XCCAM_ImageReq The API The image data acquisition
request
XCCAM_ImageComplete The API The image data acquisition
completion wait
XCCAM_ImageReqAbortAll The API The image data acquisition
cancellation XCCAM_VSyncReq The API VSyncThe acquisition request
XCCAM_VSyncComplete The API VSyncThe acquisition
completion wait
XCCAM_SetImageCallBack The API The setting of an image data
acquisition call back function
XCCAM_SetEventCallBack The API The Event call back function
setting
XCCAM_GetLibraryRevision The API The XC library revision
acquisition
XCCAM_GetGigEPktLog GigE Only GigE The camera packet
information acquisition
XC-SDK 2018 Overview
Sony IP&S inc. PPG PD2 DD4 section 2. It prohibits reprinting contents without notice. Page 8
XCCAM_TestStream GigE Only GigE The film test packet
reception
XCCAM_ResourceAllocGigE GigE Only GigE The camera
communication resource securing
XCCAM_HeartbeatMode GigE Only The Heartbeat adjusts-the-
hours XCCAM_ActionCommand GigE Only ActionCommand Published
XCCAM_ActionCommandAll GigE Only All the ports ActionCommand
Published XCCAM_ActionCommandTime GigE Only XCCAM_ActionCommandAllTime GigE Only
XCCAM_SetActionAckCallBack GigE Only Ack reception of
ActionCommand XCCAM_SetPacketSizeUSB USB only XCCAM_StreamResetUSB USB only XCCAM_CreateConvHandle Color Conv. XCCAM_CloseConvHandle Color Conv. XCCAM_CloseAllCOnvHandle Color Conv. XCCAM_ColorConvExec Color Conv. XCCAM_ColorConvGetBMPINFO Color Conv. XCCAM_monoBMPINFO Color Conv. XCCAM_CategoryName Feature API XCCAM_FeatureName Feature API XCCAM_FeatureInfo Feature API XCCAM_FeatureDisplayName Feature API XCCAM_FeatureDescription Feature API XCCAM_FeatureToolTip Feature API XCCAM_FeatureUnit Feature API XCCAM_EnumerationEntryName Feature API XCCAM_EnumerationEntryDisplayName
Feature API
XCCAM_EnumerationEntryDescription Feature API XCCAM_EnumerationEntryToolTip Feature API XCCAM_EnumerationEntryValue Feature API XCCAM_EnumerationEntryIsAvailable Feature API XCCAM_GetFeatureInteger Feature API XCCAM_SetFeatureInteger Feature API
XC-SDK 2018 Overview
Page9 Sony IP&S㈱ Four PPG PD2-design section 2 It prohibits reprinting contents without notice.
XCCAM_GetFeatureFloat Feature API XCCAM_SetFeatureFloat Feature API XCCAM_GetFeatureString Feature API XCCAM_SetFeatureString Feature API XCCAM_GetFeatureBoolean Feature API XCCAM_SetFeatureBoolean Feature API XCCAM_GetFeatureEnumeration Feature API XCCAM_SetFeatureEnumeration Feature API XCCAM_GetFeatureRegister Feature API XCCAM_SetFeatureRegister Feature API XCCAM_FeatureCommand Feature API XCCAM_FeatureIs Available Feature API XCCAM_FeatureIs Writeable Feature API XCCAM_FeatureIs Readable Feature API XCCAM_ReadReg RegThe API It reads a register. XCCAM_WriteReg RegThe API The register writing in XCCAM_ReadMem RegThe API It reads a memory. XCCAM_WriteMem RegThe API The memory writing in
XC-SDK 2018 Overview
Sony IP&S inc. PPG PD2 DD4 section 2. It prohibits reprinting contents without notice. Page 10
3.3 API for .Net Framework
3.3.1 The classification . It provides the API which supported Net Framework in the following class
The XCCAM class The class to control a camera The XCCAM_WATCH class The class to share the image of one camera with more than one PC The XCCOMV class The class to do a color change
3.3.2 The API list
The list and the class of the API are as the following. The API name The class The contents SetCallBack XCCAM The system call back setting SetStructVersion XCCAM The setting of a structure definition
version GetLastError XCCAM The library error code acquisition GetList XCCAM The connection camera list
acquisition XCCAM XCCAM The camera connecting Dispose XCCAM The camera deactivating CameraInfo XCCAM The camera information acquisition CameraInfoGigE XCCAM The GigE camera information
acquisition CameraInfoUSB XCCAM The USB camera information
acquisition Camera XCCAM The camera connect-acknowledge ResourceAlloc XCCAM The resource securing ResourceAllocGigE XCCAM The GigE resource securing ResourceRelease XCCAM The resource release GetGigEPktLog XCCAM The GigE Packet Log acquisition TestStreamGigE XCCAM The GigE test packet reception Camera XCCAM The camera connect-acknowledge ResourceAlloc XCCAM The resource securing ResourceAllocGigE XCCAM The GigE resource securing
XC-SDK 2018 Overview
Page11 Sony IP&S㈱ Four PPG PD2-design section 2 It prohibits reprinting contents without notice.
ResourceRelease XCCAM The resource release GetGigEPktLog XCCAM The GigE Packet Log acquisition TestStreamGigE XCCAM The GigE test packet reception ConvMode XCCAM The color conversion mode setting
SetBMPINFO XCCAM The BITMAPINFO information
setting GetImageInfo XCCAM The Image information acquisition BufferConvExec XCCAM The color change execution ImageConvExec XCCAM The color change execution ImageStart XCCAM The image transfer beginning ImageStop XCCAM The image transfer stop ImageAlloc XCCAM It allocates in the image buffer. ImageFree XCCAM The image buffer release ImageReq XCCAM The image data acquisition request
ImageComplete XCCAM The image data acquisition
completion wait
ImageReqAbortAll XCCAM The image data acquisition
cancellation VSyncReq XCCAM VSyncThe acquisition request
VSyncComplete XCCAM VSyncThe acquisition completion
wait
SetImageCallBack XCCAM The image acquisition call back
setting
GetImageStruct XCCAM The image buffer structure
acquisition
MonoBMPINFO XCCAM The BITMAPINFO information
setting for MONO
GetLibraryRevision XCCAM Revision's being acquired by the
library Reset XCCAM Resource's being re-initialized ReDetection XCCAM The confirmation of the composition CategoryList XCCAM The category list acquisition CameraStandby XCCAM_WATCH The confirmation of a state of the
image (the stream) data communication
XCCAM_WATCHGIGE XCCAM_WATCH The camera connecting XCCOMV XCCONV The translate-table creating Dispose XCCONV The translate-table release
XC-SDK 2018 Overview
Sony IP&S inc. PPG PD2 DD4 section 2. It prohibits reprinting contents without notice. Page 12
ConvExec XCCONV The change execution SetBMPINFO XCCONV The BITMAPINFO information
setting
XC-SDK 2018 Overview
Page13 Sony IP&S㈱ Four PPG PD2-design section 2 It prohibits reprinting contents without notice.
3.4 The camera class API
It provides an API by the class definition. The camera opening Specified UID Specified UserName
voidCSonyCam() voidCSonyCam(UINT64 UID) voidCSonyCam(std::stringUserName)
The camera list acquisition
voidGetCameraList(CameraList* List )
The vender name acquisition
std::stringGetVendorName()
The model name acquisition
std::stringGetModelName()
The Serial number acquisition
std::stringGetSerialNumber()
The version number acquisition
ULONGGetGigEVersion()
The node mapping address acquisition
void *GetNodeMap()
The Feature value acquisition
voidGetFeature(std::stringFname, INT64& Value ) voidGetFeature(std::stringFname, double& Value ) voidGetFeature(std::stringFname, std::string& Value ) voidGetFeature(std::stringFname, BYTE& Value, UINT32& Length ) voidGetFeature(std::stringFname, bool& Value )
The Feature value setting
voidSetFeature(std::stringFname, INT64 Value ) voidSetFeature(std::stringFname, double Value ) voidSetFeature(std::stringFname, std::string Value ) voidSetFeature(std::stringFname, BYTE& Value, UINT32& Length ) voidSetFeature(std::stringFname, boolValue ) voidSetFeature(std::stringFname)
The image reception beginning
voidStreamStart()
The image reception ending
voidStreamStop()
The present image acquisition
void Capture (void *)pBuffer)
XC-SDK 2018 Overview
Sony IP&S inc. PPG PD2 DD4 section 2. It prohibits reprinting contents without notice. Page 14
The image acquisition curing
voidQueueCapture(void *)pBuffer)
The image acquisition completion confirmation
voidQueueCaptureComplete(void *)pBuffer, ULONGTimeOut)
The present image save
voidCaptureFile(std::stringFIleName)
The image save curing
voidQueueCaptureFile(std::stringFIleName)
The image save completion confirmation
voidQueueCaptureFileComplete(std::stringFIleName, ULONGTimeOut)
The AVI file save beginning
voidCaptureAVIFile(std::stringFIleName)
The ending of the AVI file save
voidCaptureAVIFile( )
XC-SDK 2018 Overview
Page15 Sony IP&S inc. PPG PD2 DD4 section 2. It prohibits reprinting contents without notice.
3.5 The API comparison
A difference with the API of article "XC-SDK2017 version2" is shown in this application and the past. 3.5.1 The API for the C++
Version 2 Version 3 The API classification The contents XCCAM_SetCallBack XCCAM_SetCallBack The API There is no change. XCCAM_SetStructVersion XCCAM_SetStructVersion The API There is no change. XCCAM_GetLastError XCCAM_GetErrorMsg The API It changes into the message
from the error number. XCCAM_GetList XCCAM_GetList The API There is a change in the
detailed contents. It returns the contents of Bootstrap Registers.
XCCAM_Open XCCAM_Open The API The parameter change It specifies a request by the structure.
XCCAM_Close XCCAM_Close The API There is no change. XCCAM_CloseAll XCCAM_CloseAll The API There is no change. XCCAM_Camera XCCAM_Camera The API There is no change. XCCAM_CameraInfo XCCAM_CameraInfo The API There is a change in the
detailed contents. XCCAM_GetNodeMap XCCAM_GetNodeMap The API There is no change. XCCAM_GetFeatureHandle The API Newly
GenAPIFor the C language interface of the business
XCCAM_ResourceAlloc XCCAM_ResourceAlloc The API XCCAM_WatchAllocIt shares a feature by the を abolition.
XC-SDK 2018 Overview
Sony IP&S inc. PPG PD2 DD4 section 2. It prohibits reprinting contents without notice. Page 16
XCCAM_ResourceRelease XCCAM_ResourceRelease The API There is no change. XCCAM_ConvMode XCCAM_SetConvMode The API The name change XCCAM_GetBMPINFO XCCAM_GetBMPINFO The API There is no change. XCCAM_BufferConvExec XCCAM_ImageConvExec
XCCAM_ConvExec The API It makes common, changing a parameter.
XCCAM_BufferChunkInfo XCCAM_ImageChunkInfo
XCCAM_GetChunkInfo The API It makes common, changing a parameter.
XCCAM_ImageStart XCCAM_ImageStart The API There is no change. XCCAM_ImageStop XCCAM_ImageStop The API There is no change. XCCAM_ImageAlloc XCCAM_ImageAlloc The API There is no change. XCCAM_ImageFree XCCAM_ImageFree The API There is no change. XCCAM_ImageFreeAll XCCAM_ImageFreeAll The API There is no change. XCCAM_ImageReq XCCAM_ImageReq The API There is no change. XCCAM_ImageComplete XCCAM_ImageComplete The API There is no change. XCCAM_ImageReqAbortAll XCCAM_ImageReqAbortAll The API There is no change. XCCAM_VSyncReq XCCAM_VSyncReq The API There is no change. XCCAM_VSyncComplete XCCAM_VSyncComplete The API There is no change. XCCAM_SetImageCallBack XCCAM_SetImageCallBack The API There is no change. XCCAM_SetEventCallBack XCCAM_SetEventCallBack The API There is no change. XCCAM_SetCmdTimeOut The API Newly
The change of the temporary command time-out time
XCCAM_GetLibraryRevision XCCAM_GetLibraryRevision The API There is no change. XCCAM_Reset The API The abolition XCCAM_ReDetection The API The abolition XCCAM_OpenGigE The API The abolition
XC-SDK 2018 Overview
Page17 Sony IP&S inc. PPG PD2 DD4 section 2. It prohibits reprinting contents without notice.
XCCAM_CameraInfoGigE The API The abolition XCCAM_GetGigEPktLog XCCAM_GetGigEPktLog GigE Only There is no change. XCCAM_TestStream XCCAM_TestStream GigE Only There is no change. XCCAM_GetGigEPktLog XCCAM_GetGigEPktLog GigE Only There is no change. XCCAM_TestStream XCCAM_TestStream GigE Only There is no change. XCCAM_ResourceAllocGigE XCCAM_ResourceAllocGigE GigE Only The IP address which it is
possible to specify, uses by the other PC, too.
XCCAM_HeartbeatMode XCCAM_HeartbeatMode GigE Only There is no change. XCCAM_LostPktMode GigE Only Newly
The data clearance feature in case of the packet coming-off
XCCAM_BandAdjust GigE Only Newly It specifies GevSCPD caused by due to band limitation.
XCCAM_ActionCommand XCCAM_ActionCommand GigE Only There is no change. XCCAM_ActionCommandAll XCCAM_ActionCommandAll GigE Only There is no change. XCCAM_ActionCommandTime XCCAM_ActionCommandTime GigE Only There is no change. XCCAM_ActionCommandAllTime
XCCAM_ActionCommandAllTime GigE Only There is no change.
XCCAM_SetActionAckCallBack XCCAM_SetActionAckCallBack GigE Only There is no change. XCCAM_ControlCamera GigE Only Newly XCCAM_SetPacketSizeUSB USB Only Newly XCCAM_StreamResetUSB USB Only Newly XCCAM_CreateConvHandle XCCAM_CreateConvHandle Color Conversion There is no change. XCCAM_CloseConvHandle XCCAM_CloseConvHandle Color Conversion There is no change.
XC-SDK 2018 Overview
Sony IP&S inc. PPG PD2 DD4 section 2. It prohibits reprinting contents without notice. Page 18
XCCAM_CloseAllConvHandle XCCAM_CloseAllConvHandle Color Conversion There is no change. XCCAM_ColorConvExec XCCAM_ColorConvExec Color Conversion There is no change. XCCAM_ColorConvGetBMPINFO XCCAM_ColorConvGetBMPINFO Color Conversion There is no change.
XCCAM_MonoBMPINFO XCCAM_MonoBMPINFO Color Conversion There is no change.
XCCAM_CategoryName Feature API Newly XCCAM_FeatureName Feature API Newly XCCAM_FeatureInfo Feature API Newly XCCAM_FeatureDisplayName Feature API Newly XCCAM_FeatureDescription Feature API Newly XCCAM_FeatureToolTip Feature API Newly XCCAM_FeatureUnit Feature API Newly XCCAM_EnumerationEntryName Feature API Newly XCCAM_EnumerationEntryDisplayNa
me Feature API Newly
XCCAM_EnumerationEntryDescription
Feature API Newly
XCCAM_EnumerationEntryToolTip Feature API Newly XCCAM_EnumerationEntryValue Feature API Newly XCCAM_EnumerationEntryIsAvailabl
e Feature API Newly
XCCAM_GetFeatureInteger Feature API Newly XCCAM_SetFeatureInteger Feature API Newly XCCAM_GetFeatureFloat Feature API Newly XCCAM_SetFeatureFloat Feature API Newly XCCAM_GetFeatureString Feature API Newly XCCAM_SetFeatureString Feature API Newly XCCAM_GetFeatureBoolean Feature API Newly
XC-SDK 2018 Overview
Page19 Sony IP&S inc. PPG PD2 DD4 section 2. It prohibits reprinting contents without notice.
XCCAM_SetFeatureBoolean Feature API Newly XCCAM_GetFeatureEnumeration Feature API Newly XCCAM_SetFeatureEnumeration Feature API Newly XCCAM_GetFeatureRegister Feature API Newly XCCAM_SetFeatureRegiste Feature API Newly XCCAM_FeatureCommand Feature API Newly XCCAM_FeatureIsAvailabl Feature API Newly
XCCAM_FeatureIsWritable Feature API Newly XCCAM_FeatureIsReadable Feature API Newly XCCAM_ReadReg XCCAM_ReadReg Reg_API There is no change. XCCAM_ReadMem XCCAM_ReadMem Reg_API There is no change. XCCAM_WriteReg XCCAM_WriteReg Reg_API There is no change. XCCAM_WriteMem XCCAM_WriteMem Reg_API There is no change. XCCAM_WriteRegAll Reg_API Newly
The broadcast feature of the register writing in
XCCAM_WatchOpen The WATCH class The deletion XCCAM_WatchOpenGigE The WATCH class The deletion XCCAM_WatchClose The WATCH class The deletion XCCAM_WatchCamera The WATCH class The deletion XCCAM_WatchAlloc The WATCH class The deletion XCCAM_WatchRelease The WATCH class The deletion XCCAM_WatchStart The WATCH class The deletion XCCAM_WatchStop The WATCH class The deletion
XC-SDK 2018 Overview
Sony IP&S inc. PPG PD2 DD4 section 2. It prohibits reprinting contents without notice. Page 20
3.5.2 The structurer for API of C++
Please refer the “XCCampAPI.h” for the detail.
Structure name Version 2 Version 3 The contents XCCAM_GIGESTREAMTYPE typedef enum
XCCAM_GIGEIMAGEDATA= 1, XCCAM_GIGERAWDATA, XCCAM_GIGEFILEDATA, XCCAM_GIGECHUNKDATA, XCCAM_GIGEEXTCHUNKDATA, XCCAM_GIGEVENDORDATA= 0x8000,
← There is no change.
XCCAM_TRANSMITSPEED typedef enum
XCCAM_S100M= 0, XCCAM_S200M, XCCAM_S400M, XCCAM_S800M, XCCAM_S1600M, XCCAM_S3200M, XCCAM_S1000M, XCCAM_SUSB2, XCCAM_SUSB3,
XCCAM_S100M= 0, XCCAM_S1000M, XCCAM_SUSB2=100, XCCAM_SUSB3,
Some members are abolished.
XCCAM_DIBMODE typedef enum
XCCAM_DIB32= 0, XCCAM_DIB24,
← There is no change.
XCCAM_STOREMODE typedef enum
XCCAM_MEMmode= 0, XCCAM_MEMmodeLR, XCCAM_BMPmode,
← There is no change.
XC-SDK 2018 Overview
Page21 Sony IP&S inc. PPG PD2 DD4 section 2. It prohibits reprinting contents without notice.
XCCAM_BMPmodeLR,
XCCAM_ENDIAN typedef enum
XCCAM_BIGENDIAN= 0, XCCAM_LITTLEENDIAN
← There is no change.
XCCAM_CAMERATYPE typedef enum
XCCAM_CAMERA1394= 0, XCCAM_CAMERAGIGE, XCCAM_CAMERAUSB
It is replaced XCCAM_DEVICETYPE
XCCAM_DEVICETYPE typedef enum
XCCAM_UNKNOWNDEV= -1, XCCAM_ANYDEV = 0, XCCAM_GIGECAMERA, XCCAM_USBCAMERA,
Newly
XCCAM_OPENMODE typedef enum
XCCAM_AUTO_ACCESS= 0, XCCAM_READONLY_ACCESS, XCCAM_CONTROL_ACCESS, XCCAM_EXCLUSIVE_ACCESS,
Newly
XCCAM_FEATURETYPE typedef enum
XCCAM_INTEGERTYPE= 0, XCCAM_BOOLEANTYPE, XCCAM_FLOATTYPE, XCCAM_STRINGTYPE, XCCAM_COMMANDTYPE, XCCAM_ENUMERATIONTYPE, XCCAM_CATRGORYTYPE, XCCAM_REGISTERTYPE
Newly
XC-SDK 2018 Overview
Sony IP&S inc. PPG PD2 DD4 section 2. It prohibits reprinting contents without notice. Page 22
STATUS_SYSTEMCODE typedef enum
STATUSXCCAM_BUSRESET= 1, STATUSXCCAM_POWERUP
STATUSXCCAM_POWERUP= 1, STATUSXCCAM_DEVICECHANGE,
There is some changed.
STATUS_IMAGE typedef enum
STATUSIMAGE_COMPLETE= 0, STATUSIMAGE_REQUEST_PENDING, STATUSIMAGE_REQUEST_ERROR, STATUSIMAGE_REQUEST_RESTART,
Newly
STATUS_RTNCODE typedef enum
STATUSXCCAM_COMPLETE=0, STATUSXCCAM_PARAMETER_ERROR, STATUSXCCAM_BUFFER_SHORT, etc.
It is divided into XCCAM_OPENMODE and STATUS_IMAGE.
XCCAM_CAMERAINFO typedef struct *pXCCAM_CAMERAINFO;
UINT64 UID; DWORD BusNumber; XCCAM_CAMERATYPE CameraType; XCCAM_TRANSMITSPEED Speed; BYTE VendorName[ 256 ]; BYTE ModelName[ 256 ];
Structure for XCCAM_CmeraInfo It is abolished.
XCCAM_GIGECAMERAINFO typedef struct
DWORD BusNumber; BYTE MACAddr[ 6 ]; WORD Spec_Major;
Structure for XCCAM_GigECmeraInfo
XC-SDK 2018 Overview
Page23 Sony IP&S inc. PPG PD2 DD4 section 2. It prohibits reprinting contents without notice.
*pXCCAM_GIGECAMERAINFO;
WORD Spec_Minor; DWORD Dev_Mode; BYTE VendorName[ 32 ]; BYTE ModelName[ 32 ]; BYTE Dev_Ver[ 32 ]; BYTE Vendor_Info[ 48 ]; BYTE SerialNumber[ 16 ]; BYTE UserName[ 16 ];
It is replaced to XCCAM_GIGEDEVINFO
XCCAM_GIGEDEVINFO typedef struct *pXCCAM_GIGEDEVINFO;
WORD Spec_Major; WORD Spec_Minor; DWORD Dev_Mode; DWORD IPConfig; DWORD IPConfigOption; BYTE MACAddr[ 6 ]; BYTE IPAddr[ 4 ]; BYTE SubMask[ 4 ]; BYTE GateWay[ 4 ]; char VendorName[ 32 ]; char Rsvd; char ModelName[ 32 ]; char Rsvd1; char Dev_Ver[ 32 ]; char Rsvd2; char Vendor_Info[ 48 ]; char Rsvd3; char SerialNumber[ 16 ]; char Rsvd4; char UserName[ 16 ];
Newly
XC-SDK 2018 Overview
Sony IP&S inc. PPG PD2 DD4 section 2. It prohibits reprinting contents without notice. Page 24
DWORD Rsvd5;
XCCAM_USBCAMERAINFO typedef struct *pXCCAM_USBCAMERAINFO;
DWORD BusNumber; DWORD GenCP_Version; BYTE VendorName[ 64 ]; BYTE ModelName[ 64 ]; BYTE FamilyName[ 64 ]; BYTE Dev_Version[ 64 ]; BYTE Vendor_Info[ 64 ]; BYTE SerialNumber[ 64 ]; BYTE UserName[ 64 ]; UINT64 Dev_Capability;
Strucurer for XCCAM_USBCameraInfo It is replaced to XCCAM_USBDEVINFO
XCCAM_USBDEVINFO typedef struct *pXCCAM_USBDEVINFO;
UINT64 Dev_Capability; DWORD GenCP_Version; char VendorName[ 64 ]; char Rsvd; char ModelName[ 64 ]; char Rsvd1; char FamilyName[ 64 ]; char Rsvd2; char Dev_Version[ 64 ]; char Rsvd3; char Vendor_Info[ 64 ]; char Rsvd4; char SerialNumber[ 64 ]; char Rsvd5; char UserName[ 64 ];
Newly
XC-SDK 2018 Overview
Page25 Sony IP&S inc. PPG PD2 DD4 section 2. It prohibits reprinting contents without notice.
DWORD Rsvd6;
XCCAM_LIST typedef struct *pXCCAM_LIST;
DWORD CameraCount; XCCAM_CAMERAINFO Info[ 1 ];
DWORD Count; XCCAM_DEVINFO Info[ 1 ];
Structurer for XCCAM_GetList Member is changed.
XCCAM_OPENPARAM typedef struct *pXCCAM_OPENPARAM;
XCCAM_DEVICETYPE DeviceType; UINT64 UID; BYTE IPAddr[ 4 ]; char UserName[ 64 ]; ULONG Rsvd; XCCAM_OPENMODE AccMode; BOOL XML_DiskFlag;
Structurer for XCCAM_Open
XCCAM_OPENREQUEST typedef struct *pXCCAM_OPENREQUEST;
UINT64 UID; DWORD URLIdx; BYTE UserName[ 64 ];
Structure for XCCAM_OpenGigE It is abolished.
XCCAM_IMAGE typedef struct *pXCCAM_IMAGE;
DWORD Width; DWORD Height; BYTE *pBuffer; DWORD Length; DWORD PixelFormatID;
DWORD Width; DWORD Height; BYTE *pBuffer; DWORD Length; DWORD PixelFormatID;
Member is changed
XC-SDK 2018 Overview
Sony IP&S inc. PPG PD2 DD4 section 2. It prohibits reprinting contents without notice. Page 26
XCCAM_ENDIAN EndianMode; STATUS_RTNCODE Status;
XCCAM_ENDIAN EndianMode; STATUS_IMAGE Status;
XCCAM_USBSTREAMINFO Typedef struct *pXCCAM_GIGESTREAMINFO;
DOWRD Stream_Type; etc.
← There is no change.
XCCAM_IMAGEDATAINFO typedef struct *pXCCAM_IMAGEDATAINFO;
XCCAM_CAMERATYPE CameraType; union U {
struct C1394 {
XCCAM_TRANSMITSPEED Speed;
DWORD CycleTime_S; DWORD CycleCount_S; DWORD CycleTime_E; DWORD CycleCount_E;
} C1394; struct CGIGE {
BOOL Payload_Flag; XCCAM_GIGESTREAMINFO
StreamInfo; } CGigE;
XCCAM_DEVICETYPE DeviceType; union U {
struct CGIGE {
BOOL Payload_Flag; XCCAM_GIGESTREAMINFO
StreamInfo; } CGigE; struct CUSB {
BOOL Payload_Flag; XCCAM_USBSTREAMINFO
StreamInfo; } CUsb;
} u;
1394 member is abolished.
XC-SDK 2018 Overview
Page27 Sony IP&S inc. PPG PD2 DD4 section 2. It prohibits reprinting contents without notice.
struct CUSB {
BOOL Payload_Flag; XCCAM_USBSTREAMINFO
StreamInfo; } CUsb;
} u; XCCAM_PKTLOG typedef struct *pXCCAM_PKTLOG;
UINT64 ToTalPktCount; UINT64 ErrorPktCount; UINT64 RetryCount;
UINT64 ToTalPktCount; UINT64 ErrorPktCount; UINT64 RSendCount;
Structurer for GigEGetPktLog Member is changed.
XCCAM_COLORVALUE typedef struct *pXCCAM_COLORVALUE;
double R_Value; double G1_Value; double G2_Value; double B_Value;
← There is not changed.
XCCAM_COLORCONVMODE typedef struct *pXCCAM_COLORCONVMODE;
XCCAM_STOREMODE StoreMode; XCCAM_SHIFTID ShiftID; XCCAM_DIBMODE DIBMode; DWORD Parallel_Thread; BOOL BayerRevision_G; BOOL Parallel_Flag;
XCCAM_STOREMODE StoreMode; XCCAM_SHIFTID ShiftID; XCCAM_DIBMODE DIBMode; DWORD Parallel_Thread; BOOL BayerRevision_G;
Member is changed.
XC-SDK 2018 Overview
Sony IP&S inc. PPG PD2 DD4 section 2. It prohibits reprinting contents without notice. Page 28
XCCAM_EVENTINFO typedef struct *pXCCAM_EVENTINFO;
USHORT EventID; union U {
struct CGIGE {
USHORT StreamIndex; UINT64 BlockID; UINT64 TimeStamp; UINT32 Length; UCHAR Data[ 4 ];
} CGigE; struct CUSB {
UINT64 TimeStamp; UINT32 Length; UCHAR Data[ 4 ];
} CUsb; } u;
USHORT EventID; union U {
struct CGIGE {
WORD StreamIndex; UINT64 BlockID; UINT64 TimeStamp; DWORD Length; BYTE Data[ 4 ];
} CGigE; struct CUSB {
UINT64 TimeStamp; DWORD Length; BYTE Data[ 4 ];
} CUsb; } u;
Member types are changed.
XCCAM_CHUNKINFO typedef struct *pXCCAM_CHUNKINFO;
DWORD Count; struct INFO {
DWORD ChunkID; DWORD Length; PVOID pChunkData;
} Info[ 1 ];
← There is no change.
XCCAM_FEATUREINFO typedef struct
XCCAM_FEATURETYPE FType; UINT64 PollingTime; union U
Newly Structure for
XC-SDK 2018 Overview
Page29 Sony IP&S inc. PPG PD2 DD4 section 2. It prohibits reprinting contents without notice.
*pXCCAM_FEATUREINFO;
{ struct INTREG {
INT64 MinValue; INT64 MaxValue; INT64 IncValue;
} IntReg; struct FLOATREG {
double MinValue; double MaxValue; double IncValue; BOOL HasInc;
} FloatReg; struct STRINGREG {
UINT64 MaxLength; } StringReg; struct REG {
INT64 Addr; UINT64 Length;
} Reg; } u;
XCCAM_FeatureInfo
XC-SDK 2018 Overview
Sony IP&S inc. PPG PD2 DD4 section 2. It prohibits reprinting contents without notice. Page 30
4 The help
4.1 The overview
4.1.1 The offer form It is HTML Help form.
4.1.2 The offer contents We provide the following manual.
The manual of the utility software The manual of Viewer The manual of the API manual/camera feature and so on
4.1.3 The fusing with a sample It adds a code example to the explanation of each API, the explanation of the each function.
XC-SDK 2018 Overview
Page31 Sony IP&S inc. PPG PD2 DD4 section 2. It prohibits reprinting contents without notice.
4.2 The contents of the manual
4.2.1 The manual of the utility software An operating method is described.
4.2.2 The manual of Viewer The operating method of Viewer is described.
4.2.3 The manual of the API, the camera feature and so on A. The description contents
An explanation about the following is described. ♦ The specification of the API
The specification of each API is described. ♦ The each function of the camera
As for the following camera feature, it provides a sample code. The explanation of the camera setting by Trigger and so on The explanation of the camera manner of use of the multicast and so on