深圳科技sdk netsdk開發(fā)手冊

1、 !#$%&()*+,-./CD23456789:;?AB 修訂第 3 頁 共 29 頁日期修訂內(nèi)容2013/1/5第一次發(fā)布2013/9/14增加登錄設(shè)備 API NETSDK_CreateSesEx增加獲取 SDK 版本 API NETSDK_Ver解決了打開后斷線重連的 BUG2013/9/291. 增加首次連接設(shè)備失敗時(shí)的事件上報(bào)(SOCKET_CONNECT_LOST)2013/11/12增加了 NETSDK_ReuseSes接口,復(fù)用已存在會(huì)話2013/12/4修正首次重連設(shè)備后主動(dòng)斷開連接問題，心跳不穩(wěn)定問題2014/3/1增加音格式描述及使用實(shí)例目錄簡 介5概述5適用性5設(shè)計(jì)原

2、則5編程說明5典型調(diào)用順序62接口定義8SDK 初始化8登錄設(shè)備8實(shí)時(shí)監(jiān)視102.4 回放和.11回放控制13云臺(tái)控制13圖像配置13網(wǎng)絡(luò)配置152.92.10配置16配置16升級(jí)、搜索17獲取、設(shè)置系統(tǒng)時(shí)間18透明通道19獲取、設(shè)置 DDNS 信息19強(qiáng)制 I 幀192.16 設(shè)備主動(dòng).202.17 獲取 SDK 版本20格式2133.1格式213.2 音頻格式21使用實(shí)例22初始化 SDK22設(shè)備搜索22主動(dòng)連接設(shè)備234.4 設(shè)備上報(bào)254.5 請(qǐng)求實(shí)時(shí).26PTZ 控制27圖像參數(shù)配置27編碼參數(shù)配置28第 4 頁共 29 頁NetSDK 編程手冊1. 簡介1.1概述歡迎使用我公司網(wǎng)絡(luò)

3、SDK編程手冊，NetSDK是開發(fā)商在開發(fā)機(jī)聯(lián)網(wǎng)應(yīng)用時(shí)的開發(fā)套件。本文檔詳細(xì)描述了開發(fā)包中各個(gè)函數(shù)實(shí)現(xiàn)的功能、接口及其函數(shù)之間的調(diào)用關(guān)系和示例實(shí)現(xiàn)。開發(fā)包所包括的文件有：1.2適用性設(shè)計(jì)原則1.3編程說明初始化和清除使用NetSDK 包首先調(diào)用 NETSDK_Initialize()對(duì)系統(tǒng)進(jìn)行初始化，應(yīng)用程序退出時(shí)調(diào)用 NETSDK_Uninitialize()所有占用的資源。用戶登錄和注銷用 戶 在前 端 設(shè) 備 之 前 必 須 通 過 調(diào) 用NETSDK_CreateSesEx() 或()登錄到前端設(shè)備上，登錄成功后返回一個(gè)全局唯一的句NETSDK_CreateSes柄。此句柄就像一個(gè)會(huì)話

