Dahua Platform SDK (DLL Version)

Programming Manual

All rights reserved.

 Preface

Thank you for chossing our platform. This manual includes all operation ports currently
supported by the platform. Please be notified that product operation and technical instruction here
may be inaccurate. We will periodically update this manual for accurate contents.
 Table of Contents
1 INTRODUCTION.........................................................................................................................13

1.1 SUMMARY .............................................................................................................................13

1.2 CORE F UNCTION ....................................................................................................................13

2 PROGRAMMING ........................................................................................................................14

2.1 D IRECTORY ...........................................................................................................................14

2.2 USER COMMITMENT ................................................................................................................14

2.3 O PERATION FLOW ...................................................................................................................15

2.3.1 Login Flow ....................................................................................................................15

2.3.2 Device Info Loading and Obtaining .................................................................................16

2.3.3 By-level Device Info Loading and Getting ........................................................................17

2.3.4 Real-time Operation Flow with Decoder ..........................................................................18

2.3.5 Real-time Operation Flow without Decoder......................................................................19

2.3.6 Rec ord Operation Flow by File with Decoder ...................................................................20

2.3.7 Rec ord Operation Flow by Time with Decoder .................................................................21

2.3.8 Rec ord Operation Flow by File without Decoder ..............................................................22

2.3.9 Rec ord Operation Flow by Time without Decoder .............................................................23

2.3.10 PTZ Operation Flow .....................................................................................................24

2.3.11 Alarm Operation Flow ...................................................................................................25

3 EXPLANATION OF FUNCTION...................................................................................................26

3.1 FUNCTION CALLBACK ..............................................................................................................26

3.1.1 fDPSDKStatusCallback ..................................................................................................26

3.1.2 fDPSDK DeviceChangeCallback .....................................................................................26

3.1.3 .....................................................................................................................................27

3.1.4 fDPSDK DevStatusCallback ............................................................................................27

3.1.5 fMediaDataCallback .......................................................................................................27

3.1.6 fMediaDataComplete .....................................................................................................28

3.1.7 fDPSDKAlarmCallback...................................................................................................28

3/136
 3.1.8 fDPSDKOrgChangeCallback ..........................................................................................29

3.1.9 fDPSDKPersonChangeCallback .....................................................................................30

3.1.10 fDPS DKTrafficAlarmCallback ........................................................................................30

3.1.11 fDPS DKGetTrafficFlowCallback ....................................................................................31

3.1.12 fDPS DKGet DevTrafficFlowCallback ..............................................................................31

3.1.13 fDPS DKGetBayCarI nfoCallback ...................................................................................32

3.1.14 fDPS DKGetAreaSpeedDetectCallback ..........................................................................32

3.2 SDK INITIALIZATION .................................................................................................................33

3.2.1 DPSDK _Create .............................................................................................................33

3.2.2 DPSDK _Destroy............................................................................................................33

3.2.3 DPSDK _SetPlatformType...............................................................................................33

3.2.4 DPSDK _SetLog.............................................................................................................34

3.2.5 DPSDK _SetDPS DKStatusCallback.................................................................................34

3.2.6 DPSDK _InitExt ..............................................................................................................34

3.2.7 DPSDK _UnitExt ............................................................................................................35

3.3 USER L OGIN AND LOGOUT........................................................................................................35

3.3.1 DPSDK _Login ...............................................................................................................35

3.3.2 DPSDK _Logout .............................................................................................................36

3.3.3 DPSDK _GetUserI D .......................................................................................................36

3.4 O RGANIZATION D EVICE INFO ....................................................................................................36

3.4.1 DPSDK _SetDPS DKDevic eChangeCallback ....................................................................36

3.4.2 DPSDK _SetDPS DKDevic eStatusCallback ......................................................................37

3.4.3 DPSDK _LoadDGroupInfo...............................................................................................37

3.4.4 DPSDK _LoadDGroupInfoLayered ..................................................................................38

3.4.5 DPSDK _GetDGroupStr ..................................................................................................38

3.4.6 DPSDK _GetDGroupRootInfo..........................................................................................39

3.4.7 DPSDK _GetDGroupCount .............................................................................................39

3.4.8 DPSDK _GetDGroupInfo.................................................................................................39

3.4.9 DPSDK _GetChannelInfo ................................................................................................40

4/136
 3.4.10 DPS DK_GetDevStreamType ........................................................................................40

3.4.11 DPS DK_GetCameraIdbyDevInfo...................................................................................40

3.5 D EPARTMENT ZONE S TAFF I NFO ................................................................................................41

3.5.1 DPSDK _LoadOrgInfoByType..........................................................................................41

3.5.2 DPSDK _GetOrgCountB yType ........................................................................................42

3.5.3 DPSDK _GetOrgI nfoByType............................................................................................42

3.5.4 DPSDK _GetDeptAreaRelationCount ...............................................................................42

3.5.5 DPSDK _GetAllDeptAreaRelation ....................................................................................43

3.5.6 DPSDK _LoadAllP ersonInfo ............................................................................................43

3.5.7 DPSDK _GetPersonCountB yDept ...................................................................................44

3.5.8 DPSDK _GetPersonInfoByDept .......................................................................................44

3.5.9 DPSDK _SetDPS DKOrgChangeCallback.........................................................................44

3.5.10 DPS DK_Set DPSDKPersonChangeCallback ..................................................................45

3.6 G ENERAL INFO .......................................................................................................................45

3.6.1 DPSDK _GetRealStreamUrl ............................................................................................45

3.6.2 DPSDK _GetExternalRealStreamUrl ................................................................................46

3.6.3 DPSDK _SaveOptLog.....................................................................................................46

3.6.4 DPSDK _GetPeopleCount...............................................................................................47

3.7 R EAL-TIME S TREAM ................................................................................................................47

3.7.1 DPSDK _GetRealStream ................................................................................................47

3.7.2 DPSDK _CloseRealStreamByS eq ...................................................................................48

3.7.3 DPSDK _CloseRealStreamByCameraId ...........................................................................48

3.7.4 DPSDK _StartRealplay ...................................................................................................49

3.7.5 DPSDK _StopRealplayByS eq..........................................................................................49

3.7.6 DPSDK _StopRealplayByCameraId .................................................................................50

3.7.7 DPSDK _StartRecord......................................................................................................50

3.7.8 DPSDK _StopRecord......................................................................................................51

3.7.9 DPSDK _SetOsdTxt .......................................................................................................51

3.7.10 DPS DK_CleanUpOs dInfo.............................................................................................51

5/136
3.8 TALK .....................................................................................................................................52

3.8.1 DPSDK _GetTalk Stream .................................................................................................52

3.8.2 DPSDK _CloseTalk StreamBySeq ....................................................................................52

3.8.3 DPSDK _CloseTalk StreamByCameraI d ...........................................................................53

3.8.4 DPSDK _GetSdk AudioCallback Info .................................................................................53

3.8.5 DPSDK _StartTalk play ....................................................................................................54

3.8.6 DPSDK _StopTalk playB ySeq ..........................................................................................54

3.8.7 DPSDK _StopTalk playB yCameraId ..................................................................................55

3.9 R ECORD O PERATION...............................................................................................................55

3.9.1 DPSDK _Set MediaDataCompleteCallback .......................................................................55

3.9.2 DPSDK _QueryRecord ...................................................................................................56

3.9.3 DPSDK _GetRecordInf o .................................................................................................56

3.9.4 DPSDK _GetRecordStreamByFile ...................................................................................56

3.9.5 DPSDK _GetRecordStreamByTime .................................................................................57

3.9.6 DPSDK _Paus eRecordStreamB ySeq...............................................................................58

3.9.7 DPSDK _ResumeRec ordStreamB ySeq ............................................................................58

3.9.8 DPSDK _SetRecordStreamS peed ...................................................................................59

3.9.9 DPSDK _CloseRecordStreamB ySeq ...............................................................................59

3.9.10 DPS DK_CloseRecordStreamByCameraId .....................................................................59

3.9.11 DPS DK_StartPlayback ByFile ........................................................................................60

3.9.12 DPS DK_StartPlayback ByTime......................................................................................60

3.9.13 DPS DK_StartPlayback ByLocal .....................................................................................61

3.9.14 DPS DK_PausePlayback BySeq.....................................................................................61

3.9.15 DPS DK_ResumePlayback BySeq..................................................................................62

3.9.16 DPS DK_SetPlayback Speed .........................................................................................62

3.9.17 DPS DK_StopPlayback BySeq .......................................................................................63

3.9.18 DPS DK_StopPlayback ByCameraId ...............................................................................63

3.9.19 DPS DK_CloseRecordStreamByS eq ..............................................................................64

3.9.20 DPS DK_CloseRecordStreamByCameraId .....................................................................64

6/136
 3.9.21 DPS DK_GetFrameTime ...............................................................................................65

3.10 V IDEO A UX ..........................................................................................................................65

3.10.1 DPS DK_PicCapture .....................................................................................................65

3.10.2 DPS DK_GetColor ........................................................................................................65

3.10.3 DPS DK_AdjustColor ....................................................................................................66

3.10.4 DPS DK_OpenAudio.....................................................................................................66

3.10.5 DPS DK_GetVolume .....................................................................................................67

3.10.6 DPS DK_SetVolume .....................................................................................................67

3.11 P TZ O PERATION ...................................................................................................................68

3.11.1 DPS DK_PtzDirection....................................................................................................68

3.11.2 DPS DK_PtzCameraOperation ......................................................................................68

3.11.3 DPS DK_PtzSit .............................................................................................................69

3.11.4 DPS DK_PtzLock Camera ..............................................................................................69

3.11.5 DPS DK_PtzLightControl ...............................................................................................69

3.11.6 DPS DK_PtzRainBrushControl ......................................................................................70

3.11.7 DPS DK_PtzInfraredControl ...........................................................................................70

3.11.8 DPS DK_QueryPreP oint ................................................................................................71

3.11.9 DPS DK_PtzPreP oInfoperation ......................................................................................71

3.11.10 DPSDK _PtzExtendCommand .....................................................................................71

3.12 ALARM O PERATION ...............................................................................................................72

3.12.1 DPS DK_Set DPSDKAlarmCallback ...............................................................................72

3.12.2 DPS DK_EnableAlarm ..................................................................................................72

3.12.3 DPS DK_DisableAlarm ..................................................................................................73

3.12.4 DPS DK_QueryAlarmCount ...........................................................................................73

3.12.5 DPS DK_QueryAlarmInf o ..............................................................................................74

3.12.6 DPS DK_SendAlarmToServer .......................................................................................74

3.13 A NPR O PERATION................................................................................................................75

3.13.1 DPS DK_WriteTrafficViolationInfo ..................................................................................75

3.13.2 DPS DK_GetTrafficViolationInfo.....................................................................................75

7/136
 3.13.3 DPS DK_Set DPSDKTrafficAlarmCallback ......................................................................75

3.13.4 DPS DK_Set DPSDK GetTrafficFlowCallback...................................................................76

3.13.5 DPS DK_Set DPSDK GetDevTrafficFlowCallback .............................................................76

3.13.6 DPS DK_SubscribeTrafficFlow.......................................................................................77

3.13.7 DPS DK_Set DPSDK GetBayCarInfoCallback ..................................................................77

3.13.8 DPS DK_SubscribeBayCarInfo ......................................................................................77

3.13.9 DPS DK_SubscribeAreaSpeedDetectInfo .......................................................................78

3.13.10 DPSDK _SetDPS DKGetAreaS peedDetectCallback ......................................................78

3.14 TV W ALL OPERATION ............................................................................................................79

3.14.1 DPS DK_QueryTvWallList .............................................................................................79

3.14.2 DPS DK_GetTvWallList.................................................................................................79

3.14.3 DPS DK_QueryTvWallLayout ........................................................................................80

3.14.4 DPS DK_GetTvWallLayout ............................................................................................80

3.14.5 DPS DK_SetTvWallScreenSplit .....................................................................................80

3.14.6 DPS DK_SetTvWallScreenWindowS ourc e .....................................................................81

3.14.7 DPS DK_CloseTvWallScreenWindowS ource ..................................................................81

3.14.8 DPS DK_ClearTvWallScreen.........................................................................................82

4 DATA STRUCTURE EXPLANATION ...........................................................................................83

4.1 FUNCTION R ETURN ERROR DPSDK_ RETVAL_E.............................................................................83

4.2 EXAMPLE ..............................................................................................................................95

4.2.1 SDK Type......................................................................................................................95

4.2.2 SDK Status Type ...........................................................................................................95

4.2.3 Platform Type ................................................................................................................95

4.2.4 Log Level ......................................................................................................................95

4.2.5 Operation Type ..............................................................................................................96

4.2.6 Protocol Library Version .................................................................................................96

4.2.7 Obtain Node Type ..........................................................................................................96

4.2.8 Obtain Organization Type ...............................................................................................97

4.2.9 Obtain Node Depth ........................................................................................................97

8/136
 4.2.10 Node Change Notice Type............................................................................................98

4.2.11 Organization Notice Type..............................................................................................98

4.2.12 Channel Right Check ...................................................................................................99

4.2.13 Stream Type ................................................................................................................99

4.2.14 Device Manufacturer Type ............................................................................................99

4.2.15 Media Type..................................................................................................................99

4.2.16 Transmission Type ..................................................................................................... 100

4.2.17 Stream Output Load Type........................................................................................... 100

4.2.18 Stream Video Resolution Type .................................................................................... 100

4.2.19 Video Encoding Format .............................................................................................. 101

4.2.20 Audio Type ................................................................................................................ 101

4.2.21 Bit ............................................................................................................................. 101

4.2.22 Sampling Rate ........................................................................................................... 101

4.2.23 Device Type .............................................................................................................. 102

4.2.24 Picture Type .............................................................................................................. 102

4.2.25 Video Source Type..................................................................................................... 102

4.2.26 Record Type .............................................................................................................. 102

4.2.27 Record Stream Request Type ..................................................................................... 103

4.2.28 Record Stream Speed Type ........................................................................................ 103

4.2.29 PTZ Direction Command ............................................................................................ 103

4.2.30 PTZ Picture Command ............................................................................................... 104

4.2.31 PTZ Lock Type .......................................................................................................... 104

4.2.32 PTZ Pres et Opration Type .......................................................................................... 104

4.2.33 PTZ Extension Command .......................................................................................... 105

4.2.34 Alarm Type ................................................................................................................ 106

4.2.35 Alarm Occurence Type ............................................................................................... 111

4.2.36 Alarm Processing Type............................................................................................... 111

4.2.37 TV Wall Split Capability .............................................................................................. 111

4.3 STRUCTURE TYPE EXPLANATION ............................................................................................. 112

9/136
4.3.1 Login Info .................................................................................................................... 112

4.3.2 Organiz ation Info ......................................................................................................... 112

4.3.3 Device Info .................................................................................................................. 112

4.3.4 Encode Channel Info ................................................................................................... 112

4.3.5 Load Organization Request Info by Level ...................................................................... 113

4.3.6 Get Organization Quantity Request Info ........................................................................ 113

4.3.7 Get Organization Request Info ..................................................................................... 113

4.3.8 Channel Organization Node Info ................................................................................... 114

4.3.9 Get General Organization Quantity Request Info ........................................................... 114

4.3.10 Get General Organization Request Info ....................................................................... 114

4.3.11 Department Zone Relation Info ................................................................................... 115

4.3.12 Get Department Zone Relation Request Info ............................................................... 115

4.3.13 Department Staff Info ................................................................................................. 115

4.3.14 Get Department Staff Request Info.............................................................................. 116

4.3.15 Get Channel Request Info .......................................................................................... 116

4.3.16 Get Device Support ed Stream .................................................................................... 116

4.3.17 Get Media StreamUrl Reuqested Info .......................................................................... 116

4.3.18 Get Out ward Media Stream Url Requested Info ........................................................... 117

4.3.19 Obtain Stream Info ..................................................................................................... 117

4.3.20 Get Report People Flow Info....................................................................................... 118

4.3.21 Get Audio Stream Info ................................................................................................ 118

4.3.22 Audio Sampling Callback User Info ............................................................................. 118

4.3.23 Searc Record Info ...................................................................................................... 118

4.3.24 Single Video Info........................................................................................................ 119

4.3.25 Record Info ............................................................................................................... 119

4.3.26 Obtain Record Stream Info by File .............................................................................. 119

4.3.27 Obtain Record Stream Info by Time ............................................................................ 120

4.3.28 Video Image Propert Info............................................................................................ 120

4.3.29 Vehicle Violation Picture Info ...................................................................................... 120

10/136
4.3.30 Violation Alarm Data Structure Info .............................................................................. 121

4.3.31 Channel Traffic Flow Report Data Structure Info ........................................................... 122

4.3.32 Lane Traffic Flow Report Data Structure Info ................................................................ 123

4.3.33 Device Traffic Flow Report Data Structure Info ............................................................. 124

4.3.34 ANPR B ypass Report Data Structure Info .................................................................... 124

4.3.35 Zone Speed Measure Report Info ............................................................................... 125

4.3.36 Code Channel Info ..................................................................................................... 127

4.3.37 Subscription Flow Request Info................................................................................... 127

4.3.38 Subcribe ANPR Bypass Info Request Info ................................................................... 127

4.3.39 PTZ Direction Info ...................................................................................................... 128

4.3.40 PTZ Picture Command Info ........................................................................................ 128

4.3.41 PTZ 3D Location Info ................................................................................................. 128

4.3.42 PTZ Lock Info ............................................................................................................ 128

4.3.43 PTZ Open Command Info .......................................................................................... 129

4.3.44 Single Preset Info ...................................................................................................... 129

4.3.45 PTZ Pres et Info ......................................................................................................... 129

4.3.46 PTZ Pres et Operation Info .......................................................................................... 129

4.3.47 PTZ Extension Command Info .................................................................................... 130

4.3.48 Single Alarm Plan ...................................................................................................... 130

4.3.49 Alarm Plan ................................................................................................................ 130

4.3.50 Search Alarm Info ...................................................................................................... 130

4.3.51 Single Alarm Info ....................................................................................................... 131

4.3.52 Alarm Info.................................................................................................................. 131

4.3.53 Client Alarm Report Info ............................................................................................. 131

4.3.54 Single TV Wall Info .................................................................................................... 132

4.3.55 TV Wall List Info......................................................................................................... 132

4.3.56 TV Wall Info............................................................................................................... 132

4.3.57 TV Wall Layout Info.................................................................................................... 132

4.3.58 TV Wall Split Info ....................................................................................................... 133

11/136
 4.3.59 TV Wall Window Setup Video Source .......................................................................... 133

4.3.60 TV Wall Window Close Video Source .......................................................................... 133

4.4 MACOR D EFINITION............................................................................................................... 134

12/136
1 Introduction

1.1 Summary

Zhejiang Dahua platform SDK (“platform SDK”) is a complementary of Dahua DSS platform
includes further-development port for platform-related business. This manual shows port
description and procedure relevant to each business in detail. It is suitable for business of the
following platform product:
DSS-7016 Series
DSS3.0-Safe City Series
DSS3.0-Finance Series

1.2 Core Function

Core function includes:

 Platform login/logout
 Receive device info
 Real-time preview and related operation
 PTZ control. Including 8-direction PTZ control, camera attribute control and etc.
 Video playback and related operation
 Alarm control, including arm/disarm alarm, real-time alarm detection, alarm
history and etc.
The whole platform SDK will be provided in form of dynamic link library, including
platform business dynamic library and extention business library focuses on
play-related business.

13/136
2 Programming

2.1 Directory

Currently platform SDK only supports 32-bit Window system. The entire development kit
includes header, lib file, dll file and config file. Directory structure is as in Figure 2- 1:

Figure 2- 1

Demo includes platform SDK’s reference Demo which can be opened via VS2005.

Dll directory has two folderd: Debug and Release, which contains platform SDK files,
Dpsdk_Core.dll, Dpsdk_Ext.dll and other Dll related files. Copy files in these two Dll folders to
running directory. (For different versions, copy to their corresponding directories.)

Include includes platform SDK’s hearder and copy all files in Include to header (and related
folder) in installation directory.

Lib includes platform SDK static link library file and copy all files in Lib to additional directory of
installation directoty.

2.2 User Commitment

 DPSDK_Create is required to be called once. We do not recommend you to create too

many copies. When you re-create, you need to release via calling DPSDK_Destroy.

 All input variables as parameter must be initialized externally.

 All function direct return can be used to judge if it is successfully or not. Please refer to
dpsdk_error_type_e.

 Function call that interact with service are sync process, and default is 10s.

 All callback function (system status callback, alarm call back function) cannot block
platform sdk progress.

14/136
2.3 Operation Flow

2.3.1 Login Flow

Figure 2- 2

Description of Flow:

 The blue area means mandatory function and tallow area means optinal function. (These
are the same for the following diagrams.)

 User log in platform sdk and will be automatically connected to server.

 Platform sdk already has re-connection function, so after re-connected, if user registered
for status callback, then platform sdk will call back platform status to user. User can call
back without DPSDK_Login.

15/136
2.3.2 Device Info Loading and Obtaining

Figure 2- 3

Description of Flow:

 After loading device info, you can perform other operations and obtain device info string
optional.

 Organization device info string is xml format, readable, user can use xml analysis tool.

16/136
2.3.3 By-level Device Info Loading and Getting

Figure 2- 4

Description of Flow:

 Loading by level must load according to node sequence, or load all nodes at once (refer to
device info loading and getting).

 To get node sub info, please ensure the node is loaded first (for both by-level and all).

17/136
2.3.4 Real-time Operation Flow with Decoder

Figure 2- 5

Description of Flow:

 Before decoding, create window handle. After play successfully, you may view rea l-time
video in thw window.

 You can close video via SN request and channel no. If via channel no., then video in
window with multiple requests will be closed.

18/136
2.3.5 Real-time Operation Flow without Decoder

Figure 2- 6

19/136
2.3.6 Record Operation Flow by File with Decoder

Figure 2- 7

 Before playing record by file, you must search record and obtain the result as parameter
