工業(yè)相機SDK接口設(shè)計說明書

..工業(yè)相機SDK接口設(shè)計說明書編制審核批準目錄TOC\o"1-2"\h\z\u1.簡介31.1目標及范圍31.2相關(guān)術(shù)語31.3參考資料32.分析設(shè)計52.1設(shè)計思想52.2接口結(jié)構(gòu)52.3數(shù)據(jù)流分析63.接口描述〔C++接口83.1傳輸層工廠類83.2設(shè)備控制類113.3GenApi164.接口描述〔C接口214.1相機控制通用接口214.2XML相關(guān)接口374.3GigEVision相機特有的接口414.4U3V相機特有的接口435.數(shù)據(jù)結(jié)構(gòu)描述445.1MV_GIGE_DEVICE_INFO〔GigE設(shè)備信息445.2MV_USB3_DEVICE_INFO〔USB3設(shè)備信息455.3MV_CC_DEVICE_INFO〔相機信息統(tǒng)一結(jié)構(gòu)體455.4MV_FRAME_OUT_INFO〔輸出幀信息465.5MV_XML_NODE_FEATURE〔xml節(jié)點基本信息476.修訂記錄48簡介目標及范圍本文檔的目的是設(shè)計一套工業(yè)相機SDK的統(tǒng)一接口,兼容GigEVision、1394、U3V和CameraLink等標準協(xié)議。業(yè)務層軟件可同時調(diào)用GenApi和這套接口,以實現(xiàn)對相機的控制。當前版本僅支持GigEVision和U3V兩種傳輸協(xié)議,所以主要根據(jù)《GigEVisionSDK產(chǎn)品需求規(guī)格說明書》和《USB3VisionSDK產(chǎn)品需求規(guī)格說明書》進行設(shè)計,今后會在此版本的基礎(chǔ)上逐漸完善。本文檔的預期讀者是項目經(jīng)理、軟件詳細設(shè)計者、軟件開發(fā)人員、測試人員和項目管理人員等。相關(guān)術(shù)語術(shù)語/縮寫含義GigEVisionGigEVision是由自動化影像協(xié)會AIA<AutomatedImagingAssociation>發(fā)起指定的一種基于千兆以太網(wǎng)的圖像傳輸?shù)臉藴?。具有傳輸距離長〔無中繼時100米、傳輸效率高并可向上升級到萬兆網(wǎng)、通信控制方便、軟硬件互換性強、可靠性高等優(yōu)點,是未來數(shù)字圖像領(lǐng)域的主要接口標準,必將被越來越多的商家多采用。U3V全稱USB3Vision,是一種基于USB3.0技術(shù)的傳輸協(xié)議,傳輸速度快。SDK應用軟件開發(fā)包。GenICam通用相機接口,屬于上層應用開發(fā)的通用接口協(xié)議。GenApiGenICam的相機接口部分參考資料《GigEVisionSDK產(chǎn)品需求規(guī)格說明書.doc》.《USB3VisionSDK產(chǎn)品需求規(guī)格說明書.doc》.《GenICam_Standard_v2_0.pdf》.eBUSSDKC++API.chm.FlyCapture2CDocumentation.chm.FlyCapture2SDKHelp.chmJAISDK.chmImagingSource.chm.PylonCSDK.chm分析設(shè)計設(shè)計思想工業(yè)相機SDK的設(shè)計首先考慮的是支持多個相機協(xié)議,提取共性后設(shè)計通用的接口和結(jié)構(gòu)體,使得上層應用軟件不需要關(guān)心具體的相機協(xié)議。其次要支持GenICam,把GenApi引入作為SDK接口的一部分。但由于GenApi是C++類形式的接口,為保持接口風格的一致性和用戶的需求,我們也需要設(shè)計一套C++接口。另外,為簡化SDK的調(diào)用流程和上層軟件的開發(fā)難度,我們還要設(shè)計一套C接口。最后遵循SDK的易擴展性設(shè)計了這套SDK。接口結(jié)構(gòu)接口分C++和C兩套：C++接口當前版本主要包含3個類：傳輸層工廠類,通過該類獲取單件實例,然后枚舉在線設(shè)備,以及創(chuàng)建和銷毀設(shè)備；設(shè)備控制類,通過該類控制指定的設(shè)備,包括開啟停止設(shè)備、獲取圖像等；GenApi,通過該模塊可以獲取和設(shè)置相機參數(shù)。2.2-1接口結(jié)構(gòu)圖C接口C接口分為四個方向：相機控制通用接口,包含創(chuàng)建句柄、連接設(shè)備、獲取圖像數(shù)據(jù)等；XML相關(guān)接口,內(nèi)部封裝了GenICam,實現(xiàn)XML解析和所有相機參數(shù)節(jié)點的獲取及設(shè)置；GigEVision相機特有的接口,如強制IP、設(shè)置網(wǎng)絡驅(qū)動模式等；U3V相機特有的接口。數(shù)據(jù)流分析2.3-1數(shù)據(jù)流圖接口描述〔C++接口C++接口以類形式提供,所以接口描述也按照類來劃分,可劃分為三大模塊：傳輸層工廠類GetInstance功能說明獲取傳輸層工廠單件接口所在位置TlFactory.h調(diào)用上下文或依賴對象描述調(diào)用SDK的其他功能接口前,需要先調(diào)用此接口函數(shù)方法staticCTlFactory&GetInstance<>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值返回傳輸層工廠單件處理過程把工廠內(nèi)部定義的靜態(tài)成員單件實例返回備注無示例CTlFactory&tlFactory=CTlFactory::GetInstance<>;EnumerateTls功能說明枚舉支持的傳輸層類型接口所在位置TlFactory.h調(diào)用上下文或依賴對象描述需要先獲取工廠實例函數(shù)方法staticCTlFactory&GetInstance<>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值返回支持的傳輸層類型處理過程略備注無示例//2.枚舉支持的傳輸層類型unsignedintnSupportedTls=tlFactory.EnumerateTls<>;if<MV_GIGE_DEVICE==<nSupportedTls&MV_GIGE_DEVICE>>{MyGigETest<>;}EnumDevices功能說明枚舉子網(wǎng)內(nèi),指定的傳輸協(xié)議對應的所有設(shè)備接口所在位置TlFactory.h調(diào)用上下文或依賴對象描述需要先獲取工廠實例,枚舉設(shè)備獲取設(shè)備信息后,可創(chuàng)建設(shè)備實例函數(shù)方法virtualintEnumDevices<unsignedintnTLayerType,MV_CC_DEVICE_INFO_LIST&stDevList>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明nTLayerTypeunsignedint傳輸層協(xié)議類型stDevListMV_CC_DEVICE_INFO_LIST&設(shè)備信息列表輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明stDevListMV_CC_DEVICE_INFO_LIST&設(shè)備信息列表返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程由指定的協(xié)議類型,廣播相應的消息,發(fā)現(xiàn)設(shè)備并記錄設(shè)備信息備注無示例MV_CC_DEVICE_INFO_LISTstDevList;memset<&stDevList,0,sizeof<MV_CC_DEVICE_INFO_LIST>>;intnRet=tlFactory.EnumDevices<MV_GIGE_DEVICE,stDevList>;if<MV_OK!=nRet>{printf<"error:EnumDevices[%x]\n",nRet>;return1;}CreateDevice功能說明創(chuàng)建設(shè)備實例接口所在位置TlFactory.h調(diào)用上下文或依賴對象描述需要先獲取設(shè)備信息后,才能創(chuàng)建設(shè)備實例函數(shù)方法virtualIMvDevice*CreateDevice<constMV_CC_DEVICE_INFO&device>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明deviceconstMV_CC_DEVICE_INFO&指定設(shè)備的信息輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值成功,返回設(shè)備實例；失敗,返回NULL處理過程由輸入的設(shè)備信息,創(chuàng)建相應類型的設(shè)備對象備注無示例//由設(shè)備信息創(chuàng)建設(shè)備實例CMvGigEDevice*MyDevice=dynamic_cast<CMvGigEDevice*><tlFactory.CreateDevice<*<stDevList.pDeviceInfo[i]>>>;if<NULL==MyDevice>{printf<"error:CreateDevice\n">;break;}DestroyDevice功能說明銷毀設(shè)備實例及相應的資源接口所在位置TlFactory.h調(diào)用上下文或依賴對象描述前提是已創(chuàng)建設(shè)備實例函數(shù)方法virtualintDestroyDevice<IMvDevice*>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明pDeviceIMvDevice設(shè)備實例輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值成功,返回設(shè)備實例；失敗,返回錯誤碼處理過程釋放指定設(shè)備實例的內(nèi)部資源,然后刪除映射表內(nèi)的設(shè)備信息備注無示例//從工廠中銷毀設(shè)備intnRet=tlFactory.DestroyDevice<MyDevice>;if<MV_OK!=nRet>{printf<"warning:DestroyDevicefail[%x]\n",nRet>;}設(shè)備控制類Open功能說明打開設(shè)備接口所在位置MvDeviceBase.h調(diào)用上下文或依賴對象描述已創(chuàng)建設(shè)備實例函數(shù)方法virtualintOpen<>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程連接設(shè)備,獲取設(shè)備獨占權(quán)限備注無示例intnRet=MyDevice->Open<>;if<MV_OK!=nRet>{printf<"error:Open[%x]\n",nRet>;continue;}Close功能說明關(guān)閉設(shè)備接口所在位置MvDeviceBase.h調(diào)用上下文或依賴對象描述已打開設(shè)備函數(shù)方法virtualintClose<>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程斷開設(shè)備連接,釋放獨占權(quán)限備注無示例intnRet=MyDevice->Close<>;if<MV_OK!=nRet>{printf<"warning:Closefail[%x]\n",nRet>;}StartGrabbing功能說明開始采集圖像接口所在位置MvDeviceBase.h調(diào)用上下文或依賴對象描述已打開設(shè)備函數(shù)方法virtualintClose<>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程控制設(shè)備按照指定的像素格式和方式開始采集圖像備注無示例intnRet=MyDevice->StartGrabbing<>;if<MV_OK!=nRet>{printf<"error:StartGrabbing[%x]\n",nRet>;break;}StopGrabbing功能說明停止采集圖像接口所在位置MvDeviceBase.h調(diào)用上下文或依賴對象描述已開始采集圖像函數(shù)方法virtualintClose<>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程控制設(shè)備停止采集數(shù)據(jù)備注無示例intnRet=MyDevice->StopGrabbing<>;if<MV_OK!=nRet>{printf<"warning:StopGrabbingfail[%x]\n",nRet>;}GetGenICamXML功能說明獲取設(shè)備的XML文件接口所在位置MvDeviceBase.h調(diào)用上下文或依賴對象描述已開啟設(shè)備函數(shù)方法virtualintGetGenICamXML<unsignedchar*pData,unsignedintnDataSize,unsignedint*pnDataLen>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明pDataunsignedchar*待拷入數(shù)據(jù)的緩存地址nDataSizeunsignedint緩存大小輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明pnDataLenunsignedint*輸出的XML文件數(shù)據(jù)長度返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程從設(shè)備讀取XML文件,并輸出備注當pData為NULL或nDataSize比實際的xml文件小時,不拷貝數(shù)據(jù),由pnDataLen返回xml文件大?。划攑Data為有效緩存地址,且緩存足夠大時,拷貝完整數(shù)據(jù),并由pnDataLen返回xml文件大小。示例unsignedintnXMLDataLen=0;intnRet=MyDevice->GetGenICamXML<pXMLBuf,MAX_XML_FILE_SIZE,&nXMLDataLen>;if<MV_OK!=nRet||nXMLDataLen>MAX_XML_FILE_SIZE>{printf<"error:GetGenICamXMLfailed![%x]\n",nRet>;break;}GetTlProxy功能說明獲取GenICam使用的傳輸層代理類接口所在位置MvDeviceBase.h調(diào)用上下文或依賴對象描述已創(chuàng)建設(shè)備實例,已打開設(shè)備函數(shù)方法virtualTlProxyGetTlProxy<>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值成功,返回傳輸層代理；失敗,返回NULL處理過程創(chuàng)建傳輸層代理類,內(nèi)部實現(xiàn)共享設(shè)備的獨占權(quán)限備注無示例TlProxym_pMyPortTl=MyDevice->GetTlProxy<>;if<NULL==m_pMyPortTl>{printf<"error:getgigetransportlayerfailed!\n">;break;}GetOneFrame功能說明獲取一幀圖像數(shù)據(jù)接口所在位置MvDeviceBase.h調(diào)用上下文或依賴對象描述已創(chuàng)建設(shè)備實例,已打開設(shè)備,已開啟抓圖函數(shù)方法virtualintGetOneFrame<unsignedchar*pData,unsignedintnDataSize,MV_FRAME_OUT_INFO*pFrameInfo>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明pDataunsignedchar*待拷入數(shù)據(jù)的緩存地址nDataSizeunsignedint緩存大小輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明pFrameInfoMV_FRAME_OUT_INFO*輸出的幀信息返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程獲取設(shè)備采集的圖像數(shù)據(jù),按照指定的像素格式輸出備注該接口為主動式獲取幀數(shù)據(jù),上層應用程序需要根據(jù)幀率,控制好調(diào)用該接口的頻率示例intnRet=MyDevice->GetOneFrame<g_pFrameBuf,MAX_BUF_SIZE,&stInfo>;if<MV_OK!=nRet>{Sleep<10>;}else{SR_UpdateFrameData<hRenderHandle,g_pFrameBuf,stInfo.nWidth,stInfo.nHeight,0>;SR_Display<hRenderHandle,0,display>;}GenApi_LoadXMLFromFile功能說明加載設(shè)備XML文件接口所在位置NodeMapRef.h調(diào)用上下文或依賴對象描述已創(chuàng)建設(shè)備實例,已打開設(shè)備,已開啟抓圖函數(shù)方法void_LoadXMLFromFile<GenICam::gcstringFileName>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明FileNameGenICam::gcstringxml文件路徑輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值無處理過程加載設(shè)備提供的xml文件備注該方法需要接收異常示例CNodeMapRef*m_Camera=newCNodeMapRef;try{//加載xmlm_Camera->_LoadXMLFromFile<"testdevice.xml">;//導入傳輸層代理類,連接設(shè)備m_Camera->_Connect<<IPort*>m_pMyPortTl,"Device">;//獲取指定字段對應的節(jié)點CIntegerPtrptrNode=m_Camera->_GetNode<"Width">;if<NULL==ptrNode>{printf<"error:m_Camera->_GetNodefail!\n">;break;}//獲取指定字段的值intnValue=ptrNode->GetValue<>;printf<"getvalue[%x]\n",nValue>;//設(shè)定指定字段的值nValue=1280;ptrNode->SetValue<nValue>;printf<"setvalue[%x]\n",nValue>;}catch<...>{printf<"warning:GenICamXMLmoduleerror!\n">;}_Connect功能說明導入傳輸層,連接設(shè)備接口所在位置NodeMapRef.h調(diào)用上下文或依賴對象描述已成功加載xml文件,已獲取到傳輸層代理類函數(shù)方法virtualbool_Connect<IPort*pPort,constGenICam::gcstring&PortName>const;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明pPortIPort*傳輸層代理類PortNameconstGenICam::gcstring&端口名稱輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值無處理過程略備注該方法需要接收異常示例參考LoadXMLFromFile方法的示例代碼_GetNode功能說明獲取指定字段的節(jié)點接口所在位置NodeMapRef.h調(diào)用上下文或依賴對象描述已成功導入傳輸層代理類,已成功連接設(shè)備函數(shù)方法virtualINode*_GetNode<constGenICam::gcstring&key>const;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明keyconstGenICam::gcstring&字段名稱輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值成功,返回指定字段的節(jié)點；失敗,返回NULL,或拋出異常處理過程略備注該方法需要接收異常示例參考LoadXMLFromFile方法的示例代碼GetValue功能說明獲取指定字段的值接口所在位置IValue.h、Pointer.h、IInteger.h等,視類型而定調(diào)用上下文或依賴對象描述已成功獲取節(jié)點函數(shù)方法virtualint64_tGetValue<>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值成功,返回指定字段的值；失敗,拋出異常處理過程略備注需要根據(jù)指定字段的類型,來確定使用的方法。常用的有CIntegerPtr、CStringPtr、CRegisterPtr、CEnumerationPtr等,具體參照Pointer.h的定義示例參考LoadXMLFromFile方法的示例代碼SetValue功能說明獲取指定字段的值接口所在位置IValue.h、Pointer.h、IInteger.h等,視類型而定調(diào)用上下文或依賴對象描述已成功獲取節(jié)點函數(shù)方法virtualvoidSetValue<int64_tValue>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明Valueint64_t設(shè)置的值輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值失敗,拋出異常處理過程略備注需要根據(jù)指定字段的類型,來確定使用的方法。常用的有CIntegerPtr、CStringPtr、CRegisterPtr、CEnumerationPtr等,具體參照Pointer.h的定義示例參考LoadXMLFromFile方法的示例代碼接口描述〔C接口C接口按照邏輯功能,劃分為四大模塊。相機控制通用接口MV_CC_GetSDKVersion功能說明獲取SDK版本號接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述可獨立隨時調(diào)用函數(shù)方法MV_CAMCTRL_APIunsignedint__stdcallMV_CC_GetSDKVersion<>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值版本號：|主|次|修正|測試|8bits8bits8bits8bits處理過程把SDK內(nèi)部定義的當前版本號返回備注無示例unsignedintnVersion=MV_CC_GetSDKVersion<>;MV_CC_EnumerateTls功能說明枚舉支持的設(shè)備類型〔傳輸層類型接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述可獨立隨時調(diào)用函數(shù)方法MV_CAMCTRL_APIint__stdcallMV_CC_EnumerateTls<>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值支持的傳輸層類型處理過程備注無示例intnSupportedTls=MV_CC_EnumerateTls<>;MV_CC_EnumDevices功能說明設(shè)備枚舉接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述已成功加載SDK函數(shù)方法MV_CAMCTRL_APIint__stdcallMV_CC_EnumDevices<INunsignedintnTLayerType,INOUTMV_CC_DEVICE_INFO_LIST*pstDevList>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明nTLayerTypeunsignedint相機協(xié)議類型輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明pstDevListMV_CC_DEVICE_INFO_LIST*枚舉到的設(shè)備信息列表的指針返回值無處理過程根據(jù)輸入的相機協(xié)議,把發(fā)現(xiàn)的設(shè)備信息保存到設(shè)備列表pstDevList中備注無示例MV_CC_DEVICE_INFO_LISTstDevList;memset<&stDevList,0,sizeof<MV_CC_DEVICE_INFO_LIST>>;intnRet=tlFactory.EnumDevices<MV_GIGE_DEVICE,&stDevList>;if<MV_OK!=nRet>{printf<"error:EnumDevices[%x]\n",nRet>;return1;}MV_CC_CreateHandle功能說明創(chuàng)建句柄接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述無函數(shù)方法MV_CAMCTRL_APIint__stdcallMV_CC_CreateHandle<OUTvoid**handle,INconstMV_CC_DEVICE_INFO*pstDevInfo>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明pstDevInfoMV_CC_DEVICE_INFO*設(shè)備信息輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明handlevoid**句柄返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程創(chuàng)建庫內(nèi)部必須的資源和初始化內(nèi)部模塊備注無示例MV_CC_DestroyHandle功能說明銷毀句柄接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述已創(chuàng)建有效句柄函數(shù)方法MV_CAMCTRL_APIint__stdcallMV_CC_DestroyHandle<void*handle>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明handlevoid*句柄輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程釋放資源備注無示例MV_CC_IsDeviceAccessible功能說明設(shè)備是否可訪問接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述已創(chuàng)建句柄函數(shù)方法MV_CAMCTRL_APIbool__stdcallMV_CC_IsDeviceAccessible<INvoid*handle,MV_CC_DEVICE_INFO*pstDevInfo,unsignedintnAccessMode>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明handlevoid*句柄pstDevInfoMV_CC_DEVICE_INFO設(shè)備信息nAccessModeunsignedint訪問類型輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值true或false處理過程讀取設(shè)備CCP寄存器的值,判斷當前狀態(tài)是否具有某種訪問權(quán)限。備注無示例MV_CC_OpenDevice功能說明打開設(shè)備接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述已創(chuàng)建有效句柄函數(shù)方法MV_CAMCTRL_APIint__stdcallMV_CC_OpenDevice<INvoid*handle,INunsignedintnPrivilegeMode=MV_ExclusivePrivilege,INunsignedshortnSwitchoverKey=0>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明handlevoid*句柄nPrivilegeModeunsignedint設(shè)備訪問模式,默認獨占模式nSwitchoverKeyunsignedshort切換權(quán)限時的密鑰,默認無輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程根據(jù)設(shè)置的設(shè)備參數(shù),找到對應的設(shè)備,連接。備注無示例MV_CC_CloseDevice功能說明關(guān)閉設(shè)備接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述已打開設(shè)備函數(shù)方法MV_CAMCTRL_APIint__stdcallMV_CC_CloseDevice<void*handle>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明handlevoid*句柄輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程斷開相機連接,釋放資源備注無示例MV_CC_StartGrabbing功能說明開啟抓圖接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述已打開設(shè)備函數(shù)方法MV_CAMCTRL_APIint__stdcallMV_CC_StartGrabbing<void*handle>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明handlevoid*句柄輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程發(fā)送開啟抓圖命令給相機,開啟接收數(shù)據(jù)。備注無示例MV_CC_StopGrabbing功能說明停止抓圖接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述已開啟抓圖函數(shù)方法MV_CAMCTRL_APIint__stdcallMV_CC_StopGrabbing<void*handle>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明handlevoid*句柄輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程發(fā)送停止抓圖命令給相機,停止接收數(shù)據(jù)。備注無示例MV_CC_GetOneFrame功能說明獲取一幀圖像數(shù)據(jù)接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述已開啟抓圖函數(shù)方法MV_CAMCTRL_APIint__stdcallMV_CC_GetOneFrame<void*handle,INOUTunsignedchar*pData,INunsignedintnDataSize,INOUTMV_FRAME_OUT_INFO*pFrameInfo>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明handlevoid*句柄pDataunsignedchar*待輸出數(shù)據(jù)緩存nDataSizeunsignedint緩存大小輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明pDataunsignedchar*輸出數(shù)據(jù)緩存pFrameInfoMV_FRAME_OUT_INFO當前一幀圖像的信息返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程從相機或內(nèi)部緩存鏈表中獲取一幀圖像備注無示例MV_CC_GetImageInfo功能說明獲取相機圖像基本信息接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述已連接設(shè)備函數(shù)方法MV_CAMCTRL_APIint__stdcallMV_CC_GetImageInfo<void*handle,INOUTMV_IMAGE_BASIC_INFO*pstInfo>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明handlevoid*句柄pstInfoMV_IMAGE_BASIC_INFO待輸出的信息結(jié)構(gòu)輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明pstInfoMV_IMAGE_BASIC_INFO圖像基本信息返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程訪問設(shè)備,獲取當前設(shè)置備注無示例MV_CC_SetWidth功能說明設(shè)置相機圖像的寬度接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述已連接設(shè)備函數(shù)方法MV_CAMCTRL_APIint__stdcallMV_CC_SetWidth<void*handle,INOUTunsignedintnValue>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明handlevoid*句柄nValueunsignedint寬值輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程訪問設(shè)備,設(shè)置寬值備注無示例MV_CC_SetHeight功能說明設(shè)置相機圖像的高度接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述已連接設(shè)備函數(shù)方法MV_CAMCTRL_APIint__stdcallMV_CC_SetHeight<void*handle,INOUTunsignedintnValue>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明handlevoid*句柄nValueunsignedint高值輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程訪問設(shè)備,設(shè)置高值備注無示例MV_CC_SetPixelFormat功能說明設(shè)置相機圖像的像素格式接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述已連接設(shè)備函數(shù)方法MV_CAMCTRL_APIint__stdcallMV_CC_SetPixelFormat<void*handle,INOUTMvGvspPixelTypeenValue>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明handlevoid*句柄enValueMvGvspPixelType像素格式輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程訪問設(shè)備,設(shè)置像素格式備注無示例MV_CC_SetAcquisitionMode功能說明設(shè)置相機采集模式接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述已連接設(shè)備函數(shù)方法MV_CAMCTRL_APIint__stdcallMV_CC_SetPixelFormat<void*handle,INOUTMV_CAM_ACQUISITION_MODEenMode>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明handlevoid*句柄enModeMV_CAM_ACQUISITION_MODE采集模式輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程訪問設(shè)備,設(shè)置采集模式備注無示例MV_CC_SetFrameRate功能說明設(shè)置相機采集幀率接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述已連接設(shè)備函數(shù)方法MV_CAMCTRL_APIint__stdcallMV_CC_SetFrameRate<void*handle,INfloatfValue>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明handlevoid*句柄fValuefloat幀率輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程訪問設(shè)備,設(shè)置幀率備注無示例MV_CC_ReadMemory功能說明從設(shè)備寄存器內(nèi)讀取數(shù)據(jù)接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述已連接設(shè)備函數(shù)方法MV_CAMCTRL_APIint__stdcallMV_CC_ReadMemory<void*handle,void*pBuffer,__int64nAddress,__int64nLength>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明handlevoid*句柄pBuffervoid*讀出數(shù)據(jù)的緩存nAddress__int64寄存器地址nLength__int64讀取長度輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明pBuffervoid*讀出數(shù)據(jù)的緩存返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程訪問設(shè)備,讀取某段寄存器的數(shù)據(jù)備注無示例MV_CC_WriteMemory功能說明從設(shè)備寄存器內(nèi)讀取數(shù)據(jù)接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述已連接設(shè)備函數(shù)方法MV_CAMCTRL_APIint__stdcallMV_CC_WriteMemory<void*handle,constvoid*pBuffer,__int64nAddress,__int64nLength>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明handlevoid*句柄pBuffervoid*待寫入的數(shù)據(jù)nAddress__int64寄存器地址nLength__int64讀取長度輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程訪問設(shè)備,把一段數(shù)據(jù)寫入某段寄存器備注無示例MV_CC_GetAllMatchInfo功能說明獲取各種類型的信息接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述取決于獲取的信息類型函數(shù)方法MV_CAMCTRL_APIint__stdcallMV_CC_GetOneFrame<void*handle,INOUTMV_ALL_MATCH_INFO*pstInfo>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明handlevoid*句柄pstInfoMV_ALL_MATCH_INFO待輸出的信息結(jié)構(gòu)輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明pstInfoMV_ALL_MATCH_INFO輸出的信息返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程根據(jù)輸入的信息類型,獲取對應的信息結(jié)構(gòu)體備注無示例MV_CC_RegisterExceptionCallBack功能說明注冊異常消息回調(diào)接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述已創(chuàng)建句柄函數(shù)方法MV_CAMCTRL_APIint__stdcallMV_CC_RegisterExceptionCallBack<void*handle,void<__stdcall*cbException><unsignedintnMsgType,void*pUser>,void*pUser>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明handlevoid*句柄cbExceptionvoid__stdcall*回調(diào)函數(shù)pUservoid*用戶指針輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程庫內(nèi)部出現(xiàn)已定義的異常時,調(diào)用該回調(diào)函數(shù)備注無示例MV_CC_LocalUpgrade功能說明設(shè)備本地升級接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述已連接相機函數(shù)方法MV_CAMCTRL_APIint__stdcallMV_CC_LocalUpgrade<void*handle,constvoid*pFilePathName>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明handlevoid*句柄pFilePathNameconstvoid*設(shè)置相機采集模式輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程按照協(xié)商好的方式發(fā)送升級包給設(shè)備備注無示例MV_CC_GetUpgradeProcess功能說明獲取當前升級進度接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述升級進行時函數(shù)方法MV_CAMCTRL_APIint__stdcallMV_CC_GetUpgradeProcess<void*handle,unsignedint*pnProcess>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明handlevoid*句柄輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明pnProcessunsignedint已完成百分比返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程獲取升級進度百分值備注無示例MV_CC_GetOptimalPacketSize功能說明獲取最佳的packetsize,對應GigEVision設(shè)備是SCPS,對應U3V設(shè)備是每次從驅(qū)動讀取的包大小接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述升級進行時函數(shù)方法MV_CAMCTRL_APIint__stdcallMV_CC_GetOptimalPacketSize<void*handle>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明handlevoid*句柄輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值成功,返回大于0,表示包大小；失敗,返回值小于0,表示錯誤碼。處理過程SDK內(nèi)部通過某種方式,獲取到最佳的數(shù)值,輸出備注無示例MV_CC_Display功能說明顯示一幀圖像接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述已獲取到圖像數(shù)據(jù)函數(shù)方法MV_CAMCTRL_APIint__stdcallMV_CC_Display<void*handle,void*hWnd,unsignedchar*pData,MV_FRAME_OUT_INFO*pFrameInfo>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明handlevoid*句柄hWndvoid*窗口句柄pDataunsignedchar*數(shù)據(jù)指針pFrameInfoMV_FRAME_OUT_INFO*幀信息輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程顯示備注無示例XML相關(guān)接口MV_XML_GetGenICamXML功能說明獲取相機的XML數(shù)據(jù)接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述已連接設(shè)備函數(shù)方法MV_CAMCTRL_APIint__stdcallMV_XML_GetGenICamXML<void*handle,INOUTunsignedchar*pData,INunsignedintnDataSize,OUTunsignedint*pnDataLen>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明handlevoid*句柄pDataunsignedchar*待輸出的數(shù)據(jù)緩存nDataSizeunsignedint數(shù)據(jù)緩存大小輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明pDataunsignedchar*xml數(shù)據(jù)緩存pnDataLenunsignedint*xml數(shù)據(jù)長度返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程從設(shè)備獲取xml備注無示例MV_XML_GetRootNode功能說明獲取根節(jié)點接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述已載入xml函數(shù)方法MV_CAMCTRL_APIint__stdcallMV_XML_GetRootNode<void*handle,INOUTMV_XML_NODE_FEATURE*pstNode>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明handlevoid*句柄pstNodeMV_XML_NODE_FEATURE*節(jié)點信息結(jié)構(gòu)體輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明pstNodeMV_XML_NODE_FEATURE*節(jié)點信息結(jié)構(gòu)體返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程解析xml,獲取根節(jié)點備注無示例MV_XML_GetChildren功能說明獲取某個節(jié)點的所有子節(jié)點接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述已獲取根節(jié)點函數(shù)方法MV_CAMCTRL_APIint__stdcallMV_XML_GetChildren<void*handle,INMV_XML_NODE_FEATURE*pstNode,INOUTMV_XML_NODES_LIST*pstNodesList>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明handlevoid*句柄pstNodeMV_XML_NODE_FEATURE*父節(jié)點pstNodesListMV_XML_NODES_LIST*子節(jié)點列表輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明pstNodesListMV_XML_NODES_LIST*子節(jié)點列表返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程解析xml,獲取某個節(jié)點的所有子節(jié)點信息備注無示例MV_XML_GetNodeFeature功能說明獲取某個節(jié)點的詳細信息接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述已獲取某個節(jié)點的基本信息函數(shù)方法MV_CAMCTRL_APIint__stdcallMV_XML_GetNodeFeature<void*handle,INMV_XML_NODE_FEATURE*pstNode,INOUTvoid*pstFeature>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明handlevoid*句柄pstNodeMV_XML_NODE_FEATURE*節(jié)點的基本信息pstFeaturevoid*節(jié)點詳細信息存儲的地址輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明pstFeaturevoid*節(jié)點詳細信息返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程解析節(jié)點的基本信息,獲取該節(jié)點的詳細信息備注無示例MV_XML_UpdateNodeFeature功能說明設(shè)置某個節(jié)點的屬性值接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述已獲取某個節(jié)點的詳細信息函數(shù)方法MV_CAMCTRL_APIint__stdcallMV_XML_UpdateNodeFeature<void*handle,INMV_XML_InterfaceTypeenType,INOUTvoid*pstFeature>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明handlevoid*句柄enTypeMV_XML_InterfaceType節(jié)點類型pstFeaturevoid*節(jié)點的詳細信息輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程設(shè)置某個節(jié)點的屬性值,SDK內(nèi)部通過GenICam更新該節(jié)點的所有信息備注無示例MV_XML_RegisterUpdateCallBack功能說明注冊屬性更新回調(diào)接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述已載入xml函數(shù)方法MV_CAMCTRL_APIint__stdcallMV_XML_RegisterUpdateCallBack<void*handle,INvoid<__stdcall*cbUpdate><MV_XML_InterfaceTypeenType,void*pstFeature>,INvoid*pUser>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明handlevoid*句柄cbUpdatevoid__stdcall*回調(diào)函數(shù)指針pUservoid*用戶指針輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程注冊該回調(diào)后,當某個節(jié)點的屬性改變后,調(diào)用該回調(diào)函數(shù)備注無示例GigEVision相機特有的接口MV_GIGE_ForceIp功能說明強制IP接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述已獲取到設(shè)備的信息函數(shù)方法MV_CAMCTRL_APIint__stdcallMV_GIGE_ForceIp<void*handle,unsignedintnIP>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明handlevoid*句柄nIPunsignedint要設(shè)置的IP輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程根據(jù)協(xié)議,發(fā)送廣播包,指定的設(shè)備接收到后改變自身的IP備注無示例MV_GIGE_SetIpConfig功能說明配置IP方式接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述已連接設(shè)備函數(shù)方法MV_CAMCTRL_APIint__stdcallMV_GIGE_SetIpConfig<void*handle,unsignedintnType>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明handlevoid*句柄nTypeunsignedintIP方式輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程發(fā)送命令設(shè)置相機的ip方式,如DHCP、LLA等備注無示例MV_GIGE_SetNetTransMode功能說明配置IP方式接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述已創(chuàng)建句柄函數(shù)方法MV_CAMCTRL_APIint__stdcallMV_GIGE_SetNetTransMode<void*handle,unsignedintnType>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明handlevoid*句柄nTypeunsignedint網(wǎng)絡模式輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程設(shè)置SDK內(nèi)部優(yōu)先使用的網(wǎng)絡模式,如驅(qū)動或socket備注可選接口示例MV_CC_SetGevSCPSPacketSize功能說明設(shè)置SCPS接口所在位置MvCameraControl.h調(diào)用上下文或依賴對象描述已連接設(shè)備函數(shù)方法MV_CAMCTRL_APIint__stdcallMV_CC_SetGevSCPSPacketSize<void*handle,INOUTunsignedintnValue>;輸入?yún)?shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明handlevoid*句柄nValueunsignedint高值輸出參數(shù)代碼/名稱數(shù)據(jù)類型參數(shù)說明無無無返回值成功,返回MV_OK；失敗,返回錯誤碼處理過程訪問設(shè)備,設(shè)置SCPS備注無示例U3V相機特有的接口暫無,保留。數(shù)據(jù)結(jié)構(gòu)描述MV_GIGE_DEVICE_INFO〔GigE設(shè)備信息typedefstruct_MV_GIGE_DEVICE_INFO_{unsignedintnIpCfgOption;unsignedintnIpCfgCurrent;unsignedintnCurrentIp;unsignedintnCurrentSubNetMask;unsignedintnDefultGateWay;unsignedcharchManufacturerName[32];unsignedcharchModelName[32];unsignedcharchDeviceVersion[32];unsignedcharchManufacturerSpecificInfo[48];unsignedcharchSerialNumber[16];unsignedcharchUserDefinedName[16];}MV_GIGE_DEVICE_INFO;MembersDefinitio