4、通道，之后該用戶可通過此句柄前端設(shè)備。退出該會(huì)話時(shí)則通過 NETSDK_DestroySes()函數(shù)端設(shè)備上注銷此句柄以終止該會(huì)話通道的使用。建立連接與登錄是同步的。心跳功能在本開發(fā)包中提供自動(dòng)心跳功能（5 秒一次心跳）當(dāng)設(shè)備斷開回調(diào)給客戶端?；卣{(diào)函數(shù)一般都有由用戶自定義的參數(shù), 用來傳入類對(duì)象指針, 方便回調(diào)處理在類中實(shí)現(xiàn),回調(diào)應(yīng)用都可以采取這種方式。第 5 頁共 29 頁網(wǎng)絡(luò)庫NetSDK.h頭文件NetSDKDef.h結(jié)構(gòu)體定義文件NetSDK.libLib 文件NetSDK.dll接口庫NetSDK 編程手冊1.4典型調(diào)用順序A.初始化B.登錄連接設(shè)備C.實(shí)時(shí)D.回放/E.設(shè)備功能操作

5、與信息獲取F.控制G.注銷斷開設(shè)備第 6 頁共 29 頁斷開連接NETSDK_DestroySes()升級(jí)NETSDK_UpgradeDev () NETSDK_CancelUpgradeDev ()系統(tǒng)參數(shù)配置NETSDK_GetSeInfo ()NETSDK_SetSeInfo ()云臺(tái)控制NETSDK_PtzControl ()透明通道控制NETSDK_GetTransparentMSG()NETSDK_SetTransparentMSG()查詢NETSDK_SearchRecordFile ()回放及控制NETSDK_StartPlayFile ()NETSDK_PlayFileCon

6、trol()打開實(shí)時(shí)流NETSDK_CreateRealTimeStream()關(guān)閉實(shí)時(shí)流NETSDK_StopStream ()登入設(shè)備NETSDK_CreateSesEx ()SDK 初始化NETSDK_Initialize ()3 5 #!#!%!(!4 2接口定義2.1SDK 初始化1.32_tNETSDK_Initialize();函數(shù)說明：初始化 SDK, 在所有的 SDK 函數(shù)之前調(diào)用參數(shù)說明：0:ok,-1:failure2.void NETSDK_Uninitialize();函數(shù)說明：清空 SDK,參數(shù)：無 返回值：無占用的資源，在所有的 SDK 函數(shù)之后調(diào)用。典型應(yīng)用：在

7、應(yīng)用程序關(guān)閉時(shí)調(diào)用2.21.登錄設(shè)備NETSDK_hSesNETSDK_CreateSes(boolbDynamicIP,structsockaddr_in *addr, const char *username, constchar *password,16_trsvPort,u16_tmsgPort,u16_tstreort,uNETSDK_SesdevType = 0);EventCallBackcallback,LPVOIDparam,32_t函數(shù)說明：用戶到設(shè)備， 當(dāng)設(shè)備端把用戶設(shè)置為復(fù)用（ 設(shè)備默認(rèn)的用戶如admin,不能設(shè)置為復(fù)用），則使用該帳號(hào)可以多次向設(shè)備參數(shù)說明：。inbD

8、ynamicIP是否動(dòng)態(tài) IP in addr設(shè)備 IPin username用戶名in password用戶in msgPort默認(rèn) 8088信令端口in streort流端口，可以為 0： in rsvPort保留in callback事件回調(diào)函數(shù)，上線、下線、等事件通過該 回調(diào)函數(shù)通知調(diào)用者typedef void ( stdcall *NETSDK_SesEventCallBack)(第 8 頁共 29 頁NETSDK_hSesses,void* callbackParam,SesEvent_E event,void* eventParam); in param該參數(shù)將做為事件回調(diào)函數(shù)

9、 callbackParam 值。in devType設(shè)備類型，保留，常為 0返回值： 0 成功,否則失敗，登錄成功之后對(duì)設(shè)備的操作都可以通過此值(設(shè)備句柄)對(duì)應(yīng)到相應(yīng)的設(shè)備。典型應(yīng)用：在初始化后就可以調(diào)用本接口登錄到指定的設(shè)備，成功后將返回設(shè)備句柄，給相關(guān)的函數(shù)調(diào)用2.NETSDK_hSesNETSDK_CreateSesEx(char* sIP, u16_t wPort,char*sUserName,char*sPassword,NETSDK_SesEventCallBackcallback, LPVOID param);函數(shù)說明：用戶到設(shè)備，當(dāng)設(shè)備端把用戶設(shè)置為復(fù)用（設(shè)備默認(rèn)的用戶如 a

10、dmin,不能設(shè)置為復(fù)用），則使用該帳號(hào)可以多次向設(shè)備參數(shù)說明：in sIP 設(shè)備 IP in wPort信令端口 默認(rèn) 8088 in username 用戶名in password用戶in callback。事件回調(diào)函數(shù)，上線、下線、等事件通過該 回調(diào)函數(shù)通知調(diào)用者typedef void ( stdcall *NETSDK_SesEventCallBack)(NETSDK_hSesses,void* callbackParam,SesEvent_E event,void* eventParam); in param該參數(shù)將做為事件回調(diào)函數(shù) callbackParam 值。返回值： 0 成

11、功,否則失敗，登錄成功之后對(duì)設(shè)備的操作都可以通過此值(設(shè)備句柄)對(duì)應(yīng)到相應(yīng)的設(shè)備。典型應(yīng)用：在初始化后就可以調(diào)用本接口登錄到指定的設(shè)備，成功后將返回設(shè)備句柄，給第 9 頁共 29 頁相關(guān)的函數(shù)調(diào)用3.NETSDK_hSesNETSDK_ReuseSes(NETSDK_hSessid,char*sIP,u16_t wMsgPort,u*sPwd);16_t wStreort,char *sUserName, char函數(shù)說明：復(fù)用已存在的會(huì)話，避免設(shè)備因連接失敗頻繁創(chuàng)建 SES，以及用于設(shè)備IP&PORT 變化時(shí),自動(dòng)打開之前已存在的參數(shù)說明：會(huì)話insid:已存在的設(shè)備會(huì)話 IDin sIP設(shè)

12、備 IPin wMsgPort信令端口默認(rèn) 8088in wStreort默認(rèn) 8090信令端口in sUserName用戶名in sPwd用戶4.void NETSDK_DestroySes(NETSDK_hSesses);函數(shù)說明：注銷設(shè)備用戶參數(shù)說明：in sesNETSDK_CreateSes的返回值返回值：N/A典型應(yīng)用：當(dāng)需要設(shè)備主動(dòng)斷開時(shí)調(diào)用;2.31.實(shí)時(shí)監(jiān)視NETSDK_hStreamNETSDK_CreateRealTimeStream(NETSDK_hSesses,const StreamInfo_S *streamInfo, NETSDK_RecvDallBackrec

13、vDataFunc, LPVOID param);函數(shù)說明：啟動(dòng)實(shí)時(shí)監(jiān)視參數(shù)說明：in sesNETSDK_CreateSesin streamInfo的返回值請(qǐng)求流的信息，描述主、輔碼流等信息，詳見 NetSdkDef.h第 10 頁共 29 頁inrecvDataFunc流回調(diào)函數(shù)typedef void ( stdcall *NETSDK_RecvDallBack)(NETSDK_hSesses,NETSDK_hStream hStream,const u8_t *data,u32_t dataLen,32_t isKeyFrame,TimeTick_T timest,u32_t fra

14、meSeqId,void* param);inparam傳給回調(diào)函數(shù)的參數(shù)返回值：成功，否則失敗，成功返回實(shí)時(shí)流 ID(實(shí)時(shí)流句柄)，將作為相關(guān)函數(shù)的參數(shù)。0典型應(yīng)用：根據(jù)登錄時(shí)獲取到的設(shè)備信息,調(diào)用本接口,就可以打開任何有效的一路實(shí)時(shí)監(jiān)視,并通過回調(diào)函數(shù)得到流數(shù)據(jù)。2.32_t NETSDK_StopStream(const NETSDK_hStream stream);函數(shù)說明：停止實(shí)時(shí)監(jiān)視參數(shù)說明：in streamNETSDK_CreateRealTimeStream 的返回值返回值：成功返回 0，否則失敗典型應(yīng)用：關(guān)閉實(shí)時(shí)流2.41.回放和32_t NETSDK_SearchReco

15、rdFile(NETSDK_hSesses, constRcdFileSearch_S*info,NETSDK_SearchResultCallBackrcdResultCallBack, LPVOID param);函數(shù)說明：查詢參數(shù)說明：文件in ses第 11 頁共 29 頁NETSDK_CreateSes的返回值in info查詢條件，RcdFileSearch_S 詳見 NetSDKDef.hout rcdResultCallBack回調(diào)函數(shù)，返回的文件信息typedef void ( stdcall *NETSDK_SearchResultCallBack)(NETSDK_hSes

16、ses,const char *data,u32_t arraySize,u8_t isEnd,void*param);data 為 RcdFileListResult_S， 詳見 NetSDKDef.hin param傳給回調(diào)函數(shù)的參數(shù)返回值：成功返回 0，失敗返回錯(cuò)誤碼典型應(yīng)用：在回放之前需要先調(diào)用本接口查詢2.NETSDK_hStreamNETSDK_StartPlayFile(NETSDK_hSesses,constPlayFiyTime_S*plyRcdFile,NETSDK_RecvDallBackrecvDataFunc, LPVOID param, u8_t playFlag)

17、;函數(shù)說明：回放參數(shù)說明：，收到的流通過回調(diào)函數(shù)送給調(diào)用者in sesNETSDK_CreateSesin plyRcdFile的返回值查詢條件 PlayFiyTime_S，詳見 NetSDKDef.h.out recvDataFunc回調(diào)函數(shù)，同 NETSDK_CreateRealTimeStreamin param傳給回調(diào)函數(shù)的參數(shù)in playFlag1：回放， 0：返回值：成功返回0，否則失敗第 12 頁 共 29 頁2.5回放控制1.32_tNETSDK_PlayFileControl(NETSDK_hStreamses,constPlayControl_SNULL);*contro

18、lInfo, PlayRecordByTime_S*timeInfo=函數(shù)說明：參數(shù)說明：回放控制。in sesNETSDK_StartPlayFile 的返回值in controlInfo暫停、快進(jìn)等信息，詳見 NetSDKDef.h in timeInfo，詳見 NetSDKDef.h根據(jù)時(shí)間定位返回值：成功返回 0，否則失敗2.61.云臺(tái)控制32_tNETSDK_PtzControl(NETSDK_hSesses,PtzControlInfo_S *info);函數(shù)說明：云臺(tái)控制參數(shù)說明:in sesNETSDK_CreateSesin info的返回值設(shè)備通道號(hào)、預(yù)置位、速度、命令等，

19、詳見 NetSDKDef.h返回值:成功返回 0，否則失敗返回錯(cuò)誤碼。相關(guān)函數(shù)：H264_DVR_Login，H264_DVR_RealPlay典型應(yīng)用：控制云臺(tái)，但是必須在當(dāng)前通道打開的情況下使用。2.7圖像配置1.32_tNETSDK_SetDefault(NETSDK_hSesdefualt);ses,32_t函數(shù)說明：恢復(fù)出廠2.32_t NETSDK_GetOSD(NETSDK_hSes*osdParam);ses, OUTOsd_S第 13 頁共 29 頁1 0*6 /&QR 6JzUCD 0*#) 00* 6 /&*,$2*#) 0* /&?VWX 0 ( 0*,$2 0* 6

20、/& ( 0 /&? 353* XXYZ* 023* 00* 6 /,10&*,$223* 0* /,10&8uX2 04 5 6 00* 6 E) /1)&*,$24 5 6 0*E) /1)&865 0 0,&*6 F, / F F 0*, / F,&IMN_a6 4F0& 0*6 , / 1&4F& 0*, /1&bo$ 0 0*6 / & 0* /&cde 0+) 0* &* 6 +) 0* /&fghi 0#75 0*6 / MN 0)2 ( 00* 6 A, /&*,$2)2 ( 0*A, /&z4 052 ( 00* 6 A, /&*,$252 ( 0*A, /&|o4w 2 3