request to play.

20/136
  Set media data end call only needs to be done once.

2.3.7 Record Operation Flow by Time with Decoder

Figure 2- 8

21/136
  Before playing record by time, you do not need to search record.

2.3.8 Record Operation Flow by File without Decoder

Figure 2- 9

 After requesting record and before closing record, you may perform record-related
operation.

 Before requesting record by file, you must search record.

22/136
2.3.9 Record Operation Flow by Time without Decoder

Figure 2- 10

 After requesting record and before closing record, you may perform record-related
operation.

 Before requesting record by time, you do not need to search record.

23/136
2.3.10 PTZ Operation Flow

Figure 2- 11

24/136
2.3.11 Alarm Operation Flow

Figure 2- 12

25/136
3 Explanation of Function

3.1 Function Callback

3.1.1 fDPSDKStatusCallback
Function typedef int32_t (DPSDK_CALLTYPE *fDPSDKStatusCallback)
Name ( IN int32_t nPDLLHandle,
IN int32_t nStatus,
IN void* pUserParam );
Function DPSDK status callback
Descripti
on
Paramet nPDLLHandle Sdk handle
er nStatus Media type, refer
todpsdk_status_type_e
pUserParam User parameter
Return Null
Value

3.1.2 fDPSDKDeviceChangeCallback
Function typedef int32_t (DPSDK_CALLTYPE *fDPSDKDeviceChangeCallback)
Name ( IN int32_t nPDLLHandle,
IN uint32_t nChangeType,
IN const char* szDeviceId,
IN const char* szDepCode,
IN const char* szNewDepCode,
IN void* pUserParam );
Function DPSDK status callback
Descripti
on
Paramet nPDLLHandle sdk handle
er nChangeType Node change notice type, refer to
dpsdk_change_type_e
szDeviceId Device Id，
szDepCode Organization Id
szNewDepCode New organization Id
pUserParam User parameter
 Reture Null
Value

3.1.3
3.1.4 fDPSDKDevStatusCallback
Function typedef int32_t (DPSDK_CALLTYPE *fDPSDKStatusCallback)
Name ( IN int32_t nPDLLHandle,
IN const char* szDeviceId,
IN int32_t nStatus,
IN void* pUserParam );
Function DPSDK status callback
Descripti
on
Paramet nPDLLHandle sdk handle
er szDeviceId DeviceID
nStatus Media type , refer to
dpsdk_status_type_e
pUserParam User parameter
Return Null
Value

3.1.5 fMediaDataCallback
Function typedef int32_t (DPSDK_CALLTYPE *fMediaDataCallback)
Name ( IN int32 nPDLLHandle,
IN int32_t nSeq,
IN int32_t nMediaType,
IN const char* szNodeId,
IN int32_t nParamVal,
IN char* szData,
IN int32_t nDataLen,
IN void* pUserParam);
Function Media data callback
Descripti
on
nPDLLHandle sdk handle
Paramet
nSeq Corresponding request return no.
er
nMediaType Media type , refer to
dpsdk_media_type_e
szNodeId Data corresponding channel /DeviceID

27/136
 nParamVal Extented value;media type real, refer
to dpsdk_stream_type_e;
szData Media stream data
nDataLen Data length
pUserParam User parameter
Return Null
Value

3.1.6 fMediaDataComplete
Function typedef int32_t (DPSDK_CALLTYPE *fMediaDataComplete)
Name ( IN int32nPDLLHandle,
IN int32_t nSeq,
IN int32_t nMediaType,
IN const char* szNodeId,
IN int32_t nParamVal,
IN void* pUserParam);
Function Media data end callback
Descripti
on
nPDLLHandle sdk handle
Paramet
nSeq Corresponding request return no.
er
nMediaType Media type , refer to
dpsdk_media_type_e
szNodeId Data corresponding channel/DeviceID
nParamVal Extended value;mediaType为real时,
refer to dpsdk_stream_type_e;
pUserParam User parameter
Return Null
Value

3.1.7 fDPSDKAlarmCallback
Function typedef int32_t (DPSDK_CALLTYPE *fDPSDKAlarmCallback)
Name ( IN int32nPDLLHandle,
IN const char* szAlarmId,
IN uint32_t nDeviceType,
IN const char* szCameraId,
IN const char* szDeviceName,
IN const char* szChannelName,
IN const char* szCoding,

28/136
 IN const char* szMessage,
IN uint32_t nAlarmType,
IN uint32_t nEventType,
IN uint32_t nLevel,
IN int64_t nTime,
IN char* pAlarmData,
IN uint32_t nAlarmDataLen,
IN char* pPicData,
IN uint32_t nPicDataLen,
IN void* pUserParam);
Function Alarm callback
Descripti
on
nPDLLHandle Sdk handle
Paramet
szAlarmId Alarm Id
er
nDeviceType Device type
szCameraId Channel Id
szDeviceName Device name
szChannelName Channel name
szCoding Code
szMessage Alarm message
nAlarmType Alarm type refer to
dpsdk_alarm_type_e
nEventType Event type, refer to
dpsdk_event_type_e
nLevel Alarm level
nTime Alarm time
pAlarmData Alarm data
nAlarmDataLen Alarm data length
pPicData Picture data
nPicDataLen Picture data length
pUser User data
Return Null
Value

3.1.8 fDPSDKOrgChangeCallback
Function typedef int32_t (DPSDK_CALLTYPE *fDPSDKOrgChangeCallback)
Name ( IN int32_t nPDLLHandle,
IN uint32_t nChangeType,
IN uint32_t nCount,
IN Org_Info_t* pOrgInfo,
IN void* pUserParam );

29/136
 Function Organization modify notice port
Descripti
on
nPDLLHandle sdk handle
Paramet
nChangeType Node modify notice type, refer to
er
dpsdk_dsst_change_type_e
nCount Change organization quantity
pOrgInfo Modify node record, refer to
Org_Info_t
pUserParam User parameter

Return Null
Value

3.1.9 fDPSDKPersonChangeCallback
Function typedef int32_t (DPSDK_CALLTYPE *fDPSDKPersonChangeCallback)
Name ( IN int32_t nPDLLHandle,
IN uint32_t nChangeType,
IN uint32_t nCount,
IN Person_Info_t* pPersonInfo,
IN void* pUserParam );
Function Organization modify notice port
Descripti
on
Paramet nPDLLHandle sdk handle
er nChangeType Node modify notice type, refer to
dpsdk_dsst_change_type_e
nCount Modify record quantity
pPersonInfo Mopdify node record, refer to
Person_Info_t
pUserParam User parameter
Return Null
Value

3.1.10 fDPSDKTrafficAlarmCallback
Function typedef int32_t (DPSDK_CALLTYPE *fDPSDKTrafficAlarmCallback)
Name ( IN int32_t nPDLLHandle,
IN Traffic_Alarm_Info_t* pRetInfo,
IN void* pUserParam );
Function Vehicle violation report callback

30/136
 Descripti
on
Paramet nPDLLHandle sdk handle
er pRetInfo Violation info, refer to
Traffic_Alarm_Info_t
pUserParam User parameter
Return Null
Value

3.1.11 fDPSDKGetTrafficFlowCallback
Function typedef int32_t (DPSDK_CALLTYPE *fDPSDKGetTrafficFlowCallback)
Name ( IN int32_t nPDLLHandle,
IN TrafficFlow_Info_t* pRetInfo,
IN void* pUserParam );
Function Flow report callback, this flow is counted by PTS
Descripti
on
Paramet nPDLLHandle sdk handle
er pRetInfo Reported device flow info, refer to
TrafficFlow_Info_t
pUserParam User parameter
Return Null
Value

3.1.12 fDPSDKGetDevTrafficFlowCallback
Function typedef int32_t (DPSDK_CALLTYPE
Name *fDPSDKGetDevTrafficFlowCallback)
( IN int32_t nPDLLHandle,
IN DevTrafficFlow_Info_t* pRetInfo,
IN void* pUserParam );
Function Lane flow status report callback, this flow is reported by device.
Descripti
on
Paramet nPDLLHandle sdk handle
er pRetInfo Reported lane flow status info, refer to
DevTrafficFlow_Info_t
pUserParam User parameter
Return Null

31/136
 Value

3.1.13 fDPSDKGetBayCarInfoCallback
Function typedef int32_t (DPSDK_CALLTYPE *fDPSDKGetBayCarInfoCallback)
Name ( IN int32_t nPDLLHandle,
IN Bay_Car_Info_t* pRetInfo,
IN void* pUserParam );
Function ANPR passby vehicle info report callback function definition
Descripti
on
Paramet nPDLLHandle sdk handle
er pRetInfo Reported lane flow status info, refer to
Bay_Car_Info_t
pUserParam User parameter
Return Null
Value

3.1.14 fDPSDKGetAreaSpeedDetectCallback
Function typedef int32_t
Name (DPSDK_CALLTYPE *fDPSDKGetAreaSpeedDetectCallback)
( IN int32_t nPDLLHandle,
IN Area_Detect_Info_t* pRetInfo,
IN void* pUserParam );
Function ANPR passby vehicle info report callback definition
Descripti
on
Paramet nPDLLHandle sdk handle
er pRetInfo Reported lane flow status info, refer to
Area_Detect_Info_t
pUserParam User parameter
Return Null
Value

32/136
3.2 Sdk Initialization

3.2.1 DPSDK_Create
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HODDPSDK_Create
Name ( IN dpsdk_sdk_type_e nType,
OUT int32_t& nPDLLHandle );
Function Create sdk handle
Descripti
on
Paramet nType SDK type, refer to
er dpsdk_sdk_type_e
nPDLLHandle Return sdk handle
Return Error code, refer to dpsdk_retval_e
Value

3.2.2 DPSDK_Destroy
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD DPSDK_Destroy
Name ( IN int32_t nPDLLHandle );
Function Destroy sdk handle
Descripti
on
nPDLLHandle Sdk handle
Return Error code, refer to dpsdk_retval_e
Value

3.2.3 DPSDK_SetPlatformType
Function DPSDK_DLL_API int32_t PSDK_CALL_METHOD
Name DPSDK_SetPlatformType(IN int32_t& nPDLLHandle,
IN dpsdk_core_platform_type_e nType );
Function Set platform type（This port is reserved, and notice will be released in
Descripti case of change.）
on
Paramet nPDLLHandle Sdk handle
er dpsdk_core_platform_type_e Platform type
Return Error code, refer to dpsdk_retval_e
Value

33/136
3.2.4 DPSDK_SetLog
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HODDPSDK_SetLog
Name ( IN int32_t nPDLLHandle,
IN dpsdk_log_level_e nLevel,
IN const char* szFilename,
IN bool bScreen,
IN bool bDebugger );
Function Set log
Descripti
on
Paramet nPDLLHandle Sdk handle
er nLevel Log level. Refer to dpsdk_log_level_e
szFilename File name
bScreen Output to screen or not
bDebugger Output to debugger or not
Return Error code, refer to dpsdk_retval_e
Value

3.2.5 DPSDK_SetDPSDKStatusCallback
Function DPSDK_DLL_API int32_t
Name DPSDK_CALL_MET HODDPSDK_SetDPSDKStatusCallback
( IN int32_t nPDLLHandle,
IN fDPSDKStatusCallback fun,
IN void* pUser);
Function Set DPSDK status callback
Descripti
on
Paramet nPDLLHandle Sdk handle
er fun Callback function, refer to
DPSDKStatusCallback
pUser User parameter
Return Error code, refer to dpsdk_retval_e
Value

3.2.6 DPSDK_InitExt
Function DPSDK_EXT_API int32_t DPSDK_EXT_CALL_MET HOD
Name DPSDK_InitExt

34/136
 ( void );
Function Initialization extension library
Descripti
on
Return Error code, refer to dpsdk_retval_e
Value

3.2.7 DPSDK_UnitExt
Function DPSDK_EXT_API int32_t DPSDK_EXT_CALL_MET HOD
Name DPSDK_UnitExt
( void );
Function Anti-initialization extension library
Descripti
on
Return Error code, refer to dpsdk_retval_e
Value

3.3 User Login and Logout

3.3.1 DPSDK_Login
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD DPSDK_Login
Name ( IN int32_t nPDLLHandle,
IN Login_Info_t* pLoginInfo,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT
);
Function User login
Descripti
on
Paramet nPDLLHandle Sdk handle
er pLoginInfo Login info, refer to Login_Info_t
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