21、.32_t NETSDK_GetAlarmOutput(NETSDK_hSesses,u16_tchnnlNo, OUT AlarmOutParam_S *info);/chnnlNo(0,1)32_t NETSDK_SetAlarmOutput(NETSDK_hSesAlarmOutParam_S *info);ses, const函數(shù)說警輸出設(shè)置4.32_tu16_tNETSDK_GetMotionDetect(NETSDK_hSeschnnlNo, OUT VMotionDetect_S *motionDetect);ses,32_t NETSDK_SetMotionDetect(NET

22、SDK_hSes VMotionDetect_S *motionDetect);函數(shù)說明：移動(dòng)偵測靈敏度、偵測范圍設(shè)置ses, const2.11升級(jí)、搜索1.32_tNETSDK_UpgradeDev(NETSDK_hSesses,32_tTranferFileType_EfileNameLen);fileType,constchar*fileName,函數(shù)說明：設(shè)置對(duì)前端設(shè)備網(wǎng)絡(luò)升級(jí)程序參數(shù)說明：in sesNETSDK_CreateSesin fileType要升級(jí)的文件類型,詳見 NetSDKDef.h enum TranferFileType_E的返回值TRANFER_UPGRADE

23、_FILE = 0, /.升級(jí)系統(tǒng);in fileName要升級(jí)的文件路徑名in fileNameLen要升級(jí)的文件名返回值：成功返回升級(jí)句柄 ID，失敗返回 0典型應(yīng)用：升級(jí)2.32_t NETSDK_CancelUpgradeDev(NETSDK_hSesses);函數(shù)說明：停止升級(jí)參數(shù)說明：in ses第 17 頁共 29 頁NETSDK_CreateSes返回值：0 成功，否則失敗的返回值a)典型應(yīng)用：停止升級(jí)3.32_t NETSDK_SearchDevice(u32_t msTimeOut);函數(shù)說明：搜索設(shè)備，以廣播方式搜索網(wǎng)內(nèi)設(shè)備參數(shù)說明：in msTimeOut搜索時(shí)間，毫秒

24、。返回值：返回搜到的設(shè)備數(shù)。4.32_t NETSDK_GetDeviceInfo(udeviceInfo);32_t index,OUTDeviceInfo_S*函數(shù)說明：從搜索的結(jié)果中獲取設(shè)備的詳細(xì)信息。參數(shù)說明：in index設(shè)備索引out deviceInfo設(shè)備信息 DeviceInfo_S,詳見 NetSDKDef.h返回值：0 成功，否則失敗2.12獲取、設(shè)置系統(tǒng)時(shí)間1.32_tNETSDK_GetDeviceTime(NETSDK_hSesses,OUTSystemTime_S *pDevTime);32_tNETSDK_SetDeviceTime(NETSDK_hSesse

25、s,constSystemTime_S *pDevTime);d)函數(shù)說明：設(shè)置系統(tǒng)時(shí)間e) 參數(shù)說明：in sesNETSDK_CreateSes返回值in pDevTime系統(tǒng)時(shí)間 ，SystemTime_S 詳見 NetSDKDef.hf) 返回值：0 成功否則失敗第 18 頁共 29 頁/_ ) 50 0*7- 3* 0 /*7-4&0+ )*+ 3,-./01 4N! #bc$XYU(N a 0 0* 6 /& 0* /&8QR 99: 9,: * : %0( #bc-bH c + *+ ( 0*,$2 chnnlNo);m)n)函數(shù)說明： 強(qiáng)制 I 幀參數(shù)說明：in sesNETS

26、DK_CreateSes返回值in chnnlNo控制的設(shè)備通道號(hào)返回值：0 成功否則失敗2.16設(shè)備主動(dòng)1.32_t NETSDK_GetServicePort(NETSDK_hSes*netConfigInfo);32_t NETSDK_SetServicePort(NETSDK_hSes*netConfigInfo);ses, OUT NetConfig_S2.ses, const NetConfig_So)函數(shù)說明：設(shè)置服務(wù)端口， NetConfig_S 中的如果設(shè)定了服務(wù)器的 IP 地址和端，則設(shè)備主服務(wù)器。p)參數(shù)說明：insesNETSDK_CreateSes返回值innetCo

27、nfigInfo網(wǎng)絡(luò)相關(guān)端口的結(jié)構(gòu)體，NetConfig_S 詳見 NetSDKDef.hq)返回值：0 成功，否則失敗3.32_tNETSDK_GetDeviceID(NETSDK_hSesses,OUTDevName_S *pDevID);32_t NETSDK_SetDeviceID(NETSDK_hSesDevName_S *pDevID);ses, const函數(shù)說明：獲取/設(shè)置設(shè)備 ID, 該 ID 為主動(dòng)時(shí)唯一標(biāo)識(shí)設(shè)備2.17獲取 SDK 版本Const char* NETSDK_Ver();第 20 頁共 29 頁3格式來自設(shè)備的實(shí)時(shí)和回放通過回調(diào)函數(shù)NETSDK_RecvDa

28、llBack輸出數(shù)據(jù)格式為：數(shù)據(jù)頭(16 字節(jié))+數(shù)據(jù)+音頻數(shù)據(jù)數(shù)據(jù)頭:3.1格式數(shù)據(jù)格式為標(biāo)準(zhǔn)的 H264：起始碼+NA編碼參數(shù)it3.2音頻格式音頻數(shù)據(jù)格式為對(duì)應(yīng)的標(biāo)準(zhǔn)編碼格式第 21 頁共 29 頁編碼Profile分辨率幀率H.264Main:4.11080P 720P D1 VGA CIF QCIF30目前支持的音頻編碼參數(shù)，用于語音時(shí)客戶端接收設(shè)備的音頻編碼數(shù)據(jù)音頻參數(shù) 用于語音對(duì)講時(shí)客戶端發(fā)給設(shè)備的音頻編碼數(shù)據(jù)4使用實(shí)例使用 SDK 必須包含頭文件#include NetSdk.h#include netsdkdef.h4.1初始化 SDK1. NETSDK_Initialize

29、();2. NETSDK_Uninitialize();4.2設(shè)備搜索nCount = NETSDK_SearchDevice(1000);/1secondfor (nItem = 0; nItem errCode = 0)第 23 頁共 29 頁prf(連接設(shè)備成功sesid=%dn,ses);break;case EVENT_CONNECTION_LOST:prf(sesid=%d connectfailure!n,ses);break;/發(fā)起連接請(qǐng)求sesid =NETSDK_CreateSesEx(51,8088,super,999999,SesEventProc

30、,0);if (sesid 0)/ok第 24 頁 共 29 頁4.4設(shè)備上報(bào)接收設(shè)備的回調(diào)函數(shù)與連接設(shè)備的回調(diào)函數(shù)復(fù)用。支持的事件類型參考 EventType_Evoid CALL_METHOD SesEventProc(ses, LPVOIDcallbackParam, SesEvent_E SesEvent, LPVOIDeventParam)switch(SesEvent)case EVENT_ALARM_NOTIFY:MsgEventLogEventEx_S* pEvent = (MsgEventLogEventEx_S*)eventParam;nEventType = pEvent

31、 -event;switch(nEventType)caseEVENT_TYPE_IOINPUT:caseEVENT_TYPE_IOINPUTPASS:caseEVENT_TYPE_LOST:caseEVENT_TYPE_RESUME:caseEVENT_TYPE_MOTIONED:caseEVENT_TYPE_MOTIONPASS:第 25 頁共 29 頁4.5請(qǐng)求實(shí)時(shí)/流回調(diào)函數(shù)voidCALL_METHOD RecvDallBack(NETSDK_hSesses,NETSDK_hStream hStream,const u8_t *data, u32_tdataLen,32_t isKe

32、yFrame, TimeTick_Ttimest,u32_t frameSeqId, void* param)const FrameHead_S* pHeader = reret_cast(data);char*p= pHeader-body;char*pAudio = p+pHeader-Len;/發(fā)起打開請(qǐng)求StreamInfo_S streamInfo;/主碼流streamInfo.channel= 0;streamInfo.channelStream=CHANNEL_STREAM_MAIN;streamInfo.streamType=第 26共 29 頁頁STREOSITE;/副碼流/streamInfo.channel= 1;/streamInfo.channelStream = CHANNEL_STREAM_DUAL;/streamInfo.streamT