35/136
3.3.2 DPSDK_Logout
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD DPSDK_Logout
Name ( IN int32_t nPDLLHandle,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function User logout
Descripti
on
Paramet nPDLLHandle Sdk handle
er nTimeout Ovetrime default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.3.3 DPSDK_GetUserID
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD DPSDK_GetUserID
Name ( IN int32_t nPDLLHandle,
OUT uint32_t& nUserId );
Function Obtain user ID
Descripti
on
Paramet nPDLLHandle Sdk handle
er nUserId Return user ID
Return Error code, refer to dpsdk_retval_e
Value

3.4 Organization Device Info

3.4.1 DPSDK_SetDPSDKDeviceChangeCallback
Function DPSDK_DLL_API int32_t
Name DPSDK_CALL_MET HODDPSDK_SetDPSDKDeviceChangeCallback
( IN int32_t nPDLLHandle,
IN fDPSDKDeviceChangeCallback fun,
IN void* pUser);
Function Set DPSDK status callback
Descripti
on
Paramet nPDLLHandle Sdk handle

36/136
 er fun Callback function, refer to
fDPSDKDeviceChangeCallback
pUser User parameter
Function Error code, refer to dpsdk_retval_e
Descripti
on

3.4.2 DPSDK_SetDPSDKDeviceStatusCallback
Function DPSDK_DLL_API int32_t
Name DPSDK_CALL_MET HODDPSDK_SetDPSDKDeviceStatusCallback
( IN int32_t nPDLLHandle,
IN fDPSDKDeviceChangeCallback fun,
IN void* pUser);
Function Set DPSDK status callback
Descripti
on
Paramet nPDLLHandle Sdk handle
er fun Callback function, refer to
fDPSDKDeviceChangeCallback
pUser User parameter
Function Error code，refer to dpsdk_retval_e
Descripti
on

3.4.3 DPSDK_LoadDGroupInfo
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_LoadDGroupInfo
( IN int32_t nPDLLHandle,
OUT int32_t& nGroupLen,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Load organizational info
Descripti
on
Paramet nPDLLHandle Sdk handle
er nGroupLen Return organizational device info string
size
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e

37/136
 Value

3.4.4 DPSDK_LoadDGroupInfoLayered
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_LoadDGroupInfoLayered
( IN int32_t nPDLLHandle,
IN Load_Dep_Info_t* pGetInfo,
OUT int32_t& nGroupLen,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function By level load organization info
Descripti
on
Paramet nPDLLHandle Sdk handle
er pGetInfo By level obtain node info
nGroupLen Organization device info string size
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.4.5 DPSDK_GetDGroupStr
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_GetDGroupStr
( IN int32_t nPDLLHandle,
OUT char* szGroupBuf,
IN int32_t nGroupLen,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Obtain organizational info
Descripti
on
Paramet nPDLLHandle Sdk handle
er szGroupBuf Return organizational structure info
string
nGroupLen Organizational device info string size
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

38/136
3.4.6 DPSDK_GetDGroupRootInfo
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_GetDGroupRootInfo
( IN int32_t nPDLLHandle,
INOUT Get_Dep_Info_t* pGetInfo );
Function Get organization sub organization and sub device info
Descripti
on
Paramet nPDLLHandle Sdk handle
er pGetInfo Get organization request info, refer to
Get_Dep_Info_t
Return Error code, refer to dpsdk_retval_e
Value

3.4.7 DPSDK_GetDGroupCount
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_GetDGroupCount
( IN int32_t nPDLLHandle,
INOUT Get_Dep_Count_Info_t* pGetInfo );
Function Get organization sub organization and sub device quantity
Descripti
on
Paramet nPDLLHandle Sdk handle
er pGetInfo Get organization quantity request info,
refer to Get_Dep_Count_Info_t
Return Error code, refer to dpsdk_retval_e
Value

3.4.8 DPSDK_GetDGroupInfo
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_GetDGroupInfo
( IN int32_t nPDLLHandle,
INOUT Get_Dep_Info_t* pGetInfo );
Function Get organization sub organization and sub device info
Descripti
on
Paramet nPDLLHandle Sdk handle

39/136
 er pGetInfo Get organization request info, refer to
Get_Dep_Info_t
Return Error code, refer to dpsdk_retval_e
Value

3.4.9 DPSDK_GetChannelInfo
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_GetChannelInfo
( IN int32_t nPDLLHandle,
INOUT Get_Channel_Info_t* pGetInfo );
Function Get device channel info
Descripti
on
Paramet nPDLLHandle Sdk handle
er pGetInfo Sub channel request info refer to
Get_Channel_Info_t
Return Error code, refer to dpsdk_retval_e
Value

3.4.10 DPSDK_GetDevStreamType
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_GetDevStreamType
( IN int32_t nPDLLHandle,
INOUT Get_Dev_StreamType_Info_t* pGetInfo );
Function Get device supported bis stream type
Descripti
on
Paramet nPDLLHandle Sdk handle
er pGetInfo Get info, refer to
Get_Dev_StreamType_Info_t
Return Error code, refer to dpsdk_retval_e
Value

3.4.11 DPSDK_GetCameraIdbyDevInfo
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD DPSDK_
Name GetCameraIdbyDevInfo
(IN int32_t nPDLLHandle,
IN const char* szDevIp,

40/136
 IN const int nPort,
IN const int nChnlNum,
OUT char* szCameraId,
IN dpsdk_dev_unit_type_e nUnitType = DPSDK_DEV_UNIT_ENC);
Function Via device IP and port plus channel to get channel code
Descripti
on
Paramet nPDLLHandle Sdk handle
er szDevIp Device IP
nPort Device port
nChnlNum Channel no.
szCameraId Channel ID, output value
nUnitType Unit type, refer to
dpsdk_dev_unit_type_e
Return Error code, refer to dpsdk_retval_e
Value

3.5 Department Zone Staff Info

3.5.1 DPSDK_LoadOrgInfoByType
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_LoadOrgInfoByType
( IN int32_t nPDLLHandle,
IN dpsdk_org_node_e type,
OUT int32_t& nOrgCount,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT);
Function Load sprcific type of node organization info, including organization,
Descripti department, monitoring zone and district.
on
Paramet nPDLLHandle sdk handle
er type General node type, refer to
dpsdk_org_node_e
nOrgCount Return organization info quantity
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

41/136
3.5.2 DPSDK_GetOrgCountByType
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_GetOrgCountByType
( IN int32_t nPDLLHandle,
IN dpsdk_org_node_e type,
INOUT Get_Org_Count_Info_t* pGetInfo );
Function Get specific type of organization sub organization quantity
Descripti
on
Paramet nPDLLHandle sdk handle
er type Node type, refer to
dpsdk_org_node_e
pGetInfo Get organization quantity request info,
refer to Get_Org_Count_Info_t
Return Error code, refer to dpsdk_retval_e
Value

3.5.3 DPSDK_GetOrgInfoByType
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_GetOrgInfoByType
( IN int32_t nPDLLHandle,
IN dpsdk_org_node_e type,
INOUT Get_Org_Info_t* pGetInfo);
Function Get organization sub organization info
Descripti
on
Paramet nPDLLHandle sdk handle
er type Node type, refer to
dpsdk_org_node_e
pGetInfo Get organization request info, refer to
Get_Org_Info_t
Return Error code, refer to dpsdk_retval_e
Value

3.5.4 DPSDK_GetDeptAreaRelationCount
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_GetDeptAreaRelationCount

42/136
 ( IN int32_t nPDLLHandle,
OUT int32_t& nCount,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT);
Function Get department and zone relationship record
Descripti
on
Paramet nPDLLHandle sdk handle
er nCount Department and zone relationship
record
type Node type, refer to
dpsdk_org_node_e
Return Error code, refer to dpsdk_retval_e
Value

3.5.5 DPSDK_GetAllDeptAreaRelation
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_GetAllDeptAreaRelation
( IN int32_t nPDLLHandle,
INOUT Get_DeptArea_Relation_t* pGetInfo);
Function Get department and zone relationship record
Descripti
on
Paramet nPDLLHandle sdk handle
er pGetInfo Get department and zone relationship
request info, refer to
Get_DeptArea_Relation_t
Return Error code, refer to dpsdk_retval_e
Value

3.5.6 DPSDK_LoadAllPersonInfo
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_LoadAllPersonInfo
( IN int32_t nPDLLHandle,
OUT int32_t& nPersonCount,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT);
Function Load department or zone all staff info
Descripti
on
Paramet nPDLLHandle sdk handle

43/136
 er nPersonCount All staff quantity
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.5.7 DPSDK_GetPersonCountByDept
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_GetPersonCountByDept
( IN int32_t nPDLLHandle,
IN char* szDeptCode,
OUT int32_t& nPersonCount)
Function Load specific department or zone all staff quantity
Descripti
on
Paramet nPDLLHandle sdk handle
er szDeptCode Department no.
nPersonCount Staff quantity
Return Error code, refer to dpsdk_retval_e
Value

3.5.8 DPSDK_GetPersonInfoByDept
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_GetPersonInfoByDept
( IN int32_t nPDLLHandle,
INOUT Get_Person_Info_t * pGetInfo);
Function Get department staff info
Descripti
on
Paramet nPDLLHandle sdk handle
er pGetInfo Staff info, refer to Get_Person_Info_t
Return Error code, refer to dpsdk_retval_e
Value

3.5.9 DPSDK_SetDPSDKOrgChangeCallback
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_SetDPSDKOrgChangeCallback
( IN int32_t nPDLLHandle,

44/136
 IN fDPSDKOrgChangeCallback fun,
IN void* pUser);
Function Set organization node to modify callback function
Descripti
on
Paramet nPDLLHandle sdk handle
er fun Callback function, refer to
fDPSDKOrgChangeCallback
pUser User parameter
Return Error code, refer to dpsdk_retval_e
Value

3.5.10 DPSDK_SetDPSDKPersonChangeCallback
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_SetDPSDKPersonChangeCallback
( IN int32_t nPDLLHandle,
IN fDPSDKPersonChangeCallback fun,
IN void* pUser);
Function Set organization node to modify call function
Descripti
on
Paramet nPDLLHandle sdk handle
er fun Callback function, refer to
fDPSDKPersonChangeCallback
pUser User parameter
Return Error code, refer to dpsdk_retval_e
Value

3.6 General Info

3.6.1 DPSDK_GetRealStreamUrl
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_GetRealStreamUrl
( IN int32_t nPDLLHandle,
INOUT Get_RealStreamUrl_Info_t* pRealStreamUrlInfo,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Get media string URL
Descripti

45/136
 on
Paramet nPDLLHandle sdk handle
er pRealStreamUrlInfo Get Url required info, refer to
Get_RealStreamUrl_Info_t
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.6.2 DPSDK_GetExternalRealStreamUrl
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_GetExternalRealStreamUrl
( IN int32_t nPDLLHandle,
INOUT Get_ExternalRealStreamUrl_Info_t* pRealStreamUrlInfo,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Get DSS platform outward media string URL
Descripti
on
Paramet nPDLLHandle sdk handle
er pRealStreamUrlInfo Get Url required info, refer to
Get_ExternalRealStreamUrl_Info_t
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.6.3 DPSDK_SaveOptLog
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_SaveOptLog
( IN int32_t nPDLLHandle,
IN const char* szCameraId,
IN uint64_t optTime,
IN dpsdk_log_optType_e optType,
IN const char* optDesc);
Function Save operator log
Descripti
on
Paramet nPDLLHandle sdk handle
er szCameraId Channel no.
optTime Operation time
optType Operation type

46/136
 optDesc Operation description, refer to
dpsdk_log_optType_e
Return Error code, refer to dpsdk_retval_e
Value

3.6.4 DPSDK_GetPeopleCount
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_GetPeopleCount
( IN int32_t nPDLLHandle,
IN Get_People_Count_t* pGetPCount,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Count people flow info
Descripti
on
Paramet nPDLLHandle sdk handle
er pGetPCount People flow info, refer to
Get_People_Count_t
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.7 Real-time Stream

3.7.1 DPSDK_GetRealStream
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_GetRealStream
( IN int32_t nPDLLHandle,
OUT int32_t& nRealSeq,
IN Get_RealStream_Info_t* pGetInfo,
IN fMediaDataCallback pFun,
IN void* pUser,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT);
Function Obtain real-time stream
Descripti
on
Paramet nPDLLHandle Sdk handle
er nRealSeq Return real-time sn, may use in

47/136
 real-time operation
pGetInfo Request info, refer to
Get_RealStream_Info_t
pFun Stream callback, refer to
fMediaDataCallback
pUser User callback parameter
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.7.2 DPSDK_CloseRealStreamBySeq
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_CloseRealStreamBySeq
( IN int32_t nPDLLHandle,
IN int32_t nRealSeq,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Close real-time stream according to request sn
Descripti
on
Paramet nPDLLHandle Sdk handle
er nRealSeq Real-time sn
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.7.3 DPSDK_CloseRealStreamByCameraId
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_CloseRealStreamByCameraId
( IN int32_t nPDLLHandle,
IN const char* szCameraId,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Close real-time stream according to channel no.
Descripti
on
Paramet nPDLLHandle sdk handle
er szCameraId Channel no.
nTimeout Overtime, default

48/136
 DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.7.4 DPSDK_StartRealplay
Function DPSDK_EXT_API int32_t DPSDK_EXT_CALL_MET HOD
Name DPSDK_StartRealplay
( IN int32_t nPDLLHandle,
OUT int32_t& nRealSeq,
IN Get_RealStream_Info_t* pGetInfo,
IN void* hDestWnd,
IN int32_t nTimeout = DPSDK_EXT_DEFAULT_TIMEOUT);
Function Play real-time stream
Descripti
on
Paramet nPDLLHandle sdk handle
er nRealSeq Return real-time sn, may use in
real-time operation
pGetInfo Request info, refer to
Get_RealStream_Info_t
hDestWnd Window handle
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.7.5 DPSDK_StopRealplayBySeq
Function DPSDK_EXT_API int32_t DPSDK_EXT_CALL_MET HOD
Name DPSDK_StopRealplayBySeq
( IN int32_t nPDLLHandle,
IN int32_t nRealSeq,

IN int32_t nTimeout = DPSDK_EXT_DEFAULT_TIMEOUT );

Function Close playing real-time stream according to request sn
Descripti
on
Paramet nPDLLHandle sdk handle
er nRealSeq Return real-time sn, may use in
real-time operation

49/136
 nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.7.6 DPSDK_StopRealplayByCameraId
Function DPSDK_EXT_API int32_t DPSDK_EXT_CALL_MET HOD
Name DPSDK_StopRealplayByCameraId
( IN int32_t nPDLLHandle,
IN const char* szCameraId,
IN int32_t nTimeout = DPSDK_EXT_DEFAULT_TIMEOUT );
Function Close playing real-time stream according to channel no.
Descripti
on
Paramet nPDLLHandle sdk handle
er szCameraId Channel no.
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.7.7 DPSDK_StartRecord
Function DPSDK_EXT_API int32_t DPSDK_EXT_CALL_MET HOD
Name DPSDK_StartRecord
( IN int32_t nPDLLHandle,
IN int32_t nRealSeq,
INchar* szFilename,
INint32_tnDataType);
Function Start real time video recording
Descripti
on
Paramet nPDLLHandle sdk handle
er nRealSeq Return real time no no., may use to
realtime operate parameter
szFilename Record storafe full path
nDataType 0 means original video tream, default is
0，reserved parameter
Return Error code, refer to dpsdk_retval_e

50/136
 Value

3.7.8 DPSDK_StopRecord
Function DPSDK_EXT_API int32_t DPSDK_EXT_CALL_MET HOD
Name DPSDK_StopRecord
( IN int32_t nPDLLHandle,
IN int32_t nRealSeq);
Function Stop real time video recording
Descripti
on
Paramet nPDLLHandle sdk handle
er nRealSeq Return real time no., may use to real
time operate parameter
Return Error code, refer to dpsdk_retval_e
Value

3.7.9 DPSDK_SetOsdTxt
Function DPSDK_EXT_API int32_t DPSDK_EXT_CALL_MET HOD
Name DPSDK_SetOsdTxt
( IN int32_t nPDLLHandle,
IN int32_t nRealSeq，
IN char* szOsdTxt);
Function Set Osd text info
Descripti
on
Paramet nPDLLHandle sdk handle
er nRealSeq Return real time no., may use to real
time operate parameter
szOsdTxt Osd text info
Return Error code, refer to dpsdk_retval_e
Value

3.7.10 DPSDK_CleanUpOsdInfo
Function DPSDK_EXT_API int32_t DPSDK_EXT_CALL_MET HOD
Name DPSDK_CleanUpOsdInfo
( IN int32_t nPDLLHandle,
IN int32_t nRealSeq);
Function Clear Osd info

51/136
 Descripti
on
Paramet nPDLLHandle sdk handle
er nRealSeq Return real time no., may use to real
time operate parameter
Return Error code, refer to dpsdk_retval_e
Value

3.8 Talk

3.8.1 DPSDK_GetTalkStream
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_GetTalkStream
( IN int32_t nPDLLHandle,
OUT int32_t& nTalkSeq,
IN Get_TalkStream_Info_t* pGetInfo, IN
fMediaDataCallback pFun,
IN void* pUser, IN
int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Get audio stream
Descripti
on
Paramet nPDLLHandle sdk handle
er nRealSeq Stream request no., may be future
operation mark
pGetInfo Request info, refer to
Get_TalkStream_Info_t
pFun Stream callback, refer to
fMediaDataCallback
pUser User callback parameter
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.8.2 DPSDK_CloseTalkStreamBySeq
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_CloseTalkStreamBySeq

52/136
 ( IN int32_t nPDLLHandle,
IN int32_t nTalkSeq,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Close audio stream by request no.
Descripti
on
Paramet nPDLLHandle sdk handle
er nTalkSeq Audio no.
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.8.3 DPSDK_CloseTalkStreamByCameraId
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_CloseTalkStreamByCameraId
( IN int32_t nPDLLHandle,
IN const char* szCameraId,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Close audio stream by channel no.
Descripti
on
Paramet nPDLLHandle sdk handle
er szCameraId Channel no.
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.8.4 DPSDK_GetSdkAudioCallbackInfo
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_GetSdkAudioCallbackInfo
( IN int32_t nPDLLHandle,
OUT void* &pCallBackFun,
OUT AudioUserParam_t* &pUserParam);
Function Get audio collection callback info
Descripti
on
Paramet nPDLLHandle sdk handle

53/136
 er pCallBackFun Audio sampling callback function
pUserParam Audio sampling user parameter, refer to
AudioUserParam_t
Return Error code, refer to dpsdk_retval_e
Value

3.8.5 DPSDK_StartTalkplay
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD DPSDK_StartTalk
Name ( IN int32_t nPDLLHandle,
OUT int32_t& nTalkSeq,
IN Get_TalkStream_Info_t* pGetInfo, IN
int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Play real time stream
Descripti
on
Paramet nPDLLHandle sdk handle
er nTalkSeq Return real time no., may use to real
time operate parameter
pGetInfo Request info, refer to
Get_TalkStream_Info_t
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.8.6 DPSDK_StopTalkplayBySeq
Function DPSDK_EXT_API int32_t DPSDK_EXT_CALL_MET HOD
Name DPSDK_StopTalkplayBySeq
( IN int32_t nPDLLHandle,
IN int32_t nTalkSeq,
IN int32_t nTimeout = DPSDK_EXT_DEFAULT_TIMEOUT );

Function Close audio stream by request no.

Descripti
on
Paramet nPDLLHandle sdk handle
er nTalkSeq Return real time no., may use to real
time operate parameter

54/136
 nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.8.7 DPSDK_StopTalkplayByCameraId
Function DPSDK_EXT_API int32_t DPSDK_EXT_CALL_MET HOD
Name DPSDK_StopTalkplayByCameraId
( IN int32_t nPDLLHandle,
IN const char* szCameraId,
IN int32_t nTimeout = DPSDK_EXT_DEFAULT_TIMEOUT );
Function Close audio stream by channel no.
Descripti
on
Paramet nPDLLHandle sdk handle
er szCameraId Channel no.
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.9 Record Operation

3.9.1 DPSDK_SetMediaDataCompleteCallback
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_SetMediaDataCompleteCallback
( IN int32_t nPDLLHandle,
IN fMediaDataComplete pFun,
IN void* pUser );
Function Set media data end callback
Descripti
on
Paramet nPDLLHandle Sdk handle
er fun Callback function, refer to
fMediaDataComplete
pUser User parameter
Error code, refer to dpsdk_retval_e
Return

55/136
 Value

3.9.2 DPSDK_QueryRecord
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_QueryRecord
( IN int32_t nPDLLHandle,
IN Query_Record_Info_t* pQueryInfo,
OUT int& nRecordCount,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Search record
Descripti
on
Paramet nPDLLHandle sdk handle
er pQueryInfo Refer to Query_Record_Info_t
nRecordCount Return record no.
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.9.3 DPSDK_GetRecordInfo
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_GetRecordInfo
( IN int32_t nPDLLHandle,
INOUT Record_Info_t* pRecords );
Function Obtain record info
Descripti
on
Paramet nPDLLHandle sdk handle
er pRecords Refer to Record_Info_t
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.9.4 DPSDK_GetRecordStreamByFile
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_GetRecordStreamByFile

56/136
 ( IN int32_t nPDLLHandle,
OUT int32_t& nPlaybackSeq,
IN Get_RecordStream_File_Info_t* pRecordInfo,
IN fMediaDataCallback pFun,
IN void* pUser,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Record stream according to file request
Descripti
on
Paramet nPDLLHandle sdk handle
er nPlaybackSeq Return playback no., may use in
playback operation
pRecordInfo Refer to Get_RecordStream_File_Info_t
pFun Stream callback, refer to
fMediaDataCallback
pUser User callback parameter
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.9.5 DPSDK_GetRecordStreamByTime
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_GetRecordStreamByTime
( IN int32_t nPDLLHandle,
OUT int32_t& nPlaybackSeq,
IN Get_RecordStream_Time_Info_t* pRecordInfo,
IN fMediaDataCallback pFun,
IN void* pUser,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Record stream according to time request
Descripti
on
Paramet nPDLLHandle sdk handle
er nPlaybackSeq Return playback no., may use in
playback operation
pRecordInfo Refer to
Get_RecordStream_Time_Info_t
pFun Stream callback, refer to
fMediaDataCallback
pUser User callback parameter

57/136
 nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.9.6 DPSDK_PauseRecordStreamBySeq
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_PauseRecordStreamBySeq
( IN int32_t nPDLLHandle,
IN int32_t nPlaybackSeq,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Pause record stream
Descripti
on
Paramet nPDLLHandle sdk handle
er nPlaybackSeq Playback no.
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.9.7 DPSDK_ResumeRecordStreamBySeq
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_ResumeRecordStreamBySeq
( IN int32_t nPDLLHandle,
IN int32_t nPlaybackSeq,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Recover record stream
Descripti
on
Paramet nPDLLHandle sdk handle
er nPlaybackSeq Playback no.
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

Note: need to be used with DPSDK_PauseRecordStreamBySeq

58/136
3.9.8 DPSDK_SetRecordStreamSpeed
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_SetRecordStreamSpeed
( IN int32_t nPDLLHandle,
IN int32_t nPlaybackSeq,
IN dpsdk_dpsdk_speeed_e nSpeed,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Set record bit stream rate
Descripti
on
Paramet nPDLLHandle sdk handle
er nPlaybackSeq Playback no.
nSpeed Play rate, refer to
dpsdk_dpsdk_speeed_e
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.9.9 DPSDK_CloseRecordStreamBySeq
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_CloseRecordStreamBySeq
( IN int32_t nPDLLHandle,
IN int32_t nPlaybackSeq,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Close record stream according to request no.
Descripti
on
Paramet nPDLLHandle sdk handle
er nPlaybackSeq Playback no.
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.9.10 DPSDK_CloseRecordStreamByCameraId
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_CloseRecordStreamByCameraId
( IN int32_t nPDLLHandle,

59/136
 IN const char* szCameraId,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Close record stream according to channel no.
Descripti
on
Paramet nPDLLHandle sdk handle
er szCameraId Channel no.
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.9.11 DPSDK_StartPlaybackByFile
Function DPSDK_EXT_API int32_t DPSDK_EXT_CALL_MET HOD
Name DPSDK_StartPlaybackByFile
( IN int32_t nPDLLHandle,
OUT int32_t& nPlaybackSeq,
IN Get_RecordStream_File_Info_t* pRecordInfo,
IN void* hDestWnd,
IN int32_t nTimeout = DPSDK_EXT_DEFAULT_TIMEOUT );
Function Play record stream according to file
Descripti
on
Paramet nPDLLHandle sdk handle
er nPlaybackSeq Return playback no., may use in
playback operation
pRecordInfo Refer to Get_RecordStream_File_Info_t
hDestWnd Window handle
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.9.12 DPSDK_StartPlaybackByTime
Function DPSDK_EXT_API int32_t DPSDK_EXT_CALL_MET HOD
Name DPSDK_StartPlaybackByTime
( IN int32_t nPDLLHandle,
OUT int32_t& nPlaybackSeq,
IN Get_RecordStream_Time_Info_t* pRecordInfo,

60/136
 IN void* hDestWnd,
IN int32_t nTimeout = DPSDK_EXT_DEFAULT_TIMEOUT );
Function Play record stream according to time
Descripti
on
Paramet nPDLLHandle sdk handle
er nPlaybackSeq Return playback no., may use in
playback operation
pRecordInfo Refer to
Get_RecordStream_Time_Info_t
hDestWnd Window handle
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.9.13 DPSDK_StartPlaybackByLocal
Function DPSDK_EXT_API int32_t DPSDK_EXT_CALL_MET HOD
Name DPSDK_StartPlaybackByLocal
( IN int32_t nPDLLHandle,
OUT int32_t& nPlaybackSeq,
IN Get_RecordStream_Time_Info_t* pRecordInfo,
IN void* hDestWnd);
Function Local record playback
Descripti
on
Paramet nPDLLHandle Sdk handle
er nPlaybackSeq Return playback no., may use to
palyback operation
pRecordInfo Refer to
Get_RecordStream_Time_Info_t
hDestWnd Window handle
Error code, refer to dpsdk_retval_e
Return
Value

3.9.14 DPSDK_PausePlaybackBySeq
Function DPSDK_EXT_API int32_t DPSDK_EXT_CALL_MET HOD
Name DPSDK_PausePlaybackBySeq

61/136
 ( IN int32_t nPDLLHandle,
IN int32_t nPlaybackSeq,
IN int32_t nTimeout = DPSDK_EXT_DEFAULT_TIMEOUT );
Function Pause playing record stream
Descripti
on
Paramet nPDLLHandle sdk handle
er nPlaybackSeq Playback no.
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.9.15 DPSDK_ResumePlaybackBySeq
Function DPSDK_EXT_API int32_t DPSDK_EXT_CALL_MET HOD
Name DPSDK_ResumePlaybackBySeq
( IN int32_t nPDLLHandle,
IN int32_t nPlaybackSeq,
IN int32_t nTimeout = DPSDK_EXT_DEFAULT_TIMEOUT );
Function Recover playing record stream
Descripti
on
Paramet nPDLLHandle sdk handle
er nPlaybackSeq Playback no.
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.9.16 DPSDK_SetPlaybackSpeed
Function DPSDK_EXT_API int32_t DPSDK_EXT_CALL_MET HOD
Name DPSDK_SetPlaybackSpeed
( IN int32_t nPDLLHandle,
IN int32_t nPlaybackSeq,
IN dpsdk_dpsdk_speeed_e nSpeed,
IN int32_t nTimeout = DPSDK_EXT_DEFAULT_TIMEOUT );
Function Set bit stream rate for playing record
Descripti
on

62/136
 Paramet nPDLLHandle sdk handle
er nPlaybackSeq Playback no.
nSpeed Playing rate, refer to
dpsdk_dpsdk_speeed_e
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.9.17 DPSDK_StopPlaybackBySeq
Function DPSDK_EXT_API int32_t DPSDK_EXT_CALL_MET HOD
Name DPSDK_StopPlaybackBySeq
( IN int32_t nPDLLHandle,
IN int32_t nPlaybackSeq,
IN int32_t nTimeout = DPSDK_EXT_DEFAULT_TIMEOUT );
Function Restore play record stream
Descripti
on
Paramet nPDLLHandle Sdk handle
er nPlaybackSeq Playback no.
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Error code, refer to dpsdk_retval_e
Return
Value

3.9.18 DPSDK_StopPlaybackByCameraId
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_StopPlaybackByCameraId
( IN int32_t nPDLLHandle,
IN const char* szCameraId,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Stop playing record stream by channel
Descripti
on
Paramet nPDLLHandle Sdk handle
er szCameraId Channel no.
nTimeout Ovrtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Error code, refer to dpsdk_retval_e
Return

63/136
 Value

3.9.19 DPSDK_CloseRecordStreamBySeq
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_DPSDK_StopPlaybackBySeq
( IN int32_t nPDLLHandle,
IN int32_t nPlaybackSeq,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Stop playing record stream according to request no.
Descripti
on
Paramet nPDLLHandle sdk handle
er nPlaybackSeq Playback no.
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.9.20 DPSDK_CloseRecordStreamByCameraId
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_StopPlaybackByCameraId
( IN int32_t nPDLLHandle,
IN const char* szCameraId,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Stop playing record according to channel no.
Descripti
on
Paramet nPDLLHandle sdk handle
er szCameraId Channel no.
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

64/136
3.9.21 DPSDK_GetFrameTime
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_GetFrameTime
( IN int32_t nPDLLHandle,
IN const char* szCameraId,
OUTuint64_t&nFramTime);
Function Stop playing record stream by channel
Descripti
on
Paramet nPDLLHandle Sdk handle
er szCameraId Channel no.
nFramTime Current playback stream play time
Return Error code, refer to dpsdk_retval_e
Value

3.10 Video Aux

3.10.1 DPSDK_PicCapture
Function int32_t DPSDK_CALL_MET HOD DPSDK_PicCapture
Name ( IN int32_t nPDLLHandle,
IN int32_t nSeq,
IN dpsdk_pic_type_e nPicType,
IN const char* szFilename );
Function PTZ direction control
Descripti
on
Paramet nPDLLHandle Sdk handle
er nSeq No.
nPicType Picture type, refer to dpsdk_pic_type_e
szFilename File no.
Return Error code, refer to dpsdk_retval_e
Value

3.10.2 DPSDK_GetColor
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_GetColor
( IN int32_t nPDLLHandle,

65/136
 IN int32_t nSeq,
OUT Video_Color_Info_t &videoColorInfo);
Function Get video property
Descripti
on
Paramet nPDLLHandle Sdk handle
er nSeq No.
videoColorInfo Video property Video_Color_Info_t
Return Error code, refer to dpsdk_retval_e
Value

3.10.3 DPSDK_AdjustColor
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_AdjustColor
( IN int32_t nPDLLHandle,
IN int32_t nSeq,
IN Video_Color_Info_t videoColorInfo);
Function Adjust video property
Descripti
on
Paramet nPDLLHandle Sdk handle
er nSeq No.
videoColorInfo Video property Video_Color_Info_t
Return Error code, refer to dpsdk_retval_e
Value

3.10.4 DPSDK_OpenAudio
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD DPSDK_OpenAudio
Name ( IN int32_t nPDLLHandle,
IN int32_t nRealSeq,
IN bool bOpen);
Function Open video talk
Descripti
on
Paramet nPDLLHandle Sdk handle
er nSeq Stream request no., may use as future
operation mark
bOpen True open talk, false close talk
Return Error code, refer to dpsdk_retval_e

66/136
 Value

3.10.5 DPSDK_GetVolume
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_GetVolume
( IN int32_t nPDLLHandle,
IN int32_t nSeq,
OUT int32_t &nVol);
Function Get volume
Descripti
on
Paramet nPDLLHandle Sdk handle
er nSeq Stream request no., may use as future
operation mark
nVol Volume
Return Error code, refer to dpsdk_retval_e
Value

3.10.6 DPSDK_SetVolume
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_SetVolume
( IN int32_t nPDLLHandle,
IN int32_t nSeq,
IN int32_t nVol);
Function Volume
Descripti
on
Paramet nPDLLHandle Sdk handle
er nSeq Stream request no., may use as future
operation mark
nVol Volume
Return Error code, refer to dpsdk_retval_e
Value

67/136
3.11 PTZ Operation

3.11.1 DPSDK_PtzDirection
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_PtzDirection
( IN int32_t nPDLLHandle,
IN Ptz_Direct_Info_t* pDirectInfo,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );

Function PTZ direction control

Descripti
on
Paramet nPDLLHandle sdk handle
er pDirectInfo Direction command, refer to
Ptz_Direct_Info_t
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.11.2 DPSDK_PtzCameraOperation
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_PtzCameraOperation
( IN int32_t nPDLLHandle,
IN Ptz_Operation_Info_t* pOperationInfo,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function PTZ video control
Descripti
on
Paramet nPDLLHandle sdk handle
er pOperationInfo Operation info, refer to
Ptz_Operation_Info_t
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

68/136
3.11.3 DPSDK_PtzSit
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD DPSDK_PtzSit
Name ( IN int32_t nPDLLHandle,
IN Ptz_Sit_Info_t* pSitInfo,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function PTZ 3D positioning
Descripti
on
Paramet nPDLLHandle sdk handle
er pSitInfo Position info, refer to Ptz_Sit_Info_t
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.11.4 DPSDK_PtzLockCamera
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_PtzLockCamera
( IN int32_t nPDLLHandle,
IN Ptz_Lock_Info_t* pLockInfo,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function PTZ lock info
Descripti
on
Paramet nPDLLHandle sdk handle
er pLockInfo Lock info, refer to Ptz_Lock_Info_t
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.11.5 DPSDK_PtzLightControl
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_PtzLightControl
( IN int32_t nPDLLHandle,
IN Ptz_Ext_Cmd_Info_t* Cmd,
IN int nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function PTZ light operation
Descripti

69/136
 on
Paramet nPDLLHandle sdk handle
er Cmd Command, refer to Ptz_Ext_Cmd_Info_t
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.11.6 DPSDK_PtzRainBrushControl
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_PtzRainBrushControl
( IN int32_t nPDLLHandle,
IN Ptz_Ext_Cmd_Info_t* Cmd,
IN int nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function PTZ wiper operation
Descripti
on
Paramet nPDLLHandle sdk handle
er Cmd Command, refer to Ptz_Ext_Cmd_Info_t
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.11.7 DPSDK_PtzInfraredControl
Function int32_t DPSDK_CALL_MET HOD DPSDK_PtzInfraredControl
Name ( IN int32_t nPDLLHandle,
IN Ptz_Ext_Cmd_Info_t* Cmd,
IN int nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function PTZ IR operation
Descripti
on
Paramet nPDLLHandle sdk handle
er Cmd Command, refer to Ptz_Ext_Cmd_Info_t
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

70/136
3.11.8 DPSDK_QueryPrePoint
Function int32_t DPSDK_CALL_MET HOD DPSDK_QueryPrePoint
Name ( IN int32_t nPDLLHandle,
IN const char* szCameraId,
INOUT Ptz_Prepoint_Info_t* pPrepoint ,
IN int nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Search preset info
Descripti
on
Paramet nPDLLHandle sdk handle
er szCameraId Channel no.
pPrepoint Preset info, refer to Ptz_Prepoint_Info_t
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.11.9 DPSDK_PtzPrePoInfoperation
Function int32_t DPSDK_CALL_MET HOD DPSDK_PtzPrePo Infoperation
Name ( IN int32_t nPDLLHandle,
IN Ptz_Prepoint_Operation_Info_t* pOperation ,
IN int nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Preset operation
Descripti
on
Paramet nPDLLHandle sdk handle
er pOperation Preset operation info, refer to
Ptz_Prepoint_Operation_Info_t
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.11.10 DPSDK_PtzExtendCommand
Function int32_t DPSDK_CALL_MET HOD DPSDK_PtzExtendCommand
Name ( IN int32_t nPDLLHandle,
IN Ptz_Extend_Command_Info_t* pExtCmd,
IN int nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Extention command

71/136
 Descripti
on
Paramet nPDLLHandle Sdk handle
er pExtCmd Extention command info, refer to
Ptz_Extend_Command_Info_t
nTimeout Ovrtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.12 Alarm Operation

3.12.1 DPSDK_SetDPSDKAlarmCallback
Function DPSDK_DLL_API int32_t
Name DPSDK_CALL_MET HODDPSDK_SetDPSDKAlarmCallback
( IN int32_t nPDLLHandle,
IN fDPSDKAlarmCallback fun,
IN void* pUser);
Function Set alarm callback
Descripti
on
Paramet nPDLLHandle sdk handle
er fun Alarm callback, refer to
fDPSDKAlarmCallback
pUser User parameter, use when callback
Return Error code, refer to dpsdk_retval_e
Value

3.12.2 DPSDK_EnableAlarm
Function int32_t DPSDK_CALL_MET HOD DPSDK_EnableAlarm
Name ( IN int32_t nPDLLHandle,
IN Alarm_Enable_Info_t* pSourceInfo ,
IN int nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Arm alarm
Descripti
on
Paramet nPDLLHandle sdk handle
er pSourceInfo Alarm plan, refer to

72/136
 Alarm_Enable_Info_t
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.12.3 DPSDK_DisableAlarm
Function int32_t DPSDK_CALL_MET HOD DPSDK_DisableAlarm
Name ( IN int32_t nPDLLHandle,
IN int nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Disarm alarm
Descripti
on
Paramet nPDLLHandle sdk handle
er nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.12.4 DPSDK_QueryAlarmCount
Function int32_t DPSDK_CALL_MET HOD DPSDK_QueryAlarmCount
Name ( IN int32_t nPDLLHandle,
IN Alarm_Query_Info_t* pQuery,
OUT int& nCount,
IN int nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Search alarm no.
Descripti
on
Paramet nPDLLHandle sdk handle
er pQuery Search info, refer to
Alarm_Query_Info_t
nCount Return alarm no.
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

73/136
3.12.5 DPSDK_QueryAlarmInfo
Function int32_t DPSDK_CALL_MET HOD DPSDK_QueryAlarmInfo
Name ( IN int32_t nPDLLHandle,
IN Alarm_Query_Info_t* pQuery,
INOUT Alarm_ Info_t* pInfo,
IN int nFirstNum,
IN int nQueryCount,
IN int nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Search alarm info
Descripti
on
Paramet nPDLLHandle sdk handle
er pQuery Search info, refer to
Alarm_Query_Info_t
pInfo Alarm info, refer to Alarm_Info_t
nFirstNum Obtain starting from
nQueryCount Quantity of obtained record
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.12.6 DPSDK_SendAlarmToServer
Function int32_t DPSDK_CALL_MET HODDPSDK_SendAlarmToServer
Name (IN int32_t nPDLLHandle,
IN Client_Alarm_Info_t* pAlarmInfo,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Send alarm to server
Descripti
on
Paramet nPDLLHandle Sdk handle
er pAlarmInfo Alarm info, refer to Client_Alarm_Info_t
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Error code, refer to dpsdk_retval_e
Return
Value

74/136
3.13 ANPR Operation

3.13.1 DPSDK_WriteTrafficViolationInfo
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_WriteTrafficViolationInfo
(IN int32_t nPDLLHandle,
INOUT Traffic_Violation_Info_t* pGetInfo,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT);
Function Vehicle violation picture info write
Descripti
on
Paramet nPDLLHandle Sdk handle
er pGetInfo Detailed violation info
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.13.2 DPSDK_GetTrafficViolationInfo
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_GetTrafficViolationInfo
(IN int32_t nPDLLHandle,
INOUT Traffic_Violation_Info_t* pGetInfo,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT);
Function Vehicle violation picture info search
Descripti
on
Paramet nPDLLHandle Sdk handle
er pGetInfo Detailed violation info
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.13.3 DPSDK_SetDPSDKTrafficAlarmCallback
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_SetDPSDKTrafficAlarmCallback
( IN int32_t nPDLLHandle,

75/136
 IN fDPSDKTrafficAlarmCallback fun,
IN void* pUser);
Function Set violation alarm callback
Descripti
on
Paramet nPDLLHandle Sdk handle
er fDPSDKTrafficAlarmCallback Callback function
pUser User parameter
Return Error code, refer to dpsdk_retval_e
Value

3.13.4 DPSDK_SetDPSDKGetTrafficFlowCallback
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_SetDPSDKGetTrafficFlowCallback
(IN int32_t nPDLLHandle,
IN fDPSDKGetTrafficFlowCallback fun, IN
void* pUser);
Function Set flow report callback
Descripti
on
Paramet nPDLLHandle Sdk handle
er fDPSDKGetTrafficFlowCallback Flow callback function
pUser User parameter
Return Error code, refer to dpsdk_retval_e
Value

3.13.5 DPSDK_SetDPSDKGetDevTrafficFlowCallback
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_SetDPSDKGetDevTrafficFlowCallback
(IN int32_t nPDLLHandle,
IN fDPSDKGetDevTrafficFlowCallback fun,
IN void* pUser);
Function Set device lane flow report callback
Descripti
on
Paramet nPDLLHandle Sdk handle
er fDPSDKGetDevTrafficFlowCall Device report flow callback function
back
pUser User parameter

76/136
 Return Error code, refer to dpsdk_retval_e
Value

3.13.6 DPSDK_SubscribeTrafficFlow
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_SubscribeTrafficFlow
( IN int32_t nPDLLHandle,
IN Subscribe_Traffic_Flow_Info_t* pFlowInfo,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT);
Function Subscribe flow report
Descripti
on
Paramet nPDLLHandle Sdk handle
er pFlowInfo Request info
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.13.7 DPSDK_SetDPSDKGetBayCarInfoCallback
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_SetDPSDKGetBayCarInfoCallback(
IN int32_t nPDLLHandle,
IN fDPSDKGetBayCarInfoCallback fun,
IN void* pUser);
Function Set ANPR bypass info (without picture) report callback
Descripti
on
Paramet nPDLLHandle Sdk handle
er fDPSDKGetBayCarInfoCallback Device report flow callback function
pUser User parameter
Return Error code, refer to dpsdk_retval_e
Value

3.13.8 DPSDK_SubscribeBayCarInfo
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_SubscribeBayCarInfo(

77/136
 IN int32_t nPDLLHandle,
IN Subscribe_Bay_Car_Info_t* pGetInfo,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT);
Function Subscribe ANPR bypass info report
Descripti
on
Paramet nPDLLHandle Sdk handle
er pGetInfo Request info
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.13.9 DPSDK_SubscribeAreaSpeedDetectInfo
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_SubscribeAreaSpeedDetectInfo
( IN int32_t nPDLLHandle, IN
int32_t nSubscribeFlag, IN int32_t
nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT);
Function Subcribe zone speed measure report
Descripti
on
Paramet nPDLLHandle Sdk handle
er nSubscribeFlag Subscribe mark：1，subcribe；2，cancel
nTimeout Overtime, unit is ms
Return Error code, refer to dpsdk_retval_e
Value

3.13.10 DPSDK_SetDPSDKGetAreaSpeedDetectCallback
Function Set zone speed measure report callback.
Name @param IN nPDLLHandle SDK HANDLE
DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
DPSDK_SetDPSDKGetAreaSpeedDetectCallback
(IN int32_t nPDLLHandle, IN
fDPSDKGetAreaSpeedDetectCallback fun, IN
void* pUser);
Function Set zone speed measure report callback.
Descripti
on
Paramet nPDLLHandle Sdk handle

78/136
 er fDPSDKGetBayCarInfoCallba Callback function
ck
pUser User parameter
Return Error code, refer to dpsdk_retval_e
Value

3.14 TV Wall Operation

3.14.1 DPSDK_QueryTvWallList
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_QueryTvWallList
( IN int32_t nPDLLHandle,
OUT uint32_t& nCount,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEO UT );
Function Search TV wall list quantity
Descripti
on
Paramet nPDLLHandle Sdk handle
er nCount Return quantity
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.14.2 DPSDK_GetTvWallList
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_GetTvWallList
( IN int32_t nPDLLHandle,
INOUT TvWall_List_Info_t* pTvWallListInfo);
Function Get TV wall list info
Descripti
on
Paramet nPDLLHandle Sdk handle
er pTvWallListInfo TV wall list info, refer to
TvWall_List_Info_t
Return Error code, refer to dpsdk_retval_e
Value

79/136
3.14.3 DPSDK_QueryTvWallLayout
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_QueryTvWallLayout( IN int32_t nPDLLHandle,
IN int32_t nTvWallId,
OUT uint32_t& nCount,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Search TV wall layout info
Descripti
on
Paramet nPDLLHandle Sdk handle
er nTvWallId TV wall ID
nCount Return quantity
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.14.4 DPSDK_GetTvWallLayout

Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD

Name DPSDK_GetTvWallLayout
( IN int32_t nPDLLHandle,
INOUT TvWall_Layout_Info_t* pTvWallLayoutInfo);
Function Get TV wall layout info
Descripti
on
Paramet nPDLLHandle Sdk handle
er pTvWallLayoutInfo TV wall layout info, refer to
TvWall_Layout_Info_t
Return Error code, refer to dpsdk_retval_e
Value

3.14.5 DPSDK_SetTvWallScreenSplit
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_SetTvWallScreenSplit
( IN int32_t nPDLLHandle,
IN TvWall_Screen_Split_t* pSplitInfo,

80/136
 IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function TV wall screen split
Descripti
on
Paramet nPDLLHandle Sdk handle
er pSplitInfo TV wall creen split, refer to
TvWall_Screen_Split_t
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.14.6 DPSDK_SetTvWallScreenWindowSource
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_SetTvWallScreenWindowSource
( IN int32_t nPDLLHandle,
IN Set_TvWall_Screen_Window_Source_t* pWindowSourceInfo,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Set TV wall screen window video source
Descripti
on
Paramet nPDLLHandle Sdk handle
er pWindowSourceInfo TV wall screen split, refer to
Set_TvWall_Screen_Window_Source_t
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.14.7 DPSDK_CloseTvWallScreenWindowSource
Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD
Name DPSDK_CloseTvWallScreenWindowSource
( IN int32_t nPDLLHandle,
IN TvWall_Screen_Close_Source_t* pCloseSourceInfo,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Close TV wall screen window video source
Descripti
on

81/136
 Paramet nPDLLHandle Sdk handle
er pCloseSourceInfo TV wall screen split, refer to
TvWall_Screen_Close_Source_t
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

3.14.8 DPSDK_ClearTvWallScreen

Function DPSDK_DLL_API int32_t DPSDK_CALL_MET HOD

Name DPSDK_SetPipTvWallScreen
( IN int32_t nPDLLHandle,
IN int32_t nTvWallId,
IN int32_t nTimeout = DPSDK_CORE_DEFAULT_TIMEOUT );
Function Clear TV wall screen
Descripti
on
Paramet nPDLLHandle Sdk handle
er nTvWallId TV wall ID
nTimeout Overtime, default
DPSDK_CORE_DEFAULT_TIMEOUT
Return Error code, refer to dpsdk_retval_e
Value

82/136
4 Data Structure Explanation

4.1 Function Return Error dpsdk_retval_e

错误码 定义 翻译
0 DPSDK_RET_SUCCESS Success
Ptotocol analysis
1 DPSDK_RET_SERIALIZE_PDU_FAILED
failed
Data sending
2 DPSDK_RET_SENDDATA_FAILED
failed
3 DPSDK_RET_NET_CONNECT_FAILED Connection failed
4 DPSDK_RET_ALREADY_LOGIN Already logged in
5 DPSDK_RET_ALREADY_LOGOUT Logged out
6 DPSDK_RET_SERIALIZE_XML_FAILED Xml analysis failed
7 DPSDK_RET_NODE_NO_RIGHT No right operation
8 DPSDK_RET_UNKNOW_DEVICE Unknown device
9 DPSDK_RET_UNKNOW_CHANNEL Unknown channel
10 DPSDK_RET_DEVICE_OFFLINE Device offline
Rtsp connection
11 DPSDK_RET_RTSP_CONNECT_FAILED
failed
12 DPSDK_RET_RTP_LISTEN_FAILED Rtp listening failed
Rtp connection
13 DPSDK_RET_RTP_CONNECT_FAILED
failed
Rtsp analysis port
14 DPSDK_RET_PARSE_TRANSPORT_FAILED
failed
Command already
15 DPSDK_RET_ALREADY_CANCELED
canceled
Invalid session
fixme: check
16 DPSDK_RET_UNKNOWN_SESSION current comdition
and response
together
Talk parameter
17 DPSDK_RET_TALK_INNVALIDPARAM
error
18 DPSDK_RET_TALK_NOT_SUPPORT Do not support talk
Corresponding
19 DPSDK_RET_DMSSESSION_NOT_FOUND dmsSession not
found
20 DPSDK_RET_ADSSESSION_NOT_FOUND ADS not found
21 DPSDK_RET_ADSSESSION_NOT_LOGIN ADS loging failed
ALARM record not
22 DPSDK_RET_DATABASE_NO_RECORD
found
Alarm type not
23 DPSDK_RET_ALARMTYPE_NOT_MATCH
matched
Failed to process
24 DPSDK_RET_ADSCOMF IRM_FAIL
alarm
Cannot find
25 DPSDK_RET_PLAYBACK_SESSION_NOT_FOUND
playback session
Unknown
26 DPSDK_RET_PLAYBACK_UNKNOW_PLAYTYPE
playback type
Network SDK seek
27 DPSDK_RET_PLAYBACK_NETSDK_SEEK_FAIL
command failed
Playback position
28 DPSDK_RET_PLAYBACK_SEEK_SIZE_ERROR
size error
Playback position
29 DPSDK_RET_PLAYBACK_SEEK_TIME_ERROR
time error
Device not found
30 DPSDK_RET_PLAYBACK_DEVICE_NOT_FOUND
at playback
One playback
31 DPSDK_RET_PLAYBACK_PLAY_REPEAT
channel only
Info type not
32 DPSDK_RET_INVALID_CONF IGTYPE
supported
Stream type not
33 DPSDK_RET_UNSUPPORTED_STREAM
supported
Device info not
34 DPSDK_RET_PLAYBACK_NOTFIND_DEV
found
Playback
35 DPSDK_RET_PLAYBACK_PARAM
parameter error
Playback unknown
36 DPSDK_RET_PLAYBACK_PARAM_CAMERA
camera
FTP server not
37 DPSDK_RET_FTPSERVER_NOT_FIND
found
Call curl return
38 DPSDK_RET_FTPCURL_ERROR
error
Call curl return
39 DPSDK_RET_FTPCURL_LOCALFILE_NOT_OPEN erroe and local file
not found
Call curl return
40 DPSDK_RET_FTPCURL_LOCALFILE_NOT_READ and open local file
error
41 DPSDK_RET_FTPCURL_FTPFILE_ERROR Call curl return

84/136
 and operating
remote file error
Call curl return
42 DPSDK_RET_FTPCURL_FREE_ERROR
and release error
43 DPSDK_RET_PCS_ERROR PCS error
44 DPSDK_RET_PES_ERROR PES error
Not logged on
45 DPSDK_RET_PES_NOT_LOGIN
PES
Alarm host
46 DPSDK_RET_PES_ENCODE_AHSOTCMD_FAILED
command failed
Access control
47 DPSDK_RET_PES_ENCODE_DCTRL_FAILED
command failed
Channel no. is
48 DPSDK_RET_CHANNEL_EMPTY
null.
49 DPSDK_RET_MSG_EMPTY Message is null.
50 DPSDK_RET_MSG_INVALID_CMD Invalid operation
Protocol analysis
51 DPSDK_RET_DECODE_PDU_FAILED
failed
Data sending is
52 DPSDK_RET_SENDDATA_EMPTY
null.
Corresponding
53 DPSDK_RET_PESSESSION_NOT_FOUND possession not
found
Alarm message
54 DPSDK_RET_ALARMREPORT_NEW_FAILED memory
application failed
Not logged on
55 DPSDK_RET_PCS_NOT_LOGIN
PCS
Correspodning
56 DPSDK_RET_RTSPMDL_NOT_FIND RTSPMDL not
found
Undefined RTSP
57 DPSDK_RET_RTSPMSG_INVALID_CMD
operation
58 DPSDK_RET_LOAD_XML Xml analysis failed
59 DPSDK_RET_CMS_RET_ERROR CMS return error
60 DPSDK_RET_DMS_RET_ERROR DMS return error
61 DPSDK_RET_PCS_RET_ERROR PCS return error
62 DPSDK_RET_RTSP_RET_ERROR RTSP return error
CMS reurn error –
63 DPSDK_RET_CMS_ERR_NOT_FOUND
not found
64 DPSDK_RET_CONFIGEX_LOGIN_FAIL Device login failed
65 DPSDK_RET_CONFIGEX_LOGINOUT_FAIL Device logout failed

85/136
 NetSDK return
66 DPSDK_RET_NETSDK_ERROR
failed
The structure
67 DPSDK_RET_DEVCONFIG_STRUCT_UNABLE_OPERATOR doesnot support
this operation
Invalid local
68 DPSDK_RET_LOCAL_INVALID_ USERNAME
username
Invalid local
69 DPSDK_RET_LOCAL_INVALID_PASSWORD
password
1001 DPSDK_CORE_ERROR_NOT_SUPPORT Not support
Obtaining memory
1002 DPSDK_CORE_ERROR_GET_MEMORY_FAIL
failed
1003 DPSDK_CORE_ERROR_WITHOUT_CREATE Not created
1004 DPSDK_CORE_ERROR_CREATE_FAIL Creation failed
1005 DPSDK_CORE_ERROR_INIT_FAIL Initialization failed
Unintialization
1006 DPSDK_CORE_ERROR_UINIT_FAIL
failed
1007 DPSDK_CORE_ERROR_WITHOUT_INIT Not initialized
1008 DPSDK_CORE_ERROR_INVALID_HANDLE Invalid handle
1009 DPSDK_CORE_ERROR_INVALID_PARAM Invalid parameter
Operation
1010 DPSDK_CORE_ERROR_TIMEOUT
overtime
1011 DPSDK_CORE_ERROR_SYNCFUN_ERROR Sync call error
1012 DPSDK_CORE_ERROR_SERIES Series failed
1013 DPSDK_CORE_ERROR_FOUND_FAIL Search failed
1014 DPSDK_CORE_ERROR_SIZE_ZERO Size is zero
Alarm arm
1015 DPSDK_CORE_ERROR_PARSE_ALARM_ENABLE_FAIL
analysis failed
Obtaining free Port
1016 DPSDK_CORE_ERROR_GET_FREEPORT_FAIL
failed
1017 DPSDK_CORE_ERROR_INVALID_SEQ Invalid SEQ
1018 DPSDK_CORE_ERROR_WITHOUT_LOGIN Not login
1019 DPSDK_CORE_ERROR_WITHOUT_LODEGROUP Not load device
1020 DPSDK_CORE_ERROR_ERROR_LEN Length error
1021 DPSDK_CORE_ERROR_RANGE_OVER Cross zone
1022 DPSDK_CORE_ERROR_CAPT URE_FAIL Sanpshot failed
1023 DPSDK_CORE_ERROR_OPEN_F ILE_FAIL Failed to open file
1024 DPSDK_CORE_ERROR_SAVE_FILE_FAIL Failed to save file
Failed to real time
1025 DPSDK_CORE_ERROR_STARTRECORD_FAIL
record video
Failed to stop real
1026 DPSDK_CORE_ERROR_STOPRECORD_FAIL
time record video

86/136
 Failed to set osd
1027 DPSDK_CORE_ERROR_SETOSDT XT_FAIL
info
Search all records,
100000 only front-end
SERVER_RET_CMS_ERR_QUERY_PU_SUCCESS
1 search is
successful
Search all records,
100000
SERVER_RET_CMS_ERR_QUERY_CENTER_SUCCESS only central search
2
is successful
100042
SERVER_RET_CMS_ERR_NO_USER_ID User ID inexists
1
100042 This username
SERVER_RET_CMS_ERR_NO_USER_NAME_TO_ID
2 cannot match ID
100042
SERVER_RET_CMS_ERR_NO_USER_NAME Username inexists
3
100042
SERVER_RET_CMS_ERR_PASSWORD_INVALID Password invalid
4
100042
SERVER_RET_CMS_ERR_INVALID_USER_ID Invalid user ID
5
100042
SERVER_RET_CMS_ERR_USER_LOCKED User is locked
6
100042
SERVER_RET_CMS_ERR_SESSION_EXIST User session exist
7
100042 User session not
SERVER_RET_CMS_ERR_NO_SESSION
8 exist
100042
SERVER_RET_CMS_ERR_SERVER_REGISTERED Service registered
9
100043 Service not
SERVER_RET_CMS_ERR_SERVER_NOT_REGISTER
0 registered
100043
SERVER_RET_CMS_ERR_INVALID_CAMERA_ID Camera id invalid
1
100043
SERVER_RET_CMS_ERR_NO_DEVICE Device not found
2
100043 Media session
SERVER_RET_CMS_ERR_MEDIA_SESSION_EXIST
3 exist
100043 Granted session
SERVER_RET_CMS_ERR_GRANT_SESSION_EXIST
4 exist
100043 Camera list not
SERVER_RET_CMS_ERR_NO_CAMERA_ROW
5 found
100043
SERVER_RET_CMS_ERR_UNKNOWN_TYPE Invalid type
6
100043 SERVER_RET_CMS_ERR_TOO_MANY_GROUP_COUNT Too many user

87/136
7 group
100043
SERVER_RET_CMS_ERR_TOO_MANY Too many
8
100043
SERVER_RET_CMS_ERR_EXIST_HIGH_USER Higher user exist
9
100052 Connection not
SERVER_RET_CMS_ERR_NO_CONNECTION
1 exist
100052 Unregistered
SERVER_RET_CMS_ERR_INVALID_SERVER
2 service
100052 Service domain
SERVER_RET_CMS_ERR_NO_DOMAIN
3 not exist
100052 Service object not
SERVER_RET_CMS_ERR_NO_SERVER_BEAN
4 exist
100052
SERVER_RET_CMS_ERR_NO_MTS_TO_USE No MTS available
5
100052
SERVER_RET_CMS_ERR_SESSION_DELETE Session deleted
6
100052 Service is
SERVER_RET_CMS_ERR_SERVER_RECONNECT
7 reconnecting
100052 Failed to add
SERVER_RET_CMS_ERR_ADD_CAMERA_FAILED
8 camera
100052
SERVER_RET_CMS_ERR_ADD_CLIENT_FAILED Failed to add client
9
100053 Failed to access
SERVER_RET_CMS_ERR_DATABASE_ACCESS_FAILED
0 database
100053 Database no
SERVER_RET_CMS_ERR_DATABASE_NO_RECORD
1 record
100053
SERVER_RET_CMS_ERR_DATA_TOO_LONG Data too long
2
100053 No user group
SERVER_RET_CMS_ERR_NO_GROUPS_OF_USER
3 found
100053 Failed to search
SERVER_RET_CMS_ERR_QUERY_RECORD_FAILED
4 record
Playback the
100053
SERVER_RET_CMS_ERR_OT HER_USER_PLAYBACK camera by other
5
user
100053 Reach front-end
SERVER_RET_CMS_ERR_REACH_PU_PLAYBACK_LIMIT
6 playback limit
100053
SERVER_RET_CMS_ERR_NO_DMS_TO_USE No DMS available
7
100053 Device authorized
SERVER_RET_CMS_ERR_DEV_GRANT_CHANGED
8 to other service

88/136
100053
SERVER_RET_CMS_ERR_ADD_DVR_FAILED Failed to add DVR
9
100054 Failed to authorize
SERVER_RET_CMS_ERR_GRANT_FAILED
0 DMS
100054
SERVER_RET_CMS_ERR_SS_PLAYBACK_FAILED SS playback failed
1
100054
SERVER_RET_CMS_ERR_REACH_SYSTEM_LIMIT Reach system limit
2
100054 Invalid device
SERVER_RET_CMS_ERR_INVALID_DEVICE_PROVIDER
3 provider
100054
SERVER_RET_CMS_ERR_NO_URL No URL upgrade
4
100054
SERVER_RET_CMS_ERR_NO_SS_TO_USE No SS available
5
100054 Frong-end search
SERVER_RET_CMS_ERR_PU_QUERY_TIMEOUT
6 overtime
100054 Front-end record
SERVER_RET_CMS_ERR_PU_QUERY_RECORD_FAILED
7 search failed
100054
SERVER_RET_CMS_ERR_NO_MTS_FOR_DEVICE No MTS for device
8
100054
SERVER_RET_CMS_ERR_DEVICE_IN_TALKING Device in talk
9
100055
SERVER_RET_CMS_ERR_DEVICE_NOT_TALKING Device not in talk
0
CMS is ready to
100055
SERVER_RET_CMS_ERR_ENCODE_PDU response, failed to
1
Encode
CMS is ready to
100055
SERVER_RET_CMS_ERR_DECODE_PDU response, failed to
2
Decode
100055 No lower domain
SERVER_RET_CMS_ERR_NOT_FOUND_LOWER_DOMAIN
3 found
100055 Not login lower
SERVER_RET_CMS_ERR_NOT_LOGIN_LOWER_DOMAIN
4 domain
100055
SERVER_RET_CMS_ERR_NO_RIGHT No authority
5
100055 Failed to search
SERVER_RET_CMS_ERR_QUERY_ALARM_FAILED
6 alarm
100055
SERVER_RET_CMS_ERR_DEIVCE_OFFLINE Device offline
7
100055 Lower domain
SERVER_RET_CMS_ERR_LOWER_DOMAIN_EXCEPTION
8 abnormal

89/136
100055 Alaem pre-record
SERVER_RET_CMS_ERR_ALARM_PRE_RECORD_OPENED
9 is on
Service is
100056
SERVER_RET_CMS_ERR_RECONNECT_DEVICE reconnecting
0
device
100056 Failed to send
SERVER_RET_CMS_ERR_SEND_F UN_SVR_REQ_FAIL
1 request to server
100056 Faioed to start
SERVER_RET_CMS_ERR_CU_START_RECORD_FAIL
2 recording
100056
SERVER_RET_CMS_ERR_CU_RECORING_NOW Recording
3
100056 Failed to stop
SERVER_RET_CMS_ERR_CU_STOP_RECORD_FAIL
4 recording
100056 Oher user is
SERVER_RET_CMS_ERR_CU_OT HERUSER_RECORDING
5 recording
100056 Failed to start
SERVER_RET_CMS_ERR_CU_START_RECORD_RUNNING
6 recording, running
100056 Failed to start
SERVER_RET_CMS_ERR_CU_START_RECORD_LIMITE
7 recording, limited
Failed to start
100056
SERVER_RET_CMS_ERR_CU_START_RECORD_NO_SS recording, no
8
available SS
100056 No available PES
SERVER_RET_CMS_ERR_NO_PES_TO_USE
9 server
100057
SERVER_RET_CMS_ERR_UNKNOWN_PROTOCOL Unknown protocol
0
100057
SERVER_RET_CMS_ERR_CONF IG_FILE_TIMEOUT Config file timeout
1
100057
SERVER_RET_CMS_ERR_NO_BOLCK No available block
2
100140
SERVER_RET_DMS_ERR_HAS_NO_RIGHT No privilage
1
100142
SERVER_RET_DMS_ERR_NO_PRIVILEGE No privilage
1
100152 PTZ internal
SERVER_RET_DMS_ERR_PTZ_FAILED
1 control error
100152 Device config
SERVER_RET_DMS_ERR_CONF IG_SET_FAILED
2 iternal control error
Device config
100152
SERVER_RET_DMS_ERR_CONF IG_GET_FAILED internal control
3
error
100152 SERVER_RET_DMS_ERR_CAMERA_OCCUPY Camera is

90/136
4 occupied by other
user
PTZ management
100152
SERVER_RET_DMS_ERR_PTZ_ACCESS_FAILED module access
5
failed
100152 User connect to
SERVER_RET_DMS_ERR_TCP_COMM_NO_CLIENT
6 unknown client
100152 Non-added client
SERVER_RET_DMS_ERR_CLIENT_UNIT_NOT_FOUND
7 not found
100152
SERVER_RET_DMS_ERR_DEVICE_NOT_FOUND Device not found
8
100152
SERVER_RET_DMS_ERR_PRIVILEGE_NOT_FOUND Privilege not found
9
100153 Unknown
SERVER_RET_DMS_ERR_UNKNOWN_COMMAND
0 command
100153 Occupied by
SERVER_RET_DMS_ERR_OCCUPY_BY_HIGHER_USER
1 higher user
100153 Need Server to
SERVER_RET_DMS_ERR_NORMAL_LOCK_FAILED
2 check Lock error
100153 Occupied by other
SERVER_RET_DMS_ERR_OCCUPY_BY_OTHER_USER
3 user
Need Server to
100153
SERVER_RET_DMS_ERR_NORMAL_UNLOCK_FAILED check UnLock
4
error
100153
SERVER_RET_DMS_ERR_NO_DEVICE No device
5
100153
SERVER_RET_DMS_ERR_NO_RIGHT No authority
6
100153 No lower domain
SERVER_RET_DMS_ERR_NOT_FOUND_LOWER_DOMAIN
7 found
100153 Not login lower
SERVER_RET_DMS_ERR_NOT_LOGIN_LOWER_DOMAIN
8 domain
100153 Search video
SERVER_RET_DMS_ERR_QUERY_DIAGNOSIS_ID
9 diagnosis ID failed
Search video
100154 SERVER_RET_DMS_ERR_QUERY_DIAGNOSIS_TYPE_COU
diagnosis type
0 NT
count failed
Search video
100154
SERVER_RET_DMS_ERR_QUERY_DIAGNOSIS_INFO diagnosis info
1
failed
100154 Failed to stop
SERVER_RET_DMS_ERR_STOP_QUERY_DIAGNOSIS_INFO
2 video diagnosis

91/136
 info search
100154 SERVER_RET_DMS_ERR_START_QUERY_PERSON_COUN Failed to start
3 T person count
100154 Failed to search
SERVER_RET_DMS_ERR_QUERY_PERSON_COUNT
4 person count
Failed to stop
100154
SERVER_RET_DMS_ERR_STOP_QUERY_PERSON_COUNT search person
5
count
100252
SERVER_RET_VMS_ERR_FAILED Failed-other
0
100252
SERVER_RET_VMS_ERR_ID_ALREADY_EXIST NVD ID exists
1
100252
SERVER_RET_VMS_ERR_INVALID_ID Invalid ID
2
100252
SERVER_RET_VMS_ERR_REACH_LIMIT Reach limit
3
100350
SERVER_RET_RTSP_ERR_SET UP_FAILED Failed-other
3
100352
SERVER_RET_RTSP_ERR_RECONNECT_DEVICE NVD ID exists
1
100472
SERVER_RET_ALARM_ERR_URL URL error
1
100472
SERVER_RET_ALARM_ERR_RES Invalid data
2
100472
SERVER_RET_ALARM_ERR_MDL_TYPE Invalid unit type
3
100472 Invalid scheme
SERVER_RET_ALARM_ERR_SCHEME_INDEX
4 index
100472 Invalid scheme
SERVER_RET_ALARM_ERR_SCHEME_TYPE
5 type
100472 Failed to analyze
SERVER_RET_ALARM_ERR_SCHEME_STRING
6 scheme string
100472
SERVER_RET_ALARM_ERR_ALARM_NODE Invalid alarm node
7
100542
SERVER_RET_MS_ERR_ALREADY_LOGIN Logged in
1
100542
SERVER_RET_MS_ERR_INVALID_SESSION_ID Invalid session ID
2
100542
SERVER_RET_MS_ERR_NOT_LOGIN Not logged in
3
100542
SERVER_RET_MS_ERR_INVALID_CONNECTION Invalid connection
4

92/136
100542
SERVER_RET_MS_ERR_INVALID_DEV_TYPE Invalid device type
5
100542
SERVER_RET_MS_ERR_INVALID_CAMERA_ID Invalid camera id
6
100542
SERVER_RET_MS_ERR_CAMERA_SESSION_EXIST Camera added
7
100542 Camers session
SERVER_RET_MS_ERR_NO_CAMERA_SESSION
8 not exist
100542
SERVER_RET_MS_ERR_F IND_SAME_TOKEN Find same token
9
100543 Unknown record
SERVER_RET_MS_ERR_UNKNOWN_RECORD_TYPE
0 type
100543 Invalid record file
SERVER_RET_MS_ERR_INVALID_FILE_NAME
1 name
100543 Invalid recorf time
SERVER_RET_MS_ERR_INVALID_TIME_VALUE
2 value
100543
SERVER_RET_MS_ERR_NOT_FOUND_SESSION No seccsion found
3
100543
SERVER_RET_MS_ERR_INVALID_RTSP_URL Invalid RTSP URL
4
100543
SERVER_RET_MS_ERR_PLAN_EXIST Plan exists
5
100552
SERVER_RET_MS_ERR_DEV_NOT_LOGIN Device not login
1
100552
SERVER_RET_MS_ERR_SDK_OPERATE_FAILED Sdk call failed
2
100552
SERVER_RET_MS_ERR_SESSION_USE_OUT Session out
3
100552 Rtsp connection
SERVER_RET_MS_ERR_RTSP_CONNECT_FAILED
4 failed
100552 RTP listening
SERVER_RET_MS_ERR_RTP_LISTEN_FAILED
5 failed
100552 RTSP Setup
SERVER_RET_MS_ERR_RTSP_SETUP_FAILED
6 operation failed
100552 RTSP PLAY
SERVER_RET_MS_ERR_RTSP_PLAY_FAILED
7 operation faile
Failed to add RTP
100552
SERVER_RET_MS_ERR_ADD_RTP_SESSION_FAILED SESSION to
8
serverbase
100552
SERVER_RET_MS_ERR_DISK_SPACE_NOT_ENOUGH Disk no space
9
100553 SERVER_RET_MS_ERR_OPEN_FILE_FAILED Failed to open file

93/136
0
100553 No RTSP client
SERVER_RET_MS_ERR_NOT_FOUND_RTSP_CLIENT
1 connection found
100553 RTSP
SERVER_RET_MS_ERR_RTSP_DISCONNECTED
2 disconnected
100553 Record search
SERVER_RET_MS_ERR_RECORD_QUERY_TIMEOUT
3 overtime
100553 sdk return data
SERVER_RET_MS_ERR_SDK_CALLBACK_INVALID_DATA
4 invalid
Set SS-end SNAP
100553
SERVER_RET_MS_ERR_SNAP_STORE_PAT H_INVALID storage path
5
invalid
100553 SS storage
SERVER_RET_MS_ERR_SNAP_STORE_FILE_FAILED
6 operation failed
SS failed when
100553
SERVER_RET_MS_ERR_SNAP_ENCODE_FAILED encode responses
7
to pdu
SS failed when I
100553
SERVER_RET_MS_ERR_IFRAME_2_BMP frame switch to
8
BMP
100553 Repeated PlanId
SERVER_RET_MS_ERR_DUPLICATE_PLAN_FOUND
9 found
SDK call Callback
100554
SERVER_RET_MS_ERR_SDK_CALLBACK_TIMEOUT overtime, no return
0
data
100554 camera_session_i
SERVER_RET_MS_ERR_NOT_FOUND_SESSION_ID
1 d not found
100554
SERVER_RET_MS_ERR_INVALID_STREAM_TYPE Invalid stream type
2
100554 Failed to add
SERVER_RET_MS_ERR_ADD_LIVECHANNEL_FAILED
3 livechannel
100554 Failed to get talk
SERVER_RET_MS_ERR_GET_TALKDECODE_FAILED
4 format
100554 Failed to log in
SERVER_RET_MS_ERR_LOGIN_DEV_FAILED
5 device
100554 Audio format not
SERVER_RET_MS_ERR_NOT_MATCH_AUDIO_TYPE
6 matched
100554
SERVER_RET_MS_ERR_NOT_FOUND_DISK Disk not found
7
100554 Record plan not
SERVER_RET_MS_ERR_NOT_FOUND_RECORD_PLAN
8 found

94/136
4.2 Example

4.2.1 SDK Type

typedef enum
{
DPSDK_CORE_SDK_SERVER = 1, //Server mode
}dpsdk_sdk_type_e;
Note: sever mode only.

4.2.2 SDK Status Type

typedef enum
{
DPSDK_CORE_STATUS_SERVER_ONLINE = 1, //Server
online notice
DPSDK_CORE_STATUS_SERVER_OFFLINE = 2, //Server
offline notice
}dpsdk_status_type_e;

4.2.3 Platform Type

// Platform type
typedef enum
{
DPSDK_CORE_PLATFORM_B = 0, // -B platform
DPSDK_CORE_PLATFORM_C = 1, // -C platform
DPSDK_CORE_PLATFORM_T = 2, // -T platform
DPSDK_CORE_PLATFORM_F = 3, // -F platform

DPSDK_CORE_PLATFORM_P = 4, // -P platform
DPSDK_CORE_PLATFORM_M = 5, // -M platform
DPSDK_CORE_PLATFORM_A = 6, // -A platform
}dpsdk_core_platform_type_e;

4.2.4 Log Level

typedef enum

95/136
 {
DPSDK_LOG_LEVEL_DEBUG = 2, // debug
DPSDK_LOG_LEVEL_INFO = 4, // Info
DPSDK_LOG_LEVEL_ERROR = 6, // Error
}dpsdk_log_level_e;

4.2.5 Operation Type

typedef enum
{
OPTTYPE_UNKOWN = 0, //
OPTTYPE_LOGIN = 1, // Login
OPTTYPE_LOGOUT = 2, // Logout
OPTTYPE_REAL = 3, // Real time video
OPTTYPE_PTZ = 4, // PTZ
OPTTYPE_PLAYBACK = 5, // Playback
OPTTYPE_DOWNLOAD = 6, // Download
OPTTYPE_LOCALRECORD = 7, // Local
Record
OPTTYPE_QUERYRECORD = 8, // Search
record
OPTTYPE_ARM = 9, // Alarm host
arming
OPTTYPE_DISARM = 10, // Alarm host
disarming
}dpsdk_log_optType_e;

4.2.6 Protocol Library Version

typedef enum
{
DPSDK_PROTOCOL_VERSION_I = 1, // 1st generation
protocol
DPSDK_PROTOCOL_VERSION_II = 2, // 2nd generation
protocol
}dpsdk_protocol_version_e;

4.2.7 Obtain Node Type

typedef enum
{

96/136
 DPSDK_CORE_GEN_GETGROUP_NODE_ALL = 0, // All nodes
DPSDK_CORE_GEN_GETGROUP_NODE_DEPARTMENT = 1, //
Organizational structure
DPSDK_CORE_GEN_GETGROUP_NODE_ENCODER = 11, //
Encodind device
DPSDK_CORE_GEN_GETGROUP_NODE_DECODER = 12, //
Decoding device
DPSDK_CORE_GEN_GETGROUP_NODE_ENCHANNEL = 111, //
Encoding channel
DPSDK_CORE_GEN_GETGROUP_NODE_DECHANNEL = 121, //
Decoding channel
}dpsdk_getgroup_node_e;

4.2.8 Obtain Organization Type

typedef enum
{
DPSDK_ORG_NODE_TYPE_GROUP = 1, // Organziation
DPSDK_ORG_NODE_TYPE_DEPARTMENT = 2, //
Department
DPSDK_ORG_NODE_TYPE_MONITOR_AREA = 3, // Montoring
zone
DPSDK_ORG_NODE_TYPE_ADM_AREA = 4, // District

DPSDK_ORG_NODE_TYPE_PERSION = 5, // Staff
DPSDK_ORG_NODE_TYPE_CHNDEPREL = 6, // Channel
department activation list
DPSDK_ORG_NODE_TYPE_DEPAREAREL = 7, //
Department zone activation list
}dpsdk_org_node_e;

4.2.9 Obtain Node Depth

typedef enum
{
DPSDK_CORE_GEN_GETGROUP_OPERAT ION_ALL = -1, // Obtain all
DPSDK_CORE_GEN_GETGROUP_OPERAT ION_SELF = 0, // Obtain self
DPSDK_CORE_GEN_GETGROUP_OPERAT ION_CHILD = 1, // Obtain child
}dpsdk_getgroup_operation_e;

97/136
4.2.10 Node Change Notice Type
typedef enum
{
DPSDK_CORE_CHANGE_UNDEFINE = 0, // Undefined
DPSDK_CORE_CHANGE_ADD_DEV = 1, // Add
device
DPSDK_CORE_CHANGE_MODIFY_DEV = 2, // MModify
device
DPSDK_CORE_CHANGE_DEL_DEV = 3, // Delete
device
DPSDK_CORE_CHANGE_ADD_ORG = 4, // Add
organization
DPSDK_CORE_CHANGE_MODIFY_ORG = 5, // Modify
organization
DPSDK_CORE_CHANGE_DELETE_ORG = 6, // Delete
organization
}dpsdk_change_type_e;

4.2.11 Organization Notice Type

typedef enum
{
DSST_GROUP_CHANGE_UNKNOW = 0,
DSST_GROUP_CHANGE_ORG_ADDED, // Add
organization
DSST_GROUP_CHANGE_ORG_CHANGED, //
Organization node change
DSST_GROUP_CHANGE_ORG_DELETED, //
Delete organization
DSST_GROUP_CHANGE_PERSON_ADDED, //
Add staff
DSST_GROUP_CHANGE_PERSON_CHANGED, //
Staff info change
DSST_GROUP_CHANGE_PERSON_DELETED, //
Delete staff
DSST_GROUP_CHANGE_CAR_ADDED, // Add
vehicle
DSST_GROUP_CHANGE_CAR_CHANGED, //
Vehicle info change
DSST_GROUP_CHANGE_CAR_DELETED, //

98/136
 Delete vehicle

}dpsdk_dsst_change_type_e;

4.2.12 Channel Right Check

typedef enum
{
DPSDK_CORE_CHECK_RIGHT = 0, // Check
DPSDK_CORE_NOT_CHECK_RIGHT = 1, // No check
}dpsdk_check_right_e;

4.2.13 Stream Type

typedef enum
{
DPSDK_CORE_STREAMTYPE_MAIN = 1, // Main
stream
DPSDK_CORE_STREAMTYPE_SUB = 2, // Sub
stream
}dpsdk_stream_type_e;

4.2.14 Device Manufacturer Type

typedef enum
{
DPSDK_CORE_DEVICE_FACTORY_UNDEF INE = 0, //
Undefined
DPSDK_CORE_DEVICE_FACTORY_DAHUA = 1, //
Dahua
DPSDK_CORE_DEVICE_FACTORY_HIK = 2, //
Hikvision}dpsdk_device_factory_type_e;

4.2.15 Media Type

typedef enum
{
DPSDK_CORE_MEDIATYPE_VIDEO = 1, // Video
DPSDK_CORE_MEDIATYPE_AUDIO = 2, // Audio
DPSDK_CORE_MEDIATYPE_ALL = 3, // All

99/136
 }dpsdk_media_type_e;

4.2.16 Transmission Type

typedef enum
{
DPSDK_CORE_TRANSTYPE_UDP = 0, // UDP
DPSDK_CORE_TRANSTYPE_TCP = 1, // TCP
}dpsdk_trans_type_e;

4.2.17 Stream Output Load Type

typedef enum
{
DPSDK_CORE_TRACKIDTYPE_PS = 501, // PS
pack
rd
DPSDK_CORE_TRACKIDTYPE_ORIG = 601, // 3
party original frame
DPSDK_CORE_TRACKIDTYPE_DH = 701, //
Dahua frame
DPSDK_CORE_TRACKIDTYPE_DHSTD = 801, //
Dahua standard frame
DPSDK_CORE_TRACKIDTYPE_TS = 901, // TS
pack
DPSDK_CORE_TRACKIDTYPE_RTP = 101, // RTP
standard stream
}dpsdk_trackid_type_e;

4.2.18 Stream Video Resolution Type

typedef enum
{
DPSDK_CORE_RESOLUTION_1080P = 1, // 1080P
DPSDK_CORE_RESOLUTION_130M = 2, // 130M
DPSDK_CORE_RESOLUTION_720P = 3, // 720P
DPSDK_CORE_RESOLUTION_D1 = 4, // D1
DPSDK_CORE_RESOLUTION_CIF = 5, // CIF
DPSDK_CORE_RESOLUTION_QCIF = 6, // QCIF
DPSDK_CORE_RESOLUTION_VGA = 7, // VGA
DPSDK_CORE_RESOLUTION_QVGA = 8, // QVGA
}dpsdk_resolution_type_e;

100/136
4.2.19 Video Encoding Format
typedef enum
{
DPSDK_CORE_VIDEOCODEC_H264 = 1, // h264
DPSDK_CORE_VIDEOCODEC_MPEG4 = 2, //
mpeg4
DPSDK_CORE_VIDEOCODEC_JPEG = 3, // jpeg
}dpsdk_resolution_type_e;

4.2.20 Audio Type

typedef enum{
Talk_Coding_Default = 0,
Talk_Coding_PCM = 1, //PCM
Talk_Coding_G711a, //G711a
Talk_Coding_AMR, //AMR
Talk_Coding_G711u, //G711u
Talk_Coding_G726, //G726
Talk_Coding_AAC = 8, //
Talk_Coding_G722 = 101, //G722 Hikvision
device use
Talk_Coding_G711_MU, //G711 Hikvision use
}dpsdk_audio_type_e;

4.2.21 Bit
typedef enum
{
Talk_Audio_Bits_8 = 8,
Talk_Audio_Bits_16 = 16,
}dpsdk_talk_bits_e;

4.2.22 Sampling Rate

typedef enum
{
Talk_Audio_Sam_8K = 8000,
Talk_Audio_Sam_16K = 16000,
Talk_Audio_Sam_8192 = 8192,
}Talk_Sample_Rate_e;

101/136
4.2.23 Device Type
typedef enum{
Talk_Type_Device = 1, //Device
Talk_Type_Channel //Channel
}dpsdk_talk_type_e;

4.2.24 Picture Type

typedef enum
{
DPSDK_CORE_PIC_FORMAT_BMP = 0, // BMP
DPSDK_CORE_PIC_FORMAT_JPEG = 1, // JPEG
}dpsdk_pic_type_e;

4.2.25 Video Source Type

typedef enum
{
DPSDK_CORE_PB_RECSOURCE_ALL = 1, // All
DPSDK_CORE_PB_RECSOURCE_DEVICE = 2, //
Device record
DPSDK_CORE_PB_RECSOURCE_PLATFORM = 3, // Platform
record
}dpsdk_recsource_type_e;

4.2.26 Record Type

typedef enum
{
DPSDK_CORE_PB_RECORD_UNKONWN = 0, // All record
DPSDK_CORE_PB_RECORD_MANUAL = 1, //
Manual record
DPSDK_CORE_PB_RECORD_ALARM = 2, // Alarm
record
DPSDK_CORE_PB_RECORD_MOTION_DETECT = 3, //
Motion detect
DPSDK_CORE_PB_RECORD_VIDEO_LOST = 4, // Video
loss

102/136
 DPSDK_CORE_PB_RECORD_VIDEO_SHELTER = 5, //
Privacy mask
DPSDK_CORE_PB_RECORD_T IMER = 6, // Record
timer
DPSDK_CORE_PB_RECORD_ALL_DAY = 7, // All day
record
DPSDK_CORE_PB_RECORD_CARD = 25, // Card
record
}dpsdk_record_type_e;

4.2.27 Record Stream Request Type

typedef enum
{
DPSDK_CORE_PB_MODE_NORMAL = 1, // Playback
DPSDK_CORE_PB_MODE_DOWNLOAD = 2, //
Download
}dpsdk_pb_mode_e;

4.2.28 Record Stream Speed Type

typedef enum
{
DPSDK_CORE_PB_NORMAL = 8, // 1x
DPSDK_CORE_PB_FAST2 = DPSDK_CORE_PB_NORMAL *
2, // 2x
DPSDK_CORE_PB_FAST4 = DPSDK_CORE_PB_NORMAL *
4, // 4x
DPSDK_CORE_PB_FAST8 = DPSDK_CORE_PB_NORMAL *
8, // 8x
DPSDK_CORE_PB_SLOW2 = DPSDK_CORE_PB_NORMAL / 2,
// 1/2x
DPSDK_CORE_PB_SLOW4 = DPSDK_CORE_PB_NORMAL / 4,
// 1/4x
DPSDK_CORE_PB_SLOW8 = DPSDK_CORE_PB_NORMAL / 8,
// 1/8x
}dpsdk_dpsdk_speeed_e;

4.2.29 PTZ Direction Command

typedef enum

103/136
 {
DPSDK_CORE_PTZ_GO_UP = 1, // Up
DPSDK_CORE_PTZ_GO_DOWN = 2, // Down
DPSDK_CORE_PTZ_GO_LEFT = 3, // Left
DPSDK_CORE_PTZ_GO_RIGHT = 4, // Right
DPSDK_CORE_PTZ_GO_LEFTUP = 5, // Upper left
DPSDK_CORE_PTZ_GO_LEFTDOWN = 6, // Lower left
DPSDK_CORE_PTZ_GO_RIGHT UP = 7, // Upper
right
DPSDK_CORE_PTZ_GO_RIGHTDOWN = 8, // Lower
right
}dpsdk_ptz_direct_e;

4.2.30 PTZ Picture Command

typedef enum
{
DPSDK_CORE_PTZ_ADD_ZOOM = 0, // Zoom+
DPSDK_CORE_PTZ_ADD_FOCUS = 1, // Focus+
DPSDK_CORE_PTZ_ADD_APERTURE = 2, // Iris+
DPSDK_CORE_PTZ_REDUCE_ZOOM = 3, //
Zoom-
DPSDK_CORE_PTZ_REDUCE_FOCUS = 4, //
Focus-
DPSDK_CORE_PTZ_REDUCE_APERTURE = 5, // Iris-
}dpsdk_camera_operation_e;

4.2.31 PTZ Lock Type

typedef enum
{
DPSDK_CORE_PTZ_CMD_LOCK = 1, // Lock current camera
DPSDK_CORE_PTZ_CMD_UNLOCK_ONE = 2, // Unlock current camera
DPSDK_CORE_PTZ_CMD_UNLOCK_ALL = 3, // Unlock all camera
}dpsdk_ptz_locktype_e;

4.2.32 PTZ Preset Opration Type

typedef enum
{
DPSDK_CORE_PTZ_PRESET_LOCATION = 1, // Preset

104/136
 location
DPSDK_CORE_PTZ_PRESET_ADD = 2, // Add preset
DPSDK_CORE_PTZ_PRESET_DEL = 3, // Delete
preset
}dpsdk_ptz_prepoint_cmd_e;

4.2.33 PTZ Extension Command

typedef enum
{
DPSDK_CORE_PTZ_NEW_COMMAND_BEGIN = 35, // Extension command start
DPSDK_CORE_PTZ_ADD_PRESET_TO_TOUR, // Add preset to tour
DPSDK_CORE_PTZ_DEL_PRESET_TO_TOUR, // Delete preset in tour
DPSDK_CORE_PTZ_CLEAR_TOUR, // Clear tour path
DPSDK_CORE_PTZ_START_AUTO_ROUND, // Start horizontal rotation
DPSDK_CORE_PTZ_STOP_AUTO_ROUND, // Stop horizontal
rotation
DPSDK_CORE_PTZ_SET_LEFT_SCAN_RANGE, // Set left range
DPSDK_CORE_PTZ_SET_RIGHT_SCAN_RANGE, // Set right range
DPSDK_CORE_PTZ_START_SCAN, // Start scan
DPSDK_CORE_PTZ_STOP_SCAN, // Stop scan
DPSDK_CORE_PTZ_SET_MODLE_START, // Set mode start path
DPSDK_CORE_PTZ_SET_MODLE_CANCEL, // Set mode cancel path
DPSDK_CORE_PTZ_RUN_MODLE, // Running mode path
DPSDK_CORE_PTZ_STOP_MODLE, // Stop mode path
DPSDK_CORE_PTZ_CLEAR_MODLE, // Clear mode path
DPSDK_CORE_PTZ_UPDOWN, // Flip command
DPSDK_CORE_PTZ_QUICK_ORIENTATION, // Quick orientation
H(8192) V(8192) Zoom(4)
DPSDK_CORE_PTZ_OPEN_ASSISTANT_POINT, // Assistant open point
DPSDK_CORE_PTZ_CLOSE_ASSISTANT_POINT, // Assistant close point
DPSDK_CORE_PTZ_OPEN_IPC_MENU, // Open SD menu ww
DPSDK_CORE_PTZ_CLOSE_IPC_MENU, // Close menu
DPSDK_CORE_PTZ_MENU_ASSURE, // Menu OK
DPSDK_CORE_PTZ_MENU_CALCEL, // Menu cancel
DPSDK_CORE_PTZ_MENU_UP, // Menu up
DPSDK_CORE_PTZ_MENU_DOWN, // Menu down
DPSDK_CORE_PTZ_MENU_LEFT, // Menu left
DPSDK_CORE_PTZ_MENU_RIGHT, // Menu right
}dpsdk_ptz_extend_cmd_e;

105/136
4.2.34 Alarm Type
// Alarm type
typedef enum
{
DPSDK_CORE_ALARM_TYPE_Unknown = 0, // Unknown
DPSDK_CORE_ALARM_TYPE_VIDEO_LOST, // Video loss
DPSDK_CORE_ALARM_TYPE_EXTERNAL_ALARM, //
External alarm
DPSDK_CORE_ALARM_TYPE_MOT ION_DETECT, // Motion
detect
DPSDK_CORE_ALARM_TYPE_VIDEO_SHELTER, // Privacy
mask
DPSDK_CORE_ALARM_TYPE_DISK_F ULL, // Disk
full
DPSDK_CORE_ALARM_TYPE_DISK_FAULT, // Disk
fault
DPSDK_CORE_ALARM_TYPE_FIBER, // Fiber alarm
DPSDK_CORE_ALARM_TYPE_GPS, // GPS
signal
DPSDK_CORE_ALARM_TYPE_3G, // 3G
DPSDK_CORE_ALARM_TYPE_STAT US_RECORD, // Device
record status
DPSDK_CORE_ALARM_TYPE_STAT US_DEVNAME, //
Device name
DPSDK_CORE_ALARM_TYPE_STAT US_DISKINFO, // Disk
info
//Access control
DPSDK_CORE_ALARM_TYPE_VALID_CARD_READ = 51, //
Valid card reading
DPSDK_CORE_ALARM_TYPE_INVALID_CARD_READ, // Invalid card
reading
DPSDK_CORE_ALARM_TYPE_DOOR_MAGNETIC_ERROR, //
Sensor alarm
DPSDK_CORE_ALARM_TYPE_DOOR_BREAK, //
Breakdoor alarm and unlock overtime alarm
DPSDK_CORE_ALARM_TYPE_DOOR_ABNORMAL_CLOSED,
// Door closed abnormally
DPSDK_CORE_ALARM_TYPE_DOOR_NORMAL_CLOSED, //
Door closed normally
DPSDK_CORE_ALARM_TYPE_DOOR_OPEN, // Door
open

106/136
 DPSDK_CORE_ALARM_DOOR_OPEN_TIME_OUT_BEG = 60,
DPSDK_CORE_ALARM_DOOR_OPEN_TIME_OUT_END = 70,

//end
//Alarm host
DPSDK_CORE_ALARM_TYPE_ALARM_CONTROL_ALERT = 81, //
Alarm host alarm
DPSDK_CORE_ALARM_TYPE_FIRE_ALARM, // Fire
alarm
DPSDK_CORE_ALARM_TYPE_ZONE_DISABLED, // Zone
disabled
DPSDK_CORE_ALARM_TYPE_BATTERY_EMPTY, // No
battery
//end
DPSDK_CORE_ALARM_3GFLOW, // 3G flow
DPSDK_CORE_ALARM_AAC_POWEROFF, //
ACC outage alarm
DPSDK_CORE_ALARM_SPEEDLIMIT_LOWERSPEED, //
Speedlimit alarm LowerSpeed
DPSDK_CORE_ALARM_SPEEDLIMIT_UPPERSPEED, //
Speed limit alarm UpperSpeed
DPSDK_CORE_ALARM_VEHICLEINFOUPLOAD_CHECKIN, //
Mobile custom info upload CheckIn
DPSDK_CORE_ALARM_VEHICLEINFOUPLOAD_CHECKOUT, //
Mobile custom info upload CheckOut
DPSDK_CORE_ALARM_REBOOT_EVENT, // Device
needs to be rebooted
DPSDK_CORE_ALARM_FILESYSTEM = 100, // File
system
DPSDK_CORE_ALARM_RAID_FAULT, // raid fault
DPSDK_CORE_ALARM_RECORDCHANNELF UNCTION_ABNORMAL,
// Channel function abnormal
DPSDK_CORE_SVR_HARDDISK_STAT US, // Disk
status
//Traffic
DPSDK_CORE_ALARM_OVERSPEED_OCCURE = 201, //
Overspeed alarm on
DPSDK_CORE_ALARM_OVERSPEED_DISAPPEAR, //
Overspeed alarm off
DPSDK_CORE_ALARM_DRIVEROUT_DRIVERALLOW, //
Drive out
DPSDK_CORE_ALARM_DRIVERIN_DRIVERALLOW, //
Drive in

107/136
 DPSDK_CORE_ALARM_DRIVEROUT_FORBIDDRIVE, //
Drive out forbidded drive
DPSDK_CORE_ALARM_DRIVERIN_FORBIDDRIVE, // Drive
in forbidded drive
DPSDK_CORE_ALARM_DRIVEROUT_LOADGOODS, //
Drive out load area
DPSDK_CORE_ALARM_DRIVERIN_LOADGOODS, // Drive
in load area
DPSDK_CORE_ALARM_DRIVEROUT_UNLOADGOODS,
// Drive out unload area
DPSDK_CORE_ALARM_DRIVERIN_UNLOADGOODS, //
Drive in unload area
DPSDK_CORE_ALARM_CAR_OVER_LOAD, //
Over load
DPSDK_CORE_ALARM_SPEED_SOON_ZERO, // Break
hard
DPSDK_CORE_ALARM_OSD, // osd info
DPSDK_CORE_ALARM_CROSS_INFO, //Cross
//Intelligent alarm
DPSDK_CORE_ALARM_IVS_ALARM_BEGIN = 300, // IVS
type based on dhnetsdk.h +300（add in DMS service）
DPSDK_CORE_ALARM_IVS_ALARM, // IVS
alarm
DPSDK_CORE_ALARM_CROSSLINEDETECTION, // Cross line
detect
DPSDK_CORE_ALARM_CROSSREGIONDETECTION , //
Cross line region event
DPSDK_CORE_ALARM_PASTEDETECTION, // Paste
detect
DPSDK_CORE_ALARM_LEFTDETECTION, //
Abandoned object detect
DPSDK_CORE_ALARM_STAYDETECT ION, // Stay
detect
DPSDK_CORE_ALARM_WANDERDETECTION, //
Loitering detect
DPSDK_CORE_ALARM_PRESERVAT ION, //
Preservation
DPSDK_CORE_ALARM_MOVEDETECT ION, // Move
detect
DPSDK_CORE_ALARM_TAILDETECT ION, // Tail
detect
DPSDK_CORE_ALARM_RIOTERDETECTION, // Rioter
detect

108/136
 DPSDK_CORE_ALARM_FIREDETECTION, // Fire
detect
DPSDK_CORE_ALARM_SMOKEDETECT ION, // Smoke
detect
DPSDK_CORE_ALARM_FIGHTDETECTION, // Fight
detect
DPSDK_CORE_ALARM_FLOWSTAT, // Flow stat
DPSDK_CORE_ALARM_NUMBERSTAT, //
Quantity stat
DPSDK_CORE_ALARM_CAMERACOVERDDETECTION,
// Camera covered detect
DPSDK_CORE_ALARM_CAMERAMOVEDDETECT ION, //
Camera move detect
DPSDK_CORE_ALARM_VIDEOABNORMALDETECTION, //
Video abnormal dete
DPSDK_CORE_ALARM_VIDEOBADDETECT ION, //
Video bad detect
DPSDK_CORE_ALARM_TRAFFICCONTROL, // Traffic
control
DPSDK_CORE_ALARM_TRAFFICACCIDENT, // Traffic
accident
DPSDK_CORE_ALARM_TRAFFICJUNCTION, // Traffic
intersection
DPSDK_CORE_ALARM_TRAFFICGATE, // ANPR
DPSDK_CORE_ALARM_TRAFFICSNAPSHOT, // Traffic
snapshot
DPSDK_CORE_ALARM_FACEDETECT, // Face
detect
DPSDK_CORE_ALARM_TRAFFICJAM, // Traffic jam

DPSDK_CORE_ALARM_TRAFFIC_RUNREDLIGHT= 0x00000100 + 300, // Run the red

light
DPSDK_CORE_ALARM_TRAFFIC_OVERLINE= 0x00000101 + 300,// Overline
DPSDK_CORE_ALARM_TRAFFIC_RETROGRADE= 0x00000102 + 300,//
Retrograde
DPSDK_CORE_ALARM_TRAFFIC_TURNLEFT= 0x00000103 + 300,// Turn left
DPSDK_CORE_ALARM_TRAFFIC_TURNRIGHT= 0x00000104 + 300,// Turn right
DPSDK_CORE_ALARM_TRAFFIC_UT URN= 0x00000105 + 300, // U turn
DPSDK_CORE_ALARM_TRAFFIC_OVERSPEED = 0x00000106 + 300, //
Overspeed
DPSDK_CORE_ALARM_TRAFFIC_UNDERSPEED= 0x00000107 + 300, //
Underspeed
DPSDK_CORE_ALARM_TRAFFIC_PARKING= 0x00000108 + 300, // Illegal parking

109/136
 DPSDK_CORE_ALARM_TRAFFIC_WRONGROUTE = 0x00000109 + 300, //
Wrong route
DPSDK_CORE_ALARM_TRAFFIC_CROSSLANE= 0x0000010A + 300, // Cross lane
DPSDK_CORE_ALARM_TRAFFIC_OVERYELLOWLINE = 0x0000010B + 300, //
Over yellow line
DPSDK_CORE_ALARM_TRAFFIC_DRIVINGONSHOULDER= 0x0000010C + 300,
// Driving on shoulder
DPSDK_CORE_ALARM_TRAFFIC_YELLOWPLATEINLANE= 0x0000010E + 300,
// Yellow plate in lane
DPSDK_CORE_ALARM_CROSSFENCEDETECT ION= 0x0000011F + 300, // Cross
fence detect
DPSDK_CORE_ALARM_ELECTROSPARKDETECT ION= 0X00000110 + 300, //
Electrospark detect
DPSDK_CORE_ALARM_TRAFFIC_NOPASSING= 0x00000111 + 300, // No
passing
DPSDK_CORE_ALARM_ABNORMALRUNDETECTION = 0x00000112 + 300, //
Abnormal run detect
DPSDK_CORE_ALARM_RETROGRADEDETECTION = 0x00000113 + 300, //
Retrograde detect
DPSDK_CORE_ALARM_INREGIONDETECT ION = 0x00000114 + 300, //
In region detect
DPSDK_CORE_ALARM_TAKENAWAYDETECTION = 0x00000115 + 300, //
Missing object detect
DPSDK_CORE_ALARM_PARKINGDETECTION = 0x00000116 + 300, //
Illegalparking detect
DPSDK_CORE_ALARM_FACERECOGNIT ION = 0x00000117 + 300, // Face
recognition detect
DPSDK_CORE_ALARM_TRAFFIC_MANUALSNAP = 0x00000118 + 300, //
Manual snapshot detect
DPSDK_CORE_ALARM_TRAFFIC_FLOWSTATE = 0x00000119 + 300, //
Flow stat detect
DPSDK_CORE_ALARM_TRAFFIC_STAY = 0x0000011A + 300, // Traffic stay
detect
DPSDK_CORE_ALARM_TRAFFIC_VEHICLEINROUTE = 0x0000011B + 300, //
Vehicle in route detect
DPSDK_CORE_ALARM_MOTIONDETECT = 0x0000011C + 300, // Video
motion detect
DPSDK_CORE_ALARM_LOCALALARM = 0x0000011D + 300, //
External alarm detect
DPSDK_CORE_ALARM_PRISONERRISEDETECTION = 0X0000011E + 300, //
Prisone rise detect
DPSDK_CORE_ALARM_IVS_B_ALARM_END, above alarms are IVS_B service
alarm type, cooperate with SDK

110/136
 DPSDK_CORE_ALARM_VIDEODIAGNOSIS = 0X00000120 + 300, //
Video disgnosis result detect
DPSDK_CORE_ALARM_IVS_V_ALARM =
DPSDK_CORE_ALARM_VIDEODIAGNOSIS,
DPSDK_CORE_ALARM_IVS_ALARM_END = 1000,
}dpsdk_alarm_type_e;

4.2.35 Alarm Occurence Type

typedef enum
{
ALARM_EVENT_OCCUR = 1, // Alarm occur
ALARM_EVENT_DISAPPEAR, = 2， // Alarm
cancel
}dpsdk_event_type_e;

4.2.36 Alarm Processing Type

// Alarm processing type
typedef enum
{
ALARM_DEALWITH_PENDING = 1, // Processed
ALARM_DEALWITH_RESOLVE = 2, // Resolved
ALARM_DEALWITH_SUGGESTTED = 4, // Suggested
ALARM_DEALWITH_IGNORED = 8, // Ignored
ALARM_DEALWITH_UNPROCESSED = 16 //
Unprocessed
}dpsdk_alarm_dealwith_e;

4.2.37 TV Wall Split Capability

// TV wall split capability
typedef enum
{
Screen_Split_1 = 1,
Screen_Split_4 = 4,
Screen_Split_9 = 9,
Screen_Split_16 = 16,
}tvwall_screen_split_caps;

111/136
4.3 Structure Type Explanation

4.3.1 Login Info

typedef struct tagLoginInfo
{
char szIp[DPSDK_CORE_IP_LEN]; // Server IP
int32_t nPort; // Server port
char szUsername[DPSDK_CORE_USER_NAME_LEN]; // Username
char szPassword[DPSDK_CORE_PASSWORD_LEN]; // Password
}Login_Info_t;

4.3.2 Organization Info

typedef struct tagDepInfo
{
char szCoding[DPSDK_CORE_DGROUP_DGPCODE_LEN]; // Node code
char szDepName[DPSDK_CORE_DGROUP_DGPNAME_LEN]; // Node
name
}Dep_Info_t;

4.3.3 Device Info

typedef struct tagDeviceInfo
{
char szId[DPSDK_CORE_DEV_ID_LEN]; // Device ID
char szName[DPSDK_CORE_DGROUP_DEVICENAME_LEN]; // Name
char szUser[DPSDK_CORE_USER_NAME_LEN]; // Username
char szPassword[DPSDK_CORE_PASSWORD_LEN]; // Passqord
char szIP[DPSDK_CORE_IP_LEN]; // Device IP
uint32_t nPort; // Device port
dpsdk_device_factory_type_e nFactory; // Device
manufacturer type
uint32_t nEncChannelChildCount; // Encode sub channel
quantity
}Device_Info_t;

4.3.4 Encode Channel Info

typedef struct tagEncChannelInfo
{

112/136
 char szId[DPSDK_CORE_DEV_ID_LEN]; // Channel ID
char szName[DPSDK_CORE_DGROUP_DEVICENAME_LEN]; // Name

}Enc_Channel_Info_t;

4.3.5 Load Organization Request Info by Level

typedef struct tagLoadDepInfo
{
IN char szCoding[DPSDK_CORE_DGROUP_DGPCODE_LEN]; // Node
code
IN dpsdk_getgroup_operation_e nOperation; // Get node depth
}Load_Dep_Info_t;

4.3.6 Get Organization Quantity Request Info

typedef struct tagGetDepCountInfo
{
IN char szCoding[DPSDK_CORE_DGROUP_DGPCODE_LEN]; // Node
code
OUT uint32_t nDepCount; // Organization
quantity
OUT uint32_t nDeviceCount; // Device quantity
}Get_Dep_Count_Info_t;

4.3.7 Get Organization Request Info

typedef struct tagGetDepInfo
{
IN char szCoding[DPSDK_CORE_DGROUP_DGPCODE_LEN]; //
Node code
IN uint32_t DepCount; // Organizatioon
quantity
OUT Dep_Info_t* pDepInfo; // Organization
info
IN uint32_t nDeviceCount; // Device quantity
OUT Device_Info_t* pDeviceInfo; // Device info
}Get_Dep_Info_t;

113/136
4.3.8 Channel Organization Node Info
typedef struct tagOrgInfo
{
IN char szCode[DPSDK_CORE_ORG_CODE_LEN]; //
General node code
IN char szName[DPSDK_CORE_ORG_NAME_LEN]; //
General node name
IN char szSN[DPSDK_CORE_ORG_SN_LEN]; // General
node SN
IN char szType[DPSDK_CORE_ORG_TYPE_LEN]; // General
node type
IN char szGpsX[DPSDK_CORE_ORG_GPS_LEN]; //
General node longitude
IN char szGpsY[DPSDK_CORE_ORG_GPS_LEN]; //
General node latitude
IN char szMemo[DPSDK_CORE_ORG_MEMO_LEN]; //
General node description
uint32_t domainId; // Domain ID
uint32_t state; // Status
}Org_Info_t;

4.3.9 Get General Organization Quantity Request Info

typedef struct tagGetOrgCountInfo
{
IN char szCoding[DPSDK_CORE_ORG_CODE_LEN]; // Node
code
OUT uint32_t nGroupCount; // General
organization quantity
}Get_Org_Count_Info_t;

4.3.10 Get General Organization Request Info

typedef struct tagGetOrgInfo
{
IN char szCoding[DPSDK_CORE_ORG_CODE_LEN]; // Node code
IN uint32_t nOrgCount; // Organization
quantity
OUT Org_Info_t* pOrgInfo; // General
organization info
}Get_Org_Info_t;

114/136
4.3.11 Department Zone Relation Info
typedef struct tagDeptAreaRelation
{
Char szDeptCode[DPSDK_CORE_ORG_CODE_LEN];
//Department node encode
char szAreaCode[DPSDK_CORE_ORG_CODE_LEN]; //Zone
node code
}DeptArea_Relation_t;

4.3.12 Get Department Zone Relation Request Info

typedef struct tagGetDeptAreaRelation
{
IN uint32_t nCount; // Department zone
relation record
OUT DeptArea_Relation_t* pDeptAreaRelation; // Department zone
relation, create externally, if as NULL then only return quantity
}Get_DeptArea_Relation_t;

4.3.13 Department Staff Info

typedef struct tagPersonInfo
{
IN char szCode[DPSDK_CORE_PERSON_CODE_LEN]; // Staff
code
IN char szName[DPSDK_CORE_PERSON_NAME_LEN]; // Staff
name
IN char szDeptCode[DPSDK_CORE_PERSON_DEPTCODE_LEN]; // Staff
department code
IN char szSN[DPSDK_CORE_PERSON_SN_LEN]; // Staff
SN
IN char szType[DPSDK_CORE_PERSON_TYPE_LEN]; // Staff
type
IN char szOffice[DPSDK_CORE_PERSON_OFFICE_LEN]; // Staff
office
IN char szMobileNum[DPSDK_CORE_PERSON_MOBILENUM_LEN];//
Staff mobile phone number
IN char szVirtualNum[DPSDK_CORE_PERSON_VIRT UALNUM_LEN];//
Staff short no.
IN char szState[DPSDK_CORE_PERSON_STATE_LEN]; // Staff

115/136
 status
}Person_Info_t;

4.3.14 Get Department Staff Request Info

typedef struct tagGetPersonInfo
{
IN char szDeptCoding[DPSDK_CORE_PERSON_DEPTCODE_LEN];//
Department code
IN uint32_t nPersonCount; // Department
staff quantity
OUT Person_Info_t* pPersonInfo; // Staff info，
}Get_Person_Info_t;

4.3.15 Get Channel Request Info

// Get channel request info
typedef struct tagGetChannelInfo
{
IN char szDeviceId[DPSDK_CORE_DEV_ID_LEN]; // Device ID
IN uint32_t nEncChannelChildCount; // Channel
quantity
OUT Enc_Channel_Info_t* pEncChannelnfo; // Chanel info
}Get_Channel_Info_t;

4.3.16 Get Device Supported Stream

// Get device supported stream type
typedef struct tagGetDevStreamTypeInfo
{
IN char szDeviceId[DPSDK_CORE_DEV_ID_LEN]; // Device ID
IN int nUnitNo; // Unit no.
OUT dpsdk_stream_type_e nStreamType; // Supported
stream type
}Get_Dev_StreamType_Info_t;

4.3.17 Get Media StreamUrl Reuqested Info

typedef struct tagGetRealStreamUrlInfo
{

116/136
 IN char szCameraId[DPSDK_CORE_CHL_ID_LEN]; // Channel ID
IN dpsdk_stream_type_e nStreamType; // Stream type
IN dpsdk_media_type_e nMediaType; // Media type
IN dpsdk_trans_type_e nTransType; // Transmission
type
OUT char szUrl[DPSDK_TAG_URL_LEN]; // URL info
}Get_RealStreamUrl_Info_t;

4.3.18 Get Outward Media Stream Url Requested Info

typedef struct tagGetExternalRealStreamUrlInfo
{
IN char szCameraId[DPSDK_CORE_CHL_ID_LEN]; // Channel ID
IN dpsdk_stream_type_e nStreamType; // Stream type
IN dpsdk_media_type_e nMediaType; // Media type
IN dpsdk_trans_type_e nTransType; // Transmission type
IN dpsdk_trackid_type_e nTrackId; // Track ID
IN bool bUsedVCS; // Need VCS
conversion
IN dpsdk_videocodec_type_e nVcsVideocodec; // Video encoding
format after conversion, bUsedVCS as 1 is valid
IN dpsdk_resolution_type_e nVcsResolution; // Stream video
resolution, bUsedVCS as 1 is valid
IN uint32_t nVcsfps; // Stream frame rate,
bUsedVCS as 1 is valid.
IN uint32_t nVcsbps; // Stream bit rate,
bUsedVCS as 1 is valid.
OUT char szUrl[DPSDK_TAG_URL_LEN]; // URL info
}Get_ExternalRealStreamUrl_Info_t;

4.3.19 Obtain Stream Info

// Obtain stream info
typedef struct tagGetRealStreamInfo
{
char szCameraId[DPSDK_CORE_CHL_ID_LEN]; // Channel ID
dpsdk_stream_type_e nStreamType; // Stream type
dpsdk_media_type_e nMediaType; // Media type
dpsdk_trans_type_e nTransType; // Transmission type
}Get_RealStream_Info_t;

117/136
4.3.20 Get Report People Flow Info
// Get report people flow info
typedef struct tagGetPeopleCount
{
char szBeginTime[DPSDK_CORE_T IME_LENGTH]; // Start time
char szEndTime[DPSDK_CORE_T IME_LENGTH]; // End time
uint32_t nEnterCount; // Enter people
uint32_t nExitCount; // Exit people
}Get_People_Count_t;

4.3.21 Get Audio Stream Info

typedef struct tagGetTalkStreamInfo
{
char szCameraId[DPSDK_CORE_CHL_ID_LEN]; // Device or
channel ID dpsdk_audio_type_e nAudioType; // Audio
type
dpsdk_talk_type_e nTalkType; // Device type
dpsdk_talk_bits_e nBitsType; // Bit
Talk_Sample_Rate_e nSampleType; // Sampling rate
type
dpsdk_trans_type_e nTransType; // Transmission
type

}Get_TalkStream_Info_t;

4.3.22 Audio Sampling Callback User Info

typedef struct tagAudioUserParam
{
long objectPoint; //

}AudioUserParam_t;

4.3.23 Searc Record Info

typedef struct tagQueryRecordInfo
{
char szCameraId[DPSDK_CORE_CHL_ID_LEN]; // Channel ID

118/136
 dpsdk_check_right_e nRight; // Check channel
right or not
dpsdk_recsource_type_e nSource; // Record source type
dpsdk_record_type_e nRecordType; // Record type
uint64_t uBeginTime; // Start time
uint64_t uEndTime; // End time
}Query_Record_Info_t;

4.3.24 Single Video Info

typedef struct tagSingleRecordInfo
{
int32_t nFileIndex; // File index
dpsdk_recsource_type_e nSource; // Record source type
dpsdk_record_type_e nRecordType; // Record type
uint64_t uBeginTime; // Start time
uint64_t uEndTime; // End time
uint64_t uLength; // Size
}Single_Record_Info_t;

4.3.25 Record Info

typedef struct tagRecordInfo
{
IN char szCameraId[DPSDK_CORE_CHL_ID_LEN]; // Channel ID
IN int32_t nBegin; // Record start
IN int32_t nCount; // Request record
count
OUT int32_t nRetCount; // Actural return
count
OUT Single_Record_Info_t* pSingleRecord; // Record info
}Record_Info_t;

4.3.26 Obtain Record Stream Info by File

typedef struct tagGetRecordStreamFileInfo
{
char szCameraId[DPSDK_CORE_CHL_ID_LEN]; // Channel ID
dpsdk_pb_mode_e nMode; // Record Request
Type

119/136
 uint32_t nFileIndex; // File index
}Get_RecordStream_File_Info_t;

4.3.27 Obtain Record Stream Info by Time

typedef struct tagGetRecordStreamTimeInfo
{
char szCameraId[DPSDK_CORE_CHL_ID_LEN]; // Channel ID
dpsdk_pb_mode_e nMode; // Record Request

// By time
dpsdk_recsource_type_e nSource; // Record source type
uint64_t uBeginTime; // Start time
uint64_t uEndTime; // End time
}Get_RecordStream_Time_Info_t;

4.3.28 Video Image Propert Info

typedef struct tagVideoColorInfo
{
int32_t nBrightness; // Brightness, default;
range 0-128
int32_t nContrast; //
Contrasy,default;range 0-128
int32_t nSaturation; // Saturation,default;
range 0-128
int32_t nHue; // HUE, default;
range 0-128
}Video_Color_Info_t;

4.3.29 Vehicle Violation Picture Info

typedef struct tagTrafficViolationInfo
{
char szRecordId[DPSDK_CORE_CAR_RECORD_ID_LEN]; // Record
ID
char szDeviceId[DPSDK_CORE_DEV_ID_LEN]; // Device ID
int32_t nChannel; // Channel
char szChannelId[DPSDK_CORE_CHL_ID_LEN]; // Channel
no.
int32_t ntype; // Violation alarm违章

120/136
 type
char szDeviceName[DPSDK_CORE_DGROUP_DEVICENAME_LEN];//
Device name
char szDeviceChnName[DPSDK_CORE_DGROUP_CHNNAME_LEN]; //
Channel name
char szCarNum[DPSDK_CORE_CAR_NUM_LENGTH]; // Plate no.
int32_t nCarNumType; // Plate type
int32_t nCarNumColor; // Plate color
int32_t nCarColor; // Vehicel color
int32_t nCarType; // Vehicle type
int32_t nCarLogo; // Logo type
int32_t nWay; // Lane no.
int32_t nCarSpeed; // Speed
int32_t nCarLen; // Vehicle length
unit
int32_t nCardirect; // Direction
direction
int32_t nMaxSpeed; // Speed limit
int32_t nMinSpeed; // Min limtt,
char szCapturedate[DPSDK_CORE_TIME_LEN]; // Precise to
second
char szOptNote[DPSDK_CORE_OPT_NOTE_LEN]; // Note
int32_t nPicNum; // Picture
char
szPicName[DPSDK_CORE_BAY_IMG_NUM][DPSDK_CORE_F ILEPAT H_LEN];
//Picture file name，max supports . If it is null, then create by PTS.
int32_t nRtPlate[DPSDK_CORE_COORDINATE_LEN]; // Plate coordinate,

int32_t nDataSource; // Data source

}Traffic_Violation_Info_t;

4.3.30 Violation Alarm Data Structure Info

typedef struct tagTrafficAlarmInfo
{
char szCameraId[DPSDK_CORE_CHL_ID_LEN]; // Channel ID
char nPtsIp[DPSDK_CORE_BAY_IP_LEN]; // pts LAN
char nPtsIpy[DPSDK_CORE_BAY_IP_LEN]; // pts WAN
int32_t nPicPort; // pic LAN port
int32_t nPicPorty; // pic WAN port

121/136
 dpsdk_alarm_type_e type; // Violation type
char szCarNum[DPSDK_CORE_CAR_NUM_LENGTH]; // Plate
int32_t nLicentype; // Plate color type
int32_t nCarColor; // Vehicle color
int32_t nCarLogo; // Logo type
int32_t nWay; // Lane no.
char
szPicUrl[DPSDK_CORE_BAY_IMG_NUM][DPSDK_CORE_BAY_URL_LEN];
// Picture URL
uint32_t nPicGroupStoreID; // Picture group
storage ID
int32_t bNeedStore; // Save disk or not
int32_t bStored; // Saved or not
int32_t nAlarmLevel; // Alarm level
int32_t nAlarmTime; // Alarm time
precise to second，
//New text
int32_t nChannel; // Channel
char szDeviceId[DPSDK_CORE_DEV_ID_LEN]; // Device ID
char szDeviceName[DPSDK_CORE_DGROUP_DEVICENAME_LEN];//
Device name
char szDeviceChnName[DPSDK_CORE_DGROUP_CHNNAME_LEN]; //
Channel name
int32_t nCarType; // Vehicel type
int32_t nCarSpeed; // Speed
int32_t nCarLen; // Vehicle length
unit
int32_t nCardirect; // Direction
int32_t nMaxSpeed; // Speed limit
int32_t nMinSpeed; // Min limit
int32_t nRtPlate[DPSDK_CORE_COORDINATE_LEN]; // Plate
length coordinate
}Traffic_Alarm_Info_t;

4.3.31 Channel Traffic Flow Report Data Structure Info

typedef struct tagTrafficFlowInfo

{ char szChannelId[DPSDK_CORE_CHL_ID_LEN]; // Channel no.
char szDirect[DPSDK_CORE_DIRECT_LEN]; // Direction
no.
uint16_t nInterval; // Report interval unit上

122/136
 second
uint16_t nTrafficFlow; // Traffic flow
uint64_t nTime; // Report time
second
}TrafficFlow_Info_t;

4.3.32 Lane Traffic Flow Report Data Structure Info

typedef struct tagTrafficFlowLaneState

{
uint64_t nDateTime; //Data report time UTC
time
uint32_t nDetectorID; //Check lane no.
uint32_t nVolume; //Traffic volume（car/unit time）
car quantity
uint32_t nFlowRate; //Flow rate（car/hour）car
quantity
uint32_t nAverageSpeed; //Average speed
（km/hour）
float fTimeOccupancy; //Average time
occupancy（%）
uint32_t nTimeHeadway; // Head distance（s）
uint32_t nLength; //Average vehicle length
(m)
uint32_t nBackOfQueue; //Queue length（m）
uint32_t nTravelTime; //Travel time（s）
uint32_t nDelay; //Delay（s）
uint32_t nMotoVehicles; //Mimi car traffic （car/unit
time）
uint32_t nSmallVehicles; //Small car traffic（car/unit
time）
uint32_t nMediumVehicles; //Medium car traffic
（car/unit time）
uint32_t nLargeVehicles; //Big car traffic（car/unit
time）
uint32_t nLongVehicles; //Mega car traffic（car/unit
time）
uint32_t nState; //Status value：-flow too
large,2-flow too large recover,3-normal,4-flow too small,5-flow too small recover
uint32_t nFlow; //Flow value，unit：car
uint32_t nPeriod; //Flow value corresponding

123/136
 statistcis time
uint32_t nDrivingDir; //Direction，up and down.
Up, as vehicle approaching device/Down, as vehicle leanving device
}TrafficFlow_Lane_State;

4.3.33 Device Traffic Flow Report Data Structure Info

typedef struct tagDevTrafficFlowInfo

{
char szChannelId[DPSDK_CORE_CHL_ID_LEN]; // Channel no.
char szDirect[DPSDK_CORE_DIRECT_LEN]; // Direction no.,
see directionary
uint16_t nTrafficLaneNum; // Report lane flow
quantity
TrafficFlow_Lane_State* pLaneState; // Lane traffic flow status
}DevTrafficFlow_Info_t;

4.3.34 ANPR Bypass Report Data Structure Info

typedef struct tagBayCarInfo

{
char szDeviceId[DPSDK_CORE_DEV_ID_LEN]; //Device ID
int32_t nDevChnId; //Channel no.
char szChannelId[DPSDK_CORE_CHL_ID_LEN]; //Channel
ID
char szDeviceName[DPSDK_CORE_DGROUP_DEVICENAME_LEN];
//Device name
char szDeviceChnName[DPSDK_CORE_DGROUP_CHNNAME_LEN];
//Channel name
char szCarNum[DPSDK_CORE_CAR_NUM_LENGTH];
//Plate no.
int32_t nCarNumType; //Plate type
int32_t nCarNumColor; // Plate color
int32_t nCarSpeed; // Speed
int32_t nCarType; // Vehicle type
int32_t nCarColor; //Vehicle color
int32_t nCarLen; // Vehicle legnth
int32_t nCarDirect; // Direction

124/136
 int32_t nWayId; //Lane no.
unsigned long long lCaptureTime; //Snapshot time,
precise to ms
unsigned long lPicGroupStoreID; // Picture group
storage disk ID
int32_t nIsNeedStore; //Picture group
requires storage disk 0 ：Not need 1：need
int32_t nIsStoraged; // Picture group
has storage disk 0：imcomplete storage disk 1：compelte disk，reserved，not use for now
char szCaptureOrg[DPSDK_CORE_DGROUP_DGPNAME_LEN];
//Wanted organization
char szOptOrg[DPSDK_CORE_DGROUP_DGPNAME_LEN];
//Arming organization
char szOptUser[DPSDK_CORE_PERSON_NAME_LEN];
//Arming staff
char szOptNote[DPSDK_CORE_OPT_NOTE_LEN]; // Note
char szImg0Path[DPSDK_CORE_IMG_PAT H_LEN]; //Picture
path
char szImg1Path[DPSDK_CORE_IMG_PAT H_LEN];
char szImg2Path[DPSDK_CORE_IMG_PAT H_LEN];
char szImg3Path[DPSDK_CORE_IMG_PAT H_LEN];
char szImg4Path[DPSDK_CORE_IMG_PAT H_LEN];
char szImg5Path[DPSDK_CORE_IMG_PAT H_LEN];
}Bay_Car_Info_t;

4.3.35 Zone Speed Measure Report Info

//Zone speed measure report info

typedef struct tagAreaDetectInfo
{
char szAreaId[DPSDK_CORE_AREA_ID_LEN]; // Zone ID 50
char szAreaName[DPSDK_CORE_AREA_NAME_LEN]; // Zone
name 256
char szStartDevId[DPSDK_CORE_DEV_ID_LEN]; // Start device ID
uint32_t nStartChnNum; // Starting channel no.
char szStartChnId[DPSDK_CORE_CHL_ID_LEN]; // Starting
channel ID
char szStartDevName[DPSDK_CORE_DGROUP_CHNNAME_LEN]; //
Starting device name, UTF8 code
char szStartDevChnName[DPSDK_CORE_DGROUP_CHNNAME_LEN];//

125/136
Starting channel name, UTF8 code
uint64_t nStartCapTime; // Starting point pass time
uint32_t nStartCarSpeed; // Starting point pass
speed
char szStartPosId[DPSDK_CORE_POS_ID_LEN]; // Starting point
ANPR ID
char szStartPosName[DPSDK_CORE_POS_NAME_LEN]; // Starting
point ANPR name
char szEndDevId[DPSDK_CORE_DEV_ID_LEN]; // End point
device ID
uint32_t nEndChnNum; // End point
channel no.
char szEndChnId[DPSDK_CORE_CHL_ID_LEN]; // End point
channel ID
char szEndDevName[DPSDK_CORE_DGROUP_CHNNAME_LEN];// End
point device name,UTF8 code
char szEndDevChnName[DPSDK_CORE_DGROUP_CHNNAME_LEN]//
End point channel name,UTF8 code
uint64_t nEndCapTime; // End point pass
time
uint32_t nEndCarSpeed; // End time pass
speed
char szEndPosId[DPSDK_CORE_POS_ID_LEN]; // End point
ANPR ID
char szEndPosName[DPSDK_CORE_POS_NAME_LEN]; // End
point ANPR anme
uint32_t nAreaRange; // Zone distance
uint32_t nMinSpeed; // Road min speed
uint32_t nMaxSpeed; // Road max speed
char szCarNum[DPSDK_CORE_CAR_NUM_LENGTH]; // Plate
no.，UTF8 code
uint32_t nCarNumType; // Plate type
uint32_t nCarNumColor; // Plate color
uint32_t nCarColor; // Vehicle color
uint32_t nCarType; // Vehicle type
uint32_t nCarLogo; // Logo type
uint32_t nCarAvgSpeed; // Vehicle average
speed
uint32_t nIsIllegalSpeed; // Over speed or low
speed
uint32_t nPicNum; // Picture, max
support picture
char

126/136
 szPicName[DPSDK_CORE_BAY_IMG_NUM][DPSDK_CORE_F ILEPAT H_LEN]; //
Picture file name，max support pictures.
uint32_t nRtPlate[DPSDK_CORE_COORDINATE_LEN]; // Plate
coordinate, left,top, right, bottom, cannot exceed
char szCarPlatePicURL[256]; // Plate small
picture URL

}Area_Detect_Info_t;

4.3.36 Code Channel Info

typedef struct tagEncChannelInfo
{
dpsdk_camera_type_e m_nCameraType; // Type，
refer to CameraType_e
char szId[DPSDK_CORE_DEV_ID_LEN]; // Channel ID
char szName[DPSDK_CORE_DGROUP_DEVICENAME_LEN]; // Name
}Enc_Channel_Info_t;

4.3.37 Subscription Flow Request Info

typedef struct tagSubscribeTrafficFlowInfo
{
int32_t nChnlCount; // Subcribe channel
quantity
int32_t nInterval; // Subcribe report
interval 15s multiple
Enc_Channel_Info_t* pEncChannelnfo; // Channel info
int32_t nSubscribeFlag; // Subcribe mark

}Subscribe_Traffic_Flow_Info_t;

4.3.38 Subcribe ANPR Bypass Info Request Info

//Subcribe ANPR bypass info request info
typedef struct tagSubscribeBayCarInfo
{
int32_t nChnlCount; // Subcribe channel

127/136
 quantity
Enc_Channel_Info_t* pEncChannelnfo; // Channel info
int32_t nSubscribeFlag; // Subcription
mark.:cancel，：subcribe
}Subscribe_Bay_Car_Info_t;

4.3.39 PTZ Direction Info

typedef struct tagPtzDirectInfo
{
char szCameraId[DPSDK_CORE_CHL_ID_LEN]; // Channel ID
dpsdk_ptz_direct_e nDirect; // PTZ direction command
int32_t nStep; // Step length
bool bStop; // Channel ID
}Ptz_Direct_Info_t;

4.3.40 PTZ Picture Command Info

typedef struct tagPtzOperationInfo
{
char szCameraId[DPSDK_CORE_CHL_ID_LEN]; // Channel ID
dpsdk_camera_operation_e nOperation; // PTZ picture
command
int32_t nStep; // Step length
bool bStop; // Channel ID
}Ptz_Operation_Info_t;

4.3.41 PTZ 3D Location Info

typedef struct tagPtzSitInfo
{
char szCameraId[DPSDK_CORE_CHL_ID_LEN]; // Channel ID
int32_t pointX; // Coordinate X
int32_t pointY; // Coordinate Y
int32_t pointZ; // Coordinate Z
}Ptz_Sit_Info_t;

4.3.42 PTZ Lock Info

typedef struct tagPtzLockInfo
{

128/136
 char szCameraId[DPSDK_CORE_CHL_ID_LEN]; // Channel ID
dpsdk_ptz_locktype_e nLock; // Lock/Unlock type
}Ptz_Lock_Info_t;

4.3.43 PTZ Open Command Info

typedef struct tagPtzOpenCommandInfo
{
char szCameraId[DPSDK_CORE_CHL_ID_LEN]; // Channel ID
bool bOpen; // Open
}Ptz_Ext_Cmd_Info_t;

4.3.44 Single Preset Info

typedef struct tagPtzSinglePrepointInfo
{
int32_t nCode; // Preset no.
char szName[DPSDK_CORE_POINT_NAME_LEN]; // Name
}Ptz_Single_Prepoint_Info_t;

4.3.45 PTZ Preset Info

typedef struct tagPtzPrepointInfo
{
IN int32_t nCount; // Preset count
OUT Ptz_Single_Prepoint_Info_tpPoints[DPSDK_CORE_POINT_COUNT]; // Preset info
IN char szCameraId[DPSDK_CORE_CHL_ID_LEN]; // Channel ID
}Ptz_Prepoint_Info_t;

4.3.46 PTZ Preset Operation Info

// PTZ preset operation info
typedef struct tagPtzPrepoInfoperationInfo
{
char szCameraId[DPSDK_CORE_CHL_ID_LEN]; // Channel ID
dpsdk_ptz_prepoint_cmd_e nCmd; // Preset command
Ptz_Single_Prepoint_Info_t pPoints; // Preset info
}Ptz_Prepoint_Operation_Info_t;

129/136
4.3.47 PTZ Extension Command Info
typedef struct tagPtzExtendCommandInfo
{
char szCameraId[DPSDK_CORE_CHL_ID_LEN]; // Channel ID
dpsdk_ptz_extend_cmd_e nCmd; // Extension
command
int32_t nParam; // Parameter
}Ptz_Extend_Command_Info_t;

4.3.48 Single Alarm Plan

typedef struct tagAlarmSingleEnableInfo
{
char szAlarmDevId[DPSDK_CORE_CHL_ID_LEN]; // Alarm device ID
int nVideoNo; // Video channel related alarm
int nAlarmInput; // Alarm input channel related alarm
dpsdk_alarm_type_e nAlarmType; // Alarm type
}Alarm_Single_Enable_Info_t;

4.3.49 Alarm Plan

typedef struct tagAlarmEnableInfo
{
int nCount; // Alarm arm count
Alarm_Single_Enable_Info_t* pSources; // Alarm content
}Alarm_Enable_Info_t;

4.3.50 Search Alarm Info

typedef struct tagAlarmQueryInfo
{
char szCameraID[DPSDK_CORE_CHL_ID_LEN]; // Channel ID
uint64_t uStartTime; // Start time
uint64_t uEndTime; // End time
dpsdk_alarm_dealwith_e nDealWith; // Alarm processing
type
dpsdk_alarm_source_e nSource; // Alarm source type
dpsdk_alarm_type_e nAlarmType; // Alarm type
dpsdk_alarm_device_type_e nDeviceType; // Alarm device type
}Alarm_Query_Info_t;

130/136
4.3.51 Single Alarm Info
typedef struct tagSingleAlarmInfo
{
dpsdk_alarm_type_e nAlarmType; // Alarm type
dpsdk_event_type_e nEventType; // detect status
char szDevId[DPSDK_CORE_DEV_ID_LEN]; // Alarm
device ID
uint32_t uChannel; // Alarm channel
uint64_t uAlarmTime; // Alarm time
dpsdk_alarm_source_e nSource; // Alarm source, use char to be
compatible with server
dpsdk_alarm_device_type_e nDevType; // Device type
dpsdk_alarm_dealwith_e nDealWith; // Processing
suggestion
}Single_Alarm_Info_t;

4.3.52 Alarm Info

typedef struct tagAlarmInfo
{
IN int32_t nCount; // Request record
count OUT int32_t nRetCount; // Actual
return count
OUT Single_Alarm_Info_t* pAlarmInfo; // Alarm info
}Alarm_Info_t;

4.3.53 Client Alarm Report Info

typedef struct tagClientAlarmInfo
{
char szCameraId[DPSDK_CORE_CHL_ID_LEN]; // Alarm channel
ID
dpsdk_alarm_type_e enAlarmType; // Alarm type
dpsdk_event_type_e enStatus; // Event status
uint64_t uAlarmTime; // Alarm time
char szMsg[DPSDK_CORE_ALARM_MSG_LEN]; // Alarm info
}Client_Alarm_Info_t;

131/136
4.3.54 Single TV Wall Info
typedef struct tagTvWallInfo
{
uint32_t nTvWallId; // TV wall ID
uint32_t nState; // Enable status
char szName[DPSDK_CORE_TVWALL_NAME_LEN]; // Name
}TvWall_Info_t;

4.3.55 TV Wall List Info

// TV wall list info
typedef struct tagTvWallListInfo
{
IN uint32_t nCount; // TV wall quantity
OUT TvWall_Info_t* pTvWallInfo; // TV wall info
}TvWall_List_Info_t;

4.3.56 TV Wall Info

// TV wall info
typedef struct tagTvWallScreenInfo
{
uint32_t nScreenId; // Screen ID
char szName[DPSDK_CORE_TVWALL_NAME_LEN]; // Name
float fLeft; // Left margin
float fTop; // Top margin
float fWidth; // Width
float fHeight; // Height
bool bBind; // Bind decoder or not
}TvWall_Screen_Info_t;

4.3.57 TV Wall Layout Info

// TV wall layout info
typedef struct tagTvWallLayoutInfo
{
IN uint32_t nTvWallId; // TV wall ID
IN uint32_t nCount; // Screen quantity
OUT TvWall_Screen_Info_t* pScreenInfo; // Screen info
}TvWall_Layout_Info_t;

132/136
4.3.58 TV Wall Split Info
// TV wall split（after split, window ID starts from ，from left to right，from top to bottom，
user self maintain）
typedef struct tagTvWallScreenSplit
{
IN uint32_t nTvWallId; // TV wall ID
IN uint32_t nScreenId; // Screen ID
IN tvwall_screen_split_caps enSplitNum; // Split quantity
}TvWall_Screen_Split_t;

4.3.59 TV Wall Window Setup Video Source

// TV wall window setup video source

typedef struct tagSetTvWallScreenWindowSource
{
IN uint32_t nTvWallId; // TV wall ID
IN uint32_t nScreenId; // Screen ID
IN uint32_t nWindowId; // Window ID
IN char szCameraId[DPSDK_CORE_CHL_ID_LEN]; // Channel ID
IN dpsdk_stream_type_e enStreamType; // Stream type
IN int nStayTime; // Stay time
}Set_TvWall_Screen_Window_Source_t;

4.3.60 TV Wall Window Close Video Source

// TV wall window close video source

typedef struct tagTvWallScreenCloseSource
{
IN uint32_t nTvWallId; // TV wall ID
IN uint32_t nScreenId; // Screen ID
IN uint32_t nWindowId; // Window ID
}TvWall_Screen_Close_Source_t;

133/136
4.4 Macor Definition

Macro Value Definition

Remote IP address
DPSDK_CORE_IP_LEN 46
length
Device username too
DPSDK_CORE_USER_NAME_LEN 64
long
DPSDK_CORE_PASSWORD_LEN 64 Password length
DPSDK_CORE_REC_FILENAME_LEN 64 Record file name length
DPSDK_CORE_DEV_ID_LEN 64 Device ID length
DPSDK_CORE_REC_DISKID_LEN 64 Record disk ID length
DPSDK_CORE_CHL_ID_LEN 64 Channel ID length
DPSDK_CORE_POINT_COUNT 80 Preset quantity
DPSDK_CORE_POINT_NAME_LEN 32 Preset name length
Alarm search result
DPSDK_CORE_ALARM_MSG_LEN (4*1024)
length
Alarm search result title
DPSDK_CORE_ALARM_TITLE_LEN 256
length
Default overtime, unit is
DPSDK_CORE_DEFAULT_TIMEOUT 10000
ms
DPSDK_CORE_DGROUP_DGPNAME_LEN 256 Organization name length
DPSDK_CORE_DGROUP_DGPCODE_LEN 128 Organziation Code length
DPSDK_CORE_28181_SN_LENGTH 64 SN length
DPSDK_CORE_TIME_LENGTH 32 Time string length
DPSDK_CORE_DGROUP_DEVICENAME_LEN 256 Device name length
CFL_ERROR_SUCCESS 200 Successful error code
CLIENT_ERROR_BASE 420 Client error value
SERVER_ERROR_BASE 520 Server error code
DSS_ERROR_BASE 720 Basic error code
DSS_ERROR_CODE_BASE 1000000 Server error base
DSS_DMS_BASE 1000 DMS error code base
DSS_VMS_BASE 2000 VMS error code base
DSS_RTSP_BASE 3000 RTSP error code base
DSS_ALARM_BASE 4000 ALARM error code base
DPSDK_CORE_FILEPATH_LEN 256 File path length
DPSDK_CORE_IMG_PAT H_LEN 256 Picture file path length
DPSDK_CORE_BAY_IMG_NUM 6 Picture quantity
DPSDK_CORE_IMG_URL 1024 URL length
Device channel name
DPSDK_CORE_DGROUP_CHNNAME_LEN 256
length
DPSDK_CORE_ORG_CODE_LEN 128 Organziation node length

134/136
DPSDK_CORE_ORG_NAME_LEN 256 Organization name length
DPSDK_CORE_ORG_SN_LEN 256 Organization SN
DPSDK_CORE_ORG_TYPE_LEN 16 Organization node type
Organization node
DPSDK_CORE_ORG_GPS_LEN 64
longitude
Organization node
DPSDK_CORE_ORG_MEMO_LEN 1024
description
DPSDK_CORE_DIRECT_LEN 4 Direction no.
DPSDK_CORE_CAR_RECORD_ID_LEN 128 Record ID
DPSDK_CORE_OPT_NOTE_LEN 256 Note
DPSDK_CORE_TIME_LEN 128 Time（unit is s）length
DPSDK_CORE_COORDINATE_LEN 4 Plate coordinate length
DPSDK_CORE_PERSON_CODE_LEN 256 ID
DPSDK_CORE_PERSON_NAME_LEN 256 Staff name length
DPSDK_CORE_PERSON_DEPTCODE_LEN 128 Organization length
DPSDK_CORE_PERSON_SN_LEN 256 Staff SN length
DPSDK_CORE_PERSON_TYPE_LEN 16 Staff type length
DPSDK_CORE_PERSON_OFFICE_LEN 256 Staff offlice location
DPSDK_CORE_PERSON_MOBILENUM_LEN 64 Staff mobile phone
DPSDK_CORE_PERSON_VIRTUALNUM_LEN 64 Staff short no.
DPSDK_CORE_PERSON_STATE_LEN 16 Staff status
DPSDK_CORE_CAR_CODE_LEN 256 Vehicle code
DPSDK_CORE_CAR_COLOR_LEN 16 Vehicle color
DPSDK_CORE_CAR_TYPE_LEN 16 Vehicle type
DPSDK_CORE_CAR_MODEL_LEN 256 Vehicle brand model
DPSDK_CORE_CAR_SIZE_LEN 64 Vehicle size
DPSDK_CORE_CAR_VIN_LEN 64 Frame no.
DPSDK_CORE_ENG_NO_LEN 64 Engine no.
DPSDK_CORE_REGIST_LEN 256 Plate place
DPSDK_CORE_REGIST_DATE_LEN 32 Registration date
DPSDK_CORE_CAR_PICPATH_LEN 256 Vehicle picture path
DPSDK_CORE_CAR_PLATENO_LEN 64 Plate no.
DPSDK_CORE_CAR_PLATECOLOR_LEN 16 Vehicle color
DPSDK_CORE_CAR_PLATETYPE_LEN 16 Plate type
DPSDK_CORE_CAR_OWNERNAME_LEN 256 Owner name
DPSDK_CORE_CAR_OWNERPHONE_LEN 64 Owner tel
DPSDK_CORE_DEPTCODE_LEN 128 Department code
Data library self-increase
DPSDK_CORE_DBID_LEN 32
ID length
DPSDK_CORE_TVWALL_NAME_LEN 256 TV wall name length
DPSDK_CORE_BAY_IP_LEN 64 IP length

135/136
DPSDK_CORE_CAR_NUM_LENGTH 32 Plate no. length

DPSDK_CORE_BAY_URL_LEN 1024 Ulr length

DSS_MS_BASE 5000 MS error code start

136/136