SDK Programming Guide

V3.4.7
Preface

Purpose

Welcome to use NetSDK(SDK for short below) programming guide.

SDK is the software development kit used by software developer when developing DVR(digital
video recorder), DVS(digital video server), IPC(IP camere), SD(speed dome), intelligent devices to
monitor network application.
This document has described functions, interfaces and calling relationship between functions

in SDK, and also provided example codes.

Target reader

SDK software development engineers

Symbols

The symbols shown in the sheet below may appear in the document, their meanings are shown

below.

Symbol Instruction

Means: supplement to the body of the text

Revise history

Time Revised content

2016-01-15 Create

2016-08-16 Revise
Catalogue

PREFACE ................................................................................................................................2

CATALOGUE ...........................................................................................................................3

1 INTRODUCTION ........................................................................................................... 10

1.1 ABSTRACT ............................................................................................................................................................ 10

1.2 APPLICABILITY ...................................................................................................................................................... 11

2 MAJOR FUNCTIONS .................................................................................................... 12

2.1 SDK I NITAILIZATION MODULE ............................................................................................................................... 12

2.1.1 Module Intro.......................................................................................................................................... 12

2.1.2 Interfa ce Overview ............................................................................................................................... 12

2.1.3 SDK Initialization Instruction .............................................................................................................. 13

2.1.4 Example Code........................................................................................................................................ 14

2.2 DEVICE LOGIN ...................................................................................................................................................... 17

2.2.1 Intro ........................................................................................................................................................ 17

2.2.2 Interfa ce Overview ............................................................................................................................... 18

2.2.3 Process Instruction ............................................................................................................................... 18

2.2.4 Example Codes ...................................................................................................................................... 19

2.3 REAL-TIME MONITORING...................................................................................................................................... 23

2.3.1 Intro ........................................................................................................................................................ 23

2.3.2 Interfa ce Overview ............................................................................................................................... 23

2.3.3 Process Instruction ............................................................................................................................... 24

2.3.4 Example Code........................................................................................................................................ 27

2.4 RECORD PLAYBACK ............................................................................................................................................... 38

2.4.1 Intro ........................................................................................................................................................ 38

2.4.2 Interfa ce Overview ............................................................................................................................... 39

2.4.3 Process Instruction ............................................................................................................................... 39

2.4.4 Example Code........................................................................................................................................ 44

3/339
2.5 RECORD DOWNLOAD............................................................................................................................................ 59

2.5.1 Intro ........................................................................................................................................................ 59

2.5.2 Interfa ce Overview ............................................................................................................................... 60

2.5.3 Process Instruction ............................................................................................................................... 60

2.5.4 Example Code........................................................................................................................................ 65

2.6 PTZ CONTROL ...................................................................................................................................................... 80

2.6.1 Intro ........................................................................................................................................................ 80

2.6.2 Interfa ce Overview ............................................................................................................................... 80

2.6.3 Process Instruction ............................................................................................................................... 81

2.6.4 Example Code........................................................................................................................................ 83

2.7 AUDIO INTERCOM................................................................................................................................................. 95

2.7.1 Intro ........................................................................................................................................................ 95

2.7.2 Interfa ce Overview ............................................................................................................................... 95

2.7.3 Process Instruction ............................................................................................................................... 96

2.7.4 Example Code...................................................................................................................................... 100

2.8 SNAPSHOT.......................................................................................................................................................... 129

2.8.1 Intro ...................................................................................................................................................... 129

2.8.2 Interfa ce Overview ............................................................................................................................. 129

2.8.3 Process Instruction ............................................................................................................................. 129

2.8.4 Example code ...................................................................................................................................... 130

2.9 REPORT ALARM .................................................................................................................................................. 138

2.9.1 Intro ...................................................................................................................................................... 138

2.9.2 Interfa ce Overview ............................................................................................................................. 138

2.9.3 Process Instruction ............................................................................................................................. 138

2.9.4 Example Code...................................................................................................................................... 140

2.10 DEVICE SEARCH............................................................................................................................................. 147

2.10.1 Intro ...................................................................................................................................................... 147

2.10.2 Interfa ce Overview ............................................................................................................................. 148

2.10.3 Process Intruction ............................................................................................................................... 148

2.10.4 Example Code...................................................................................................................................... 150

4/339
 2.11 I NTELLIGENT EVENT R EPORT AND SNAPSHOT.................................................................................................. 162

2.11.1 Intro ...................................................................................................................................................... 162

2.11.2 Interfa ce Overview ............................................................................................................................. 162

2.11.3 Process Intruction ............................................................................................................................... 162

2.11.4 Example Code...................................................................................................................................... 164

3 CALLBACK FUNCTION DEFINITION .......................................................................... 174

3.1 FDISCONNECT .................................................................................................................................................... 174

3.2 FHAVERECONNECT ............................................................................................................................................. 175

3.3 FREAL DATACALL BACKEX..................................................................................................................................... 176

3.4 FDOWNLOADPOSCALL BACK ............................................................................................................................... 177

3.5 FDATACALL BACK ................................................................................................................................................ 178

3.6 FTIMEDOWNLOADPOSCALL BACK ....................................................................................................................... 179

3.7 FMESSCALL BACK................................................................................................................................................ 180

3.8 FSEARCHDEVICESCB........................................................................................................................................... 182

3.9 FANALYZERDATACALL BACK ................................................................................................................................. 183

3.10 FSNAP REV .................................................................................................................................................... 185

3.11 FREAL PLAYDISCONNECT................................................................................................................................ 186

3.12 PFAUDIODATACALL BACK ............................................................................................................................... 187

APPENDIX 1 STRUCT DEFINITION ...................................................................................... 189

NET_DEVICEINFO....................................................................................................................................................... 189

NET_IN_STARTLOGINEX............................................................................................................................................ 190

NET_O UT_STARTLOGINEX ....................................................................................................................................... 191

NET_PARAM ............................................................................................................................................................... 191

NET_DEVICEINFO_EX ................................................................................................................................................ 193

TAGVIDEOFRAMEPARAM ................................................................................................................................................. 194

TAGCBPCMDATAPARAM ................................................................................................................................................ 197

NET_TIME ................................................................................................................................................................... 198

NET_RECORDFILE_INFO ........................................................................................................................................... 199

CFG_PTZ_PROTOCOL_CAPS_INFO .......................................................................................................................... 200

5/339
 CFG_PTZ_MOTION_RANGE ..................................................................................................................................... 207

CFG_PTZ_LIGHTING_CONTROL............................................................................................................................... 208

DHDEV_TALKFORMAT_LIST ..................................................................................................................................... 208

DHDEV_TALKDECODE_INFO .................................................................................................................................... 209

DHDEV_SYSTEM_ATTR_CFG .................................................................................................................................... 210

NET_SPEAK_PARAM.................................................................................................................................................. 213

NET_TALK_TRANSFER_PARAM................................................................................................................................ 214

DEVICE_NET_INFO _EX .............................................................................................................................................. 215

MANUAL_SNAP_PARAMETER ................................................................................................................................. 218

OPR_RIGHT_EX .......................................................................................................................................................... 218

OPR_RIGHT_NEW ...................................................................................................................................................... 219

NET_DEV_CHN_COUNT_INFO ................................................................................................................................ 219

NET_CHN_COUNT_INFO .......................................................................................................................................... 220

NET_IN_SNAP_CFG_CAPS ........................................................................................................................................ 221

NET_O UT_SNAP_CFG_CAPS .................................................................................................................................... 222

DH_RESOLUTION_INFO ............................................................................................................................................ 223

DEOENC_ VIDEOENC_OPT ....................................................................................................................................... 223

CFG_VIDEO_FORMAT ............................................................................................................................................... 225

CFG_AUDIO_ENCODE_FORMAT ............................................................................................................................. 229

CFG_VIDEO_COVER................................................................................................................................................... 231

CFG_COVER_INFO ..................................................................................................................................................... 232

CFG_RECT.................................................................................................................................................................... 233

CFG_RGBA .................................................................................................................................................................. 234

CFG_ENCODE_INFO .................................................................................................................................................. 234

SNAP_PARAMS........................................................................................................................................................... 237

DH_VERSION_INFO ................................................................................................................................................... 238

DH_DSP_ENCODECAP............................................................................................................................................... 239

APPENDIX 2 ENUM DEFINITION.......................................................................................... 243

NET_DEVICE_TYPE .................................................................................................................................................... 243

EM_LOGIN_SPAC_CAP_TYPE................................................................................................................................... 245

6/339
 DH_R EAL PLAYTYPE ........................................................................................................................................................ 246

EM_QUERY_RECORD_TYPE ..................................................................................................................................... 247

EM_USEDEV_MODE ................................................................................................................................................. 248

EM_SUPPORT_FOCUS_MODE................................................................................................................................. 250

DH_PTZ_CONTROLTYPE ................................................................................................................................................ 250

DH_EXTPTZ_CONTROLT YPE ......................................................................................................................................... 251

DH_TALK_CODING_TYPE.......................................................................................................................................... 254

CTRLTYPE ....................................................................................................................................................................... 255

CFG_VIDEO_COMPRESSION .................................................................................................................................... 267

CFG_BITRATE_CONTROL .......................................................................................................................................... 268

CFG_IMAGE_QUALITY .............................................................................................................................................. 268

CFG_H264_PROFILE_RANK ...................................................................................................................................... 268

CFG_AUDIO_FORMAT............................................................................................................................................... 269

EM_REALPLAY_DISCONNECT_EVENT_TYPE ......................................................................................................... 269

APPENDIX 3 INTERFACE DEFINITION................................................................................. 271

CLIENT_I NIT ................................................................................................................................................................. 271

CLIENT_CLEANUP ......................................................................................................................................................... 272

CLIENT_GETSDKVERSION............................................................................................................................................. 273

CLIENT_GET LAST ERROR ............................................................................................................................................... 273

CLIENT_S ETAUTORECONNECT ....................................................................................................................................... 274

CLIENT_S ETCONNECTTIME ........................................................................................................................................... 276

CLIENT_S ET NETWORKPARAM ....................................................................................................................................... 277

CLIENT_LOGINEX2 ....................................................................................................................................................... 277

CLIENT_LOGOUT .......................................................................................................................................................... 280

CLIENT_REALPLAYEX .................................................................................................................................................... 281

CLIENT_STOPREALPLAY EX ............................................................................................................................................ 282

CLIENT_S ETREAL DATACALL BACKEX .............................................................................................................................. 283

CLIENT_FINDFILE.......................................................................................................................................................... 286

CLIENT_FINDNEXTFILE ................................................................................................................................................. 289

CLIENT_FINDCLOSE ...................................................................................................................................................... 290

7/339
CLIENT_PLAYBACKBYTIMEEX ........................................................................................................................................ 291

CLIENT_STOPPLAYBACK ................................................................................................................................................ 294

CLIENT_GETPLAY BACKO SDTIME ................................................................................................................................... 294

CLIENT_QUERYR ECORDFILE.......................................................................................................................................... 296

CLIENT_DOWNLOADBYTIMEEX..................................................................................................................................... 299

CLIENT_STOPDOWNLOAD............................................................................................................................................. 301

CLIENT_PLAYBACKBYRECORDFILEEX............................................................................................................................. 302

CLIENT_PAUSEPLAYBACK .............................................................................................................................................. 304

CLIENT_S EEKPLAYBACK ................................................................................................................................................ 305

CLIENT_FASTPLAYBACK ................................................................................................................................................ 306

CLIENT_SLOWPLAYBACK............................................................................................................................................... 307

CLIENT_NORMAL PLAYBACK .......................................................................................................................................... 308

CLIENT_DOWNLOADBYRECORDFILEEX.......................................................................................................................... 309

CLIENT_PARSED ATA ...................................................................................................................................................... 311

CLIENT_DHPTZCONTROL EX2....................................................................................................................................... 312

CLIENT_QUERY NEWSYSTEMI NFO.................................................................................................................................. 314

CLIENT_S ETDEVICEMODE ............................................................................................................................................. 317

CLIENT_S TARTSEARCHDEVICES...................................................................................................................................... 318

CLIENT_QUERYD EVSTATE ............................................................................................................................................. 319

CLIENT_S TARTTALKEX................................................................................................................................................... 321

CLIENT_STOPTALKEX .................................................................................................................................................... 322

CLIENT_RECORDSTARTEX.............................................................................................................................................. 322

CLIENT_RECORDSTOPEX............................................................................................................................................... 323

CLIENT_TALKSENDDATA ................................................................................................................................................ 324

CLIENT_AUDIODECEX................................................................................................................................................... 325

CLIENT_S ETDVRMESSCALL BACK.................................................................................................................................. 326

CLIENT_S TARTLISTEN EX ................................................................................................................................................ 327

CLIENT_STOPLISTEN ..................................................................................................................................................... 328

CLIENT_STOPSEARCHDEVICES ....................................................................................................................................... 329

CLIENT_S EARCHDEVICESBYIPS...................................................................................................................................... 330

8/339
CLIENT_REALLOADPICTUREEX ...................................................................................................................................... 331

CLIENT_CONTROL DEVICEEX.......................................................................................................................................... 333

CLIENT_STOPLOADPIC .................................................................................................................................................. 335

CLIENT_GETDOWNLOADPOS ........................................................................................................................................ 336

CLIENT_S ETSNAPREVCALL BACK.................................................................................................................................... 337

CLIENT_SNAPPICTUREEX .............................................................................................................................................. 338

9/339
 1 Introduction

1.1Abstract
SDK is the software development kit used by software developer when developing DVR(digital
video recorder), DVS(digital video server), IPC(IP camere), SD(speed dome), intelligent devices to
monitor network application.
The kit mainly includes the following functions:
Device login, real-time monitoring, record playback and playback control, record download, PTZ
control, audio intercom, video snapshpot, alarm report, device search, intelligent event report and
picture snapshot, user management and some other functions (device restart, device upgrade, video
image parameter setup, channel name setup, device network parameter setup and etc.) .
Files in development kit are shown below:

Library type Library file name Library description

dhnetsdk.h Header file

avglobal.h Header file

avnetsdk.dll 3rd generation library

dhconfigsdk.dll Configure library

dhconfigsdk.h Header file

dhconfigsdk.lib Lib file

Network library dhnetsdk.lib Lib file

dhnetsdk.dll Interface library

Infra.dll 3rd generation aux library

json.dll 3rd generation aux library

NetFramework.dll 3rd generation aux library

rd
Stream.dll 3 generation aux library

StreamSvr.dll 3rd generation aux library

dhplay.dll Decoding aux library

AUX Library adpcmdecode.dll Decoding aux library

postproc.dll Decoding aux library

10/339
 mpeg4enc.dll Decoding aux library

mpeg4dec.dll Decoding aux library

mp3dec.dll Decoding aux library

mjpegdec.dll Decoding aux library

h264dec.dll Decoding aux library

amrdec.dll Decoding aux library

aacdec.dll Decoding aux library

DhDecode.dll mobile snapshoting decoding library

IvsDrawer.dll Intelligent drawing library

1.2Applicability
Recommended memory: unused menory should not below 256M.

Supported system by SDK:

Windows

Windows10/Windows8/Windows7/vista/XP/2000 and Windows Server 2008/2003.

Linux

CentOS/Red Hat/SUSE and other general Linux OS. GCC version not below 4.1.2.

Applicable devices for each functional module are shown below:

Function Supported Device

Device Login DVR, NVR, IPC and SD

real-time monitoring DVR, NVR, IPC and SD

Record Playback and Playback Control storage device as DVR and NVR

Record Download storage device DVR and NVR

PTZ Control SD

audio intercom DVR, NVR, IPC and SD

Video snapshot DVR, NVR, IPC and SD

Alarm Report DVR, NVR, IPC and SD

Device Search DVR, NVR, IPC and SD

Intelligent Event Report and Snapshot IVS, mobile and smart SD

11/339
2 Major Functions

All the example codes are tested under Windows OS only.

2.1SDK Initailization Module

2.1.1 Module Intro

Initialization is the first step of SDK business. The module itself does not include surveillance

business, interfaces in this chapter will not make any interaction with Dahua device, but the module

is responsible for SDK initialization, and setting properties which influence business.

Warnings:

1. The initialization module of SDK will occupy a certain memory .

2. Within the same process, only the first initialization is valid.

3. You need to call cleanup interface to release resources after using SDK completely.

2.1.2 Interface Overview

SDK initialization module involves the following interfaces:

Inteface Interface Description

CLIENT_Init Interface for SDK initialization

CLIENT_Cleanup Interface for cleaning up SDK resources

CLIENT_GetSDKVersion Interface for getting SDK version information

CLIENT_GetLastError Interface for getting the function execution failure code

Interface for setting reconnection callback function after

CLIENT_SetAutoReconnect
disconnection

Interface for setting device connection timeout value and

CLIENT_SetConnectTime
trial times

CLIENT_SetNetworkParam Interface for setting log in network environment

12/339
2.1.3 SDK Initialization Instruction

a) The SDK initialization process is shown below in Figure 2-1.

Start

Initialization
CLIENT_Init

Get SDK version information

CLIENT_GetSDKVersion

Set callback function when the device

converts from off-line to on-line.
CLIENT_SetAutoReconnect

Set device connection timeout value

and trial times
CLIENT_SetConnectTime

Set network parameters

CLIENT_SetNetworkParam

Optional
Clean up SDK resources
CLIENT_Cleanup
Mandatory

End

Figure 2-1 SDK initialization process

Process description:
1. Call CLIENT_Init to initialize SDK.

2. Call CLIENT_GetSDKVersion to get SDK version informationoptional.

3. Call CLIENT_SetAutoReconnect to set offline reconnection callback function

optional,suggest calling, Internal SDK auto connect again when the device disconnect.

4. Call CLIENT_SetConnectTime to set device connection timeout value and trial times

13/339
optional.

5. Call CLIENT_SetNetworkParam to set network parameters, parameters include login

timeout value and trial timesoptional.

6. Call CLIENT_Cleanup to clean up SDK resources After using SDK function.

2.1.4 Example Code

#include<windows.h>
#include <stdio.h>
#include "dhnetsdk.h"

#pragma comment(lib , "dhnetsdk.lib")

static BOOL g_bNetSDKInitFlag = FALSE;

//************************************************************************** *******
// commonly used callback set declaration.

// callback function used when device disconnected.

// It is not recommended to call SDK interface in the SDK callback function.
//The callback function set by CLINET_Init,When the device is offline,SDK will call this callback
function.
void CALLBACK DisConnectFunc(LONG lLoginID, char *pchDVRIP, LONG nDVRPort,
DWORD dwUser);

// Callback function set after the device reconnected successfully.

// It is not recommended to call SDK interface in the SDK callback function.
// Set the callback function in CLIENT_SetAutoReconnect, when offline device is reconnected
successfully, SDK will call the function.
void CALLBACK HaveReConnect(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,
LDWORD dwUser);
//*********************************************************************************
void InitTest()
{
// SDK initialization
g_bNetSDKInitFlag = CLIENT_Init(DisConnectFunc, 0);
if (FALSE == g_bNetSDKInitFlag)
{
printf("Initialize client SDK fail; \n");
return;

14/339
 }
else
{
printf("Initialize client SDK done; \n");
}

// This operation is optional.

//Get the SDK version info.
DWORD dwNetSdkVersion = CLIENT_GetSDKVersion();
printf("NetSDK version is [%d]", dwNetSdkVersion);

// Set CLIENT_SetAutoReconnect interface.Once HaveReConnect is set, when device

gets offline, SDK will reconnect internally
//This operation is optional,but recommended.
CLIENT_SetAutoReconnect(&HaveReConnect, 0);

// Set device connection timeout value and trial times.

//This is an optional.
int nWaitTime = 5000; // timeout value is 5 seconds
int nTryTimes = 3; //If timeout,it will try to log in three times.
CLIENT_SetConnectTime(nWaitTime, nTryTimes);

//Set more network parameter, nWaittime and nConnectTryNum in NET_PARAM has the
same meaning with the timeout time and trial time set in interface CLIENT_SetConnectTime.
//This operation is optional.

NET_PARAM stuNetParm = {0};

stuNetParm.nConnectTime = 3000; //when login, connection timeout value is 3000ms.

CLIENT_SetNetworkParam(&stuNetParm);

// The first time logining to device, some data is needed to be initialized to enable normal
business function. It is recommended to wait for a while after login, the waiting time varies by
devices.
Sleep(1000);
printf("\n");
}

void RunTest()
{
if (FALSE == g_bNetSDKInitFlag)
{
return;

15/339
 }
// task realizing operation
}

void EndTest()
{
printf("input any key to quit! \n");
getchar();

//Logout device operation.

//Cleaning up initialization resources.
if (TRUE == g_bNetSDKInitFlag)
{
CLIENT_Cleanup();
g_bNetSDKInitFlag = FALSE;
}
return;
}
int main()
{
InitTest();
RunTest();
EndTest();
return 0;
}
//*********************************************************************************
//commonly used callback functions definition
void CALLBACK DisConnectFunc(LONG lLoginID, char *pchDVRIP, LONG nDVRPort,
DWORD dwUser)
{
printf("Call DisConnectFunc\n");
printf("lLoginID[0x%x]", lLoginID);
if (NULL != pchDVRIP)
{
printf("pchDVRIP[%s]\n", pchDVRIP);
}
printf("nDVRPort[%d]\n", nDVRPort);
printf("dwUser[%p]\n", dwUser);
printf("\n");
}

void CALLBACK HaveReConnect(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,

LDWORD dwUser)

16/339
 {
printf("Call HaveReConnect\n");
printf("lLoginID[0x%x]", lLoginID);
if (NULL != pchDVRIP)
{
printf("pchDVRIP[%s]\n", pchDVRIP);
}
printf("nDVRPort[%d]\n", nDVRPort);
printf("dwUser[%p]\n", dwUser);
printf("\n");
}

2.2Device Login

2.2.1 Intro

Precondition

Before logining to device, successfully initialization should be done.

Overview

Device login, as device registration is the precondition of other businesses.

When SDK initialization is complete, user need to login to Dahua device first. Only when the

sole valid login ID is generated, can we operate other businesses. Login ID is the unique sign to

recognize the login, other function SDK follows will require this login ID.

Login Method

It has three login methods according to function and use scene: sync login, async login and auto

registration login. Please refer to Ch 2.2.3.1, 2.2.3.2 and 2.2.3.3 to learn about them.

Reconnection

SDK can set device reconnection function. When encounter some special conditions (offline,

outage) which makes device become offline, it will try to reconnect to device continuously within SDK

until being online.

Among the three login methods, auto registration login dont support reconnection.

User can call SDK self-carried reconnection function, as well as can call login and logout

interface at application layer to manually control reconnection business.

17/339
 NOTE

1. The provided login operation is for Dahua devices only, not for other manufuature s devices.

Please use the login operation carefully, otherwise the device will not be able to login successfully.

2. Login and logout should be used as a pair. In case of resource leak, you must call logout

interface to logout user and release SDK resource.

2.2.2 Interface Overview

Interface Interface Description

CLIENT_Init Interface for initilization

CLIENT_Cleanup Interface for SDK clearance

CLIENT_LoginEx2 Extensive interface 2 for sync login

CLIENT_Logout Interface for logout device

CLIENT_GetLastError Interface for getting error code after failed calling interface

2.2.3 Process Instruction

When client with SDK has fluent connection to Dahua device, you can start the login operation.

When the login interface return a valid login ID, your login is successful.

Login business process flow sheet is shown in Figure 2-2.

18/339
 Start

SDK initialization
ClIENT_Ini()

NO
Successfully register user to device? Get the error code and
CLIENT_LoginEx2 analyze the failure reason

YES

Realize function business

Logout user
CLIENT_Logout

Release SDK resource

CLIENT_Cleanup

END

Figure 2-2 login business process flow sheet

Process description:

1. SDK initialization.

2. After successful initializationcall CLIENT_LoginEx2 to login device.

3. After successful login, users can realize business as needed.

4. After realizing needed business, call CLIENT_Logout to logout device.

5. Last but not the least, call CLIENT_Cleanup to release SDK resource.

2.2.4 Example Codes

#include <windows.h>
#include <stdio.h>
#include " dhnetsdk.h "

19/339
 #pragma comment(lib , " dhnetsdk.h ")

static LLONG g_lLoginHandle = 0L;

static char g_szDevIp[32] = "172.32.4.25";
static WORD g_nPort = 37777;
static char g_szUserName[64] = "admin";
static char g_szPasswd[64] = "admin";
static BOOL g_bSDKInitFlag = FALSE;

//*********************************************************************************
// commonly used callback set declaration
// callback function used when device gets offline
// Its not recommended to call SDK interfaces in this callback function
//Set the callback function in CLIENT_Initwhen device gets offlineSDK will call this function
automatically
void CALLBACK DisConnectFunc(LONG lLoginID, char *pchDVRIP, LONG nDVRPort,
DWORD dwUser)

// callback function used after device is reconnected successfully

// Its not recommended to call SDK interfaces in this callback function
// Set the callback function in CLIENT_SetAutoReconnect, when offline device is reconnected
successfully, SDK will call the function
void CALLBACK HaveReConnect(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,
LDWORD dwUser)

//*********************************************************************************
void InitTest()
{
// SDK Initialization
g_bNetSDKInitFlag = CLIENT_Init(DisConnectFunc, 0);
if (FALSE == g_bNetSDKInitFlag)
{
printf("Initialize client SDK fail; \n");
return;
}
else
{
printf("Initialize client SDK done; \n");
}

//Get the SDK version information.

// This operation is optional.
DWORD dwNetSdkVersion = CLIENT_GetSDKVersion();

20/339
 printf("NetSDK version is [%d]\n", dwNetSdkVersion);

// set CLIENT_SetAutoReconnect interface.Once HaveReConnect is set, when device

gets offline, SDK will reconnect internally
//This operation is optional,but recommended.
CLIENT_SetAutoReconnect(&HaveReConnect, 0);

// Set device connection timeout value and trial times.

//This operation is optional
int nWaitTime = 5000; // timeout value is 5 seconds
int nTryTimes = 3; //If timeout,it will try to log in three times.
CLIENT_SetConnectTime(nWaitTime, nTryTimes);

//Set more network parameter, nWaittime and nConnectTryNum in NET_PARAM has the
same meaning with the timeout time and trial time set in interface CLIENT_SetConnectTime.
//This operation is optional.

NET_PARAM stuNetParm = {0};

stuNetParm.nConnectTime = 3000; //when login, connection timeout value is 3000ms.

CLIENT_SetNetworkParam(&stuNetParm);

CLIENT_SetNetworkParam(&stuNetParm);

NET_DEVICEINFO_Ex stDevInfoEx = {0};

int nError = 0;
while(0 == g_lLoginHandle)
{
//Login device
g_lLoginHandle = CLIENT_LoginEx2(g_szDevIp, g_nPort, g_szUserName,
g_szPasswd, EM_LOGIN_SPEC_CAP_TCP, NULL, &stDevInfoEx, &nError);

if (0 == g_lLoginHandle)
{
// according to error code, you can find corresponding explanation in dhnetsdk.h.
It is to print hexadecimal here, not decimal showns in header file, please be careful with conversion
//Example: #define NET_NOT_SUPPORTED_EC(23) //Now SDK does not
support this function, error code is 0x80000017, Decimal number 23 is hexadecimal 0x17.
printf("CLIENT_LoginEx2 %s[%d]Failed!Last Error[%x]\n" , g_szDevIp , g_nPort ,
CLIENT_GetLastError());
}
else

21/339
 {
printf("CLIENT_LoginEx2 %s[%d] Success\n" , g_szDevIp , g_nPort);
}
// The first time logining to device, some data is needed to be initialized to enable
normal business function. It is recommended to wait for a while after login, the waiting time va ries
by devices.
Sleep(1000);
printf("\n");
}
}

void RunTest()
{
// business realization
}

void EndTest()
{
printf("input any key to quit! \n");
getchar();
// logout device
if (0 == g_lLoginHandle)
{
if (FALSE == CLIENT_Logout(g_lLoginHandle))
{
printf("CLIENT_Logout Failed!Last Error[%x]\n", CLIENT_GetLastError());
}
else
{
g_lLoginHandle = 0;
}
}
// clean up resource
if (TRUE == g_bSDKInitFlag)
{
CLIENT_Cleanup();
g_bSDKInitFlag = FALSE;
}
return;
}

int main()
{

22/339
 InitTest();
RunTest();
EndTest();
return 0;
}
//*********************************************************************************
// commonly used callback set definition

void CALLBACK DisConnectFunc(LONG lLoginID, char *pchDVRIP, LONG nDVRPort,

DWORD dwUser)
{
printf("Call DisConnectFunc\n");
printf("lLoginID[0x%x]", lLoginID);
if (NULL != pchDVRIP)
{
printf("pchDVRIP[%s]\n", pchDVRIP);
}
printf("nDVRPort[%d]\n", nDVRPort);
printf("dwUser[%p]\n", dwUser);
printf("\n");
}

2.3 Real-time Monitoring

2.3.1 Intro

Real-time monitoring which is to get real time stream from storage device or front-end device is

an important part of a surveillance system.

After login to device, SDK can obtain main stream, aux stream and the third stream from device.

Support: Config front-end device bit stream resolution, encode, bit rate and etc.

Support: Setup of image saturation, contrast, exposure and etc.

Support: User conveys window handle, SDK analyzes stream and play directly.

Support: Callback real-time stream data to user, let user process by himself.

Support: Save real-time record to specific folder, user can save callback stream to achieve

it or call SDK interface to realize it.

2.3.2 Interface Overview

23/339
Interface Interface Description

CLIENT_Init Interface for SDK Initialization.

CLIENT_Cleanup Interface for cleaning up SDK resources.

CLIENT_LoginEx2 Extensive interface 2 for Sync login.

CLIENT_RealPlayEx Extensive Interface for starting real-time monitoring

CLIENT_StopRealPlayEx Extensive interface for stopping real-time monitoring

Callback function Extensive interface for setting

CLIENT_SetRealDataCallBackEx
real-time monitoring data

CLIENT_Logout Interface for logout

CLIENT_GetLastError Interface for getting the function execution error code

2.3.3 Process Instruction

Real-time surveillance business includes the following two methods

SDK decoding and playing

SDK realizes real-time play by calling playsdk library in aux library.

The third party decoding and playing

SDK only callback real-time monitoring data stream to user, user decodes and plays with a

third-party library.

2.3.3.1 SDK Decoding and Playing Process

SDK decoding and playing process flow sheet is shown below in Figure 2-3.

24/339
 Start

SDK initialization

Login device
CLIENT_LoginEx2

Strat real-time monitoring,hWnd is a valid value

CLIENT_RealPlayEx

Close real-time monitoring

CLIENT_StopRealPlayEx

Logout user
CLIENT_Logout

Clean up SDK resources

CLIENT_Cleanup

End

Figure 2-3 SDK Decoding and Playing Process

Process description:

1. SDK initialization

2. After successful initialization, call CLIENT_LoginEx2 to login device.

3. After successful login, call CLIENT_RealPlayEx to start real-time monitoring, parameter

hWnd is a valid window handle.

4. After completing real-time monitoring use, call CLIENT_StopRealPlayEx to stop real-time

monitoring.

5. After realizing needed business, call CLIENT_Logout to logout device.

6. Last but not the least, call CLIENT_Cleanup to release SDK resources.

25/339
2.3.3.2 The third Party Decoding and Playing Process

The third party decoding and playing process is shown below in Figure 2-4.

Start

SDK initialization

Login device
CLIENT_LoginEx2

Strat real-time monitoring,hWnd is a

valid value
CLIENT_RealPlayEx

Set callback function

CLIENT_SetRealDataCallBack fRealDataBackEx

Close real-time monitoring

CLIENT_StopRealPlayEx

Logout user
CLIENT_Logout

Clean up SDK resources

CLIENT_Cleanup

End

Figure 2-4 The third party decoding and playing process

Process description:

1. SDK initialization.

2. After successful initialization, call CLIENT_LoginEx2 to login device.

3. After successful login, call CLIENT_RealPlayEx to start real-time monitoring, hWnd is a

26/339
valid window handle.

4. Set real-time data callback function in CLIENT_SetRealDataCallBackEx.

5. Save real-time data in callback function for further use. It is not recommended to do any

work but data stored and data delivered, or the performance will be affected when there are too

many monitoring channels.

6. After completing real-time monitoring, call CLIENT_StopRealPlayEx to stop real-time

monitoring.

7. After realizing needed business, call CLIENT_Logout to logout device.

8. Last but not the least, call CLIENT_Cleanup to release SDK resources.

2.3.4 Example Code

2.3.4.1 SDK Decoding and Playing

#include <windows.h>
#include <stdio.h>
#include "dhnetsdk.h"

#pragma comment(lib , "dhnetsdk.lib")

typedef HWND (WINAPI *PROCGETCONSOLEWINDOW)();

PROCGETCONSOLEWINDOW GetConsoleWindow;

static BOOL g_bNetSDKInitFlag = FALSE;

static LLONG g_lLoginHandle = 0L;
static LLONG g_lRealHandle = 0;
static char g_szDevIp[32] = "172.11.1.88";
static WORD g_nPort = 37777; // Before tcp connects port,the port need to keep with tcp
port config in expected login
static char g_szUserName[64] = "admin";
static char g_szPasswd[64] = "admin";

//*********************************************************************************
// commonly used callback set declaration
// callback function used when device gets offline
// Its not recommended to call SDK interfaces in this callback function
//Set the callback function in CLIENT_Initwhen device gets offlineSDK will call this function
automatically

27/339
 void CALLBACK DisConnectFunc(LONG lLoginID, char *pchDVRIP, LONG nDVRPort,
DWORD dwUser);

// callback function used after device is reconnected successfully

// Its not recommended to call SDK interfaces in this callback function
// Set the callback function in CLIENT_SetAutoReconnect, when offline device is reconnected
successfully, SDK will call the function
void CALLBACK HaveReConnect(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,
LDWORD dwUser);
//*********************************************************************************
void InitTest()
{
// SDK Initialization
g_bNetSDKInitFlag = CLIENT_Init(DisConnectFunc, 0);
if (FALSE == g_bNetSDKInitFlag)
{
printf("Initialize client SDK fail; \n");
return;
}
else
{
printf("Initialize client SDK done; \n");
}

//Get the SDK version info

// This operation is optional.
DWORD dwNetSdkVersion = CLIENT_GetSDKVersion();
printf("NetSDK version is [%d]\n", dwNetSdkVersion);

// set CLIENT_SetAutoReconnect interface.Once HaveReConnect is set, when device

gets offline, SDK will reconnect internally
//This operation is optional, but recommended.
CLIENT_SetAutoReconnect(&HaveReConnect, 0);

// Set device connection timeout value and trial times.

//This operation is optional.
int nWaitTime = 5000; // timeout value is 5 seconds
int nTryTimes = 3; //if timeout,it will try to log in three times.
CLIENT_SetConnectTime(nWaitTime, nTryTimes);

//Set more network parameter, nWaittime and nConnectTryNum in NET_PARAM has the
same meaning with the timeout time and trial time set in interface CLIENT_SetConnectTime.
//This operation is optional.

28/339
 NET_PARAM stuNetParm = {0};

stuNetParm.nConnectTime = 3000; //when login, connection timeout value is 3000ms.

CLIENT_SetNetworkParam(&stuNetParm);

NET_DEVICEINFO_Ex stDevInfoEx = {0};

int nError = 0;
while(0 == g_lLoginHandle)
{
//Login device
g_lLoginHandle = CLIENT_LoginEx2(g_szDevIp, g_nPort, g_szUserName,
g_szPasswd, EM_LOGIN_SPEC_CAP_TCP, NULL, &stDevInfoEx, &nError);

if(0 == g_lLoginHandle)
{
// according to error code, you can find corresponding explanation in dhnetsdk.h.
It is to print hexadecimal here, not decimal showns in header file, please be careful with conversion
//Example: #define NET_NOT_SUPPORTED_EC(23) //Now SDK does not
support this function, error code is 0x80000017, Decimal number 23 is hexadecimal 0x17.
printf("CLIENT_LoginEx2 %s[%d]Failed!Last Error[%x]\n" , g_szDevIp , g_nPort ,
CLIENT_GetLastError());
}
else
{
printf("CLIENT_LoginEx2 %s[%d] Success\n" , g_szDevIp , g_nPort);
}
// The first time logining to device, some data is needed to be initialized to enable
normal business function. It is recommended to wait for a while after login, the waiting time varies
by devices.
Sleep(1000);
printf("\n");
}
}

void RunTest()
{
// judge whether initialization is successful or not
if (FALSE == g_bNetSDKInitFlag)
{
return;
}
//judge whether login device or not

29/339
 if (0 == g_lLoginHandle)
{
return;
}

// realize real-time monitoring

//Get the console window handle
HMODULE hKernel32 = GetModuleHandle("kernel32");
GetConsoleWindow =
(PROCGETCONSOLEWINDOW)GetProcAddress(hKernel32,"GetConsoleWindow");
HWND hWnd = GetConsoleWindow();

printf("user can input any key to quit during real play! \n");
Sleep(1000);

//start real-time monitoring

int nChannelID = 0; // preview channel NO.
DH_RealPlayType emRealPlayType = DH_RType_Realplay; // real-time monitoring
g_lRealHandle = CLIENT_RealPlayEx(g_lLoginHandle, nChannelID, hWnd,
emRealPlayType);
if (0 == g_lRealHandle)
{
printf("CLIENT_RealPlayEx: failed! Error code: %x.\n", CLIENT_GetLastError());
}
}

void EndTest()
{
printf("input any key to quit! \n");
getchar();
// Close preview
if (0 != g_lRealHandle)
{
if(FALSE == CLIENT_StopRealPlayEx(g_lRealHandle))
{
printf("CLIENT_StopRealPlayEx Failed!Last Error[%x]\n" ,
CLIENT_GetLastError());
}
else
{
g_lRealHandle = 0;
}
}

30/339
 //Exit device
if (0 != g_lLoginHandle)
{
if(FALSE == CLIENT_Logout(g_lLoginHandle))
{
printf("CLIENT_Logout Failed!Last Error[%x]\n", CLIENT_GetLastError());
}
else
{
g_lLoginHandle = 0;
}
}
// Clean up initialization resources
if (TRUE == g_bNetSDKInitFlag)
{
CLIENT_Cleanup();
g_bNetSDKInitFlag = FALSE;
}
}

int main()
{
InitTest();
RunTest();
EndTest();
return 0;
}

//*********************************************************************************
//commonly used callback functions definition
void CALLBACK DisConnectFunc(LONG lLoginID, char *pchDVRIP, LONG nDVRPort,
DWORD dwUser)
{
printf("Call DisConnectFunc\n");
printf("lLoginID[0x%x]", lLoginID);
if (NULL != pchDVRIP)
{
printf("pchDVRIP[%s]\n", pchDVRIP);
}
printf("nDVRPort[%d]\n", nDVRPort);
printf("dwUser[%p]\n", dwUser);
printf("\n");
}

31/339
 void CALLBACK HaveReConnect(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,
LDWORD dwUser)
{
printf("Call HaveReConnect\n");
printf("lLoginID[0x%x]", lLoginID);
if (NULL != pchDVRIP)
{
printf("pchDVRIP[%s]\n", pchDVRIP);
}
printf("nDVRPort[%d]\n", nDVRPort);
printf("dwUser[%p]\n", dwUser);
printf("\n");
}

2.3.4.2 The third party decoding and playing

#include <windows.h>
#include <stdio.h>
#include "dhnetsdk.h"

#pragma comment(lib , "dhnetsdk.lib")

static BOOL g_bNetSDKInitFlag = FALSE;

static LLONG g_lLoginHandle = 0L;
static LLONG g_lRealHandle = 0;
static char g_szDevIp[32] = "172.11.1.88";
static WORD g_nPort = 37777; // Before tcp connects port,the po rt need to keep with tcp
port config in expected login
static char g_szUserName[64] = "admin";
static char g_szPasswd[64] = "admin";

//*********************************************************************************
// commonly used callback set declaration
// callback function used when device gets offline
// Its not recommended to call SDK interfaces in this callback function
//Set the callback function in CLIENT_Initwhen device gets offlineSDK will call this function
automatically
void CALLBACK DisConnectFunc(LONG lLoginID, char *pchDVRIP, LONG nDVRPort,
DWORD dwUser);

32/339
 // callback function used after device is reconnected successfully
// Its not recommended to call SDK interfaces in this callback function
// Set the callback function in CLIENT_SetAutoReconnect, when offline device is reconnected
successfully, SDK will call the function
void CALLBACK HaveReConnect(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,
LDWORD dwUser);

// Real-time monitoring data callback function

// Not recommended to call SDK interface in SDK callback function.
// The callback function is set by CLIENT_ SetRealDataCallBackEx, When real-time data is
received, SDK will call function.
//Recommend user only save data in this callback, do not encode or decode data directly.
//In other words: Copy data to your storage and encode or decode data after leaving callback.
void CALLBACK RealDataCallBackEx(LLONG lRealHandle, DWORD dwDataType, BYTE
*pBuffer, DWORD dwBufSize, LONG param, LDWORD dwUser);

//*********************************************************************************
void InitTest()
{
// SDK Initialization
g_bNetSDKInitFlag = CLIENT_Init(DisConnectFunc, 0);
if (FALSE == g_bNetSDKInitFlag)
{
printf("Initialize client SDK fail; \n");
return;
}
else
{
printf("Initialize client SDK done; \n");
}

//Get the SDK version information.

// This operation is optional.
DWORD dwNetSdkVersion = CLIENT_GetSDKVersion();
printf("NetSDK version is [%d]\n", dwNetSdkVersion);

// set CLIENT_SetAutoReconnect interface.Once HaveReConnect is set, when device

gets offline, SDK will reconnect internally
//This operation is optional,but recommended.
CLIENT_SetAutoReconnect(&HaveReConnect, 0);

// Set device connection timeout value and trial times.

33/339
 //This operation is optional
int nWaitTime = 5000; // timeout value is 5 seconds
int nTryTimes = 3; //If timeout,it will try to log in three times.
CLIENT_SetConnectTime(nWaitTime, nTryTimes);

//Set more network parameter, nWaittime and nConnectTryNum in NET_PARAM has the
same meaning with the timeout time and trial time set in interface CLIENT_SetConnectTime.
//This operation is optional.

NET_PARAM stuNetParm = {0};

stuNetParm.nConnectTime = 3000; //when login, connection timeout value is 3000ms.

CLIENT_SetNetworkParam(&stuNetParm);

CLIENT_SetNetworkParam(&stuNetParm);

NET_DEVICEINFO_Ex stDevInfoEx = {0};

int nError = 0;
while(0 == g_lLoginHandle)
{
//Login device
g_lLoginHandle = CLIENT_LoginEx2(g_szDevIp, g_nPort, g_szUserName,
g_szPasswd, EM_LOGIN_SPEC_CAP_TCP, NULL, &stDevInfoEx, &nError);

if (0 == g_lLoginHandle)
{
// according to error code, you can find corresponding explanation in dhnetsdk.h.
It is to print hexadecimal here, not decimal showns in header file, please be careful with conversion
//Example: #define NET_NOT_SUPPORTED_EC(23) //Now SDK does not
support this function, error code is 0x80000017, Decimal number 23 is hexadecimal 0x17.
printf("CLIENT_LoginEx2 %s[%d]Failed!Last Error[%x]\n" , g_szDevIp , g_nPort ,
CLIENT_GetLastError());
}
else
{
printf("CLIENT_LoginEx2 %s[%d] Success\n" , g_szDevIp , g_nPort);
}
// The first time logining to device, some data is needed to be initialized to enable
normal business function. It is recommended to wait for a while after login, the waiting time varies
by devices.
Sleep(1000);
printf("\n");
}

34/339
 }

void RunTest()
{
if (FALSE == g_bNetSDKInitFlag)
{
return;
}

if (0 == g_lLoginHandle)
{
return;
}

// Real-time monitoring realization operation

printf("user can input any key to quit during real play data callback! \n");
Sleep(1000);

//start real-time monitoring

int nChannelID = 0; // preview channel number
DH_RealPlayType emRealPlayType = DH_RType_Realplay; // real-time monitoring
g_lRealHandle = CLIENT_RealPlayEx(g_lLoginHandle, nChannelID, NULL, emRealPlayType);
if (0 == g_lRealHandle)
{
printf("CLIENT_RealPlayEx: failed! Error code: %x.\n", CLIENT_GetLastError());
return;
}
else
{
DWORD dwFlag = 0x00000001;
if (FALSE == CLIENT_SetRealDataCallBackEx(g_lRealHandle,
&RealDataCallBackEx, NULL, dwFlag))
{
printf("CLIENT_SetRealDataCallBackEx: failed! Error code: %x.\n",
CLIENT_GetLastError());
return;
}
}
}

void EndTest()
{
printf("input any key to quit! \n");

35/339
 getchar();
//Close preview
if (0 != g_lRealHandle)
{
if (FALSE == CLIENT_StopRealPlayEx(g_lRealHandle))
{
printf("CLIENT_StopRealPlayEx Failed, g_lRealHandle[%x]!Last Error[%x]\n" ,
g_lRealHandle, CLIENT_GetLastError());
}
else
{
g_lRealHandle = 0;
}
}
//Exit device
if (0 != g_lLoginHandle)
{
if(FALSE == CLIENT_Logout(g_lLoginHandle))
{
printf("CLIENT_Logout Failed!Last Error[%x]\n", CLIENT_GetLastError());
}
else
{
g_lLoginHandle = 0;
}
}
// Clean up initialization resources.
if (TRUE == g_bNetSDKInitFlag)
{
CLIENT_Cleanup();
g_bNetSDKInitFlag = FALSE;
}
}

int main()
{
InitTest();
RunTest();
EndTest();
return 0;
}

//*********************************************************************************

36/339
 //commonly used callback functions definition
void CALLBACK DisConnectFunc(LONG lLoginID, char *pchDVRIP, LONG nDVRPort,
DWORD dwUser)
{
printf("Call DisConnectFunc\n");
printf("lLoginID[0x%x]", lLoginID);
if (NULL != pchDVRIP)
{
printf("pchDVRIP[%s]\n", pchDVRIP);
}
printf("nDVRPort[%d]\n", nDVRPort);
printf("dwUser[%p]\n", dwUser);
printf("\n");
}

void CALLBACK HaveReConnect(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,

LDWORD dwUser)
{
printf("Call HaveReConnect\n");
printf("lLoginID[0x%x]", lLoginID);
if (NULL != pchDVRIP)
{
printf("pchDVRIP[%s]\n", pchDVRIP);
}
printf("nDVRPort[%d]\n", nDVRPort);
printf("dwUser[%p]\n", dwUser);
printf("\n");
}

void CALLBACK RealDataCallBackEx(LLONG lRealHandle, DWORD dwDataType, BYTE

*pBuffer, DWORD dwBufSize, LONG param, LDWORD dwUser)
{
// if more than one real-time monitoring use same data callback, we can judge by
parameter lRealHandle.
if (lRealHandle == g_lRealHandle)
{
switch(dwDataType)
{
case 0:
//original A/V hybrid data
printf("receive real data, param: lRealHandle[%p], dwDataType[%d],
pBuffer[%p], dwBufSize[%d], param[%p], dwUser[%p]\n", lRealHandle, dwDataType, pBuffer,
dwBufSize, param, dwUser);

37/339
 break;
case 1:
//standard video data

break;
case 2:
//yuv data

break;
case 3:
//pcm audio data

break;
case 4:
//original audio data

break;
default:
break;
}
}
}

2.4Record Playback

2.4.1 Intro

Overview

Record playback is to playback record of certain channels during specific periods,in order to

locate target video for research from a large quantity of videos.

Playback function includes several operations, such as play, pause, quick play,slow play,

draggering play and etc.

Record Playback Method

According to the different decoding method selected by users, record playback have two

methods: SDK decoding playback and third-party decoding playback.please refer to Ch 2.4.3 for

details.

38/339
2.4.2 Interface Overview

Interface Interface Description

CLIENT_Init Interface for SDK initialization

CLIENT_Cleanup Interface for cleaning up SDK resources

CLIENT_LoginEx2 Extensive interface 2 for Sync login

CLIENT_PlayBackByTimeEx Extensive interface for playback by time

Interface for setting work mode such as audio

CLIENT_SetDeviceMode
intercom, playback, right and etc.

CLIENT_StopPlayBack Interface for stopping record playback

CLIENT_GetPlayBackOsdTime Interface for getting playback OSD time

CLIENT_PausePlayBack Interface for pause or restoring playback

Interface for fast play. Increasing frame rate by

CLIENT_FastPlayBack
1x

Interface for slow play. Decreasing frame rate by

CLIENT_SlowPlayBack
1x

CLIENT_NormalPlayBack Interface for restoring normal play speed

Interface for positioning record playback start

CLIENT_SeekPlayBack
point

CLIENT_Logout Interface for logout

Interface for getting error code after failed calling

CLIENT_GetLastError
interface

2.4.3 Process Instruction

According to the different decoding method selected by users, r ecord playback have the

following two methods:

SDK decoding and playing back

Firstly user inputs start time, end time and valid window handle of record, then SDK will call

corresponding decoding library to analyze stream and show the video in display window.

39/339
 The third-party decoding and playing back

Firstly user inputs start time, end time and valid window handle(window handle is set to NULL in

this method) and valid playback stream callback function of record. After SDK re ceives playback

stream data, the data is called back to user for saving by playback stream callback function. After

leaving callback function, user calls a third-party library to analyze and display the saved stream

data.

2.4.3.1 SDK Decoding and Playing Back

SDK Decoding and Playing back process flow sheet is shown below in Figure 2-5.

40/339
 START

SDK initialization

Login to device
CLIENT_LoginEx2

Set playback stream type

(DH_RECORD_STREAM_TYPE)
CLIENT_SetDeviceMode

Set playback record file type

(DH_RECORD_TYPE)
CLIENT_SetDeviceMode

Start playback
Parameter hWind is a valid window handle value
CLIENT_PlayBackByTimeEx

CLIENT_SlowPlayBack slow play

CLIENT_FastPlayBack fast play
CLIENT_NormalPlayBack nomal speed play
CLIENT_PausePlayBack pause/restore
CLIENT_SeekPlayBack play by dragging

Stop playback
CLIENT_StopPlayBack

Logout user
CLIENT_Logout

Release SDK resource

CLIENT_Cleanup

END

Figure 2-5 SDK Decoding and Playing back process flow sheet

41/339
 Process description:

1. SDK initialization.

2. After successful initialization, call CLIENT_LoginEx2 to login device.

3. After successful login, call CLIENT_SetDeviceMode twice to separately set playback

stream type and playback record file type.

4. Call CLIENT_PlayBackByTimeEx to start playback, parameter hWnd is set to valid window

handle value.

5. During playback, user can call CLIENT_SlowPlayBack to slowly

play,CLIENT_FastPlayBack to fast play CLIENT_NormalPlayBack to play at normal speed,

CLIENT_PausePlayBack to pause/store play, CLIENT_SeekPlayBack to play by dragging.

6. After playback is done, call CLIENT_StopPlayBack to stop playback.

7. After realizing needed business, call CLIENT_Logout to logout device.

8. Last but not the least, call CLIENT_Cleanup to release SDK resource.

2.4.3.2 The Third-party Decoding and Playing Back

The third-party library decoding and playing back flow sheet is shown in Figure 2-6.

42/339
 START

SDK initialization

Login to device
CLIENT_LoginEx2

Set playback stream type

Parameter emType is (DH_RECORD_STREAM_TYPE
CLIENT_SetDeviceMode

Set playback record file type

Parameter emType is DH_RECORD_TYPE
CLIENT_SetDeviceMode

Start playback
Parameter hWind is set to NULL Callback function
Parameter fDownLoadDataCallBack is valid pointer pointing to callback function fDataCallBack
CLIENT_PlayBackByTimeEx

CLIENT_SlowPlayBack slow play

CLIENT_FastPlayBack fast play
CLIENT_NormalPlayBack nomal speed play
CLIENT_PausePlayBack pause/restore
CLIENT_SeekPlayBack play by dragging
These interface can be used together with a third-party library interface

Stop playback
CLIENT_StopPlayBack

Logout user
CLIENT_Logout

Release SDK resource

CLIENT_Cleanup

END

Figure 2-6 The third-party library decoding and playing back flow sheet

43/339
 Process description:

1. SDK initialization.

2. After successful initialization, call CLIENT_LoginEx2 to login device.

3. After successful login, call CLIENT_SetDeviceMode twice to separately set playback

stream type and playback record file type.

4. After successful login, call CLIENT_PlayBackByTimeEx to start playback, parameter hWnd

is set to NULL, parameter fDownLoadDataCallBack is a valid pointer pointing to a callback function.

5. After SDK receives playback stream data, the data is called back to user for saving by

playback stream callback function fDownLoadDataCallBack. After leaving callback function, user

calls a third-party library to analyze and display the saved stream data.

6. During playback, user can call CLIENT_SlowPlayBack to slowly

play,CLIENT_FastPlayBack to fast play,CLIENT_NormalPlayBack to play at normal

speed,CLIENT_PausePlayBack to pause/store play, CLIENT_SeekPlayBack to play by dragging

together with the third-party interfaces.

7. After playback is done, call CLIENT_StopPlayBack to stop playback.

8. After realizing needed business, call CLIENT_Logout to logout device.

9. Last but not the least, call CLIENT_Cleanup to release SDK resource.

2.4.4 Example Code

2.4.4.1 SDK Decoding and Playing Back

#include <windows.h>
#include <stdio.h>
#include "dhnetsdk.h"
#pragma comment(lib , "dhnetsdk.lib")

extern "C" HWND WINAPI GetConsoleWindow();

static BOOL g_bNetSDKInitFlag = FALSE;

static LLONG g_lLoginHandle = 0L;
static LLONG g_lPlayHandle = 0L;
static char g_szDevIp[32] = "172.11.1.13";
static WORD g_nPort = 37777;
static char g_szUserName[64] = "admin";

44/339
 static char g_szPasswd[64] = "admin";

//*********************************************************************************
// commonly used callback set declaration
// callback function used when device gets offline
// Its not recommended to call SDK interfaces in this callback function
//Set the callback function in CLIENT_Initwhen device gets offlineSDK will call this function
automatically
void CALLBACK DisConnectFunc(LONG lLoginID, char *pchDVRIP, LONG nDVRPort,
DWORD dwUser);

// callback function used after device is reconnected successfully

// Its not recommended to call SDK interfaces in this callback function
// Set the callback function in CLIENT_SetAutoReconnect, when offline device is reconnected
successfully, SDK will call the function
void CALLBACK HaveReConnect(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,
LDWORD dwUser);
//*********************************************************************************
void InitTest()
{
// SDK Initialization
g_bNetSDKInitFlag = CLIENT_Init(DisConnectFunc, 0);
if (FALSE == g_bNetSDKInitFlag)
{
printf("Initialize client SDK fail; \n");
return;
}
else
{
printf("Initialize client SDK done; \n");
}

//Get the SDK version info

// This operation is optional.
DWORD dwNetSdkVersion = CLIENT_GetSDKVersion();
printf("NetSDK version is [%d]\n", dwNetSdkVersion);

// set CLIENT_SetAutoReconnect interface.Once HaveReConnect is set, when device

gets offline, SDK will reconnect internally
//This operation is optional, but recommended.
CLIENT_SetAutoReconnect(&HaveReConnect, 0);

// Set device connection timeout value and trial times.

45/339
 //This operation is optional.
int nWaitTime = 5000; // timeout value is 5 seconds
int nTryTimes = 3; //if timeout,it will try to log in three times.
CLIENT_SetConnectTime(nWaitTime, nTryTimes);

//Set more network parameter, nWaittime and nConnectTryNum in NET_PARAM has the
same meaning with the timeout time and trial time set in interface CLIENT_SetConnectTime.
//This operation is optional.
NET_PARAM stuNetParm = {0};
stuNetParm.nWaittime = 3000; // when login, connection timeout value is 3000ms.
CLIENT_SetNetworkParam(&stuNetParm);

NET_DEVICEINFO_Ex stDevInfoEx = {0};

int nError = 0;
while(0 == g_lLoginHandle)
{
//Login device
g_lLoginHandle = CLIENT_LoginEx2(g_szDevIp, g_nPort, g_szUserName,
g_szPasswd, EM_LOGIN_SPEC_CAP_TCP, NULL, &stDevInfoEx, &nError);

if(0 == g_lLoginHandle)
{
// according to error code, you can find corresponding explanation in dhnetsdk.h.
It is to print hexadecimal here, not decimal showns in header file, please be careful with conversion
//Example: #define NET_NOT_SUPPORTED_EC(23)
//Now SDK does not support this function, error code is 0x80000017, Decimal
number 23 is hexadecimal 0x17.
printf("CLIENT_LoginEx2 %s[%d]Failed!Last Error[%x]\n" , g_szDevIp , g_nPort ,
CLIENT_GetLastError());
}
else
{
printf("CLIENT_LoginEx2 %s[%d] Success\n" , g_szDevIp , g_nPort);
}
// The first time logining to device, some data is needed to be initialized to enable
normal business function. It is recommended to wait for a while after login, the waiting time varies
by devices.
Sleep(1000);
printf("\n");
}
}

46/339
 void RunTest()
{
if (FALSE == g_bNetSDKInitFlag)
{
return;
}

if (0 == g_lLoginHandle)
{
return;
}

// record playback function

// get console window handle
HWND hWnd = GetConsoleWindow();

// set playback stream type

int nStreamType = 0; // 0-main/sub stream,1-main stream,2-sub stream
CLIENT_SetDeviceMode(g_lLoginHandle, DH_RECORD_STREAM_TYPE,
&nStreamType);

// set playback record file type

NET_RECORD_TYPE emFileType = NET_RECORD_TYPE_ALL; // all records
CLIENT_SetDeviceMode(g_lLoginHandle, DH_RECORD_TYPE, &emFileType);

//start record playback

int nChannelID = 0; // channel NO.
NET_TIME stuStartTime = {0};
stuStartTime.dwYear = 2015;
stuStartTime.dwMonth = 11;
stuStartTime.dwDay = 20;

NET_TIME stuStopTime = {0};

stuStopTime.dwYear = 2015;
stuStopTime.dwMonth = 11;
stuStopTime.dwDay = 21;

g_lPlayHandle = CLIENT_PlayBackByTimeEx(g_lLoginHandle, nChannelID,

&stuStartTime, &stuStopTime, hWnd, NULL, NULL, NULL, NULL);
if (0 == g_lPlayHandle)
{
printf("CLIENT_PlayBackByTimeEx: failed! Error code: %x.\n",
CLIENT_GetLastError());

47/339
 }

// user can control palyback according to needs

// due to it is a console demo, we cannot show user record playback and playback control
at the same time, here are some examples for reference.

// CLIENT_SlowPlayBack to slowly play

/* example code
if (FALSE == CLIENT_SlowPlayBack (g_lPlayHandle))
{
printf("CLIENT_SlowPlayBack Failed, g_lPlayHandle[%x]!Last Error[%x]\n" ,
g_lPlayHandle, CLIENT_GetLastError());
}
*/

// CLIENT_FastPlayBack to fast play

/* example code
if (FALSE == CLIENT_FastPlayBack (g_lPlayHandle))
{
printf("CLIENT_FastPlayBack Failed, g_lPlayHandle[%x]!Last Error[%x]\n" ,
g_lPlayHandle, CLIENT_GetLastError());
}
*/

// CLIENT_NormalPlayBack to play at normal speed

/* example code
if (FALSE == CLIENT_NormalPlayBack (g_lPlayHandle))
{
printf("CLIENT_NormalPlayBack Failed, g_lPlayHandle[%x]!Last Error[%x]\n" ,
g_lPlayHandle, CLIENT_GetLastError());
}
*/

// CLIENT_PausePlayBack to pause/restore play

/* example code
if (FALSE == CLIENT_PausePlayBack (g_lPlayHandle, TRUE))
{
printf("CLIENT_PausePlayBack Failed, g_lPlayHandle[%x]!Last Error[%x]\n" ,
g_lPlayHandle, CLIENT_GetLastError());
}
*/

// CLIENT_SeekPlayBack to play by dragging

48/339
 /* example code
int nOffsetSeconds = 2 * 60 * 60; // drag to 2*60*60s after stuStartTime to start play
if (FALSE == CLIENT_SeekPlayBack (g_lPlayHandle, nOffsetSeconds, 0))
{
printf("CLIENT_SeekPlayBack Failed, g_lPlayHandle[%x]!Last Error[%x]\n" ,
g_lPlayHandle, CLIENT_GetLastError());
}
*/
}

void EndTest()
{
printf("input any key to quit! \n");
getchar();
// close playback
if (0 != g_lPlayHandle)
{
if (FALSE == CLIENT_StopPlayBack(g_lPlayHandle))
{
printf("CLIENT_StopPlayBack Failed, g_lRealHandle[%x]!Last Error[%x]\n" ,
g_lPlayHandle, CLIENT_GetLastError());
}
else
{
g_lPlayHandle = 0;
}
}
// logout device
if (0 != g_lLoginHandle)
{
if(FALSE == CLIENT_Logout(g_lLoginHandle))
{
printf("CLIENT_Logout Failed!Last Error[%x]\n", CLIENT_GetLastError());
}
else
{
g_lLoginHandle = 0;
}
}
// cleanup initialization resource
if (TRUE == g_bNetSDKInitFlag)
{
CLIENT_Cleanup();

49/339
 g_bNetSDKInitFlag = FALSE;
}
return;
}

int main()
{
InitTest();
RunTest();
EndTest();
return 0;
}

//*********************************************************************************
// commonly used callback set definition

void CALLBACK DisConnectFunc(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,

DWORD dwUser)
{
printf("Call DisConnectFunc\n");
printf("lLoginID[0x%x]", lLoginID);
if (NULL != pchDVRIP)
{
printf("pchDVRIP[%s]\n", pchDVRIP);
}
printf("nDVRPort[%d]\n", nDVRPort);
printf("dwUser[%p]\n", dwUser);
printf("\n");
}

void CALLBACK HaveReConnect(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,

LDWORD dwUser)
{
printf("Call HaveReConnect\n");
printf("lLoginID[0x%x]", lLoginID);
if (NULL != pchDVRIP)
{
printf("pchDVRIP[%s]\n", pchDVRIP);
}
printf("nDVRPort[%d]\n", nDVRPort);
printf("dwUser[%p]\n", dwUser);
printf("\n");
}

50/339
2.4.4.2 The Third-party Decoding and Playing Back
#include <windows.h>
#include <stdio.h>
#include "dhnetsdk.h"
#pragma comment(lib , "dhnetsdk.lib")

static BOOL g_bNetSDKInitFlag = FALSE;

static LLONG g_lLoginHandle = 0L;
static LLONG g_lPlayHandle = 0L;
static char g_szDevIp[32] = "172.11.1.6";
static WORD g_nPort = 37777;
static char g_szUserName[64] = "admin";
static char g_szPasswd[64] = "admin";

//*********************************************************************************
// commonly used callback set declaration
// callback function used when device gets offline
// Its not recommended to call SDK interfaces in this callback function
//Set the callback function in CLIENT_Initwhen device gets offlineSDK will call this function
automatically
void CALLBACK DisConnectFunc(LONG lLoginID, char *pchDVRIP, LONG nDVRPort,
DWORD dwUser);

// callback function used after device is reconnected successfully

// Its not recommended to call SDK interfaces in this callback function
// Set the callback function in CLIENT_SetAutoReconnect, when offline device is reconnected
successfully, SDK will call the function
void CALLBACK HaveReConnect(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,
LDWORD dwUser);

// playback progress callback function

// Its not recommended to call SDK interfaces in this callback function
// set this callback function in CLIENT_PlayBackByTimeEx. when playback data is received,
SDK will call this function.
void CALLBACK DownLoadPosCallBack(LLONG lPlayHandle, DWORD dwTotalSize, DWORD
dwDownLoadSize, LDWORD dwUser);

// playback data callback function

// Its not recommended to call SDK interfaces in this callback function
//when parameter hWnd is NULL, the function return 0: means this callback failed, next
callback will return the same data. 1:means this callback is successful, next callback will return
follow-up data.

51/339
 // when parameter hWnd ist NULL, it will be treated as callback successful no matter what the
return value is, and next time callback will return follow-up data
// set this callback function in CLIENT_PlayBackByTimeEx. when playback data is received,
SDK will call this function.
int CALLBACK DataCallBack(LLONG lRealHandle, DWORD dwDataType, BYTE *pBuffer,
DWORD dwBufSize, LDWORD dwUser);

//*************************************************************************************
void InitTest()
{
// SDK Initialization
g_bNetSDKInitFlag = CLIENT_Init(DisConnectFunc, 0);
if (FALSE == g_bNetSDKInitFlag)
{
printf("Initialize client SDK fail; \n");
return;
}
else
{
printf("Initialize client SDK done; \n");
}

//Get the SDK version info

// This operation is optional.
DWORD dwNetSdkVersion = CLIENT_GetSDKVersion();
printf("NetSDK version is [%d]\n", dwNetSdkVersion);

// set CLIENT_SetAutoReconnect interface.Once HaveReConnect is set, when devic e

gets offline, SDK will reconnect internally
//This operation is optional, but recommended.
CLIENT_SetAutoReconnect(&HaveReConnect, 0);

// Set device connection timeout value and trial times.

//This operation is optional.
int nWaitTime = 5000; // timeout value is 5 seconds
int nTryTimes = 3; //if timeout,it will try to log in three times.
CLIENT_SetConnectTime(nWaitTime, nTryTimes);

//Set more network parameter, nWaittime and nConnectTryNum in NET_PARAM has the
same meaning with the timeout time and trial time set in interface CLIENT_SetConnectTime.

//This operation is optional.

NET_PARAM stuNetParm = {0};

52/339
 stuNetParm.nWaittime = 3000; // when login, connection timeout value is 3000ms.
CLIENT_SetNetworkParam(&stuNetParm);

NET_DEVICEINFO_Ex stDevInfoEx = {0};

int nError = 0;
while(0 == g_lLoginHandle)
{
//Login device
g_lLoginHandle = CLIENT_LoginEx2(g_szDevIp, g_nPort, g_szUserName,
g_szPasswd, EM_LOGIN_SPEC_CAP_TCP, NULL, &stDevInfoEx, &nError);

if(0 == g_lLoginHandle)
{
// according to error code, you can find corresponding explanation in dhnetsdk.h.
It is to print hexadecimal here, not decimal showns in header file, please be careful with conversion
//Example: #define NET_NOT_SUPPORTED_EC(23)
//Now SDK does not support this function, error code is 0x80000017, Decimal
number 23 is hexadecimal 0x17.
printf("CLIENT_LoginEx2 %s[%d]Failed!Last Error[%x]\n" , g_szDevIp , g_nPort ,
CLIENT_GetLastError());
}
else
{
printf("CLIENT_LoginEx2 %s[%d] Success\n" , g_szDevIp , g_nPort);
}
// The first time logining to device, some data is needed to be in itialized to enable
normal business function. It is recommended to wait for a while after login, the waiting time varies
by devices.
Sleep(1000);
printf("\n");
}
}

void RunTest()
{
if (FALSE == g_bNetSDKInitFlag)
{
return;
}

if (0 == g_lLoginHandle)
{
return;

53/339
 }

// record playback function

// set playback stream type

int nStreamType = 0; // 0-main/sub stream,1-main stream,2-sub stream
CLIENT_SetDeviceMode(g_lLoginHandle, DH_RECORD_STREAM_TYPE,
&nStreamType);

// set playback record file type

NET_RECORD_TYPE emFileType = NET_RECORD_TYPE_ALL; // all records
CLIENT_SetDeviceMode(g_lLoginHandle, DH_RECORD_TYPE, &emFileType);

//start record playback

int nChannelID = 0; // channel NO.
NET_TIME stuStartTime = {0};
stuStartTime.dwYear = 2015;
stuStartTime.dwMonth = 11;
stuStartTime.dwDay = 20;

NET_TIME stuStopTime = {0};

stuStopTime.dwYear = 2015;
stuStopTime.dwMonth = 11;
stuStopTime.dwDay = 21;

// parameter hWnd need to be NULL

// parameter fDownLoadDataCallBack need to be a valid pointer pointing to a callback
function
g_lPlayHandle = CLIENT_PlayBackByTimeEx(g_lLoginHandle, nChannelID,
&stuStartTime, &stuStopTime, NULL, &DownLoadPosCallBack, NULL, &DataCallBack, NULL);
if (g_lPlayHandle == 0)
{
printf("CLIENT_PlayBackByTimeEx: failed! Error code: %x.\n",
CLIENT_GetLastError());
}

// user control playback according to need

// due to it is third-party library decoding, when a user calls SDK playback control interface,
he needs to call control interface of third-party library at the same time
// due to it is a console demo, we cannot show user record playback and playback control
at the same time, here are some examples for reference.
// CLIENT_SlowPlayBack to slowly play
/* example code

54/339
 if (FALSE == CLIENT_SlowPlayBack (g_lPlayHandle))
{
printf("CLIENT_SlowPlayBack Failed, g_lPlayHandle[%x]!Last Error[%x]\n" ,
g_lPlayHandle, CLIENT_GetLastError());
}
//the third-party interface call

*/

// CLIENT_FastPlayBack to fast play

/* example code
if (FALSE == CLIENT_FastPlayBack (g_lPlayHandle))
{
printf("CLIENT_FastPlayBack Failed, g_lPlayHandle[%x]!Last Error[%x]\n" ,
g_lPlayHandle, CLIENT_GetLastError());
}
// the third-party interface call

*/

// CLIENT_NormalPlayBack to play at nomal speed

/* example code
if (FALSE == CLIENT_NormalPlayBack (g_lPlayHandle))
{
printf("CLIENT_NormalPlayBack Failed, g_lPlayHandle[%x]!Last Error[%x]\n" ,
g_lPlayHandle, CLIENT_GetLastError());
}
//the third-party interface call

*/

// CLIENT_PausePlayBack to pause/restore play

/* example code
if (FALSE == CLIENT_PausePlayBack (g_lPlayHandle, TRUE))
{
printf("CLIENT_PausePlayBack Failed, g_lPlayHandle[%x]!Last Error[%x]\n" ,
g_lPlayHandle, CLIENT_GetLastError());
}
// the third-party interface call

*/

// CLIENT_SeekPlayBack to play by dragging

55/339
 /* example code
int nOffsetSeconds = 2 * 60 * 60; // drag to 2*60*60s after stuStartTime to start play
if (FALSE == CLIENT_SeekPlayBack (g_lPlayHandle, nOffsetSeconds, 0))
{
printf("CLIENT_SeekPlayBack Failed, g_lPlayHandle[%x]!Last Error[%x]\n" ,
g_lPlayHandle, CLIENT_GetLastError());
}
//the third-party interface call

*/
}

void EndTest()
{
printf("input any key to quit! \n");
getchar();
// close playback
if (0 != g_lPlayHandle)
{
if (FALSE == CLIENT_StopPlayBack(g_lPlayHandle))
{
printf("CLIENT_StopPlayBack Failed, g_lRealHandle[%x]!Last Error[%x]\n" ,
g_lPlayHandle, CLIENT_GetLastError());
}
else
{
g_lPlayHandle = 0;
}
}
// logout device
if (0 != g_lLoginHandle)
{
if(FALSE == CLIENT_Logout(g_lLoginHandle))
{
printf("CLIENT_Logout Failed!Last Error[%x]\n", CLIENT_GetLastError());
}
else
{
g_lLoginHandle = 0;
}
}
// cleanup initialization resource
if (TRUE == g_bNetSDKInitFlag)

56/339
 {
CLIENT_Cleanup();
g_bNetSDKInitFlag = FALSE;
}
return;
}

int main()
{
InitTest();

RunTest();

EndTest();

return 0;
}

//*********************************************************************************
// commonly used callback set definition

void CALLBACK DisConnectFunc(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,

DWORD dwUser)
{
printf("Call DisConnectFunc\n");
printf("lLoginID[0x%x]", lLoginID);
if (NULL != pchDVRIP)
{
printf("pchDVRIP[%s]\n", pchDVRIP);
}
printf("nDVRPort[%d]\n", nDVRPort);
printf("dwUser[%p]\n", dwUser);
printf("\n");
}

void CALLBACK HaveReConnect(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,

LDWORD dwUser)
{
printf("Call HaveReConnect\n");
printf("lLoginID[0x%x]", lLoginID);
if (NULL != pchDVRIP)
{
printf("pchDVRIP[%s]\n", pchDVRIP);

57/339
 }
printf("nDVRPort[%d]\n", nDVRPort);
printf("dwUser[%p]\n", dwUser);
printf("\n");
}

void CALLBACK DownLoadPosCallBack(LLONG lPlayHandle, DWORD dwTotalSize, DWORD

dwDownLoadSize, LDWORD dwUser)
{
// If different playback/download uses the same process callback function , we can judge by
parameter 1PlayHandle
if (lPlayHandle == g_lPlayHandle)
{
printf("lPlayHandle[%p]\n", lPlayHandle);
printf("dwTotalSize[%d]\n", dwTotalSize);
printf("dwDownLoadSize[%d]\n", dwDownLoadSize);
printf("dwUser[%p]\n", dwUser);
printf("\n");
}
}

int CALLBACK DataCallBack(LLONG lRealHandle, DWORD dwDataType, BYTE *pBuffer,

DWORD dwBufSize, LDWORD dwUser)
{
int nRet = 0;
printf("call DataCallBack\n");
// If different playback/download uses the same callback function, we can judge by
parameter lRealHandle
if(lRealHandle == g_lPlayHandle)
{
BOOL bSuccess = TRUE;
// the following printing will cause frequently screen refresh, please be careful
printf("lPlayHandle[%p]\n", lRealHandle);
printf("dwDataType[%d]\n", dwDataType);
printf("pBuffer[%p]\n", pBuffer);
printf("dwBufSize[%d]\n", dwBufSize);
printf("dwUser[%p]\n", dwUser);
printf("\n");
switch(dwDataType)
{
case 0:
//Original data
// users can save stream data here for further process such as decoding and

58/339
 transferring after getting out of callback function
nRet = 1;//

break;
case 1:
//Standard video data

break;
case 2:
//yuv data

break;
case 3:
//pcm audio data

break;
case 4:
//Original audio data

break;
default:
break;
}
}
return nRet;
}

2.5Record Download

2.5.1 Intro

Video monitoring system is widely used in safe city, airport, subway, bank, factory and etc.

When something happened, its needed to download records to leaderspolice and media as

evidence for further use. Therefore, record download is a commonly used application module.

Record download process is that users get the records from storage device and save them to

local. It allows user to download records in currently selected channel, and export the records to

local hard disk or U disk.

59/339
 Record Download Methods

Record download have two methods: download by file and download by time, please refer to Ch

2.5.3.

2.5.2 Interface Overview

Interface Interface Description

CLIENT_Init Interface for SDK initialization

CLIENT_Cleanup Interface for cleaning up SDK resources

CLIENT_LoginEx2 Extensive interface 2 for Sync login

Interface for setting work mode of device audio intercom,

CLIENT_SetDeviceMode
playback and right

CLIENT_QueryRecordFile Interface for searching all files in a specified time period

CLIENT_FindFile Interface for opening record search handle

CLIENT_FindNextFile Interface for searching record file

CLIENT_FindClose Interface for closing record search handle

CLIENT_DownloadByRecordFileEx Extensive interface for downloading record by file

CLIENT_DownloadByTimeEx Extensive interface for downloading record by time

CLIENT_GetDownloadPos Interface for searching record download process

CLIENT_StopDownload Interface for stopping record download

CLIENT_Logout Interface for logout

Interface for getting error code after failed calling

CLIENT_GetLastError
interface

2.5.3 Process Instruction

Record download includes the following two methods

Download by file

Users need to point the downloaded record files information and SDK can download the

specified file and save it to a specified file. At the same time, user can also provide a callback

function pointer, so that SDK send the downloaded file info to users for further use by callback

60/339
function.

Download by time

User will need to point the start time and end time of the download file, SDK can download the

specified file in a specified time period and save it to a specified file. At the same time, user can also

provide a callback function pointer, so that SDK send the downloaded file info to users for further

use by callback function.

2.5.3.1 Download by File

Download by file process flow sheet is shown below in Figure 2-7.

61/339
 START

SDK initialization
ClIENT_Ini()

Login to device
CLIENT_LoginEx2

Set record stream type during

search
CLIENT_SetDeviceMode

Get the single record file info

CLIENT_QueryRecordFile

Get record search handle

Close record search handle

Download by file
CLIENT_DownByRecordFileEx

Search record download progress

CLIENT_GetDownLoadPos

Stop download
CLIENT_StopDownload

Logout user
CLIENT_Logout optional

mandatory
Release SDK resource
CLIENT_Cleanup

END

Figure 2-7 Download by file process flow sheet

62/339
 Process description:

1. SDK initialization.

2. After successful initializationcall CLIENT_LoginEx2 to login device.

3. Set record stream type in Call CLIENT_SetDeviceMode. Parameter EmType is

DH_RECORD_STREAM_TYPE which is recommended to set to 0-main/sub streamor some

devices will not return a result. If you only need main stream record, you can filter out sub stream

record info in result. Please refer to Appendix 2 EM_USEDEV_MODE enumeration note.

4. You can search record file with the following two methods

Call CLIENT_FindFile to get record search handle, and then call CLIENT_FindNextFile to

progressively get record file info in cycle, finally call CLIENT_FindClose to close record search

handle.

Call CLIENT_QueryRecordFile to get all record files info in a specified period.

5. After you get record file info, call CLIENT_DownloadByRecordFileEx to download record

file. At least one of the input parameters sSavedFileName and fDownLoadDataCallBack is valid.

6. During the download, call CLIENT_GetDownloadPos to search record download progress

as needed.

7. After download is finished, call CLIENT_StopDownload to stop download.

8. After business is finished, call CLIENT_Logout to logout device.

9. Last but not the least, call CLIENT_Cleanup to release SDK resource.

2.5.3.2 Download by Time

Download by time process flow sheet is shown in Figure 2-8.

63/339
 START

SDK initialization
CLIENT_init

Login to device
CLIENT_LoginEx2

Set record stream type

CLIENT_SetDeviceMode

Download by time
CLIENT_DownloadByTimeEx

Stop download
CLIENT_StopDownload

Logout user
CLIENT_Logout

Release SDK resource

CLIENT_Cleanup

END

Figure 2-8 Download by time process flow sheet

Process description

1. SDK initialization

2. After successful initializationcall CLIENT_LoginEx2 to login device.

3. Set record stream type in Call CLIENT_SetDeviceMode. Parameter EmType is

DH_RECORD_STREAM_TYPE,Please refer to Appendix 2 EM_USEDEV_MODE enumeration

note.

64/339
 4. Call CLIENT_DownloadByTimeEx to start to download by time. At least one input

parameter sSavedFileName and fDownLoadDataCallBack is valid.

5. After download is finished, call CLIENT_StopDownload to stop download. We can stop

download when download is finished or when download is still in progress as needed.

6. After business is finished, call CLIENT_Logout to logout device.

7. Last but not the least, call CLIENT_Cleanup to release SDK resource.

2.5.4 Example Code

2.5.4.1 Download by File

#include <windows.h>
#include <stdio.h>
#include <vector>
#include "dhnetsdk.h"

#pragma comment(lib , "dhnetsdk.lib")

static BOOL g_bNetSDKInitFlag = FALSE;

static LLONG g_lLoginHandle = 0L;
static LLONG g_lDownloadHandle = 0L;
static char g_szDevIp[32] = "172.11.1.30";
static WORD g_nPort = 37777;
static char g_szUserName[64] = "admin";
static char g_szPasswd[64] = "admin";
static const int g_nMaxRecordFileCount = 5000;
//*********************************************************************************
// commonly used callback set declaration
// callback function used when device gets offline
// Its not recommended to call SDK interfaces in this callback function
//Set the callback function in CLIENT_Initwhen device gets offlineSDK will call this function
automatically
void CALLBACK DisConnectFunc(LONG lLoginID, char *pchDVRIP, LONG nDVRPort,
DWORD dwUser);

// callback function used after device is reconnected successfully

// Its not recommended to call SDK interfaces in this callback function
// Set the callback function in CLIENT_SetAutoReconnect, when offline device is reconnected
successfully, SDK will call the function

65/339
 void CALLBACK HaveReConnect(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,
LDWORD dwUser);

// playback/download progress callback function

// Its not recommended to call SDK interfaces in this callback function
// dwDownLoadSize: -1 means playback/download finished-2 means failed to write fileother
value means valid data
// Set this callback function in CLIENT_DownloadByRecordFileEx. When SDK receives
playback/downloaded data, SDK will call this function.
void CALLBACK DownLoadPosCallBack(LLONG lPlayHandle, DWORD dwTotalSize, DWORD
dwDownLoadSize, LDWORD dwUser);

// playback/download data callback function

// Its not recommended to call SDK interfaces in this callback function
// playbackreturn value0 means this playback failednext callback will return the same data
1 means this callback successful, next callback will return the following data
// Downloadno matter what return from the callback function, it will be treated as callback is
successful, next callback will return the following data
// Set this callback function in CLIENT_DownloadByRecordFileEx. When SDK receives
playback/downloaded data, SDK will call this function.
int CALLBACK DataCallBack(LLONG lRealHandle, DWORD dwDataType, BYTE *pBuffer,
DWORD dwBufSize, LDWORD dwUser);

//*********************************************************************************
void InitTest()
{
// SDK initialization
g_bNetSDKInitFlag = CLIENT_Init(DisConnectFunc, 0);
if (FALSE == g_bNetSDKInitFlag)
{
printf("Initialize client SDK fail; \n");
return;
}
else
{
printf("Initialize client SDK done; \n");
}

// get SDK version info

// this operation is optional
DWORD dwNetSdkVersion = CLIENT_GetSDKVersion();
printf("NetSDK version is [%d]\n", dwNetSdkVersion);

66/339
 // set CLIENT_SetAutoReconnect interface.Once HaveReConnect is set, when device
gets offline, SDK will reconnect internally.
// this operation is optional, but recommended
CLIENT_SetAutoReconnect(&HaveReConnect, 0);

// set connectting device timeout time and attempts

// this operation is optional
int nWaitTime = 5000; // timeout time is set to 5s
int nTryTimes = 3; // if timeout, you have 3 attempts
CLIENT_SetConnectTime(nWaitTime, nTryTimes);

//Set more network parameter, nWaittime and nConnectTryNum in NET_PARAM has the
same meaning with the timeout time and trial time set in interface CLIENT_SetConnectTime.
//This operation is optional.
NET_PARAM stuNetParm = {0};
stuNetParm.nWaittime = 3000; // when login, connection timeout value is 3000ms.
CLIENT_SetNetworkParam(&stuNetParm);

NET_DEVICEINFO_Ex stDevInfoEx = {0};

int nError = 0;
while(0 == g_lLoginHandle)
{
// login device
g_lLoginHandle = CLIENT_LoginEx2(g_szDevIp, g_nPort, g_szUserName,
g_szPasswd, EM_LOGIN_SPEC_CAP_TCP, NULL, &stDevInfoEx, &nError);

if (0 == g_lLoginHandle)
{
// according to error code, you can find corresponding explanation in dhnetsdk.h.
It is to print hexadecimal here, not decimal showns in header file, please be careful with conversion
// example
// #define NET_NOT_SUPPORTED_EC(23)
// current SDK does not support the function, corresponding error code is
0x80000017. Decimal number 23 is hexadecimal 0x17.
printf("CLIENT_LoginEx2 %s[%d]Failed!Last Error[%x]\n" , g_szDevIp , g_nPort ,
CLIENT_GetLastError());
}
else
{
printf("CLIENT_LoginEx2 %s[%d] Success\n" , g_szDevIp , g_nPort);
}
// The first time logining to device, some data is needed to be initialized to enable

67/339
normal business function. It is recommended to wait for a while after login, the waiting time varies
by devices.
Sleep(1000);
printf("\n");
}
}

void RunTest()
{
if (FALSE == g_bNetSDKInitFlag)
{
return;
}

if (0 == g_lLoginHandle)
{
return;
}
// record file search
// set record stream type
int nStreamType = 0; // 0-main stream/sub stream,1-main stream,2-sub stream
CLIENT_SetDeviceMode(g_lLoginHandle, DH_RECORD_STREAM_TYPE,
&nStreamType);
// there are two methods to search files: 1.take all record files in the specified time period
once2take all records in the specified time period in several times.
// here is the second method, the first method can refer to CLIENT_QueryRecordFile
interface
int nChannelID = 0; // channel no.
NET_TIME stuStartTime = {0};
stuStartTime.dwYear = 2015;
stuStartTime.dwMonth = 9;
stuStartTime.dwDay = 20;

NET_TIME stuStopTime = {0};

stuStopTime.dwYear = 2015;
stuStopTime.dwMonth = 9;
stuStopTime.dwDay = 30;
int lFindHandle = CLIENT_FindFile(g_lLoginHandle, nChannelID, 0, NULL, &stuStartTime,
&stuStopTime, FALSE, 5000);
if (0 == lFindHandle)
{
printf("CLIENT_FindFile Failed!Last Error[%x]\n",CLIENT_GetLastError());
return;

68/339
 }
// demo
std::vector<NET_RECORDFILE_INFO> bufFileInfo(g_nMaxRecordFileCount);

for (int nFileIndex = 0; nFileIndex < g_nMaxRecordFileCount; ++nFileIndex)

{
int result = CLIENT_FindNextFile(lFindHandle, &bufFileInfo[nFileIndex]);
if (0 == result)// finish taking record files info {
break;
}
else if (1 != result)// parameter error
{
printf("CLIENT_FindNextFile Failed!Last Error[%x]\n",CLIENT_GetLastError());
break;
}
}

//stop search
if(0 != lFindHandle)
{
CLIENT_FindClose(lFindHandle);
}
// set the first file queried as download file
NET_RECORDFILE_INFO stuNetFileInfo;
if (nFileIndex > 0)
{
memcpy(&stuNetFileInfo, (void *)&bufFileInfo[0], sizeof(stuNetFileInfo));
}
else
{
printf("no record, return\n");
return;
}

// record file download

// start record download
// at least one of the two parameters sSavedFileName and fDownLoadDataCallBack is
valid
// the downloaded data is save to parameter sSavedFileName or save to callback function
as needed
g_lDownloadHandle = CLIENT_DownloadByRecordFileEx(g_lLoginHandle,
&stuNetFileInfo, "test.dav", DownLoadPosCallBack, NULL, DataCallBack, NULL);
if (0 == g_lDownloadHandle)

69/339
 {
printf("CLIENT_DownloadByRecordFileEx: failed! Error code: %x.\n",
CLIENT_GetLastError());
}
}

void EndTest()
{
printf("input any key to quit! \n");
getchar();
// stop download,we can call this interface after download ends or during download.
if (0 != g_lDownloadHandle)
{
if (FALSE == CLIENT_StopDownload(g_lDownloadHandle))
{
printf("CLIENT_StopDownload Failed, g_lDownloadHandle[%x]!Last
Error[%x]\n" , g_lDownloadHandle, CLIENT_GetLastError());
}
else
{
g_lDownloadHandle = 0;
}
}
// logout device
if (0 != g_lLoginHandle)
{
if(FALSE == CLIENT_Logout(g_lLoginHandle))
{
printf("CLIENT_Logout Failed!Last Error[%x]\n", CLIENT_GetLastError());
}
else
{
g_lLoginHandle = 0;
}
}
// cleanup initialization resource
if (TRUE == g_bNetSDKInitFlag)
{
CLIENT_Cleanup();
g_bNetSDKInitFlag = FALSE;
}

return;

70/339
 }

int main()
{
InitTest();
RunTest();
EndTest();
return 0;
}

//*********************************************************************************
// commonly used callback set definition
void CALLBACK DisConnectFunc(LONG lLoginID, char *pchDVRIP, LONG nDVRPort,
DWORD dwUser)
{
printf("Call DisConnectFunc\n");
printf("lLoginID[0x%x]", lLoginID);
if (NULL != pchDVRIP)
{
printf("pchDVRIP[%s]\n", pchDVRIP);
}
printf("nDVRPort[%d]\n", nDVRPort);
printf("dwUser[%p]\n", dwUser);
printf("\n");
}

void CALLBACK HaveReConnect(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,

LDWORD dwUser)
{
printf("Call HaveReConnect\n");
printf("lLoginID[0x%x]", lLoginID);
if (NULL != pchDVRIP)
{
printf("pchDVRIP[%s]\n", pchDVRIP);
}
printf("nDVRPort[%d]\n", nDVRPort);
printf("dwUser[%p]\n", dwUser);
printf("\n");
}

void CALLBACK DownLoadPosCallBack(LLONG lPlayHandle, DWORD dwTotalSize, DWORD

dwDownLoadSize, LDWORD dwUser)
{

71/339
 // If different playback/download uses the same process callback function, we can judge by
parameter 1PlayHandle
if (lPlayHandle == g_lDownloadHandle)
{
printf("lPlayHandle[%p]\n", lPlayHandle);
printf("dwTotalSize[%d]\n", dwTotalSize);
printf("dwDownLoadSize[%d]\n", dwDownLoadSize);
printf("dwUser[%p]\n", dwUser);
printf("\n");
}
}

int CALLBACK DataCallBack(LLONG lRealHandle, DWORD dwDataType, BYTE *pBuffer,

DWORD dwBufSize, LDWORD dwUser)
{
int nRet = 0;
printf("call DataCallBack\n");
// If different playback/download uses the same data callback function, we can judge by
parameter 1RealHandle
if(lRealHandle == g_lDownloadHandle)
{
printf("lPlayHandle[%p]\n", lRealHandle);
printf("dwDataType[%d]\n", dwDataType);
printf("pBuffer[%p]\n", pBuffer);
printf("dwBufSize[%d]\n", dwBufSize);
printf("dwUser[%p]\n", dwUser);
printf("\n");
switch(dwDataType)
{
case 0:
//Original data
// users can save stream data here for further process such as decoding and
transferring after getting out of callback function
nRet = 1;

break;
case 1:
//Standard video data

break;
case 2:
//yuv data

72/339
 break;
case 3:
//pcm audio data

break;
case 4:
//Original audio data

break;
default:
break;
}
}
return nRet;
}

2.5.4.2 Download by Time

#include <windows.h>
#include <stdio.h>
#include "dhnetsdk.h"

#pragma comment(lib , "dhnetsdk.lib")

static BOOL g_bNetSDKInitFlag = FALSE;

static LLONG g_lLoginHandle = 0L;
static LLONG g_lDownloadHandle = 0L;
static char g_szDevIp[32] = "172.11.1.221";
static WORD g_nPort = 37777;
static char g_szUserName[64] = "admin";
static char g_szPasswd[64] = "admin";

//*********************************************************************************
// commonly used callback set declaration
// callback function used when device gets offline
// Its not recommended to call SDK interfaces in this callback function
//Set the callback function in CLIENT_Initwhen device gets offlineSDK will call this function
automatically
void CALLBACK DisConnectFunc(LONG lLoginID, char *pchDVRIP, LONG nDVRPort,
DWORD dwUser);

// callback function used after device is reconnected successfully

// Its not recommended to call SDK interfaces in this callback function

73/339
 // Set the callback function in CLIENT_SetAutoReconnect, when offline device is reconnected
successfully, SDK will call the function
void CALLBACK HaveReConnect(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,
LDWORD dwUser);

// playback by time progress callback function

// Its not recommended to call SDK interfaces in this callback function
// dwDownLoadSize: -1 means playback/download finished-2 means failed to write fileother
value means valid data
// Set this callback function in CLIENT_DownloadByTimeEx. When SDK receives
playback/downloaded data, SDK will call this function.
void CALLBACK TimeDownLoadPosCallBack(LLONG lPlayHandle, DWORD dwTotalSize,
DWORD dwDownLoadSize, int index, NET_RECORDFILE_INFO recordfileinfo, LDWORD
dwUser);

// playback/download data callback function

// Its not recommended to call SDK interfaces in this callback function
// playbackreturn value0 means this playback failednext callback will return the same data
1 means this callback successful, next callback will return the following data
// Downloadno matter what return from the callback function, it will be treated as callback is
successful, next callback will return the following data
// Set this callback function in CLIENT_DownloadByTimeEx. When SDK receives
playback/downloaded data, SDK will call this function.
int CALLBACK DataCallBack(LLONG lRealHandle, DWORD dwDataType, BYTE *pBuffer,
DWORD dwBufSize, LDWORD dwUser);

//*********************************************************************************
void InitTest()
{
// SDK initialization
g_bNetSDKInitFlag = CLIENT_Init(DisConnectFunc, 0);
if (FALSE == g_bNetSDKInitFlag)
{
printf("Initialize client SDK fail; \n");
return;
}
else
{
printf("Initialize client SDK done; \n");
}

// get SDK version info

// this operation is optional

74/339
 DWORD dwNetSdkVersion = CLIENT_GetSDKVersion();
printf("NetSDK version is [%d]\n", dwNetSdkVersion);

// set CLIENT_SetAutoReconnect interface.Once HaveReConnect is set, when device

gets offline, SDK will reconnect internally
// this operation is optional, but recommended
CLIENT_SetAutoReconnect(&HaveReConnect, 0);

// set connectting device timeout time and attempts

// this operation is optional
int nWaitTime = 5000; // timeout time is set to 5s
int nTryTimes = 3; // if timeout, you have 3 attempts
CLIENT_SetConnectTime(nWaitTime, nTryTimes);

//Set more network parameter, nWaittime and nConnectTryNum in NET_PARAM has the
same meaning with the timeout time and trial time set in interface CLIENT_SetConnectTime.
//This operation is optional.
NET_PARAM stuNetParm = {0};
stuNetParm.nWaittime = 3000; // when login, connection timeout value is 3000ms.
CLIENT_SetNetworkParam(&stuNetParm);

NET_DEVICEINFO_Ex stDevInfoEx = {0};

int nError = 0;
while(0 == g_lLoginHandle)
{
// login device
g_lLoginHandle = CLIENT_LoginEx2(g_szDevIp, g_nPort, g_szUserName,
g_szPasswd, EM_LOGIN_SPEC_CAP_TCP, NULL, &stDevInfoEx, &nError);

if (0 == g_lLoginHandle)
{
// according to error code, you can find corresponding explanation in dhnetsdk.h.
It is to print hexadecimal here, not decimal showns in header file, please be careful with conversion
// example
// #define NET_NOT_SUPPORTED_EC(23)
// current SDK does not support the function, corresponding error code is
0x80000017. Decimal number 23 is hexadecimal 0x17.
printf("CLIENT_LoginEx2 %s[%d]Failed!Last Error[%x]\n" , g_szDevIp , g_nPort ,
CLIENT_GetLastError());
}
else
{

75/339
 printf("CLIENT_LoginEx2 %s[%d] Success\n" , g_szDevIp , g_nPort);
}
// The first time logining to device, some data is needed to be initialized to enable
normal business function. It is recommended to wait for a while after login, the waiting time varies
by devices.
Sleep(1000);
printf("\n");
}
}

void RunTest()
{
if (FALSE == g_bNetSDKInitFlag)
{
return;
}

if (0 == g_lLoginHandle)
{
return;
}
// record file search
// set record stream type
int nStreamType = 0; // 0-main/sub stream,1-main stream,2-sub stream
CLIENT_SetDeviceMode(g_lLoginHandle, DH_RECORD_STREAM_TYPE,
&nStreamType);

int nChannelID = 0; // channel no.

NET_TIME stuStartTime = {0};
stuStartTime.dwYear = 2015;
stuStartTime.dwMonth = 9;
stuStartTime.dwDay = 17;

NET_TIME stuStopTime = {0};

stuStopTime.dwYear = 2015;
stuStopTime.dwMonth = 9;
stuStopTime.dwDay = 18;

// start record download

// at least one of the two parameters sSavedFileName and fDownL oadDataCallBack is
valid
g_lDownloadHandle = CLIENT_DownloadByTimeEx(g_lLoginHandle, nChannelID,
EM_RECORD_TYPE_ALL, &stuStartTime, &stuStopTime, "test.dav", TimeDownLoadPosCallBack,

76/339
NULL, DataCallBack, NULL);
if (g_lDownloadHandle == 0)
{
printf("CLIENT_DownloadByTimeEx: failed! Error code: %x.\n",
CLIENT_GetLastError());
}
}

void EndTest()
{
printf("input any key to quit! \n");
getchar();
// stop download,we can call this interface after download end or during download.
if (0 != g_lDownloadHandle)
{
if (FALSE == CLIENT_StopDownload(g_lDownloadHandle))
{
printf("CLIENT_StopDownload Failed, g_lDownloadHandle[%x]!Last
Error[%x]\n" , g_lDownloadHandle, CLIENT_GetLastError());
}
else
{
g_lDownloadHandle = 0;
}
}
// logout device
if (0 != g_lLoginHandle)
{
if(FALSE == CLIENT_Logout(g_lLoginHandle))
{
printf("CLIENT_Logout Failed!Last Error[%x]\n", CLIENT_GetLastError());
}
else
{
g_lLoginHandle = 0;
}
}
// cleanup initialization resource
if (TRUE == g_bNetSDKInitFlag)
{
CLIENT_Cleanup();
g_bNetSDKInitFlag = FALSE;
}

77/339
 return;
}

int main()
{
InitTest();
RunTest();
EndTest();
return 0;
}

//*********************************************************************************
// commonly used callback set definition
void CALLBACK DisConnectFunc(LONG lLoginID, char *pchDVRIP, LONG nDVRPort,
DWORD dwUser)
{
printf("Call DisConnectFunc\n");
printf("lLoginID[0x%x]", lLoginID);
if (NULL != pchDVRIP)
{
printf("pchDVRIP[%s]\n", pchDVRIP);
}
printf("nDVRPort[%d]\n", nDVRPort);
printf("dwUser[%p]\n", dwUser);
printf("\n");
}

void CALLBACK HaveReConnect(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,

LDWORD dwUser)
{
printf("Call HaveReConnect\n");
printf("lLoginID[0x%x]", lLoginID);
if (NULL != pchDVRIP)
{
printf("pchDVRIP[%s]\n", pchDVRIP);
}
printf("nDVRPort[%d]\n", nDVRPort);
printf("dwUser[%p]\n", dwUser);
printf("\n");
}

void CALLBACK TimeDownLoadPosCallBack(LLONG lPlayHandle, DWORD dwTotalSize,

78/339
DWORD dwDownLoadSize, int index, NET_RECORDFILE_INFO recordfileinfo, LDWORD
dwUser)
{
// If different playback/download uses the same process callback function, we can judge by
parameter 1PlayHandle
if (lPlayHandle == g_lDownloadHandle)
{
printf("lPlayHandle[%p]\n", lPlayHandle);
printf("dwTotalSize[%d]\n", dwTotalSize);
printf("dwDownLoadSize[%d]\n", dwDownLoadSize);
printf("dwUser[%p]\n", dwUser);
printf("\n");
}
}

int CALLBACK DataCallBack(LLONG lRealHandle, DWORD dwDataType, BYTE *pBuffer,

DWORD dwBufSize, LDWORD dwUser)
{
int nRet = 0;
printf("call DataCallBack\n");
// If different playback/download uses the same data callback function, we can judge by
parameter 1RealHandle
if(lRealHandle == g_lDownloadHandle)
{
printf("lPlayHandle[%p]\n", lRealHandle);
printf("dwDataType[%d]\n", dwDataType);
printf("pBuffer[%p]\n", pBuffer);
printf("dwBufSize[%d]\n", dwBufSize);
printf("dwUser[%p]\n", dwUser);
printf("\n");
switch(dwDataType)
{
case 0:
//Original data
// users can save stream data here for further process such as decoding and
transferring after getting out of callback function
nRet = 1;

break;
case 1:
//Standard video data

break;

79/339
 case 2:
//yuv data

break;
case 3:
//pcm audio data

break;
case 4:
//Original audio data

break;
default:
break;
}
}
return nRet;
}

2.6PTZ Control

2.6.1 Intro

PTZ is a mechanical platform which carries camera device and protective cover can remote

monitor and control in all directions. PTZ is made of two motors and capable for horizontal and

vertical motion, therefore it can provide omnibearing and multi-angle viewing for video camere.

PTZ control is an important part of a surveillance system. Users have different demands for

suiveillance in different application scene. For example, users may want to track the surveillance

screen in a normal application scene. Users can control PTZ device via SDK, such as move

up/down/left/right, focus, zoom in/out, point-to-point tour and 3D positioning.

2.6.2 Interface Overview

Interface Interface Description

CLIENT_Init Interface for SDK initialization

CLIENT_Cleanup Interface for cleaning up SDK resources

CLIENT_LoginEx2 Extensive interface 2 for sync login

80/339
Interface Interface Description

CLIENT_ParseData Interface for analyzing the obtained config info

CLIENT_DHPTZControlEx2 Extensive interface for private PTZ control

CLIENT_QueryNewSystemInfo Interface for obtaining new system capacity set

CLIENT_Logout Interface for logout device

CLIENT_GetLastError Interface for getting error code after failed calling interface

2.6.3 Process Instruction

PTZ controller process flow sheet is shown in Figure 2-9.

81/339
 START

SDK initialization
CLIENT_init

Login to device
CLIENT_LoginEx2

Get PTZ capacity set

CLIENT_QueryNewSystemInfo

Analyze obtained json data

CLIENT_ParseData

PTZ control operation

ClIENT_DHPTZControlEx2

Logout user
ClIENT_Logout

Release SDK resource

CLIENT_Cleanup

END

Figure 2-9 PTZ controller process flow sheet

Process description

1. SDK initialization

2. After successful initialization, call CLIENT_LoginEx2 to login device.

3. After successfully login, firstly call CLIENT_QueryNewSystemInfo interface. The second

parameter szCommand is set to CFG_CAP_CMD_PTZ to obtain PTZ capacity set, and

secondly call CLIENT_ParseData interfaceThe parameter szCommand is set to

82/339
 CFG_CAP_CMD_PTZ to analyze the obtained capacity set.

4. Call CLIENT_DHPTZControlEx2 interface to operate PTZ according to the demand.

Different PTZ command requires may have different parameters. For example some

commands as left/right movement may require corresponding stop command. Please

refer to example code.

5. After operation is done, call CLIENT_Logout to logout device.

6. After SDK function is done, call CLIENT_Cleanup to release SDK resource.

2.6.4 Example Code

#include<windows.h>
#include <stdio.h>
#include <vector>
#include <string>
#include "dhnetsdk.h"
#include "dhconfigsdk.h"

#pragma comment(lib , "dhnetsdk.lib")

#pragma comment(lib , "dhconfigsdk.lib")

static BOOL g_bNetSDKInitFlag = FALSE;

static LLONG g_lLoginHandle = 0L;
static LLONG g_lDownloadHandle = 0L;
static char g_szDevIp[32] = "171.2.7.34";
static int g_nPort = 37777; // tcp to connect port, need to match tcp port config in expected
login device page
static char g_szUserName[64] = "admin";
static char g_szPasswd[64] = "admin";

//*********************************************************************************
// commonly used callback set declaration
// callback function used when device gets offline
// Its not recommended to call SDK interfaces in this callback function
//Set the callback function in CLIENT_Initwhen device gets offlineSDK will call this function
automatically
void CALLBACK DisConnectFunc(LONG lLoginID, char *pchDVRIP, LONG nDVRPort,
DWORD dwUser);

83/339
 // callback function used after device is reconnected successfully
// Its not recommended to call SDK interfaces in this callback function
// Set the callback function in CLIENT_SetAutoReconnect, when offline device is reconnected
successfully, SDK will call the function
void CALLBACK HaveReConnect(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,
LDWORD dwUser);

//**********************************************************************************
void InitTest()
{
// SDK initialization
g_bNetSDKInitFlag = CLIENT_Init(DisConnectFunc, 0);
if (FALSE == g_bNetSDKInitFlag)
{
printf("Initialize client SDK fail; \n");
return;
}
else
{
printf("Initialize client SDK done; \n");
}

// get SDK version info

// this operation is optional
DWORD dwNetSdkVersion = CLIENT_GetSDKVersion();
printf("NetSDK version is [%d]\n", dwNetSdkVersion);

// set CLIENT_SetAutoReconnect interface.Once HaveReConnect is set, when device

gets offline, SDK will reconnect internally.
// this operation is optional, but recommended
CLIENT_SetAutoReconnect(&HaveReConnect, 0);

// set connectting device timeout time and attempts

// this operation is optional
int nWaitTime = 5000; // timeout time is set to 5s
int nTryTimes = 3; // if timeout, you have 3 attempts
CLIENT_SetConnectTime(nWaitTime, nTryTimes);

//Set more network parameter, nWaittime and nConnectTryNum in NET_PARAM has the
same meaning with the timeout time and trial time set in interface CLIENT_SetConnectTime.
//This operation is optional.
NET_PARAM stuNetParm = {0};

84/339
 stuNetParm.nWaittime = 3000; // when login, connection timeout value is 3000ms.
CLIENT_SetNetworkParam(&stuNetParm);

NET_DEVICEINFO_Ex stDevInfoEx = {0};

int nError = 0;
while(0 == g_lLoginHandle)
{
// login device
g_lLoginHandle = CLIENT_LoginEx2(g_szDevIp, g_nPort, g_szUserName,
g_szPasswd, EM_LOGIN_SPEC_CAP_TCP, NULL, &stDevInfoEx, &nError);

if (0 == g_lLoginHandle)
{
// according to error code, you can find corresponding explanation in dhSDK.h. It is
to print hexadecimal here, not decimal showns in header file, please be careful with conversion
// example
// #define NET_NOT_SUPPORTED_EC(23)
// current SDK does not support the function, corresponding error code is 0x80000017.
Decimal number 23 is hexadecimal 0x17.
printf("CLIENT_LoginEx2 %s[%d]Failed!Last Error[%x]\n" , g_szDevIp , g_nPort ,
CLIENT_GetLastError());
}
else
{
printf("CLIENT_LoginEx2 %s[%d] Success\n" , g_szDevIp , g_nPort);
}
// The first time logining to device, some data is needed to be initialized to enable
normal business function. It is recommended to wait for a while after login, t he waiting time varies
by devices.
Sleep(1000);
printf("\n");
}
}

// Ptz control info struct

typedef struct tagPtzControlInfo
{
tagPtzControlInfo():m_iCmd(-1), m_bStopFlag(false){}
tagPtzControlInfo(int iCmd, const std::string& sDescription, bool
bStopFlag):m_iCmd(iCmd), m_sDescription(sDescription), m_bStopFlag(bStopFlag){}
int m_iCmd;
std::string m_sDescription;
bool m_bStopFlag; // parial Ptz operationafter start need to call corresponding stop

85/339
operation
}PtzControlInfo;

// get int input

int GetIntInput(char *szPromt, int& nError);

void RunTest()
{
if (FALSE == g_bNetSDKInitFlag)
{
return;
}

if (0 == g_lLoginHandle)
{
return;
}

// get PTZ capacity set

char szBuffer[2048] = "";

int nError = 0;
if (FALSE == CLIENT_QueryNewSystemInfo(g_lLoginHandle, CFG_CAP_CMD_PTZ, 0,
szBuffer, (DWORD)sizeof(szBuffer), &nError))
{
printf("CLIENT_QueryNewSystemInfo Failed, cmd[CFG_CAP_CMD_PTZ], Last
Error[%x]\n" , CLIENT_GetLastError());
return;
}

CFG_PTZ_PROTOCOL_CAPS_INFO stuPtzCapsInfo =
{sizeof(CFG_PTZ_PROTOCOL_CAPS_INFO)};
if (FALSE == CLIENT_ParseData(CFG_CAP_CMD_PTZ, szBuffer, &stuPtzCapsInfo,
sizeof(stuPtzCapsInfo), NULL))
{
printf("CLIENT_ParseData Failed, cmd[CFG_CAP_CMD_PTZ], Last Error[%x]\n" ,
CLIENT_GetLastError());
return;
}

// PTZ operation
std::vector<PtzControlInfo> vecPtzControl;
if (TRUE == stuPtzCapsInfo.bTile)

86/339
 {
vecPtzControl.push_back(PtzControlInfo(int(DH_PTZ_UP_CONTROL), "up", true));
vecPtzControl.push_back(PtzControlInfo(int(DH_PTZ_DOWN_CONTROL), "down",
true));
}

if (TRUE == stuPtzCapsInfo.bPan)
{
vecPtzControl.push_back(PtzControlInfo(int(DH_PTZ_LEFT_CONTROL), "left",
true));
vecPtzControl.push_back(PtzControlInfo(int(DH_PTZ_RIGHT_CONTROL), "right",
true));
}

if (TRUE == stuPtzCapsInfo.bZoom)
{
vecPtzControl.push_back(PtzControlInfo(int(DH_PTZ_ZOOM_ADD_CONTROL),
"zoom +", true));
vecPtzControl.push_back(PtzControlInfo(int(DH_PTZ_ZOOM_DEC_CONTROL),
"zoom -", true));
}

if (TRUE == stuPtzCapsInfo.bFocus)
{
vecPtzControl.push_back(PtzControlInfo(int(DH_PTZ_FOCUS_ADD_CONTROL),
"focus +", true));
vecPtzControl.push_back(PtzControlInfo(int(DH_PTZ_FOCUS_DEC_CONTROL),
"focus -", true));
}

if (TRUE == stuPtzCapsInfo.bIris)
{

vecPtzControl.push_back(PtzControlInfo(int(DH_PTZ_APERTURE_ADD_CONTROL), "aperture
+", true));

vecPtzControl.push_back(PtzControlInfo(int(DH_PTZ_APERTURE_DEC_CONTROL), "aperture -",

true));
}

if (TRUE == stuPtzCapsInfo.bPreset)
{
vecPtzControl.push_back(PtzControlInfo(int(DH_PTZ_POINT_MOVE_CONTROL),

87/339
"go to preset point", false));
vecPtzControl.push_back(PtzControlInfo(int(DH_PTZ_POINT_SET_CONTROL), "set
preset point", false));
}

if (TRUE == stuPtzCapsInfo.bRemovePreset)
{
vecPtzControl.push_back(PtzControlInfo(int(DH_PTZ_POINT_DEL_CONTROL),
"delete preset point", false));
}

if (TRUE == stuPtzCapsInfo.bTour)
{
vecPtzControl.push_back(PtzControlInfo(int(DH_PTZ_POINT_LOOP_CONTROL),
"point-to-point tour", false));
vecPtzControl.push_back(PtzControlInfo(int(DH_EXTPTZ_ADDTOLOOP), "add
preset point to tour", false));
vecPtzControl.push_back(PtzControlInfo(int(DH_EXTPTZ_DELFROMLOOP), "delete
preset point in tour", false));
}

if (TRUE == stuPtzCapsInfo.bRemoveTour)
{
vecPtzControl.push_back(PtzControlInfo(int(DH_EXTPTZ_CLOSELOOP), "clear
tour", false));
}

if (TRUE == stuPtzCapsInfo.bTile && TRUE == stuPtzCapsInfo.bPan)

{
vecPtzControl.push_back(PtzControlInfo(int(DH_EXTPTZ_LEFTTOP), "left up",
true));
vecPtzControl.push_back(PtzControlInfo(int(DH_EXTPTZ_RIGHTTOP), "right up",
true));
vecPtzControl.push_back(PtzControlInfo(int(DH_EXTPTZ_LEFTDOWN), "left down",
true));
vecPtzControl.push_back(PtzControlInfo(int(DH_EXTPTZ_RIGHTDOWN), "right
down", true));
}

if (TRUE == stuPtzCapsInfo.bMoveRelatively)
{
vecPtzControl.push_back(PtzControlInfo(int(DH_EXTPTZ_FASTGOTO), "quick
position", false));

88/339
 }

if (TRUE == stuPtzCapsInfo.bMoveAbsolutely)
{
vecPtzControl.push_back(PtzControlInfo(int(DH_EXTPTZ_EXACTGOTO), "3D
position precisely ", false));
}

vecPtzControl.push_back(PtzControlInfo(int(-2), "pause", false));

vecPtzControl.push_back(PtzControlInfo(int(-1), "exit", true));
PtzControlInfo cLastChoose;
while(TRUE)
{
printf("PTZ control operation\n");
for (std::vector<PtzControlInfo>::const_iterator iter = vecPtzControl.begin(); iter !=
vecPtzControl.end(); ++iter)
{
printf("\t%d\t:%s\n", iter->m_iCmd, iter->m_sDescription.c_str());
}
int nError = 0;
int nChoose = GetIntInput("\t selection", nError);
if (0 != nError)
{
printf("invalid input! \n");
continue;
}

std::vector<PtzControlInfo>::iterator iterFind = vecPtzControl.begin();

for (; iterFind != vecPtzControl.end(); ++iterFind)
{
if (nChoose == iterFind->m_iCmd)
{
break;
}
}

if (iterFind == vecPtzControl.end())
{
printf("pleas input valid operation\n");
continue;
}
// stop the last opetation
int nChannelId = 0;

89/339
 if (true == cLastChoose.m_bStopFlag)
{
if (FALSE == CLIENT_DHPTZControlEx2(g_lLoginHandle, nChannelId,
cLastChoose.m_iCmd, 0, 0, 0, TRUE))
{
printf("CLIENT_DHPTZControlEx2 Failed,
cLastChoose->GetCmd()[%x]!Last Error[%x]\n" , cLastChoose.m_iCmd, CLIENT_GetLastError());
}
}

if (iterFind->m_sDescription == "pause")
{
cLastChoose = *iterFind;
continue;
}

if (iterFind->m_sDescription == "exit")
{
break;
}
// different PTZ commands correspond to different extra parameter setup plans .
Parameter setup guide are showing below:
// extra parameter
LONG lParam1 = 0;
LONG lParam2 = 0;
LONG lParam3 = 0;
void* pParam4 = NULL;
if (DH_PTZ_UP_CONTROL <= iterFind->m_iCmd && iterFind->m_iCmd <=
DH_PTZ_RIGHT_CONTROL)
{
// vertical/horizontal movement speedvalid range (1-8)
lParam2 = 3;
}
else if (DH_PTZ_ZOOM_ADD_CONTROL <= iterFind->m_iCmd &&
iterFind->m_iCmd <= DH_PTZ_APERTURE_DEC_CONTROL)
{
// speed, valid range (1-8)
lParam1 = 3;
}
else if (DH_PTZ_POINT_MOVE_CONTROL <= iterFind->m_iCmd &&
iterFind->m_iCmd <= DH_PTZ_POINT_DEL_CONTROL)
{

90/339
 // lParam2 means preset point NO.
printf("\t preset point NO.(%2d-%2d):",
stuPtzCapsInfo.wPresetMin,stuPtzCapsInfo.wPresetMax);
scanf("%d", &lParam2);
}
else if (DH_PTZ_POINT_LOOP_CONTROL == iterFind->m_iCmd)
{
// lParam1 means tour path, lParam376 start96 stop
printf("\t tour path(%2d-%2d):",
stuPtzCapsInfo.wTourMin,stuPtzCapsInfo.wTourMax);
scanf("%d", &lParam1);
printf("\t1:start \n\t2: stop \n\t select:");
int nTmp = 0;
scanf("%d", &nTmp);
if (1 == nTmp)
{
lParam3 = 76;
}
else if (2 == nTmp)
{
lParam3 = 96;
}
}
else if (DH_PTZ_LAMP_CONTROL == iterFind->m_iCmd)
{
// lParam1 means switch control
printf("\t1:enable\n\t0:disable\n\t select:");
scanf("%d", &lParam1);
}
else if (DH_EXTPTZ_LEFTTOP <= iterFind->m_iCmd && iterFind->m_iCmd <=
DH_EXTPTZ_RIGHTDOWN)
{
// vertical speed valid range (1-8)
lParam1 = 1;
// horizontal speed valid range (1-8)
lParam2 = 1;
}
else if (DH_EXTPTZ_ADDTOLOOP <= iterFind->m_iCmd && iterFind->m_iCmd <=
DH_EXTPTZ_DELFROMLOOP)
{
// lParam1 means tour path
printf("\t tour path (%2d-%2d):",
stuPtzCapsInfo.wTourMin,stuPtzCapsInfo.wTourMax);

91/339
 scanf("%d", &lParam1);
// lParam2 means preset point NO.
printf("\t preset point NO. (%2d-%2d):",
stuPtzCapsInfo.wPresetMin,stuPtzCapsInfo.wPresetMax);
scanf("%d", &lParam2);
}
else if (DH_EXTPTZ_CLOSELOOP == iterFind->m_iCmd)
{
// lParam1 means tour path
printf("\t tour path(%2d-%2d):",
stuPtzCapsInfo.wTourMin,stuPtzCapsInfo.wTourMax);
scanf("%d", &lParam1);
}
else if (DH_EXTPTZ_FASTGOTO == iterFind->m_iCmd)
{
// horizontal coordinatevalid range (-8191 ~ 8191)
lParam1 = 2000;
// vertical coordinate, valid range (-8191 ~ 8191)
lParam2 = 2000;
// zoom, valid range (-16 ~ 16)
lParam3 = 2;
}
else if (DH_EXTPTZ_EXACTGOTO == iterFind->m_iCmd)
{
// horizontal coordinate, valid range and accuracy is 10x of capacity set
acquisition range
printf("\t horizontal coordinate (%2d-%2d):",
10*stuPtzCapsInfo.stuPtzMotionRange.nHorizontalAngleMin,
10*stuPtzCapsInfo.stuPtzMotionRange.nHorizontalAngleMax);
scanf("%d", &lParam1);
// vertical coordinate, valid range, accuracy is 10x of capacity set acquisition
range
printf("\t vertical coordinate (%2d-%2d):",
10*stuPtzCapsInfo.stuPtzMotionRange.nVerticalAngleMin,
10*stuPtzCapsInfo.stuPtzMotionRange.nVerticalAngleMax);
scanf("%d", &lParam2);
// zoomvalid range 1 ~ 128
lParam3 = 2;
}

if (FALSE == CLIENT_DHPTZControlEx2(g_lLoginHandle, nChannelId,

iterFind->m_iCmd, lParam1, lParam2, lParam3, FALSE, pParam4))
{

92/339
 printf("CLIENT_DHPTZControlEx2 Failed, nChoose[%x]!Last Error[%x]\n" ,
nChoose, CLIENT_GetLastError());
}
cLastChoose = *iterFind;
}
}

void EndTest()
{
printf("input any key to quit! \n");
getchar();
// logout device
if (0 != g_lLoginHandle)
{
if(FALSE == CLIENT_Logout(g_lLoginHandle))
{
printf("CLIENT_Logout Failed!Last Error[%x]\n", CLIENT_GetLastError());
}
else
{
g_lLoginHandle = 0;
}
}
// cleanup initialization resource
if (TRUE == g_bNetSDKInitFlag)
{
CLIENT_Cleanup();
g_bNetSDKInitFlag = FALSE;
}
return;
}

int main()
{
InitTest();

RunTest();

EndTest();

return 0;
}

93/339
 //*********************************************************************************
// commonly used callback set definition
void CALLBACK DisConnectFunc(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,
DWORD dwUser)
{
printf("Call DisConnectFunc\n");
printf("lLoginID[0x%x]", lLoginID);
if (NULL != pchDVRIP)
{
printf("pchDVRIP[%s]\n", pchDVRIP);
}
printf("nDVRPort[%d]\n", nDVRPort);
printf("dwUser[%p]\n", dwUser);
printf("\n");
}

void CALLBACK HaveReConnect(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,

LDWORD dwUser)
{
printf("Call HaveReConnect\n");
printf("lLoginID[0x%x]", lLoginID);
if (NULL != pchDVRIP)
{
printf("pchDVRIP[%s]\n", pchDVRIP);
}
printf("nDVRPort[%d]\n", nDVRPort);
printf("dwUser[%p]\n", dwUser);
printf("\n");
}

int GetIntInput(char *szPromt, int& nError)

{
long int nGet = 0;
char* pError = NULL;
printf(szPromt);
char szUserInput[32] = "";
gets(szUserInput);
nGet = strtol(szUserInput, &pError, 10);
if ('\0' != *pError)
{
// input parameter error
nError = -1;
}

94/339
 else
{
nError = 0;
}

return nGet;
}

2.7Audio intercom

2.7.1 Intro

Audio intercom is mainly used for audio interacting between local platform and front -end device

located environment.

The chapter mainly tells users how to use SDK to audio intercoming with front-end device.

Audio intercom mode

Audio intercom has two modes: client mode and server mode, please refer to Ch 2.7.3 for

details.

2.7.2 Interface Overview

Interface Interface Description

CLIENT_Init Interface for SDK Initialization.

CLIENT_Cleanup Interface for cleaning up SDK resources

CLIENT_LoginEx2 Extensive interface 2 for Sync login

CLIENT_QueryDevState Interface for searching device status

CLIENT_StartTalkEx Extensive interface for opening audio intercom

CLIENT_StopTalkEx Extensive interface for stopping audio intercom

Extensive interface for starting client recording(valid in Windows

CLIENT_RecordStartEx
platform only)

Extensive interface for stopping client recording(valid in Windows

CLIENT_RecordStopEx
platform only)

95/339
 Interface Interface Description

CLIENT_TalkSendData Interface for sending audio data to device

Extensive interface for decoding audio data(valid in Windows

CLIENT_AudioDecEx
platform only)

CLIENT_Logout Interface for logout

CLIENT_GetLastError Interface for getting error code after failed calling interface

2.7.3 Process Instruction

Audio intercom has two modes:

Client mode

SDK allows user to provide a callback function. The callback function is called when SDK

collects audio data from local sound card or receives data from the front-end. In callback function

user can not only send collected local audio data to front-end device but decode and play the

received front-end audio data. This mode is valid in Windows platform only.

Server mode

SDK allows user to provide one callback function. The callback function is called when SDK

receives audio data from front-end device. In callback function user can save audio data received

from front-end device for future use such as audio data transfer, calling a third-party library to

decode and play audio data and etc. For local audio data, user can collect it by calling a third-party

library and then send it to device by calling SDK interface.

2.7.3.1 Client Mode

Client mode process flow sheet is shown below in Figure 2-10.

96/339
 Start

SDK initialization

Login device
CLIENT_LoginEx2

Set as client intercom mode

CLIENT_SetDeviceMode

Set audio intercom encode info

CLIENT_SetDeviceMode

Set intercom parameter

CLIENT_SetDeviceMode

Set transfer mode

CLIENT_SetDeviceMode

Start audio intercom CLIENT_StartTackEx

Set callback function pfAudioDataCallBack

Decode device audio data in callback

Start PC recording
CLIENT_RecordStartEx decode device audio data
CLIENT_AudioDec

Send PC audio data to device in callback

Stop PC recording
Send PC audio data to device
CLIENT_RecordStopEx
CLIENT_TalkSendData

Stop audio intercom

CLIENT_StopTalkEx

Logout user
CLIENT_Logout

Release SDK resources

CLIENT_Cleanup Optional flow-progress

End

Figure 2-10 Client mode process flow sheet

97/339
 Process description:

1. SDK initialization

2. After successful initialization, call CLIENT_LoginEx2 to login device.

3. Call CLIENT_SetDeviceMode to set client mode as audio intercom mode, Parameter

emType is DH_TALK_CLIENT_MODE.

4. Call CLIENT_SetDeviceMode to set audio intercom encode information,Parameter

emType is DH_TALK_ENCODE_TYPE.

5. Call CLIENT_SetDeviceMode to set audio intercom parameter, Parameter emType is

DH_TALK_SPEAK_PARAM.

6. Call CLIENT_SetDeviceMode to set audio intercom transfer mode, no-transfer mode

means audio intercom between local PC and logined device; and transfer mode means audio

intercom between local PC and front-end device connected with specific channel of the logined

device.

7. Call CLIENT_StartTalkEx to set callback function and start audio intercom.In callback

function, call CLIENT_AudioDec to decode audio data sent by device and call

CLIENT_TalkSendData to send audio data from PC to device.

8. Call CLIENT_RecordStartEx to start PC recording. Only after this interface is called, can

audio intercom callback function set by CLIENT_StartTalkEx will receive local audio data.

9. After audio intercom is finished, call CLIENT_RecordStopEx to stop PC recording.

10. Call CLIENT_StopTalkEx to stop audio intercom.

11. Call CLIENT_Logout to logout device.

12. Last but not the least, call CLIENT_Cleanup to release SDK resources.

2.7.3.2 Server Mode

Server mode process flow sheet is shown below in Figure 2-11.

98/339
 Start

SDK initialization

Login device
CLIENT_LoginEx2

Set as server intercom mode

CLIENT_SetDeviceMode

Set audio intercom encode info

CLIENT_SetDeviceMode

Set intercom parameter

CLIENT_SetDeviceMode

Set forwarding mode

CLIENT_SetDeviceMode

Start audio intercom

In callback, user transfers or
CLIENT_StartTackEx
Set callback function
decodes device audio data by
pfAudioDataCallBack himself

1.Encode original audio data to be the same type with intercom

encode type
2.Call CLIENT_TalkSendData to send audio data to device

Stop audio intercom

CLIENT_StopTalkEx

Logout user
CLIENT_Logout

Release SDK resources

CLIENT_Cleanup

End

Figure 2-11 Server mode process flow sheet

Process description:

1. SDK initialization

2. After successful initialization, call CLIENT_LoginEx2 to login device.

99/339
 3. Call CLIENT_SetDeviceMode to set server mode as audio intercom mode, Parameter

emType is DH_TALK_SERVER_MODE.

4. Call CLIENT_SetDeviceMode to set audio intercom encode information,Parameter

emType is DH_TALK_ENCODE_TYPE.

5. Call CLIENT_SetDeviceMode to set audio intercom parameter, Parameter emType is

DH_TALK_SPEAK_PARAM.

6. Call CLIENT_SetDeviceMode to set audio intercom transfer mode, no-transfer mode

means audio intercom between local PC and logined device; and transfer mode means audio

intercom between local PC and front-end device connected with specific channel of the logined

device.

7. Call CLIENT_StartTalkEx to set callback function and start audio intercom. In callback

function, the audio data sent by device can be dealt with by users with the methods as transfer or

decoding and playing.

8. At first user encodes original audio data to be the same type with intercom encode typ e,

then adds 8 corresponding private protocol bytes in front of encoded data, and finally calls

CLIENT_TalkSendData to send audio data to device.

9. After intercom function is finished, call CLIENT_StopTalkEx to stop audio intercom.

10. Call CLIENT_Logout to logout device.

11. Last but not the least, call CLIENT_Cleanup to release SDK resources.

2.7.4 Example Code

2.7.4.1 Client Mode

#include <windows.h>
#include <stdio.h>

#include "dhnetsdk.h"

#pragma comment(lib , "dhnetsdk.lib")

100/339
 static BOOL g_bNetSDKInitFlag = FALSE;

static LLONG g_lLoginHandle = 0L;

static LLONG g_lTalkHandle = 0L;

static BOOL g_bRecordFlag = FALSE;

static char g_szDevIp[32] = "172.23.2.66";

static WORD g_nPort = 37777;

static char g_szUserName[64] = "admin";

static char g_szPasswd[64] = "admin";

//*********************************************************************************

// commonly used callback set declaration

// callback function used when device gets offline
// Its not recommended to call SDK interfaces in this callback function
//Set the callback function in CLIENT_Initwhen device gets offlineSDK will call this function
automatically
void CALLBACK DisConnectFunc(LONG lLoginID, char *pchDVRIP, LONG nDVRPort,
DWORD dwUser);

// callback function used after device is reconnected successfully

// Its not recommended to call SDK interfaces in this callback function
// Set the callback function in CLIENT_SetAutoReconnect, when offline device is reconnected
successfully, SDK will call the function
void CALLBACK HaveReConnect(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,
LDWORD dwUser);

// audio intercom data callback function

// It is not recommended to call SDK interface in the SDK callback function, but in this callback
function CLIENT_TalkSendData and CLIENT_AudioDec SDK interface s can be called.
// Set the callback function in CLIENT_StartTalkEx. SDK will call this function when receiving
sound card data detected by local PC,or audio data sent by device,.
void CALLBACK AudioDataCallBack(LLONG lTalkHandle, char *pDataBuf, DWORD
dwBufSize, BYTE byAudioFlag, DWORD dwUser);

//*********************************************************************************

void InitTest()

101/339
 {

// SDK Initialization

g_bNetSDKInitFlag = CLIENT_Init(DisConnectFunc, 0);

if (FALSE == g_bNetSDKInitFlag)

printf("Initialize client SDK fail; \n");

return;

else

printf("Initialize client SDK done; \n");

}
//Get the SDK version info
// This operation is optional.

DWORD dwNetSdkVersion = CLIENT_GetSDKVersion();

printf("NetSDK version is [%d]\n", dwNetSdkVersion);

// set CLIENT_SetAutoReconnect interface.Once HaveReConnect is set, when device

gets offline, SDK will reconnect internally
//This operation is optional,but recommended.

CLIENT_SetAutoReconnect(&HaveReConnect, 0);

// Set device connection timeout value and trial times.

//This operation is optional.
int nWaitTime = 5000; // timeout value is 5 seconds

int nTryTimes = 3; //if timeout,it will try to log in three times.

CLIENT_SetConnectTime(nWaitTime, nTryTimes);

//Set more network parameter, nWaittime and nConnectTryNum in NET_PARAM has the
same meaning with the timeout time and trial time set in interface CLIENT_SetConnectTime.
//This operation is optional.
NET_PARAM stuNetParm = {0};
stuNetParm.nWaittime = 3000; // when login, connection timeout value is 3000ms.
CLIENT_SetNetworkParam(&stuNetParm);

102/339
 NET_DEVICEINFO_Ex stDevInfoEx = {0};

int nError = 0;

while(0 == g_lLoginHandle)

//Login device

g_lLoginHandle = CLIENT_LoginEx2(g_szDevIp, g_nPort, g_szUserName,

g_szPasswd, EM_LOGIN_SPEC_CAP_TCP, NULL, &stDevInfoEx, &nError);

if(0 == g_lLoginHandle)

// according to error code, you can find corresponding explanation in dhnetsdk.h.

It is to print hexadecimal here, not decimal showns in header file, please be careful with conversion
//Example: #define NET_NOT_SUPPORTED_EC(23)
//Now SDK does not support this function, error code is 0x80000017, Decimal
number 23 is hexadecimal 0x17.

printf("CLIENT_LoginEx2 %s[%d]Failed!Last Error[%x]\n" , g_szDevIp , g_nPort ,

CLIENT_GetLastError());

else

printf("CLIENT_LoginEx2 %s[%d] Success\n" , g_szDevIp , g_nPort);

// The first time logining to device, some data is needed to be initialized to enable
normal business function. It is recommended to wait for a while after login, the waiting time varies
by devices.

Sleep(1000);

printf("\n");

void RunTest()

103/339
 if (FALSE == g_bNetSDKInitFlag)

return;

if (0 == g_lLoginHandle)

return;

//Set as audio intercom client mode

BOOL bSuccess = CLIENT_SetDeviceMode(g_lLoginHandle, DH_TALK_CLIENT_MODE,
NULL);

if (FALSE == bSuccess)

printf("CLIENT_SetDeviceMode cmd[%d] Failed!Last Error[%x]\n" ,

DH_TALK_CLIENT_MODE, CLIENT_GetLastError());

return;

//Get audio intercom encode type supported by front-end device

DHDEV_TALKFORMAT_LIST stulstTalkEncode;

int retlen = 0;

bSuccess = CLIENT_QueryDevState(g_lLoginHandle, DH_DEVSTATE_TALK_ECTYPE,

(char*)&stulstTalkEncode, sizeof(stulstTalkEncode), &retlen, 3000);

if (FALSE == bSuccess || retlen != sizeof(stulstTalkEncode))

printf("CLIENT_QueryDevState cmd[%d] Failed!Last Error[%x]\n" ,

DH_DEVSTATE_TALK_ECTYPE, CLIENT_GetLastError());

return;

104/339
 //Set audio intercom encode info.

DHDEV_TALKDECODE_INFO curTalkMode;

//Select the first encode method in the list, user can select other encode method as
needed.

curTalkMode = stulstTalkEncode.type[0];

bSuccess = CLIENT_SetDeviceMode(g_lLoginHandle, DH_TALK_ENCODE_TYPE,

&curTalkMode);

if (FALSE == bSuccess)

printf("CLIENT_SetDeviceMode cmd[%d] Failed!Last Error[%x]\n" ,

DH_TALK_ENCODE_TYPE, CLIENT_GetLastError());

return;

//Set audio intercom parameter

NET_SPEAK_PARAM stuSpeak = {sizeof(stuSpeak)};

stuSpeak.nMode = 0; // 0intercomdefault mode1shoutReset stuSpeak.nMode

when switch from shout to intercom.

stuSpeak.nSpeakerChannel = 0; // audio intercom channel number, set 0

bSuccess = CLIENT_SetDeviceMode(g_lLoginHandle, DH_TALK_SPEAK_PARAM,

&stuSpeak);

if (FALSE == bSuccess)

printf("CLIENT_SetDeviceMode cmd[%d] Failed!Last Error[%x]\n" ,

DH_TALK_SPEAK_PARAM, CLIENT_GetLastError());

return;

//Set as transfer mode

NET_TALK_TRANSFER_PARAM stuTransfer = {sizeof(stuTransfer)};

stuTransfer.bTransfer = FALSE; //Close transfer mode because its intercom with login
device.

bSuccess = CLIENT_SetDeviceMode(g_lLoginHandle, DH_TALK_TRANSFER_MODE,

105/339
&stuTransfer);

if (FALSE == bSuccess)

printf("CLIENT_SetDeviceMode cmd[%d] Failed!Last Error[%x]\n" ,

DH_TALK_TRANSFER_MODE, CLIENT_GetLastError());

return;

g_lTalkHandle = CLIENT_StartTalkEx(g_lLoginHandle, AudioDataCallBack,

(DWORD)NULL);

if(0 != g_lTalkHandle)

//Start local recording.Its no need to call this interface if it is one-way audio intercom
between DVR and PC.

BOOL bSuccess = CLIENT_RecordStartEx(g_lLoginHandle);

if(TRUE == bSuccess)

g_bRecordFlag = TRUE;

else

if (FALSE == CLIENT_StopTalkEx(g_lTalkHandle))

printf("CLIENT_StopTalkEx Failed!Last Error[%x]\n",

CLIENT_GetLastError());

else

g_lTalkHandle = 0;

106/339
 else

printf("CLIENT_StartTalkEx Failed!Last Error[%x]\n", CLIENT_GetLastError());

void EndTest()

printf("input any key to quit! \n");

getchar();

//Stop local recording

if (TRUE == g_bRecordFlag)
{

if (!CLIENT_RecordStopEx(g_lLoginHandle))

printf("CLIENT_RecordStop Failed!Last Error[%x]\n", CLIENT_GetLastError());

else

g_bRecordFlag = FALSE;

//Stop audio intercom

if (0 != g_lTalkHandle)

if(FALSE == CLIENT_StopTalkEx(g_lTalkHandle))

printf("CLIENT_StopTalkEx Failed!Last Error[%x]\n", CLIENT_GetLastError());

else

107/339
 g_lTalkHandle = 0;

//Exit device

if (0 != g_lLoginHandle)

if(FALSE == CLIENT_Logout(g_lLoginHandle))

printf("CLIENT_Logout Failed!Last Error[%x]\n", CLIENT_GetLastError());

else

{
g_lLoginHandle = 0;

// Clean up initialization resources.

if (TRUE == g_bNetSDKInitFlag)

CLIENT_Cleanup();

g_bNetSDKInitFlag = FALSE;

return;

int main()

InitTest();

RunTest();

EndTest();

return 0;

108/339
 }

//*********************************************************************************

//commonly used callback functions definition

void CALLBACK DisConnectFunc(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,

DWORD dwUser)

printf("Call DisConnectFunc\n");

printf("lLoginID[0x%x]", lLoginID);

if (NULL != pchDVRIP)

printf("pchDVRIP[%s]\n", pchDVRIP);

printf("nDVRPort[%d]\n", nDVRPort);

printf("dwUser[%p]\n", dwUser);

printf("\n");

void CALLBACK HaveReConnect(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,

LDWORD dwUser)

printf("Call HaveReConnect\n");

printf("lLoginID[0x%x]", lLoginID);

if (NULL != pchDVRIP)

printf("pchDVRIP[%s]\n", pchDVRIP);

printf("nDVRPort[%d]\n", nDVRPort);

printf("dwUser[%p]\n", dwUser);

printf("\n");

109/339
 void CALLBACK AudioDataCallBack(LLONG lTalkHandle, char *pDataBuf, DWORD
dwBufSize, BYTE byAudioFlag, DWORD dwUser)

//If different audio intercoms use the same data callback function, user can judge by
parameter 1TalkHandle.

if (g_lTalkHandle != lTalkHandle)

return;

if(0 == byAudioFlag)

//Send received sound card data which is detected by local PC to device. This
interface must follow the interface CLIENT_RecordStartEx.

LONG lSendLen = CLIENT_TalkSendData(lTalkHandle, pDataBuf, dwBufSize);

if(lSendLen != (LONG)dwBufSize)

printf("CLIENT_TalkSendData Failed!Last Error[%x]\n" ,

CLIENT_GetLastError());

else if(1 == byAudioFlag)

//Send received audio data sent by device to SDK for decoding and playing.

CLIENT_AudioDec(pDataBuf, dwBufSize);

#ifdef _DEBUG

FILE *stream;

if( (stream = fopen("E:\\Talk.txt", "a+b")) != NULL )

int numwritten = fwrite( pDataBuf, sizeof( char ), dwBufSize, stream );

fclose( stream );

110/339
 }

#endif

2.7.4.2 Server Mode

#include <windows.h>
#include <stdio.h>

#include "dhplay.h"

#include "Alaw_encoder.h"

#include "dhnetsdk.h"

#pragma comment(lib , "dhplay.lib") // the third-party encoding/decoding library. Take Dahua

encoding/decoding library for example in the following example code.

#pragma comment(lib , "dhnetsdk.lib")

static BOOL g_bNetSDKInitFlag = FALSE;

static LLONG g_lLoginHandle = 0L;

static LLONG g_lTalkHandle = 0L;

static BOOL g_bOpenAudioRecord = FALSE;

static char g_szDevIp[32] = "172.23.1.27";

static WORD g_nPort = 37777;

static char g_szUserName[64] = "admin";

static char g_szPasswd[64] = "admin";

static DHDEV_TALKDECODE_INFO g_curTalkMode;

//*********************************************************************************

// commonly used callback set declaration

// callback function used when device gets offline
// Its not recommended to call SDK interfaces in this callback function
//Set the callback function in CLIENT_Initwhen device gets offlineSDK will call this function
automatically
void CALLBACK DisConnectFunc(LONG lLoginID, char *pchDVRIP, LONG nDVRPort,
DWORD dwUser);

111/339
 // callback function used after device is reconnected successfully
// Its not recommended to call SDK interfaces in this callback function
// Set the callback function in CLIENT_SetAutoReconnect, when offline device is reconnected
successfully, SDK will call the function
void CALLBACK HaveReConnect(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,
LDWORD dwUser);

// audio intercom data callback function

//only audio data sent by device can be received in server mode
// It is not recommended to call SDK interface in the SDK callback function, but in this callback
function CLIENT_TalkSendData and CLIENT_AudioDec SDK interfaces can be called.
// Set the callback function in CLIENT_StartTalkEx. SDK will call this function when receiving
sound card data detected by local PC,or audio data sent by device,.
void CALLBACK AudioDataCallBack(LLONG lTalkHandle, char *pDataBuf, DWORD
dwBufSize, BYTE byAudioFlag, DWORD dwUser);

// PC audio encode send callback function

//pDataBuffer is original audio data, DataLength is the length of valid data.

//Set up PLAY_OpenAudioRecord interface By Dahua encoding/decoding library, when

detecting sound card data, Dahua encoding/decoding library will call this function.

void CALLBACK AudioCallFunction(LPBYTE pDataBuffer, DWORD DataLength, void* pUser);

//*********************************************************************************

// function declaration

// This interface is an example to call Dahua encoding/decoding library to collect audio

intercom data. Use Dahua encoding/decoding library to get PC original audio stream.

BOOL StartAudioRecord();

BOOL StopAudioRecord();

//*********************************************************************************

void InitTest()

// SDK Initialization

g_bNetSDKInitFlag = CLIENT_Init(DisConnectFunc, 0);

if (FALSE == g_bNetSDKInitFlag)

112/339
 {

printf("Initialize client SDK fail; \n");

return;

else

printf("Initialize client SDK done; \n");

//Get the SDK version info

// This operation is optional.

DWORD dwNetSdkVersion = CLIENT_GetSDKVersion();

printf("NetSDK version is [%d]\n", dwNetSdkVersion);

// set CLIENT_SetAutoReconnect interface.Once HaveReConnect is set, when device

gets offline, SDK will reconnect internally
//This operation is optional,but recommended.

CLIENT_SetAutoReconnect(&HaveReConnect, 0);

// Set device connection timeout value and trial times.

//This operation is optional.
int nWaitTime = 5000; // timeout value is 5 seconds

int nTryTimes = 3; //if timeout,it will try to log in three times.

CLIENT_SetConnectTime(nWaitTime, nTryTimes);

//Set more network parameter, nWaittime and nConnectTryNum in NET_PARAM has the
same meaning with the timeout time and trial time set in interface CLIENT_SetConnectTime.
//This operation is optional.
NET_PARAM stuNetParm = {0};
stuNetParm.nWaittime = 3000; // when login, connection timeout value is 3000ms.
CLIENT_SetNetworkParam(&stuNetParm);

NET_DEVICEINFO_Ex stDevInfoEx = {0};

int nError = 0;

while(0 == g_lLoginHandle)

113/339
 {

//Login device

g_lLoginHandle = CLIENT_LoginEx2(g_szDevIp, g_nPort, g_szUserName,

g_szPasswd, EM_LOGIN_SPEC_CAP_TCP, NULL, &stDevInfoEx, &nError);

if(0 == g_lLoginHandle)

// according to error code, you can find corresponding explanation in dhnetsdk.h.

It is to print hexadecimal here, not decimal showns in header file, please be careful with conversion
//Example: #define NET_NOT_SUPPORTED_EC(23)
//Now SDK does not support this function, error code is 0x80000017, Decimal
number 23 is hexadecimal 0x17.

printf("CLIENT_LoginEx2 %s[%d]Failed!Last Error[%x]\n" , g_szDevIp , g_nPort ,

CLIENT_GetLastError());

else

printf("CLIENT_LoginEx2 %s[%d] Success\n" , g_szDevIp , g_nPort);

// The first time logining to device, some data is needed to be initialized to enable
normal business function. It is recommended to wait for a while after login, the waiting time varies
by devices.

Sleep(1000);

printf("\n");

void RunTest()

if (FALSE == g_bNetSDKInitFlag)

return;

114/339
 if (0 == g_lLoginHandle)

return;

//Set as server intercom mode

BOOL bSuccess = CLIENT_SetDeviceMode(g_lLoginHandle,

DH_TALK_SERVER_MODE, NULL);

if (FALSE == bSuccess)

printf("CLIENT_SetDeviceMode cmd[%d] Failed!Last Error[%x]\n" ,

DH_TALK_SERVER_MODE, CLIENT_GetLastError());

return;

//Get audio intercom encode type supported by front-end device

DHDEV_TALKFORMAT_LIST stulstTalkEncode;

int retlen = 0;

bSuccess = CLIENT_QueryDevState(g_lLoginHandle, DH_DEVSTATE_TALK_ECTYPE,

(char*)&stulstTalkEncode, sizeof(stulstTalkEncode), &retlen, 3000);

if (FALSE == bSuccess || retlen != sizeof(stulstTalkEncode))

printf("CLIENT_QueryDevState cmd[%d] Failed!Last Error[%x]\n" ,

DH_DEVSTATE_TALK_ECTYPE, CLIENT_GetLastError());

return;

//Set audio intercom encode info

g_curTalkMode = stulstTalkEncode.type[0];

bSuccess = CLIENT_SetDeviceMode(g_lLoginHandle, DH_TALK_ENCODE_TYPE,

&g_curTalkMode);

if (FALSE == bSuccess)

115/339
 {

printf("CLIENT_SetDeviceMode cmd[%d] Failed!Last Error[%x]\n" ,

DH_TALK_ENCODE_TYPE, CLIENT_GetLastError());

return;

//Set intercom parameter

NET_SPEAK_PARAM stuSpeak = {sizeof(stuSpeak)};

stuSpeak.nMode = 0; // 0intercomdefault mode1shoutReset stuSpeak.nMode

when switch from shout to intercom

stuSpeak.nSpeakerChannel = 0; //audio intercom channel number,set 0.

bSuccess = CLIENT_SetDeviceMode(g_lLoginHandle, DH_TALK_SPEAK_PARAM,

&stuSpeak);

if (FALSE == bSuccess)

printf("CLIENT_SetDeviceMode cmd[%d] Failed!Last Error[%x]\n" ,

DH_TALK_SPEAK_PARAM, CLIENT_GetLastError());

return;

//Set as transfer mode

NET_TALK_TRANSFER_PARAM stuTransfer = {sizeof(stuTransfer)};

stuTransfer.bTransfer = FALSE; //Close transfer mode because its intercom with login
device.

bSuccess = CLIENT_SetDeviceMode(g_lLoginHandle, DH_TALK_TRANSFER_MODE,

&stuTransfer);

if (FALSE == bSuccess)

printf("CLIENT_SetDeviceMode cmd[%d] Failed!Last Error[%x]\n" ,

DH_TALK_TRANSFER_MODE, CLIENT_GetLastError());

return;

116/339
 g_lTalkHandle = CLIENT_StartTalkEx(g_lLoginHandle, AudioDataCallBack,
(DWORD)NULL);

if(0 != g_lTalkHandle)

bSuccess = StartAudioRecord();

if(TRUE == bSuccess)

g_bOpenAudioRecord = TRUE;

else

printf("StartAudioRecord Failed!\n");

CLIENT_StopTalkEx(g_lTalkHandle);

g_lTalkHandle = 0;

else

printf("CLIENT_StartTalkEx Failed!Last Error[%x]\n", CLIENT_GetLastError());

void EndTest()

printf("input any key to quit! \n");

getchar();

// clean up Dahua encoding/decoding library resources.

if(TRUE == g_bOpenAudioRecord)

if (TRUE == StopAudioRecord())

117/339
 g_bOpenAudioRecord = FALSE;

//Stop audio intercom

if (0 != g_lTalkHandle)

if(FALSE == CLIENT_StopTalkEx(g_lTalkHandle))

printf("CLIENT_StopTalkEx Failed!Last Error[%x]\n", CLIENT_GetLastError());

else
{

g_lTalkHandle = 0;

//Logout device

if (0 != g_lLoginHandle)

if(FALSE == CLIENT_Logout(g_lLoginHandle))

printf("CLIENT_Logout Failed!Last Error[%x]\n", CLIENT_GetLastError());

else

g_lLoginHandle = 0;

// Clean up initialization resources.

if (TRUE == g_bNetSDKInitFlag)

118/339
 CLIENT_Cleanup();

g_bNetSDKInitFlag = FALSE;

return;

int main()

InitTest();

RunTest();

EndTest();
return 0;

//*********************************************************************************

//commonly used callback functions definition

void CALLBACK DisConnectFunc(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,

DWORD dwUser)

printf("Call DisConnectFunc\n");

printf("lLoginID[0x%x]", lLoginID);

if (NULL != pchDVRIP)

printf("pchDVRIP[%s]\n", pchDVRIP);

printf("nDVRPort[%d]\n", nDVRPort);

printf("dwUser[%p]\n", dwUser);

printf("\n");

119/339
 void CALLBACK HaveReConnect(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,
LDWORD dwUser)

printf("Call HaveReConnect\n");

printf("lLoginID[0x%x]", lLoginID);

if (NULL != pchDVRIP)

printf("pchDVRIP[%s]\n", pchDVRIP);

printf("nDVRPort[%d]\n", nDVRPort);

printf("dwUser[%p]\n", dwUser);

printf("\n");

void CALLBACK AudioDataCallBack(LLONG lTalkHandle, char *pDataBuf, DWORD

dwBufSize, BYTE byAudioFlag, DWORD dwUser)

//If different audio intercoms use the same data callback function, user can judge by
parameter 1TalkHandle.

if (g_lTalkHandle != lTalkHandle)

return;

if(1 == byAudioFlag)

// User can handle the audio data sent by device by himself such as transfer and
decoding and playing.

// The following is an example of dealing with the data with Dahua encoding/decoding
library

120/339
 int nPort = 99;

//For PCM format withour header , please add 128.

if (g_curTalkMode.encodeType == DH_TALK_DEFAULT)

nPort = 100;

for (unsigned int i = 0; i < dwBufSize; i++)

pDataBuf[i] += (char)128;

//You can use PLAY SDK to decode to get PCM and then encode to other formats if
you to get a uniform formats.

PLAY_InputData(nPort,(BYTE *)pDataBuf,dwBufSize);

#ifdef _DEBUG

FILE *stream;

if( (stream = fopen("E:\\Talk.txt", "a+b")) != NULL )

int numwritten = fwrite( pDataBuf, sizeof( char ), dwBufSize, stream );

fclose( stream );

#endif

void CALLBACK AudioCallFunction(LPBYTE pDataBuffer, DWORD DataLength, void* pUser)

char* pCbData = NULL;

pCbData = new char[102400];

if (NULL == pCbData)

121/339
 return;

int iCbLen = 0;

//Former 8 bytes in intercom stream are private protocol data, others are audio data of
corresponding intercom encode type.

// The following codes show that what the former 8 bytes are when PCMg711a and g711u
encoding.

if (g_curTalkMode.encodeType == DH_TALK_DEFAULT || g_curTalkMode.encodeType ==

DH_TALK_PCM)

if (g_curTalkMode.nAudioBit == 8)

for(unsigned int j = 0 ; j < DataLength; j++)

*(pDataBuffer + j) += 128;

pCbData[0]=0x00;

pCbData[1]=0x00;

pCbData[2]=0x01;

pCbData[3]=0xF0;

pCbData[4]=g_curTalkMode.nAudioBit==8?0x07:0x0C;

if( 8000 == g_curTalkMode.dwSampleRate )

pCbData[5]=0x02;//8k

else if(16000 == g_curTalkMode.dwSampleRate)

pCbData[5] = 0x04;

122/339
 else if(48000 == g_curTalkMode.dwSampleRate)

pCbData[5] = 0x09;

*(DWORD*)(pCbData+6)=DataLength;

memcpy(pCbData+8, pDataBuffer, DataLength);

iCbLen = 8+DataLength;

else if (g_curTalkMode.encodeType == DH_TALK_G711a)

{
//Encode the original audio data to g711a.

if (g711a_Encode((char*)pDataBuffer, pCbData+8, DataLength, &iCbLen) != 1)

goto end;

//Private bit stream format frame head

pCbData[0]=0x00;

pCbData[1]=0x00;

pCbData[2]=0x01;

pCbData[3]=0xF0;

pCbData[4]=0x0E; //G711A

if( 8000 == g_curTalkMode.dwSampleRate )

pCbData[5]=0x02;//8k

else if(16000 == g_curTalkMode.dwSampleRate)

123/339
 {

pCbData[5] = 0x04;

else if(48000 == g_curTalkMode.dwSampleRate)

pCbData[5] = 0x09;

pCbData[6]=BYTE(iCbLen&0xff);

pCbData[7]=BYTE(iCbLen>>8);

iCbLen += 8;
}

else if (g_curTalkMode.encodeType == DH_TALK_G711u)

// Encode the original audio data to g711u.

if (g711u_Encode((char*)pDataBuffer, pCbData+8, DataLength, &iCbLen) != 1)

goto end;

//Private bit stream format frame head.

pCbData[0]=0x00;

pCbData[1]=0x00;

pCbData[2]=0x01;

pCbData[3]=0xF0;

pCbData[4]=0x0A; //G711u

if( 8000 == g_curTalkMode.dwSampleRate )

pCbData[5]=0x02; //8k

124/339
 }

else if(16000 == g_curTalkMode.dwSampleRate)

pCbData[5] = 0x04;

else if(48000 == g_curTalkMode.dwSampleRate)

pCbData[5] = 0x09;

pCbData[6]=BYTE(iCbLen&0xff);

pCbData[7]=BYTE(iCbLen>>8);

iCbLen += 8;

else

goto end;

// Send the data from the PC to DVR

CLIENT_TalkSendData(g_lTalkHandle, (char *)pCbData, iCbLen);

end:

if (pCbData != NULL)

delete[] pCbData;

//*********************************************************************************

125/339
 BOOL StartAudioRecord()

// It is the characteristics of Dahua encoding/decoding library.

//First confirm decode port.DH_TALK_DEFAULT is 100 port number and then rest is 99
port number.

int nPort = 99;

if (g_curTalkMode.encodeType == DH_TALK_DEFAULT)

nPort = 100;

//Then specify frame length

int nFrameLength = 1024;

switch(g_curTalkMode.encodeType)

case DH_TALK_DEFAULT:

case DH_TALK_PCM:

nFrameLength = 1024;

break;

case DH_TALK_G711a:

nFrameLength = 1280;

break;

case DH_TALK_AMR:

nFrameLength = 320;

break;

case DH_TALK_G711u:

nFrameLength = 320;

break;

case DH_TALK_G726:

nFrameLength = 320;

break;

126/339
 case DH_TALK_AAC:

nFrameLength = 1024;

default:

break;

if (g_curTalkMode.dwSampleRate == 48000) //If sampling rate is 48K,update audio

length.

nFrameLength = 48*40*2; // sampling rate multiply by 40 and 2.

BOOL bRet = FALSE;

//Then call PLAYSDK library to begin recording audio

BOOL bOpenRet = PLAY_OpenStream(nPort,0,0,1024*900);

if(bOpenRet)

BOOL bPlayRet = PLAY_Play(nPort,0);

if(bPlayRet)

PLAY_PlaySoundShare(nPort);

BOOL bSuccess =
PLAY_OpenAudioRecord(AudioCallFunction,g_curTalkMode.nAudioBi
t,

g_curTalkMode.dwSampleRate,nFrameLength,0,NULL);

if(bSuccess)

bRet = TRUE;

else

127/339
 PLAY_StopSoundShare(nPort);

PLAY_Stop(nPort);

PLAY_CloseStream(nPort);

else

PLAY_CloseStream(nPort);

return bRet;
}

BOOL StopAudioRecord()

// It is the characteristics of Dahua encoding/decoding library.

BOOL bSuccess = PLAY_CloseAudioRecord();

if(TRUE == bSuccess)

PLAY_Stop(100);

PLAY_Stop(99);

PLAY_StopSoundShare(100);

PLAY_StopSoundShare(99);

PLAY_CloseStream(100);

PLAY_CloseStream(99);

else

printf("PLAY_CloseAudioRecord Failed! \n");

128/339
 return bSuccess;

2.8Snapshot

2.8.1 Intro

Video snapshot,as to snapshot picture not only from video,but also from device, used by upper

users for platform development requirements.

Snapshot picture from device: User call SDK interface to send snapshot command to

device,device snapshots current image in real-time monitoring and sends to SDK,SDK will return

picture data to user,user can configure interface by SDK to set some parameters, such as picture

encoding type and resolution.

2.8.2 Interface Overview

Interface Interface Description

CLIENT_Init Interface for SDK Initialization.

CLIENT_Cleanup Interface for cleaning up SDK resources.

CLIENT_LoginEx2 Extensive interface 2 for Sync login.

CLIENT_SetSnapRevCallBack Set vedio snapshotdata callback function

CLIENT_SnapPictureEx Extensive interface for snapshot request.

CLIENT_Logout Interface for logout device.

CLIENT_GetLastError Interface for getting error code after failed calling interface.

2.8.3 Process Instruction

Video snapshot process flow sheet is shown below in Figure 2-12.

129/339
 Start

SDK initialization

Login device
CLIENT_LoginEx2

User gets and saves video snapshot

Set video snapshot data callback function picture information for further use by
CLIENT_SetSnapRevCallBack video snapshot data callback
function(fSnapRev)

Send snapshot command to front-end device

CLIENT_SnapPictureEx

Logout user
CLIENT_Logout

Release SDK sources

CLIENT_Cleanup

End

Figure 2-12 Video snapshot process flow sheet

Process discription

1. SDK initialization.

2. After successful initialization, call CLIENT_LoginEx2 to login device.

3. Call CLIENT_SetSnapRevCallBack to set snapshot callback function, when SDK receives

snapshot data sent from device,it will call fSnapRev callback function to recall picture informatio n

and data to user.

4. Call CLIENT_SnapPictureEx to send snapshot command to front-end device, wait for

device to reply picture information in callback function(fSnapRev).

5. Call CLIENT_Logout to logout device.

6. Last but not the least, call CLIENT_Cleanup to release SDK resources.

2.8.4 Example code

130/339
 #include <windows.h>
#include <stdio.h>
#include <time.h>
#include "dhnetsdk.h"
#include "dhconfigsdk.h"

#pragma comment(lib, "dhnetsdk.lib")

#pragma comment(lib, "dhconfigsdk.lib")

static BOOL g_bNetSDKInitFlag = FALSE;

static LLONG g_lLoginHandle = 0L;
static char g_szDevIp[32] = "172.23.1.27";
static WORD g_nPort = 37777; // Before tcp connects port,the port need to keep with tcp port
config in expected login
static char g_szUserName[64] = "admin";
static char g_szPasswd[64] = "admin";
static short g_nCmdSerial = 0; //snapshot SN

//*********************************************************************************
// commonly used callback set declaration
// callback function used when device gets offline
// Its not recommended to call SDK interfaces in this callback function
//Set the callback function in CLIENT_Init,when device gets offline,SDK will call this function
automatically
void CALLBACK DisConnectFunc(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,
DWORD dwUser);

// callback function used after device is reconnected successfully.

// Its not recommended to call SDK interfaces in this callback function.
// Set the callback function in CLIENT_SetAutoReconnect, when offline device is reconnected
successfully, SDK will call the function.
void CALLBACK HaveReConnect(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,
LDWORD dwUser);

//Snapshot callback function.

// Its not recommended to call SDK interfaces in this callback function.
//Set the callback function in CLIENT_SetSnapRevCallBack,when snapshot data is sent over
by front-end device,SDK will call this function.
void CALLBACK SnapRev(LLONG lLoginID, BYTE *pBuf, UINT RevLen, UINT EncodeType,
DWORD CmdSerial, LDWORD dwUser);

//*********************************************************************************
// commonly used function set declaration

131/339
 //Get int input
int GetIntInput(char *szPromt, int& nError);

//Get input string

void GetStringInput(const char *szPromt , char *szBuffer);

//*********************************************************************************
void InitTest()
{
//SDK initialization.
g_bNetSDKInitFlag = CLIENT_Init(DisConnectFunc, 0);
if (FALSE == g_bNetSDKInitFlag)
{
printf("Initialize client SDK fail; \n");
return;
}
else
{
printf("Initialize client SDK done; \n");
}

// get SDK version info

// this operation is optional
DWORD dwNetSdkVersion = CLIENT_GetSDKVersion();
printf("NetSDK version is [%d]\n", dwNetSdkVersion);

// set CLIENT_SetAutoReconnect interface.Once HaveReConnect is set, when device

gets offline, SDK will reconnect internally.
// this operation is optional, but recommended
CLIENT_SetAutoReconnect(&HaveReConnect, 0);

// set connectting device timeout time and attempts

// this operation is optional

int nWaitTime = 5000; //Timeout value is 5 seconds.

int nTryTimes = 3; //If timeout,it will try to log in three times.

CLIENT_SetConnectTime(nWaitTime, nTryTimes);

//Set more network parameter, nWaittime and nConnectTryNum in NET_PARAM has the
same meaning with the timeout time and trial time set in interface CLIENT_SetConnectTime.

132/339
 //This operation is optional.
NET_PARAM stuNetParm = {0};
stuNetParm.nWaittime = 3000; // when login, connection timeout value is 3000ms.
CLIENT_SetNetworkParam(&stuNetParm);

NET_DEVICEINFO_Ex stDevInfoEx = {0};

int nError = 0;
while(0 == g_lLoginHandle)
{
//Login device
g_lLoginHandle = CLIENT_LoginEx2(g_szDevIp, g_nPort, g_szUserName,
g_szPasswd, EM_LOGIN_SPEC_CAP_TCP, NULL, &stDevInfoEx, &nError);

if(0 == g_lLoginHandle)
{
// according to error code, you can find corresponding explanation in dhnetsdk.h.
It is to print hexadecimal here, not decimal shows in header file, please be careful with conversion
//Example: #define NET_NOT_SUPPORTED_EC(23)
//Current SDK does not support this function, error code is 0x80000017, Decimal
number 23 is hexadecimal 0x17.
printf("CLIENT_LoginEx2 %s[%d]Failed!Last Error[%x]\n" , g_szDevIp , g_nPort ,
CLIENT_GetLastError());
}
else
{
printf("CLIENT_LoginEx2 %s[%d] Success\n" , g_szDevIp , g_nPort);
}
// The first time logining to device, some data is needed to be initialized to enable
normal business function. It is recommended to wait for a while after login, the waiting time varies
by devices.
Sleep(1000);
printf("\n");
}
}

void RunTest()
{
if (FALSE == g_bNetSDKInitFlag)
{
return;
}

133/339
 if (0 == g_lLoginHandle)
{
return;
}

//Set snapshot callback function.

CLIENT_SetSnapRevCallBack(SnapRev, NULL);

//Send snapshot command to front-end device.

// Snapshot channel defaults 0, and mode defaults request one frame.
int nChannelId = 0;
int nSnapType = 0;// Snapshot mode;0:request one frame,1:send out requestion
regularly,2: Request consecutively

SNAP_PARAMS stuSnapParams;
stuSnapParams.Channel = nChannelId;
stuSnapParams.mode = nSnapType;
stuSnapParams.CmdSerial = ++g_nCmdSerial; //request SN, valid range
0~65535,over this range will be cut to unsigned short
if (FALSE == CLIENT_SnapPictureEx(g_lLoginHandle, &stuSnapParams))
{
printf("CLIENT_SnapPictureEx Failed!Last Error[%x]\n",
CLIENT_GetLastError());
return;
}
else
{
printf("CLIENT_SnapPictureEx succ\n");
}

GetStringInput("'q': exit; 'c': continue\n", szUserChoose);

}while('q' != szUserChoose[0]);

return;
}

void EndTest()
{
printf("input any key to quit! \n");
getchar();

//Logout device
if (0 != g_lLoginHandle)

134/339
 {
if(FALSE == CLIENT_Logout(g_lLoginHandle))
{
printf("CLIENT_Logout Failed!Last Error[%x]\n", CLIENT_GetLastError());
}
else
{
g_lLoginHandle = 0;
}
}
// Clean up initialization resources.
if (TRUE == g_bNetSDKInitFlag)
{
CLIENT_Cleanup();
g_bNetSDKInitFlag = FALSE;
}

exit(0);
}

int main()
{
InitTest();

RunTest();

EndTest();

return 0;
}

//*********************************************************************************
// commonly used callback set declaration
void CALLBACK DisConnectFunc(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,
DWORD dwUser)
{
printf("Call DisConnectFunc\n");
printf("lLoginID[0x%x]", lLoginID);
if (NULL != pchDVRIP)
{
printf("pchDVRIP[%s]\n", pchDVRIP);
}
printf("nDVRPort[%d]\n", nDVRPort);

135/339
 printf("dwUser[%p]\n", dwUser);
printf("\n");
}

void CALLBACK HaveReConnect(LLONG lLoginID, char *pchDVRIP, LONG nDVRPo rt,

LDWORD dwUser)
{
printf("Call HaveReConnect\n");
printf("lLoginID[0x%x]", lLoginID);
if (NULL != pchDVRIP)
{
printf("pchDVRIP[%s]\n", pchDVRIP);
}
printf("nDVRPort[%d]\n", nDVRPort);
printf("dwUser[%p]\n", dwUser);
printf("\n");
}

void CALLBACK SnapRev(LLONG lLoginID, BYTE *pBuf, UINT RevLen, UINT EncodeType,
DWORD CmdSerial, LDWORD dwUser)
{
printf("[SnapRev] -- receive data!\n");
if(lLoginID == g_lLoginHandle)
{
if (NULL != pBuf && RevLen > 0)
{
char szPicturePath[256] = "";
time_t stuTime;
time(&stuTime);
char szTmpTime[128] = "";
strftime(szTmpTime, sizeof(szTmpTime) - 1, "%y%m%d_%H%M%S",
gmtime(&stuTime));
_snprintf(szPicturePath, sizeof(szPicturePath)-1, "%d_%s.jpg", CmdSerial,
szTmpTime);
FILE* pFile = fopen(szPicturePath, "wb");
if (NULL == pFile)
{
return;
}

int nWrite = 0;
while(nWrite != RevLen)
{

136/339
 nWrite += fwrite(pBuf + nWrite, 1, RevLen - nWrite, pFile);
}

fclose(pFile);
}

}
}

//*********************************************************************************
// commonly used function set declaration
int GetIntInput(char *szPromt, int& nError)
{
long int nGet = 0;
char* pError = NULL;
printf(szPromt);
char szUserInput[32] = "";
gets(szUserInput);
nGet = strtol(szUserInput, &pError, 10);
if ('\0' != *pError)
{
//input parameter error
nError = -1;
}
else
{
nError = 0;
}

return nGet;
}

void GetStringInput(const char *szPromt , char *szBuffer)

{
printf(szPromt);
gets(szBuffer);
}

137/339
2.9Report Alarm

2.9.1 Intro

Report alarm, when front-end device detects special event set previously, send alarm to

platform-end and notify the platform. The platform may receive external alarmvideo signal lost

alarmtampering alarm and motion detection alarm uploaded by device.

The method of alarm report is that SDK actively connects device and subscribes alarm function

from device. When device detects alarm event, it will immediately send the event to SDK.

2.9.2 Interface Overview

Interface Interface Description

CLIENT_Init Interface for initilization

CLIENT_Cleanup Interface for cleaning up SDK resources

CLIENT_LoginEx2 Extensive interface for sync login

CLIENT_SetDVRMessCallBack Interface for setting alarm callback function

Extensive interface for subscribing alarm event from

CLIENT_StartListenEx
device

CLIENT_StopListen Interface for stopping subscribing alarm

CLIENT_Logout Interface for logout device

Interface for getting error code after failed calling

CLIENT_GetLastError
interface

2.9.3 Process Instruction

Report alarm process flow sheet is shown in Figure 2-13.

138/339
 START

SDK initialization
CLIENT_init

Login to device
CLIENT_LoginEx2

Set alarm event callback function

Alarm event callback function
CLIETN_SetDVRMessCallBack

Subscribe alarm from device

CLIENT_StartListenEx

Subscribe alarm from device

CLIENT_StopListen

Logout user
CLIENT_Logout

Release SDK resource

CLIENT_Cleanup

END

Figure 2-13 Report alarm process flow sheet

Process discription

1. SDK initialization

2. After successful initialization, call CLIENT_LoginEx2 to login device.

3. Call CLIENT_SetDVRMessCallBack to set alarm event callback functionthis interface

shall be called before alarm subscription.

4. Call CLIENT_StartListenEx to subscribe alarm from device. After successful subscription,

alarm event reported by device is sent to user via callback function set in

CLIENT_SetDVRMessCallBack.

5. After alarm report function is finished, call CLIENT_StopListen to stop device alarm

139/339
subscription.

6. Call CLIENT_Logout to logout device.

7. Last but not the least, call CLIENT_Cleanup to release SDK resources.

2.9.4 Example Code

#include<windows.h>
#include <stdio.h>
#include "dhnetsdk.h"

#pragma comment(lib , "dhnetsdk.lib")

static BOOL g_bNetSDKInitFlag = FALSE;

static LLONG g_lLoginHandle = 0L;
static char g_szDevIp[32] = "172.23.2.66";
static WORD g_nPort = 37777;
static char g_szUserName[64] = "admin";
static char g_szPasswd[64] = "admin";
static BOOL g_bStartListenFlag = FALSE;

//*********************************************************************************
// commonly used callback set declaration
// callback function used when device gets offline
// Its not recommended to call SDK interfaces in this callback function
//Set the callback function in CLIENT_Initwhen device gets offlineSDK will call this function
automatically
void CALLBACK DisConnectFunc(LONG lLoginID, char *pchDVRIP, LONG nDVRPort,
DWORD dwUser);

// callback function used after device is reconnected successfully

// Its not recommended to call SDK interfaces in this callback function
// Set the callback function in CLIENT_SetAutoReconnect, when offline device is reconnected
successfully, SDK will call the function
void CALLBACK HaveReConnect(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,
LDWORD dwUser);

// alarm event callback function

140/339
 // Its not recommended to call SDK interfaces in this callback function
// set this callback function in CLIENT_SetDVRMessCallBack. When receiving alarm event
reported by deviceSDK will call this function
BOOL CALLBACK MessCallBack(LONG lCommand, LLONG lLoginID, char *pBuf, DWORD
dwBufLen, char *pchDVRIP, LONG nDVRPort, LDWORD dwUser);

//********************************************************************************** void InitTest()

{
// SDK initialization
g_bNetSDKInitFlag = CLIENT_Init(DisConnectFunc, 0);
if (FALSE == g_bNetSDKInitFlag)
{
printf("Initialize client SDK fail; \n");
return;
}
else
{
printf("Initialize client SDK done; \n");
}

// get SDK version info

// this operation is optional
DWORD dwNetSdkVersion = CLIENT_GetSDKVersion();
printf("NetSDK version is [%d]\n", dwNetSdkVersion);

// set CLIENT_SetAutoReconnect interface.Once HaveReConnect is set, when device

gets offline, SDK will reconnect internally.
// this operation is optional, but recommended
CLIENT_SetAutoReconnect(&HaveReConnect, 0);

// set connectting device timeout time and attempts

// this operation is optional
int nWaitTime = 5000; // timeout time is set to 5s
int nTryTimes = 3; // if timeout, you have 3 attempts
CLIENT_SetConnectTime(nWaitTime, nTryTimes);

//Set more network parameter, nWaittime and nConnectTryNum in NET_PARAM has th e

same meaning with the timeout time and trial time set in interface CLIENT_SetConnectTime.
//This operation is optional.
NET_PARAM stuNetParm = {0};
stuNetParm.nWaittime = 3000; // when login, connection timeout value is 3000ms.

141/339
 CLIENT_SetNetworkParam(&stuNetParm);

NET_DEVICEINFO_Ex stDevInfoEx = {0};

int nError = 0;
while(0 == g_lLoginHandle)
{
// login device
g_lLoginHandle = CLIENT_LoginEx2(g_szDevIp, g_nPort, g_szUserName,
g_szPasswd, EM_LOGIN_SPEC_CAP_TCP, NULL, &stDevInfoEx, &nError);

if (0 == g_lLoginHandle)
{
// according to error code, you can find corresponding explanation in dhnetsdk.h.
It is to print hexadecimal here, not decimal showns in header file, please be careful with conversion
// example
// #define NET_NOT_SUPPORTED_EC(23)
// current SDK does not support the function, corresponding error code is
0x80000017. Decimal number 23 is hexadecimal 0x17.
printf("CLIENT_LoginEx2 %s[%d]Failed!Last Error[%x]\n" , g_szDevIp , g_nPort ,
CLIENT_GetLastError());
}
else
{
printf("CLIENT_LoginEx2 %s[%d] Success\n" , g_szDevIp , g_nPort);
}
// The first time logining to device, some data is needed to be initialized to enable
normal business function. It is recommended to wait for a while after login, the waiting time varies
by devices.
Sleep(1000);
printf("\n");
}
}

void RunTest()
{
if (FALSE == g_bNetSDKInitFlag)
{
return;
}

if (0 == g_lLoginHandle)

142/339
 {
return;
}
// set alarm event callback function
CLIENT_SetDVRMessCallBack(MessCallBack , NULL);

// subscribe alarm from device

if( TRUE == CLIENT_StartListenEx(g_lLoginHandle))
{
g_bStartListenFlag = TRUE;
printf("CLIENT_StartListenEx Success! \nJust Wait Event....\n");
}
else
{
printf("CLIENT_StartListenEx Failed!Last Error[%x]\n" , CLIENT_GetLastError());
}
}

void EndTest()
{
printf("input any key to quit! \n");
getchar();
// stop subscribing alarm from device
if (TRUE == g_bStartListenFlag)
{
if (FALSE == CLIENT_StopListen(g_lLoginHandle))
{
printf("CLIENT_StopListen Failed!Last Error[%x]\n", CLIENT_GetLastError());
}
else
{
g_bStartListenFlag = FALSE;
}
}

143/339
 // logout device
if (0 != g_lLoginHandle)
{
if(FALSE == CLIENT_Logout(g_lLoginHandle))
{
printf("CLIENT_Logout Failed!Last Error[%x]\n", CLIENT_GetLastError());
}
else
{
g_lLoginHandle = 0;
}
}
// cleanup initialization resource
if (TRUE == g_bNetSDKInitFlag)
{
CLIENT_Cleanup();
g_bNetSDKInitFlag = FALSE;
}

return;
}

int main()
{
InitTest();
RunTest();
EndTest();
return 0;
}

//*********************************************************************************
// commonly used callback definition set
void CALLBACK DisConnectFunc(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,
DWORD dwUser)
{

144/339
 printf("Call DisConnectFunc\n");
printf("lLoginID[0x%x]", lLoginID);
if (NULL != pchDVRIP)
{
printf("pchDVRIP[%s]\n", pchDVRIP);
}
printf("nDVRPort[%d]\n", nDVRPort);
printf("dwUser[%p]\n", dwUser);
printf("\n");
}

void CALLBACK HaveReConnect(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,

LDWORD dwUser)
{
printf("Call HaveReConnect\n");
printf("lLoginID[0x%x]", lLoginID);
if (NULL != pchDVRIP)
{
printf("pchDVRIP[%s]\n", pchDVRIP);
}
printf("nDVRPort[%d]\n", nDVRPort);
printf("dwUser[%p]\n", dwUser);
printf("\n");
}

BOOL CALLBACK MessCallBack(LONG lCommand, LLONG lLoginID, char *pBuf, DWORD

dwBufLen, char *pchDVRIP, LONG nDVRPort, LDWORD dwUser)
{
printf("[MessCallBack] -- Get Event IP[%s] , port[%d]\n" , pchDVRIP , nDVRPort);

// only part of alarm processing methods is listed in the demo, user can deal with
corresponding alarm event info accordingly, please refer to related event explanation in header file
dhnetsdk.h for details.
switch(lCommand)
{

145/339
 case DH_ALARM_ALARM_EX:
{
printf("\n external alarm\n");
if (NULL != pBuf)
{
BYTE* pInfo = (BYTE*)pBuf;
for(unsigned int i = 0; i < dwBufLen/sizeof(BYTE); ++i)
{
printf("nChannelID = [%2d], state = [%d]\n", i, *(pInfo + i));
}
}
}
break;
case DH_MOTION_ALARM_EX:
{
printf("\n motion detection alarm\n");
if (NULL != pBuf)
{
BYTE* pInfo = (BYTE*)pBuf;
for(unsigned int i = 0; i < dwBufLen/sizeof(BYTE); ++i)
{
printf("nChannelID = [%2d], state = [%d]\n", i, *(pInfo + i));
}
}
}
break;
case DH_ALARM_ALARM_EX_REMOTE:
{
printf("\n remote external alarm \n");
if (NULL != pBuf)
{
ALARM_REMOTE_ALARM_INFO* pInfo =
(ALARM_REMOTE_ALARM_INFO *)pBuf;
printf("nChannelID = %d\n" , pInfo->nChannelID);
printf("nState = %d\n" , pInfo->nState);

146/339
 }
}
break;
case DH_ALARM_ACCESS_CTL_EVENT:
{
printf("\n access control event \n");
if (NULL != pBuf)
{
ALARM_ACCESS_CTL_EVENT_INFO* pInfo =
(ALARM_ACCESS_CTL_EVENT_INFO *)pBuf;
printf(" unlock method = %d\n" , pInfo->emOpenMethod);
printf(" card NO. = [%s]\n" , pInfo->szCardNo);
}
}
break;
default:
printf("\n[MessCallBack] other alarm Get lCommand = 0x%x\n" , lCommand);
break;
}
return TRUE;
}

2.10 Device Search

2.10.1 Intro

Device search is mainly used to help user to get device info from network. Device search can

work with login function. Device search interface can find relevant devices and login interface can

147/339
 login these devices.

Device search is classified into the following two types by whether crossing segment or not

Async same -segment device search

Search for device info within current segment.

Sync cross-segment device search

According to user-set segment info, searching for device in corresponding segment.

2.10.2 Interface Overview

Interface Interface Description

CLIENT_Init Interface for initilization

CLIENT_Cleanup Interface for cleaning up SDK resources

Interface for async searching for IPC, NVS and etc. within
CLIENT_StartSearchDevices
same segment

Interface for stopping async search for IPC, NVS and etc.
CLIENT_StopSearchDevices
within same segment

CLIENT_SearchDevicesByIPs Interface for sync searching cross-segment device

CLIENT_GetLastError Interface for getting error code after failed calling interface

2.10.3 Process Intruction

2.10.3.1 Async Search for Same-segment Device

Async search for device within the same segment is shown in Figure 2-14.

148/339
 START

SDK initialization

Async search devices within User obtains and saves relevant device info
the same segment for further use via async search device
CLIENT_StartSearchDevice callback fSearchDeviceCB

Stop aSync search device

within the same segment
CLIENT_StopSearchDevice

Release SDK resource

CLIENT_Cleanup

END

Figure 2-14 Async search for devices within the same segment

Process discription

1. SDK initialization

2. Call CLIENT_StartSearchDevices to async search for devices within the same segment.

User gets the obtained device info via callback function fSearchDevicesCB which is set in this

interface. The search operation has no timeout time, user needs to stop searching by calling

interface CLIENT_StopSearchDevices.

3. Call CLIENT_StopSearchDevices to stop async searching device within the same

segment.

4. When SDK function use is done, call CLIENT_Cleanup to release SDK resourc e.

2.10.3.2 Sync Search for Cross-segment Device

Sync search for cross-segment device is shown in Figure 2-15.

149/339
 START

SDK initialization

Sync search cross-segment User obtains and saves relevant device info
device for further use via sync search device
CLIENT_SearchDevicesByIPS callback fSearchDeviceCB

Release SDK resource

CLIENT_Cleanup

END

Figure 2-15 Sync search for cross-segment device

Process description

1. SDK initialization.

2. Call CLIENT_SearchDevicesByIPs to sync search for device crossing segment. User gets

the obtained device info via callback function fSearchDevicesCB which is set in this interface. Only

when searching time is out or searching all the devices cross the segment , the interface return.

User can decide the timeout time according to net condition.

3. Call CLIENT_Cleanup to release SDK resource.

2.10.4 Example Code

2.10.4.1 Async Search for Same-segment Device

#include<windows.h>
#include <stdio.h>
#include <list>
#include "dhnetsdk.h"

#pragma comment(lib , "dhnetsdk.lib")

150/339
 static BOOL g_bNetSDKInitFlag = FALSE;
static LLONG g_lSearchHandle = 0L;
static CRITICAL_SECTION g_mDeviceListLock; // device list operation lock
static std::list<DEVICE_NET_INFO_EX> g_lDeviceList; // device list

//*********************************************************************************
// commonly used callback set declaration
// callback function used when device gets offline
// Its not recommended to call SDK interfaces in this callback function
//Set the callback function in CLIENT_Initwhen device gets offlineSDK will call this function
automatically
void CALLBACK DisConnectFunc(LONG lLoginID, char *pchDVRIP, LONG nDVRPort,
DWORD dwUser);

// callback function used after device is reconnected successfully

// Its not recommended to call SDK interfaces in this callback function
// Set the callback function in CLIENT_SetAutoReconnect, when offline device is reconnected
successfully, SDK will call the function
void CALLBACK HaveReConnect(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,
LDWORD dwUser);

// async search for device callback

// Its not recommended to call SDK interfaces in this callback function
// set this callback function in CLIENT_StartSearchDevices/CLIENT_SearchDevicesByIPs.
SDK will call this function when device is found.
void CALLBACK SearchDevicesCB(DEVICE_NET_INFO_EX *pDevNetInfo, void* pUserData);

//*********************************************************************************
void InitTest()
{
// initialization thread lock
InitializeCriticalSection(&g_mDeviceListLock);

// initialization SDK
g_bNetSDKInitFlag = CLIENT_Init(DisConnectFunc, 0);
if (FALSE == g_bNetSDKInitFlag)

151/339
 {
printf("Initialize client SDK fail; \n");
return;
}
else
{
printf("Initialize client SDK done; \n");
}
// get SDK version info
// this operation is optional
DWORD dwNetSdkVersion = CLIENT_GetSDKVersion();
printf("NetSDK version is [%d]\n", dwNetSdkVersion);

// set CLIENT_SetAutoReconnect interface.Once HaveReConnect is set, when device

gets offline, SDK will reconnect internally.
// this operation is optional, but recommended
CLIENT_SetAutoReconnect(&HaveReConnect, 0);

// set connectting device timeout time and attempts

// this operation is optional
int nWaitTime = 5000; // timeout time is set to 5s
int nTryTimes = 3; // if timeout, you have 3 attempts
CLIENT_SetConnectTime(nWaitTime, nTryTimes);

//Set more network parameter, nWaittime and nConnectTryNum in NET_PARAM has the
same meaning with the timeout time and trial time set in interface CLIENT_SetConnectTime.
//This operation is optional.
NET_PARAM stuNetParm = {0};
stuNetParm.nWaittime = 3000; // when login, connection timeout value is 3000ms.
CLIENT_SetNetworkParam(&stuNetParm);
}

void RunTest()
{
if (FALSE == g_bNetSDKInitFlag)
{
return;
}

152/339
 // start async search for same-segment device
g_lSearchHandle = CLIENT_StartSearchDevices(SearchDevicesCB, &g_lDeviceList);
if (NULL == g_lSearchHandle)
{
printf("CLIENT_StartSearchDevices Failed!Last Error[%x]\n",
CLIENT_GetLastError());
return;
}
int nIndex = 0;
int nSearchTime = 0;
int nSearchLimit = 10;// search lasts for 10s, user can modify this value according to
network condition
while (TRUE)
{
if (nSearchLimit == nSearchTime++)
{
break;
}

EnterCriticalSection(&g_mDeviceListLock);
for (std::list<DEVICE_NET_INFO_EX>::iterator iter = g_lDeviceList.begin(); iter !=
g_lDeviceList.end();)
{
printf("\n************** find device *************\n");
printf("nIndex[%d]\n", ++nIndex);
printf("iIPVersion[%d]\n", iter->iIPVersion);
printf("szIP[%s]\n", iter->szIP);
printf("nPort[%d]\n", iter->nPort);
g_lDeviceList.erase(iter);
iter = g_lDeviceList.begin();
}
LeaveCriticalSection(&g_mDeviceListLock);

Sleep(1000);
}

153/339
 }

void EndTest()
{
printf("input any key to quit! \n");
getchar();
// cleanup thread lock resource
DeleteCriticalSection(&g_mDeviceListLock);

// stop async search for same-segment devices

if (NULL != g_lSearchHandle)
{
if (FALSE == CLIENT_StopSearchDevices(g_lSearchHandle))
{
printf("CLIENT_StopSearchDevices Failed!Last Error[%x]\n",
CLIENT_GetLastError());
}
}

// cleanup initialization resource

if (TRUE == g_bNetSDKInitFlag)
{
CLIENT_Cleanup();
g_bNetSDKInitFlag = FALSE;
}
}

int main()
{
InitTest();

RunTest();

EndTest();

154/339
 return 0;
}

void CALLBACK DisConnectFunc(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,

DWORD dwUser)
{
printf("Call DisConnectFunc\n");
printf("lLoginID[0x%x]", lLoginID);
if (NULL != pchDVRIP)
{
printf("pchDVRIP[%s]\n", pchDVRIP);
}
printf("nDVRPort[%d]\n", nDVRPort);
printf("dwUser[%p]\n", dwUser);
printf("\n");
}

void CALLBACK HaveReConnect(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,

LDWORD dwUser)
{
printf("Call HaveReConnect\n");
printf("lLoginID[0x%x]", lLoginID);
if (NULL != pchDVRIP)
{
printf("pchDVRIP[%s]\n", pchDVRIP);
}
printf("nDVRPort[%d]\n", nDVRPort);
printf("dwUser[%p]\n", dwUser);
printf("\n");
}

void CALLBACK SearchDevicesCB(DEVICE_NET_INFO_EX *pDevNetInfo, void* pUserData)

{
if ((NULL == pDevNetInfo) || (NULL == pUserData))
{

155/339
 printf("warming param is null\n");
return;
}

std::list<DEVICE_NET_INFO_EX>* pDeviceList =
(std::list<DEVICE_NET_INFO_EX>*)pUserData;
EnterCriticalSection(&g_mDeviceListLock);
pDeviceList->push_back(*pDevNetInfo);
LeaveCriticalSection(&g_mDeviceListLock);
return;
}

2.10.4.2 Sync Search for Cross-segment Device

#include<windows.h>
#include <stdio.h>
#include <list>
#include "dhnetsdk.h"

#pragma comment(lib , "dhnetsdk.lib")

static BOOL g_bNetSDKInitFlag = FALSE;

static std::list<DEVICE_NET_INFO_EX> g_lDeviceList; // device list

// ***************************************get local IP interface

std::string GetLocalIpAddress();

//*********************************************************************************
// commonly used callback set declaration
// callback function used when device gets offline
// Its not recommended to call SDK interfaces in this callback function
//Set the callback function in CLIENT_Initwhen device gets offlineSDK will call this function
automatically
void CALLBACK DisConnectFunc(LONG lLoginID, char *pchDVRIP, LONG nDVRPort,
DWORD dwUser);

// callback function used after device is reconnected successfully

156/339
 // Its not recommended to call SDK interfaces in this callback function
// Set the callback function in CLIENT_SetAutoReconnect, when offline device is reconnected
successfully, SDK will call the function
void CALLBACK HaveReConnect(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,
LDWORD dwUser);

// sync search for device callback

// Its not recommended to call SDK interfaces in this callback function
// set this callback function in CLIENT_StartSearchDevices/CLIENT_SearchDevicesByIPs.
SDK will call this function when device is found.
void CALLBACK SearchDevicesCB(DEVICE_NET_INFO_EX *pDevNetInfo, void* pUserData);

//*********************************************************************************
void InitTest()
{
// SDK initialization
g_bNetSDKInitFlag = CLIENT_Init(DisConnectFunc, 0);
if (FALSE == g_bNetSDKInitFlag)
{
printf("Initialize client SDK fail; \n");
return;
}
else
{
printf("Initialize client SDK done; \n");
}

// get SDK version info

// this operation is optional
DWORD dwNetSdkVersion = CLIENT_GetSDKVersion();
printf("NetSDK version is [%d]\n", dwNetSdkVersion);

// set CLIENT_SetAutoReconnect interface.Once HaveReConnect is set, when device

gets offline, SDK will reconnect internally.
// this operation is optional, but recommended
CLIENT_SetAutoReconnect(&HaveReConnect, 0);

// set connectting device timeout time and attempts

// this operation is optional
int nWaitTime = 5000; // timeout time is set to 5s

157/339
 int nTryTimes = 3; // if timeout, you have 3 attempts
CLIENT_SetConnectTime(nWaitTime, nTryTimes);

//Set more network parameter, nWaittime and nConnectTryNum in NET_PARAM has the
same meaning with the timeout time and trial time set in interface CLIENT_SetConnectTime.
//This operation is optional.
NET_PARAM stuNetParm = {0};
stuNetParm.nWaittime = 3000; // when login, connection timeout value is 3000ms.
CLIENT_SetNetworkParam(&stuNetParm);
}

void RunTest()
{
if (FALSE == g_bNetSDKInitFlag)
{
return;
}
// start sync search for cross-segment device
char szLocalIp[64] = "";
strncpy(szLocalIp, GetLocalIpAddress().c_str(), sizeof(szLocalIp) - 1);

DEVICE_IP_SEARCH_INFO stuTmp = {sizeof(stuTmp)};

stuTmp.nIpNum = 256; // valid IP address number
for (unsigned int i = 0; i < stuTmp.nIpNum; ++i)
{
// user needs to ensure IP address validity and network connection. Here the
searching segment is 172.11.1.xxx, and local IP address is 10.34.3.77
_snprintf(stuTmp.szIP[i], sizeof(stuTmp.szIP[i]) - 1, "172.11.1.%d", i);
}

DWORD dwWaitTime = 5000;

// please note that this interface will return until timeout, user shall decide timeout time
according to net condition
if (FALSE == CLIENT_SearchDevicesByIPs(&stuTmp, SearchDevicesCB,
(LDWORD)&g_lDeviceList, szLocalIp, dwWaitTime))
{
printf("CLIENT_SearchDevicesByIPs Failed!Last Error[%x]\n",

158/339
CLIENT_GetLastError());
return;
}

int nIndex = 0;
for (std::list<DEVICE_NET_INFO_EX>::iterator iter = g_lDeviceList.begin(); iter !=
g_lDeviceList.end(); ++iter)
{
printf("\n************** find device *************\n");
printf("nIndex[%d]\n", ++nIndex);
printf("iIPVersion[%d]\n", iter->iIPVersion);
printf("szIP[%s]\n", iter->szIP);
printf("nPort[%d]\n", iter->nPort);
}
}

void EndTest()
{
printf("input any key to quit! \n");
getchar();

// cleanup initialization resource

if (TRUE == g_bNetSDKInitFlag)
{
CLIENT_Cleanup();
g_bNetSDKInitFlag = FALSE;
}
}

int main()
{
InitTest();

RunTest();

159/339
 EndTest();

return 0;
}

//*********************************************************************************
//commonly used callback set definition
void CALLBACK DisConnectFunc(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,
DWORD dwUser)
{
printf("Call DisConnectFunc\n");
printf("lLoginID[0x%x]", lLoginID);
if (NULL != pchDVRIP)
{
printf("pchDVRIP[%s]\n", pchDVRIP);
}
printf("nDVRPort[%d]\n", nDVRPort);
printf("dwUser[%p]\n", dwUser);
printf("\n");
}

void CALLBACK HaveReConnect(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,

LDWORD dwUser)
{
printf("Call HaveReConnect\n");
printf("lLoginID[0x%x]", lLoginID);
if (NULL != pchDVRIP)
{
printf("pchDVRIP[%s]\n", pchDVRIP);
}
printf("nDVRPort[%d]\n", nDVRPort);
printf("dwUser[%p]\n", dwUser);
printf("\n");
}

160/339
 void CALLBACK SearchDevicesCB(DEVICE_NET_INFO_EX *pDevNetInfo, void* pUserData)
{
if ((NULL == pDevNetInfo) || (NULL == pUserData))
{
printf("warming param is null\n");
return;
}

std::list<DEVICE_NET_INFO_EX>* pDeviceList =
(std::list<DEVICE_NET_INFO_EX>*)pUserData;
pDeviceList->push_back(*pDevNetInfo);
return;
}

// *************************************** get local IP interface

std::string GetLocalIpAddress()
{
WSADATA wsaData;
if (0 != WSAStartup(MAKEWORD(2,2), &wsaData))
{
return "";
}

char local[255] = "";

gethostname(local, sizeof(local));
hostent* ph = gethostbyname(local);
if (NULL == ph)
{
return "";
}

in_addr addr;
memcpy(&addr, ph->h_addr_list[0], sizeof(in_addr));

std::string localIP(inet_ntoa(addr));

161/339
 WSACleanup();
return localIP;
}

2.11 Intelligent Event Report and Snapshot

2.11.1 Intro

Intelligent event report is that devices judge whether to report events and to send pictures to

users or not according to real-time stream intelligent analyzation and intelligent event tr igger rules

configured by users. Intelligent events are: scene change, cross picket line, enter picket zone, leave

picket zone, in picket zone, across enclosure, straggle detection, carry-over detection, move

detection, goods protection, illegal parking, fast moving, go in the wrong direction etc.

Intelligent snapshot event: user manually sends a command to device after subscribing event

successfully. Device snapshots pictute of current scene and reports it to user via intelligent event.

2.11.2 Interface Overview

Interface Interface Description

CLIENT_Init Interface for initilization

CLIENT_Cleanup Interface for cleaning up SDK resources

CLIENT_LoginEx2 Extensive interface 2 for sync login

CLIENT_RealLoadPictureEx Interface for intelligent picture alarm subscription

CLIENT_ControlDeviceEx Extensive interface for device control

CLIENT_Logout Interface for logout device

CLIENT_GetLastError Interface for getting error code after failed calling interface

2.11.3 Process Intruction

Intelligent event report and snapshot process flow sheet is shown in Figure 2-16.

162/339
 START

SDK initialization

Device login
CLIENT_LoginEx2

User obtains and saves intelligent alarm

Subscribe intelligent picture alarm from device
info and carried picture info by callback
CLIENT_RealLoadPictureEx
fAnalyzerDataCallBack

Trigger intelligent picture alarm manually

CLIENT_ControlDeviceEx.emType is
DH_MANUAL_SNAP

Stop subscribing intelligent picture alarm from

device
CLIENT_StopLoadPic

Logout user
CLIENT_Logout

Release SDK resource

CLIENT_Cleanup

END

Figure 2-16 intelligent event report and snapshot

Process discription

1. SDK initialization

2. After successful initialization, call CLIENT_LoginEx2 to login device.

3. Call CLIENT_RealLoadPictureEx to subscribe intelligent snapshot alarm from device. After

successful subscription, the intelligent snapshot alarm event reported by device will be sent to user

by callback function fAnalyzerDataCallBack. In callback function, user should converts input

character to corresponding struct according to the instruction in SDK header files, and then displays

163/339
and saves event as needed. Due to SDK receving buffer is 2M by default, when callback picture info

exceed 2M,user need to call CLIENT_SetNetworkParam interface to set receiving buffer again,

otherwise SDK will abandon data pack over 2M

4. If a user wants to manually trigger intelligent picture alarm, he can call

CLIENT_ControlDeviceEx interface with parameter emType DH_MANUAL_SNAP. SDK will send

command to device, device then snapshots current monitoring video and reports it to user.

5. After intelligent picture alarm report function is done, call CLIENT_StopLoadPic to stop

subscribing intelligent picture alarm from device.

6. After business use is done, call CLIENT_Logout to logout device.

7. After SDK function use is done, call CLIENT_Cleanup to release SDK resource.

2.11.4 Example Code

#include<windows.h>
#include <stdio.h>
#include <list>
#include <time.h>
#include "dhnetsdk.h"

#pragma comment(lib , "dhnetsdk.lib")

static BOOL g_bNetSDKInitFlag = FALSE;

static LLONG g_lLoginHandle = 0L;
static LLONG g_lRealLoadHandle = 0L;
static char g_szDevIp[32] = "192.168.4.12";
static int g_nPort = 37777;
static char g_szUserName[64] = "admin";
static char g_szPasswd[64] = "admin";

//*********************************************************************************
// commonly used callback set declaration
// callback function used when device gets offline
// Its not recommended to call SDK interfaces in this callback function
//Set the callback function in CLIENT_Initwhen device gets offlineSDK will call this function

164/339
automatically
void CALLBACK DisConnectFunc(LONG lLoginID, char *pchDVRIP, LONG nDVRPort,
DWORD dwUser);

// callback function used after device is reconnected successfully

// Its not recommended to call SDK interfaces in this callback function
// Set the callback function in CLIENT_SetAutoReconnect, when offline device is reconnected
successfully, SDK will call the function
void CALLBACK HaveReConnect(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,
LDWORD dwUser);

// intelligent analyzing data callback

// Its not recommended to call SDK interfaces in this callback function
// set this callback function in CLIENT_RealLoadPictureEx/CLIENT_RealLoadPicture, SDK
will call this function when device-end has intelligent picture event to report.
// nSequence is used when uploading the same picture. 0 means it is the first time to appear; 2
means it is the last time to appear or only appear once; 1 means it will appear again later
// int nState =* (int*) reserved means current callback data status. 0 means real-time data; 1
means offline data; 2 means offline transmission done.
// return value is abolished, no special meaning
// due to SDK receving buffer is 2M by default, when callback picture info exceed 2M,use r need
to call CLIENT_SetNetworkParam interface to set receiving buffer again, otherwise SDK will
abandon data pack over 2M
int CALLBACK AnalyzerDataCallBack(LLONG lAnalyzerHandle, DWORD dwAlarmType,
void* pAlarmInfo, BYTE *pBuffer, DWORD dwBufSize, LDWORD dwUser, int nSequence, void
*reserved);

//*********************************************************************************
void InitTest()
{
// SDK initialization
g_bNetSDKInitFlag = CLIENT_Init(DisConnectFunc, 0);
if (FALSE == g_bNetSDKInitFlag)
{
printf("Initialize client SDK fail; \n");
return;
}
else
{
printf("Initialize client SDK done; \n");

165/339
 }

// get SDK version info

// this operation is optional
DWORD dwNetSdkVersion = CLIENT_GetSDKVersion();
printf("NetSDK version is [%d]\n", dwNetSdkVersion);

// set CLIENT_SetAutoReconnect interface.Once HaveReConnect is set, when device

gets offline, SDK will reconnect internally.
// this operation is optional, but recommended
CLIENT_SetAutoReconnect(&HaveReConnect, 0);

// set connectting device timeout time and attempts

// this operation is optional
int nWaitTime = 5000; // timeout time is set to 5s
int nTryTimes = 3; // if timeout, you have 3 attempts
CLIENT_SetConnectTime(nWaitTime, nTryTimes);

//Set more network parameter, nWaittime and nConnectTryNum in NET_PARAM has the
same meaning with the timeout time and trial time set in interface CLIENT_SetConnectTime.
//This operation is optional.
NET_PARAM stuNetParm = {0};
stuNetParm.nWaittime = 3000; // when login, connection timeout value is 3000ms.
CLIENT_SetNetworkParam(&stuNetParm);

NET_DEVICEINFO_Ex stDevInfoEx = {0};

int nError = 0;
while(0 == g_lLoginHandle)
{
// login device
g_lLoginHandle = CLIENT_LoginEx2(g_szDevIp, g_nPort, g_szUserName,
g_szPasswd, EM_LOGIN_SPEC_CAP_TCP, NULL, &stDevInfoEx, &nError);

if (0 == g_lLoginHandle)
{
// according to error code, you can find corresponding explanation in dhSDK.h. It is
to print hexadecimal here, not decimal showns in header file, please be careful with conversion
// example
// #define NET_NOT_SUPPORTED_EC(23)
// current SDK does not support the function, corresponding error code is 0x80000017.
Decimal number 23 is hexadecimal 0x17.
printf("CLIENT_LoginEx2 %s[%d]Failed!Last Error[%x]\n" , g_szDevIp , g_nPort ,

166/339
CLIENT_GetLastError());
}
else
{
printf("CLIENT_LoginEx2 %s[%d] Success\n" , g_szDevIp , g_nPort);
}
// The first time logining to device, some data is needed to be initialized to enable
normal business function. It is recommended to wait for a while after login, the waiting time varies
by devices.
Sleep(1000);
printf("\n");
}
}

void RunTest()
{
if (FALSE == g_bNetSDKInitFlag)
{
return;
}

if (0 == g_lLoginHandle)
{
return;
}

// subscribe intelligent picture alarm

LDWORD dwUser = 0;
Int nChannel = 0;
// each setup corresponds to one channel, and corresponds to event of a certain type
// if a user wants to set all types of event for one channel, the parameter dwAlarmType
should be set to EVENT_IVS_ALL
// If you want to set that one channel uploads two events, please call
CLIENT_RealLoadPictureEx twice and set different event type
g_lRealLoadHandle = CLIENT_RealLoadPictureEx(g_lLoginHandle, nChannel,
EVENT_IVS_ALL, TRUE, AnalyzerDataCallBack, dwUser, NULL);
if (0 == g_lRealLoadHandle)

167/339
 {
printf("CLIENT_RealLoadPictureEx Failed!Last Error[%x]\n",
CLIENT_GetLastError());
return;
}

// manually snapshot trigger intelligent picture alarm function

while(1)
{
char szGetBuf[64] = "";
printf("manual snap, \'q\': quit, other: yes\n");
gets(szGetBuf);
// enter 'q' to exit manual snapshot trigger alarm, other s mean to trigger alarm
if (0 == strncmp(szGetBuf, "q", sizeof(szGetBuf) - 1))
{
break;
}

MANUAL_SNAP_PARAMETER stuSanpParam = {0};

stuSanpParam.nChannel = 0;
strncpy((char*)stuSanpParam.bySequence, "just for test",
sizeof(stuSanpParam.bySequence));
// manually snapshot trigger alarm function, this function is only valid for ITC device
if (FALSE == CLIENT_ControlDeviceEx(g_lLoginHandle, DH_MANUAL_SNAP,
&stuSanpParam))
{
printf("CLIENT_ControlDeviceEx Failed!Last Error[%x]\n",
CLIENT_GetLastError());
break;
}
}
}

void EndTest()
{

168/339
printf("input any key to quit! \n");
getchar();

// stop subscribing picture alarm

if (0 != g_lRealLoadHandle)
{
if (FALSE == CLIENT_StopLoadPic(g_lRealLoadHandle))
{
printf("CLIENT_StopLoadPic Failed!Last Error[%x]\n", CLIENT_GetLastError());
}
else
{
g_lRealLoadHandle = 0;
}
}

// logout device
if (0 != g_lLoginHandle)
{
if (FALSE == CLIENT_Logout(g_lLoginHandle))
{
printf("CLIENT_Logout Failed!Last Error[%x]\n", CLIENT_GetLastError());
}
else
{
g_lLoginHandle = 0;
}
}

// cleanup initialization resource

if (TRUE == g_bNetSDKInitFlag)
{
CLIENT_Cleanup();
g_bNetSDKInitFlag = FALSE;

169/339
 }
return;
}

int main()
{
InitTest();
RunTest();
EndTest();
return 0;
}
//*********************************************************************************
// commonly used callback set definition
void CALLBACK DisConnectFunc(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,
DWORD dwUser)
{
printf("Call DisConnectFunc\n");
printf("lLoginID[0x%x]", lLoginID);
if (NULL != pchDVRIP)
{
printf("pchDVRIP[%s]\n", pchDVRIP);
}
printf("nDVRPort[%d]\n", nDVRPort);
printf("dwUser[%p]\n", dwUser);
printf("\n");
}

void CALLBACK HaveReConnect(LLONG lLoginID, char *pchDVRIP, LONG nDVRPort,

LDWORD dwUser)
{
printf("Call HaveReConnect\n");
printf("lLoginID[0x%x]", lLoginID);
if (NULL != pchDVRIP)
{
printf("pchDVRIP[%s]\n", pchDVRIP);

170/339
 }
printf("nDVRPort[%d]\n", nDVRPort);
printf("dwUser[%p]\n", dwUser);
printf("\n");
}

int CALLBACK AnalyzerDataCallBack(LLONG lAnalyzerHandle, DWORD dwAlarmType,

void* pAlarmInfo, BYTE *pBuffer, DWORD dwBufSize, LDWORD dwUser, int nSequence, void
*reserved)
{
if (lAnalyzerHandle != g_lRealLoadHandle)
{
return 0;
}

int nAlarmChn = 0;
switch(dwAlarmType)
{
case EVENT_IVS_TRAFFIC_OVERLINE:
{
printf("EVENT_IVS_TRAFFIC_OVERLINE event\n");
DEV_EVENT_TRAFFIC_OVERLINE_INFO* pStuInfo =
(DEV_EVENT_TRAFFIC_OVERLINE_INFO*)pAlarmInfo;
nAlarmChn = pStuInfo->nChannelID;
printf("nChannelID[%d]\n", pStuInfo->nChannelID);
}
break;
case EVENT_IVS_PARKINGDETECTION:
{
printf("EVENT_IVS_PARKINGDETECTION event\n");
DEV_EVENT_PARKINGDETECTION_INFO* pStuInfo =
(DEV_EVENT_PARKINGDETECT ION_INFO*)pAlarmInfo;
nAlarmChn = pStuInfo->nChannelID;
printf("nChannelID[%d]\n", pStuInfo->nChannelID);
}

171/339
 break;
case EVENT_IVS_TRAFFIC_MANUALSNAP:
{
printf("EVENT_IVS_TRAFFIC_MANUALSNAP event\n");
DEV_EVENT_TRAFFIC_MANUALSNAP_INFO* pStuInfo =
(DEV_EVENT_TRAFFIC_MANUALSNAP_INFO*)pAlarmInfo;
nAlarmChn = pStuInfo->nChannelID;
// pStuInfo->szManualSnapNo should be "just for test"
printf("nChannelID[%d]\n", pStuInfo->nChannelID);

}
break;
default:
printf("other event type[%d]\n", dwAlarmType);
break;
}

if (dwBufSize > 0 && NULL != pBuffer)

{
// in case of too many picturse being received at the same time, mark with i than
saving pictures via receiving time which may cause overlapping.
static int i;
char szPicturePath[256] = "";
time_t stuTime;
time(&stuTime);
char szTmpTime[128] = "";
strftime(szTmpTime, sizeof(szTmpTime) - 1, "%y%m%d_%H%M%S",
gmtime(&stuTime));
_snprintf(szPicturePath, sizeof(szPicturePath)-1, "%d_%s.jpg", ++i, szTmpTime);

FILE* pFile = fopen(szPicturePath, "wb");

if (NULL == pFile)
{
return 0;
}

172/339
 int nWrite = 0;
while(nWrite != dwBufSize)
{
nWrite += fwrite(pBuffer + nWrite, 1, dwBufSize - nWrite, pFile);
}

fclose(pFile);
}

return 1;
}

173/339
3 Callback function definition

3.1fDisConnect
Option Instruction

Disconnection callback function. Informing user via this callback when

Interface description
logined device gets disconnected.

Precondition none

typedef void(CALLBACK *fDisConnect)(

LLONG lLoginID,

char *pchDVRIP,
Function
LONG nDVRPort,

LDWORD dwUser

);

lLoginID

Logined device ID.

Return value of login interface CLIENT_LoginEx2 .

pchDVRIP

Device IP.

Parameter Disconnected device IP which is the input IP of login interface.

nDVRPort

Device port.

Disconnected device port which is the input port of login interface.

dwUser

User data

Return value None

Set this callback in interface CLIENT_Init.

Note User can identify which device gets disconnected via parameters

lLoginID, pchDVRIP and nDVRPort.

174/339
3.2fHaveReConnect

Option Instruction

Successful reconnection callback function.

Interface
When the disconnected device gets reconnected, call this interface to inform
description
user.

Precondition None

typedef void (CALLBACK *fHaveReConnect)(

LLONG lLoginID,

char *pchDVRIP,
Function
LONG nDVRPort,

LDWORD dwUser

);

lLoginID

Logined device ID.

Return value of login interface CLIENT_LoginEx2.

pchDVRIP

Device IP.

Parameter Disconnected device IP which is the input IP of login interface.

nDVRPort

Device port.

Disconnected device port which is the input port of login interface.

dwUser

User data

Return value None

Set this callback in interface CLIENT_SetAutoReconnect.

Note User can identify which device gets reconnected via parameters lLoginID

pchDVRIP and nDVRPort.

175/339
3.3fRealDataCallBackEx

Option Instruction

Interface description Real-time monitoring data callback function prototype extension

Precondition None

typedef void (CALLBACK*fRealDataCallBackEx)(

LLONG lRealHandle,

DWORD dwDataType,

BYTE *pBuffer,
Function
DWORD dwBufSize,

LONG param,

LDWORD dwUser

);

lRealHandle

Real-time monitoring handle.

Return value of real-tme monitoring interface like

CLIENT_RealPlayExc et. dwDataType.

Type of data being called back.

The type is decided by parameter dwFlag set in

CLIENT_SetRealDataCallBackEx.

dwDataType description

Parameter 0 Original data which is the data

stored by CLIENT_SaveRealData

1 Frame data

2 Yuv data

3 Pcm data

pBuffer

Buffer for callback data.

Data of different length will be called back according to different

dwDataType value. The data are called back by frame for every

176/339
Option Instruction

dwDataType value but 0, each time one frame is called back.

dwBufSize

Callback data length.

Different dwDataType has different length.(unit: byte).

param

callback data parameter struct.

when dwDataType is 0 and 2, param is 0.

When dwDataType is 1, param is a pointer of struct

tagVideoFrameParam type. See struct tagVideoFrameParam for

details.

When dwDataType is 3, param is a pointer of struct

tagCBPCMDataParam type. See struct tagCBPCMDataParam for

details.

dwUserData

user data.

Return value None

Set the callback function in CLIENT_SetRealDataCallBackEx.

Note User can identify which real-time monitoring the callback data belongs

to via parameter lRealHandle.

3.4fDownLoadPosCallBack

Option Instruction

Interface description Playback pos callback function

Precondition None

typedef void (CALLBACK *fDownLoadPosCallBack)(

LLONG lPlayHandle,

Function DWORD dwTotalSize,

DWORD dwDownLoadSize,

LDWORD dwUser

177/339
Option Instruction

);

lPlayHandle

Playback handle

Return value of playback interface like CLIENT_PlayBackByTimeEx

etc.

dwTotalSize

Total size of the playback.(unit: KB)

parameter
dwDownLoadSize

The size has been played. (unit: KB)

dwDownLoadSize = -1 means the playback is finished.

dwDownLoadSize = -2 means failed to write files.

dwUser

User data

Return value None

Set the callback function in CLIENT_PlayBackByTimeEx.

Note
User can identify which playback it is via parameter lRealHandle.

3.5fDataCallBack
Option Instruction

Interface description Playback data callback function

Precondition None

typedef int (CALLBACK *fDataCallBack)(

LLONG lRealHandle,

DWORD dwDataType,

Function BYTE *pBuffer,

DWORD dwBufSize,

LDWORD dwUser

);

Parameter lRealHandle

178/339
Option Instruction

Playback handle

Return value of playback interface like CLIENT_PlayBackByTimeEx

etc.

dwDataType

Data type.

The value remains 0,which means data of original type.

pBuffer

Data stored buffer.

Used to store callback video data.

dwBufSize

Data stored buffer length.(unit: byte)

dwUser

User data

0: means callback failed, and next time the same data will be returned.

Return value 1: means callback succeeded, and next time the follow-up data will be

returned.

Set the callback function in interfaces like CLIENT_PlayBackByTimeEx

etc.

If parameter hWnd of CLIENT_PlayBackByTimeEx is not NULL, no

Note
matter what value returns, the callback is being considered successful

and next callback will return follow-up data.

User can identify which playback it is via parameter lRealHandle.

3.6fTimeDownLoadPosCallBack

Option Instruction

Interface description Download by time callback function

Precondition None

typedef void (CALLBACK *fTimeDownLoadPosCallBack) (

Function
LLONG lPlayHandle,

179/339
Option Instruction

DWORD dwTotalSize,

DWORD dwDownLoadSize,

int index,

NET_RECORDFILE_INFO recordfileinfo,

LDWORD dwUser

);

lPlayHandle

Download handle

Return value of interfaces like CLIENT_DownloadByTimeEx etc.

dwTotalSize

Total size to be downloaded.(unit: KB)

dwDownLoadSize

The size has been downloaded,(unit: KB)

Parameter
index

Video files NO. during current download.

recordfileinfo

Current downloaded files info.

See struct NET_RECORDFILE_INFO for details.

dwUser

User data

Return value None

Set the callback function in interfaces like CLIENT_DownloadByTimeEx

Note etc.

User can identify which download it is via parameter lRealHandle.

3.7fMessCallBack

Option Instruction

Interface description Alarm report callback function prototype

precondition None

180/339
Option Instruction

typedef BOOL (CALLBACK *fMessCallBack)(

LONG lCommand,

LLONG lLoginID,

char *pBuf,

function DWORD dwBufLen,

char *pchDVRIP,

LONG nDVRPort,

LDWORD dwUser

);

lCommand

Alarm event type being called back.

Use matched with pBuf, different lCommand has different pBuf.

Please see note below for details.

lLoginID

Logined device ID.

Return value of login interface CLIENT_LoginEx2.

pBuf

Alarm data received buffer.

pBuf points to different data type according to different listen interface

parameter
and different lCommand .

Please see note for details

dwBufLen

The length of pBuf (unit:BYTE)

pchDVRIP

Device IP which reports alarm

nDVRPort

Device port which reports alarm

dwUser

User data

181/339
Option Instruction

Return value None

All the logined device use the same alarm report callback function .

User judges which login report the alarm by parameter lLoginID.

pBuf points to different data type according to different listen interface and

different lCommand.

Note As there are too many alarm events, here we dont introduce them all,

user can search the following key section in header file Eng_dhnetsdk.h

for details:

// Extensive alarm type,corresponding to CLIENT_StartListenEx

#define DH_ALARM_ALARM_EX 0x2101 // External alarm

3.8fSearchDevicesCB

Option Instruction

Interface
Device search callback prototype
description

Precondition None

typedef void (CALLBACK *fSearchDevicesCB)(

DEVICE_NET_INFO_EX *pDevNetInfo,
Function
void* pUserData

);

pDevNetInfo

Device info struct.

Parameter See struct DEVICE_NET_INFO_EX for details.

pUserData

User data

Return value None

Device search callback function.

Note
Its not recommended to call SDK interfaces in this callback function.

182/339
Option Instruction

Set the callback function in CLIENT_StartSearchDevices

/CLIENT_SearchDevicesByIPs. When device is searched out,SDK will call this

function.

3.9fAnalyzerDataCallBack

Option Instruction

Interface
Intellengent picture alarm callback function prototype
description

Precondition None

typedef int (CALLBACK *fAnalyzerDataCallBack)(

LLONG lAnalyzerHandle,

DWORD dwAlarmType,

void* pAlarmInfo,

BYTE *pBuffer,
Function
DWORD dwBufSize,

LDWORD dwUser,

int nSequence,

void *reserved

);

lAnalyzerHandle

Intelligent picture alarm subscription handle.

When multiple intelligent picture alarm subscriptions use the same callback

function, we can judge which subscription is by this parameter.

dwAlarmType
Parameter
Intelligent picture alarm typethis parameter should be used matched with

parameter pBuffer.

As there are too many alarm events, here we dont introduce them all, user

can search the following key section in header file Eng_dhnetsdk.h for

details:

183/339
Option Instruction

pAlarmInfo

Struct pointer, used match with dwAlarmType, different dwAlarmType match

with different pointer.see note below for information.

pBuffer

Intelligent picture info buffer

dwBufSize

The size of intelligent picture info

dwUser

User data

nSequence

Whether the picture is repeated

0:its the first time that the picture shows up, and the follow-up alarms may

use the picture.

1this picture is the same as the one shown in tha last alarm, and the

follow-up alarms may use the picture.

2this picture is the same as the one shown in tha last alarm,and it will never

show up again.or it is the only time that the picture shows up.

(as most of alarms has an unique picture, the value is 2)

reserved

The state of the current callback. This parameter is an int pointer.

what *(int *)reserved is:

0current data is real-time data

1current data is off-line data

2off-line transfer is finished

(as most of the intelligent picture alarm data is real-time data ,the value of

*(int *)reserved is 0)

Return value The return value has no meaning,0 is OK.

Intellengent picture alarm callback function.

Note
Its not recommended to call SDK interfaces in this callback function.

184/339
Option Instruction

Set this callback function in CLIENT_RealLoadPictureEx /

CLIENT_RealLoadPicture. When there are intelligent picture event reported

by device-end, SDK will call this function.

Due to SDK receving buffer is 2M by default, when callback picture info

exceed 2M,user need to call CLIENT_SetNetworkParam interface to set

receiving buffer again, otherwise SDK will abandon data pack over 2M.

Different dwAlarmType matched with different pointer.

As there are too many alarm events, here we dont introduce them all, user

can search the following key section in header file Eng_dhnetsdk.h for details:

#define EVENT_IVS_ALL 0x00000001 // subscription all event

3.10 fSnapRev
Option Instruction

Interface
Front-end video snapshot callback function prototype
description

Precondition None

typedef void (CALLBACK *fSnapRev)(

LLONG lLoginID,

BYTE *pBuf,

UINT RevLen,
Function
UINT EncodeType,

DWORD CmdSerial,

LDWORD dwUser

);

lLoginID

Logined device ID.

Parameter When multiple front-end video snapshots use the same callback function,

we can judge which snapshot is by this parameter.

pBuf

185/339
Option Instruction

Picture info buffer

Used to store the picture info return by storage device.

RevLen

The size of picture info buffer

EncodeType

Encode type

10:jpeg picture, 0:i frame of mpeg4

CmdSerial

The serial number.

It is input by CLIENT_SnapPictureEx input parameter

dwUser

User data

Return value None

Snapshot callback function

Its not recommended to call SDK interfaces in this callback function.

Set this callback function in CLIENT_SetSnapRevCallBack. When there are

Note snapshot picture data sent by device-end, SDK will call this function.

Due to SDK receving buffer is 2M by default, when callback picture info

exceed 2M,user need to call CLIENT_SetNetworkParam interface to set

receiving buffer again, otherwise SDK will abandon data pack over 2M.

3.11 fRealPlayDisConnect
Option Instruction

Interface
Real-time monitoring disconnection callback function prototype
description

Precondition None

typedef void (CALLBACK *fRealPlayDisConnect)(

Function LLONG lOperateHandle,

EM_REALPLAY_DISCONNECT_EVENT_TYPE dwEventType,

186/339
Option Instruction

void* param,

LDWORD dwUser

);

LOperateHandle

Real-time monitoring handle.

When multiple real-time monitoring device use the same callback function,

we can judge which operation is by this parameter.

dwEventType

Parameter Event which causes disconnection.

See enum EM_REALPLAY_DISCONNECT_EVENT_TYPE for reference.

param

Reserved paramerer, default value is NULL.

dwUser

User data

Return value None

Real-time monitoring disconnection callback function

Its not recommended to call SDK interfaces in this callback function.

Note
Set the callback in CLIENT_StartRealPlay.when real-time monitoring is

disconnected,SDK will call this function.

3.12 pfAudioDataCallBack
Option Instruction

Interface
Audion data callback function protptype
description

Precondition None

typedef void (CALLBACK *pfAudioDataCallBack)(

LLONG lTalkHandle,
Function
char *pDataBuf,

DWORD dwBufSize,

187/339
Option Instruction

BYTE byAudioFlag,

LDWORD dwUser

);

lTalkHandle

Handle of audion intercom

Return value of audio intercom interfaces such as CLIENT_StartTalkEx etc.

pDataBuf

Audio data being called back

Where the data from is decided by parameter byAudioFlag

dwBufSize

The length of audio data being called back (unit:BYTE)

Parameter
byAudioFlag

Flag indicates where the audio data from

0 indicates that the audio data received is PC-end data collected by local

audio library.only CLIENT_RecordStartEx interface is called, can the data

be called back.

1 indicates the data received is sent by device-end.

dwUser

User data

Return value None

Note Set the callback in audio intercom interface such as CLIENT_StartTalkEx etc.

188/339
Appendix 1 struct definition

NET_DEVICEINFO
Option Instruction

Struct
Device info
description

typedef struct

BYTE sSerialNumber[DH_SERIALNO_LEN];

BYTE byAlarmInPortNum;

BYTE byAlarmOutPortNum;

BYTE byDiskNum;

struct BYTE byDVRType;

Union

BYTE byChanNum;

BYTE byLeftLogTimes;

};

} NET_DEVICEINFO, *LPNET_DEVICEINFO;

sSerialNumber

SN

byAlarmInPortNum

DVR alarm input amount

byAlarmOutPortNum
member
DVR alarm output amount

byDiskNum

DVR HDD amount

byDVRType

DVR type.Please refer to enum DHDEV_DEVICE_TYPE

189/339
Option Instruction

byChanNum

DVR channel amount

byLeftLogTimes

When login failed due to password error, notice user via this parameter,

remaining login times 0 means this parameter is invalid

NET_IN_STARTLOGINEX

Option Instruction

Struct description Input parameter CLIENT_StartLoginEx

typedef struct tagNET_IN_STARTLOGINEX

DWORD dwSize;

const char* szIp;

DWORD dwPort;
struct
const char* szName;

const char* szPwd;

fHaveLogin cbLogin;

LDWORD dwUser;

}NET_IN_STARTLOGINEX;

dwSize

The size of the struct.It should be set to sizeof(NET_IN_STARTLOGINEX)

when used.

szIp

device ip
member
dwPort

login port

szName

username

szPwd

190/339
 password

cbLogin

login result callsee callback function fHaveLogin for details.

dwUser

call user parameter

NET_OUT_STARTLOGINEX

Option Instruction

Struct description Out put parameter of CLIENT_StartLoginEx

typedef struct tagNET_OUT_STARTLOGINEX

{
Struct
DWORD dwSize;

}NET_OUT_STARTLOGINEX;

dwSize

Member The size of the struct.It should be set to

sizeof(NET_OUT_STARTLOGINEX)when used.

NET_PARAM

Option Instruction

Struct
Relevant parameters of login
description

typedef struct

int nWaittime;

int nConnectTime;

Struct int nConnectTryNum;

int nSubConnectSpaceTime;

int nGetDevInfoTime;

int nConnectBufSize;

int nGetConnInfoTime;

191/339
 int nSearchRecordTime;

int nsubDisconnetTime;

BYTE byNetType;

BYTE byPlaybackBufSize;

BYTE bDetectDisconnTime;

BYTE bKeepLifeInterval;

int nPicBufSize;

BYTE bReserved[4];

} NET_PARAM;

nWaittime

Waiting time(unit is ms), 0:default 5000ms.

nConnectTime

Connection timeout value(Unit is ms), 0:default 1500ms.

nConnectTryNum

Connection trial times, 0:default 1.

nSubConnectSpaceTime

Sub-connection waiting time(Unit is ms), 0:default 10ms.

nGetDevInfoTime

Access to device information timeout, 0:default 1000ms.

Member nConnectBufSize

Each connected to receive data buffer size(Bytes), 0:default 250*1024

nGetConnInfoTime

Access to sub-connect information timeout(Unit is ms), 0:default 1000ms.

nSearchRecordTime

Timeout value of search video (unit ms), default 3000ms

nsubDisconnetTime

dislink disconnect time,0:default 60000ms

byNetType

net type, 0-LAN, 1-WAN

byPlaybackBufSize

192/339
 playback data from the receive buffer size(m),when value = 0,default 4M

bDetectDisconnTime

Pulse detect offline time(second) .When it is 0, the default setup is 60s, and

the min time is 2s

bKeepLifeInterval

Pulse send out interval(second). When it is 0, the default setup is 10s, the min

internal is 2s.

nPicBufSize

actual pictures of the receive buffer size(byte)when value = 0,default

2*1024*1024

bReserved

reserved

NET_DEVICEINFO_Ex

Option Instruction

Struct
device info extension
description

typedef struct

BYTE sSerialNumber[DH_SERIALNO_LEN];

int nAlarmInPortNum;

int nAlarmOutPortNum;

int nDiskNum;

struct int nDVRType;

int nChanNum;

BYTE byLimitLoginTime;

BYTE byLeftLogTimes;

BYTE bReserved[2];

int nLockLeftTime;

char Reserved[24];

193/339
 } NET_DEVICEINFO_Ex, *LPNET_DEVICEINFO_Ex;

sSerialNumber

SN

nAlarmInPortNum

count of DVR alarm input

nAlarmOutPortNum

count of DVR alarm output

nDiskNum

number of DVR disk

nDVRType

DVR type, refer to enum DHDEV_DEVICE_TYPE

nChanNum

number of DVR channel

Member
byLimitLoginTime

Online Timeout, Not Limited Access to 0, not 0 Minutes Limit Said

byLeftLogTimes

When login failed due to password error, notice user via this parameter,

remaining login times is 0 means this parameter is invalid

bReserved

keep bytes, bytes aligned

nLockLeftTime

when log in failed, the left time for users to unlock (seconds), -1 indicate the

device havent set the parameter.

Reserved

reserved

tagVideoFrameParam

Option Instruction

Struct
Frame parameter struct of Callback video data frame
description

194/339
Option Instruction

typedef struct _tagVideoFrameParam

BYTE encode;

BYTE frametype;

BYTE format;
Struct
BYTE size;

DWORD fourcc;

DWORD reserved;

NET_TIME struTime;

} tagVideoFrameParam;

encode

Encode type

Different value corresponds to different encode type:

MPEG4 encode: 1

Dahua H264 encode: 2

ADI H264 encode: 3

Standard H264 encode:- 4

frametype

frame type

Member different value corresponds to different frame type:

I frame - 0

P frame - 1

B frame - 2

format

video format

different value corresponds to different different video format:

PAL 0

NTSC - 1

size

195/339
Option Instruction

resolution ratio

different value corresponds to different different video resolution ratio:

CIF 0

HD1 1

2CIF 2

D1 3

VGA 4

QCIF 5

QVGA 6

SVCD 7

QQVGA 8

SVGA 9

XVGA 10

WXGA 11

SXGA 12

WSXGA 13

UXGA 14

WUXGA 15

LFT 16

720 17

1080 - 18

fourcc

If it is H264 encode type, the parameter value is always 0. Or is

*( DWORD*)"DIVX" that is 0x58564944

reserved

reserved

struTime

Time information

See struct NET_TIME for information

196/339
tagCBPCMDataParam

Option Instruction

Struct
Frame parameter struct of audio data callback
description

typedef struct _tagCBPCMDataParam

BYTE channels;

BYTE samples;
Struct
BYTE depth;

BYTE param1;

DWORD reserved;

} tagCBPCMDataParam;

channels

Track amount

samples

sample rate

different value corresponds to different different sample rate:

0 8000

1 11025

2 - 16000

3 - 22050
Member
4 - 32000

5 - 44100

6 - 48000

depth

Sampling depth. Value:8/16 show directly

param1

audio data type

0 - indication no symbol

1 - indication with symbol

197/339
Option Instruction

reserved

reserved

NET_TIME

Option Instruction

Struct
Time structexact to second
description

typedef struct

DWORD dwYear;

DWORD dwMonth;

Struct DWORD dwDay;

DWORD dwHour;

DWORD dwMinute;

DWORD dwSecond;

} NET_TIME,*LPNET_TIME;

dwYear

year

dwMonth

month

dwDay

day
Member
dwHour

hour

dwMinute

minute

dwSecond

second

198/339
NET_RECORDFILE_INFO

Option Instruction

Struct
Record file info struct
description

typedef struct

unsigned int ch;

char filename[124];

unsigned int framenum;

unsigned int size;

NET_TIME starttime;

Struct NET_TIME endtime;

unsigned int driveno;

unsigned int startcluster;

BYTE nRecordFileType;

BYTE bImportantRecID;

BYTE bHint;

BYTE bRecType;

} NET_RECORDFILE_INFO, *LPNET_RECORDFILE_INFO;

ch

Channel number

filename

File name

framenum

Member the total number of file frames

size

File length

starttime

Start time

endtime

199/339
Option Instruction

End time

driveno

HDD number

(used to distinguish net record and local record.0127local record,64:HDD

1,128:net record)

startcluster

Initial cluster number

nRecordFileType

record file type

0:general record;1:alarm record;

2:motion detection;3:card number record ;

4:image 5:intelligent record

bImportantRecID

flag of whether its important record

0:general record 1:Important record

bHint

Document Indexing

(nRecordFileType==4<picture>bImportantRecID<<8 +bHint make up

picture locate index)

bRecType

stream type

0- main stream record

1-sub1 stream record

2-sub2 stream record

3-sub3 stream record

CFG_PTZ_PROTOCOL_CAPS_INFO
Option Instruction

Struct PTZ capability set information

200/339
Option Instruction

description

typedef struct tagCFG_PTZ_PROTOCOL_CAPS_INFO

int nStructSize;

BOOL bPan;

BOOL bTile;

BOOL bZoom;

BOOL bIris;

BOOL bPreset;

BOOL bRemovePreset;

BOOL bTour;

BOOL bRemoveTour;

BOOL bPattern;

BOOL bAutoPan;

BOOL bAutoScan;
Struct
BOOL bAux;

BOOL bAlarm;

BOOL bLight;

BOOL bWiper;

BOOL bFlip;

BOOL bMenu;

BOOL bMoveRelatively;

BOOL bMoveAbsolutely;

BOOL bReset;

BOOL bGetStatus;

BOOL bSupportLimit;

BOOL bPtzDevice;

BOOL bIsSupportViewRange;

WORD wCamAddrMin;

201/339
Option Instruction

WORD wCamAddrMax;

WORD wMonAddrMin;

WORD wMonAddrMax;

WORD wPresetMin;

WORD wPresetMax;

WORD wTourMin;

WORD wTourMax;

WORD wPatternMin;

WORD wPatternMax;

WORD wTileSpeedMin;

WORD wTileSpeedMax;

WORD wPanSpeedMin;

WORD wPanSpeedMax;

WORD wAutoScanMin;

WORD wAutoScanMax;

WORD wAuxMin;

WORD wAuxMax;

DWORD dwInterval;

DWORD dwType;

DWORD dwAlarmLen;

DWORD dwNearLightNumber;

DWORD dwFarLightNumber;

DWORD dwSupportViewRangeType;

DWORD dwSupportFocusMode;

char szName[MAX_PROTOCOL_NAME_LEN];

char

szAuxs[CFG_COMMON_STRING_32][CFG_COMMON_STRING_32];

CFG_PTZ_MOTION_RANGE stuPtzMotionRange;

CFG_PTZ_LIGHTING_CONTROL stuPtzLightingControl;

202/339
Option Instruction

BOOL bSupportPresetTimeSection;

BOOL bFocus;

}CFG_PTZ_PROTOCOL_CAPS_INFO;

nStructSize

set to sizeof(CFG_PTZ_PROTOCOL_CAPS_INFO) when used

bPan

Whether to support PTZ horizontal swing bTile

bTile

Whether to support PTZ vertical swinging

bZoom

Whether to support PTZ changed times

bIris

Whether to support PTZ aperture adjustment

bPreset

Whether to support the preset point

bRemovePreset
Member
Whether to support removal of preset point

bTour

Whether to support automatic cruise lines

bRemoveTour

Whether to support Clear cruise

bPattern

Whether to support the track line

bAutoPan

Whether to support automatic level swing

bAutoScan

Whether to support automatic scanning

bAux

Whether to support accessibility

203/339
Option Instruction

bAlarm

Support alarm function

bLight

Whether or not support the lighting, the contents see below

"stuPtzLightingControl".

bWiper

Whether or not support the wipers

bFlip

Whether or not support Flip camera

bMenu

Whether or not support PTZ built-in menus

bMoveRelatively

Whether or not support the PTZ by a relative coordinate positioning

bMoveAbsolutely

Whether or not support PTZ in absolute coordinates

bReset

Whether or not support PTZ reset

bGetStatus

Whether or not support Get the state of motion and orientation coordinates of

PTZ

bSupportLimit

Whether or not support the limit

bPtzDevice

Whether or not support PTZ equipment

bIsSupportViewRange

Whether or not support PTZ visible range

wCamAddrMin

The minimum channel address

wCamAddrMax

204/339
Option Instruction

The maximum number of channel address

wMonAddrMin

Minimum monitoring addresses

wMonAddrMax

The maximum number of monitoring the address

wPresetMin

Minimum preset points

wPresetMax

The maximum preset points

wTourMin

The minimum value of automatic cruise lines

wTourMax

The maximum number of automatic cruise lines

wPatternMin

The minimum value of track circuit

wPatternMax

The maximum number of track circuit

wTileSpeedMin

The minimum value of vertical speed

wTileSpeedMax

The maximum vertical speed

wPanSpeedMin

The minimum value of horizontal velocity

wPanSpeedMax

The maximum horizontal velocity

wAutoScanMin

The minimum value of automatic scanning

wAutoScanMax

The maximum number of automatic scanning

205/339
Option Instruction

wAuxMin

The minimum value of auxiliary functions

wAuxMax

The maximum number of auxiliary functions

dwInterval

Send the command time interval

dwType

The type of agreement, 0 - Local PTZ 1 - Remote PTZ

dwAlarmLen

The length of the alarm of the agreement

dwNearLightNumber

The number of near light group, 0-4, 0 means not supported

dwFarLightNumber

The number of beam group, 0-4, 0 means not supported

dwSupportViewRangeType

Visual field data acquisition mode supported by the mask, from low to high

depending on the number , currently supported.

The first 1: 1 expressed support the "ElectronicCompass" electronic compass

mode.

dwSupportFocusMode

Supported Focus mode mask, from low to high depending on the number,

see enum EM_SUPPORT_FOCUS_MODE

szName

The name of the protocol operations

szAuxs

PTZ auxiliary function names list

stuPtzMotionRange

PTZ rotation angle range, unit: degree,see struct

CFG_PTZ_MOTION_RANGEfor details

206/339
Option Instruction

stuPtzLightingControl

Lighting control content, see struct CFG_PTZ_LIGHTING_CONTROL for

details

bSupportPresetTimeSection

Whether to support the function of the preset point time configuration

bFocus

Whether to support to Ptz focus

CFG_PTZ_MOTION_RANGE
Option Instruction

Struct
PTZ rotation angle rang struct
description

typedef struct tagCFG_PTZ_MOTION_RANGE

int nHorizontalAngleMin;

Struct int nHorizontalAngleMax;

int nVerticalAngleMin;

int nVerticalAngleMax;

}CFG_PTZ_MOTION_RANGE;

nHorizontalAngleMin

Minimum level angle range, unit: degree

nHorizontalAngleMax

The maximum horizontal angle range, unit: degree

Member
nVerticalAngleMin

Vertical angle range minimum, unit: degree

nVerticalAngleMax

Maximum vertical angle range, unit: degree

207/339
CFG_PTZ_LIGHTING_CONTROL

Option Instruction

Struct description PTZ rotation angle range, unit: degree

typedef struct tagCFG_PTZ_LIGHTING_CONTROL

char szMode[CFG_COMMON_STRING_32];
Struct
DWORD dwNearLightNumber;

DWORD dwFarLightNumber;

}CFG_PTZ_LIGHTING_CONTROL;

szMode

Manual Lighting Control Mode

"on-off"Direct Switch Mode,

"adjustLight"Manually Adjust Brightness Mode

Member
dwNearLightNumber

The number of near light group

dwFarLightNumber

The number of beam group

DHDEV_TALKFORMAT_LIST
Option Instruction

Strict description The audio talk type the device supported

typedef struct

Int nSupportNum;
Struct
DHDEV_TALKDECODE_INFO type[64];

Char reserved[64];

} DHDEV_TALKFORMAT_LIST;

nSupportNum
Member
amount

208/339
Option Instruction

type

Encode type

See struct DHDEV_TALKDECODE_INFO for details

reserved

reserved

DHDEV_TALKDECODE_INFO

Option Instruction

Struct description Audio encode information

typedef struct

DH_TALK_CODING_TYPE encodeType;

int nAudioBit;
Struct
DWORD dwSampleRate;

int nPacketPeriod;

char reserved[60];

} DHDEV_TALKDECODE_INFO;

encodeType

Encode type

See enum DH_TALK_CODING_TYPE for details

nAudioBit

Bit:8/16

Member dwSampleRate

Sampling rate such as 8000 or 16000

nPacketPeriod

Pack Period,Unit:ms

reserved

reserved

209/339
DHDEV_SYSTEM_ATTR_CFG

Option Instruction

Struct description System information

typedef struct

DWORD dwSize;

/* The following are read only for device */

DH_VERSION_INFO stVersion;

DH_DSP_ENCODECAP stDspEncodeCap;

BYTE szDevSerialNo[DH_DEV_SERIALNO_LEN];

BYTE byDevType;

BYTE szDevType[DH_DEV_TYPE_LEN];

BYTE byVideoCaptureNum;

BYTE byAudioCaptureNum;

BYTE byTalkInChanNum;

BYTE byTalkOutChanNum;

Struct BYTE byDecodeChanNum;

BYTE byAlarmInNum;

BYTE byAlarmOutNum;

BYTE byNetIONum;

BYTE byUsbIONum;

BYTE byIdeIONum;

BYTE byComIONum;

BYTE byLPTIONum;

BYTE byVgaIONum;

BYTE byIdeControlNum;

BYTE byIdeControlType;

BYTE byCapability;

BYTE byMatrixOutNum;

/* The following are read-write part for device */

210/339
Option Instruction

BYTE byOverWrite;

BYTE byRecordLen;

BYTE byDSTEnable;

WORD wDevNo;

BYTE byVideoStandard;

BYTE byDateFormat;

BYTE byDateSprtr;

BYTE byTimeFmt;

BYTE byLanguage;

} DHDEV_SYSTEM_ATTR_CFG, *LPDHDEV_SYSTEM_ATTR_CFG;

dwSize

size of struct, the parameter can be set to

sizeof(DHDEV_SYSTEM_ATTR_CFG) when used

/* The following are read only for device */

stVersion

device version information, see struct DH_VERSION_INFO for details

stDspEncodeCap

DSP capability description, see struct DH_DSP_ENCODECAP for details

szDevSerialNo

Member SN

ByDevType

device type. Please refer to enumeration DHDEV_DEVICE_TYPE

szDevType

Device detailed type. String format. It may be empty.

ByVideoCaptureNum

Video port amount

ByAudioCaptureNum

Audio port amount

byTalkInChanNum

211/339
Option Instruction

NSP

ByTalkOutChanNum

NSP

byDecodeChanNum

NSP

ByAlarmInNum

Alarm input port amount

ByAlarmOutNum

Alarm output amount port

ByNetIONum

network port amount

byUsbIONum

USB port amount

ByIdeIONum

IDE amount

ByComIONum

COM amount

ByLPTIONum

LPT amount

byVgaIONum

NSP

byIdeControlNum

NSP

byIdeControlType

NSP

byCapability

NSP, expansible description

ByMatrixOutNum

video matrix output amount

212/339
Option Instruction

/* The following are read-write part for device */

ByOverWrite

Deal method when HDD is full, (1:overwrite; 0: stop)

ByRecordLen

Video Package length

ByDSTEnable

Enable DTS or not 1--enable. 0--disable

WDevNo

Device serial number. Remote control can use this SN to control.

ByVideoStandard

Video format

ByDateFormat

Date format

ByDateSprtr

Date separator(0:".",1:"-",2:"/")

ByTimeFmt

Time separator (0-24H,1-12H)

byLanguage

Please refer to DH_LANGUAGE_TYPE for enumeration value

NET_SPEAK_PARAM
Option Instruction

Struct description Audio talk parameter struct

typedef struct __NET_SPEAK_PARAM

DWORD dwSize;
Struct
int nMode;

int nSpeakerChannel;

BOOL bEnableWait;

213/339
Option Instruction

} NET_SPEAK_PARAM;

dwSize

struct sizeset to sizeof(NET_SPEAK_PARAM) when used

nMode

mode type

0: talk back(default), 1: propaganda,from propaganda ro talk back,need

afresh to configure

Member nSpeakerChannel

reproducer channel, valid when nMode ==1.

bEnableWait

Wait for device to responding or not when enable bidirectional talk. Default

setup is no.TRUE:wait ;FALSE:no, the timeout time is set by

CLIENT_SetNetworkParam, corresponds to nWaittime in struct

NET_PARAM.

NET_TALK_TRANSFER_PARAM

Option Instruction

Struct description Open the forwarding mode of intercom or not

typedef struct tagNET_TALK_TRANSFER_PARAM

Struct DWORD dwSize;

BOOL bTransfer;

}NET_TALK_TRANSFER_PARAM;

dwSize

sizeof sturct, set to sizeof(NET_TALK_TRANSFER_PARAM) when used.

Member
bTransfer

Open the forwarding mode of intercom or not, TRUE: yes, FALSE: no

214/339
DEVICE_NET_INFO_EX

Option Instruction

Struct description Callback info struct of to CLIENT_StartSearchDevices

typedef struct

int iIPVersion;

char szIP[64];

int nPort;

char szSubmask[64];

char szGateway[64];

char szMac[DH_MACADDR_LEN];

char szDeviceType[DH_DEV_TYPE_LEN];

BYTE byManuFactory;

BYTE byDefinition;

bool bDhcpEn;

BYTE byReserved1;

Struct char verifyData[88];

char szSerialNo[DH_DEV_SERIALNO_LEN];

char szDevSoftVersion[DH_MAX_URL_LEN];

char szDetailType[DH_DEV_TYPE_LEN];

char szVendor[DH_MAX_STRING_LEN];

char szDevName[DH_MACHINE_NAME_NUM];

char szUserName[DH_USER_NAME_LENGT H_EX];

char szPassWord[DH_USER_NAME_LENGTH_EX];

unsigned short nHttpPort;

WORD wVideoInputCh;

WORD wRemoteVideoInputCh;

WORD wVideoOutputCh;

WORD wAlarmInputCh;

WORD wAlarmOutputCh;

215/339
Option Instruction

char cReserved[244];

}DEVICE_NET_INFO_EX;

iIPVersion

ip version, 4 for IPV4 6 for IPV6

szIP

IP IPV4 like"192.168.0.1" IPV6 like "2008::1/64"

nPort

tcp port

szSubmask

Subnet mask(IPV6 do not have subnet mask)

szGateway

Gateway

szMac

MAC address

szDeviceType

Member Device type

byManuFactory

device manufactory, see class EM_IPC_TYPE

byDefinition

1-Standard definition 2-High definition

bDhcpEn

Dhcp, true-open, false-close

byReserved1

reserved, used for byte alignment

verifyData

verify data, obtained in CLIENT_StartSearchDevices callback function(the

data can be used to verify when modifying IP)

szSerialNo

SN

216/339
Option Instruction

szDevSoftVersion

soft version

szDetailType

device detail type

szVendor

OEM type

SzDevName

Device name

szUserName

user name for log in device(it need be filled when modify device ip)

szPassWord

pass word for log in device(it need be filled when modify device ip)

nHttpPort

HTTP server port

wVideoInputCh

count of video input channel

wRemoteVideoInputCh

count of remote video input

wVideoOutputCh

count of video output channel

wAlarmInputCh

count of alarm input

wAlarmOutputCh

count of alarm output

cReserved

reserved

217/339
MANUAL_SNAP_PARAMETER

Option Instruction

Struct
Manual snap parameter
description

typedef struct _MANUAL_SNAP_PARAMETER{

int nChannel;

Struct BYTE bySequence[64];

BYTE byReserved[60];

}MANUAL_SNAP_PARAMETER;

nChannel

snap channel,start with 0

bySequence

snap sequence string, the string can be returned when corresponding

Member intelligent picture reported.

If triggering multiple manual snap events at the same time, user can identify

witch snap is by this parameter.

byReserved

reserved

OPR_RIGHT_EX

Option Instruction

Struct
Right information
description

typedef struct _OPR_RIGHT_EX

DWORD dwID;
Struct
char name[DH_RIGHT_NAME_LENGT H];

char memo[DH_MEMO_LENGTH];

} OPR_RIGHT_EX;

218/339
Option Instruction

dwID

right ID, each right has its own ID.

name
Member
right name

memo

right note

OPR_RIGHT_NEW

Option Instruction

Struct description Right information

typedef struct _OPR_RIGHT_NEW

DWORD dwSize;

Struct DWORD dwID;

char name[DH_RIGHT_NAME_LENGT H];

char memo[DH_MEMO_LENGTH];

} OPR_RIGHT_NEW;

dwSize

size of struct, set to sizeof(OPR_RIGHT_NEW) when used

dwID

right ID, each right has its own ID.

Member
name

Right name

memo

note

NET_DEV_CHN_COUNT_INFO

Option Instruction

219/339
Option Instruction

Struct
Device channel amount information struct
description

typedef struct tagNET_DEV_CHN_COUNT_INFO

DWORD dwSize;
Struct
NET_CHN_COUNT_INFO stuVideoIn;

NET_CHN_COUNT_INFO stuVideoOut;

} NET_DEV_CHN_COUNT_INFO;

dwSize

size of struct, set to sizeof(NET_DEV_CHN_COUNT_INFO) when used

stuVideoIn
Member
Video Input Channel, see struct NET_CHN_COUNT_INFO for details.

stuVideoOut

Video Output Channel,see struct NET_CHN_COUNT_INFO for details.

NET_CHN_COUNT_INFO
Option Instruction

Struct
Channel number information
description

typedef struct tagNET_CHN_COUNT_INFO

DWORD dwSize;

int nMaxTotal;

int nCurTotal;
Struct
int nMaxLocal;

int nCurLocal;

int nMaxRemote;

int nCurRemote;

} NET_CHN_COUNT_INFO;

220/339
Option Instruction

dwSize

size of struct, set to sizeof(NET_CHN_COUNT_INFO) when used

nMaxTotal

Equipment to the total number of channels (the sum of all valid channel

number

nCurTotal

the number of configured on channels

nMaxLocal
Member
Maximum number of local channels, including motherboard and pluggable

cartoon

nCurLocal

configured local channel number

nMaxRemote

Maximum number of remote channel

nCurRemote

Configured remote channel number

NET_IN_SNAP_CFG_CAPS
Option Instruction

Struct
Snap configure capacity input parameter
description

typedef struct tagNET_IN_SNAP_CFG_CAPS

Struct int nChannelId;

BYTE bReserved[1024];

}NET_IN_SNAP_CFG_CAPS;

nChannelId

Member channel NO.

bReserved

221/339
Option Instruction

reserved

NET_OUT_SNAP_CFG_CAPS

Option Instruction

Struct
Snap configure capacity output parameter
description

typedef struct tagNET_OUT_SNAP_CFG_CAPS

int nResolutionTypeNum;

DH_RESOLUTION_INFO stuResolutionTypes[DH_MAX_CAPT URE_SIZE_

NUM];

DWORD dwFramesPerSecNum;

Struct int nFramesPerSecList[DH_MAX_FPS_NUM];

DWORD dwQualityMun;

DWORD nQualityList[DH_MAX_QUALITY_NUM];

DWORD dwMode;

DWORD dwFormat;

BYTE bReserved[2048];

} NET_OUT_SNAP_CFG_CAPS;

nResolutionTypeNum

NO. of supported video resolution infor, used corresponding with parameter

stuResolutionTypes

stuResolutionTypes

Member resolution info struct, used corresponding with parameter

nResolutionTypeNum

dwFramesPerSecNum

NO. of supported frame rate info, used corresponding with parameter

nFramesPerSecLis

222/339
Option Instruction

nFramesPerSecList

frame rate list

dwQualityMun

supported video quality info, used corresponding with parameter nQualityList

nQualityList

video quality info list , used corresponding with parameter dwQualityMun

dwMode

mode presented in bit: bit 1: fixed time ,bit 2: manual

dwFormat

picture format presented in bit: bit 1:bmp, bit 2: jpg

bReserved

reserved

DH_RESOLUTION_INFO

Option Instruction

Struct
Image resolution struct
description

typedef struct

Struct unsigned short snWidth;

unsigned short snHight;

}DH_RESOLUTION_INFO;

snWidth

width
Member
snHight

heigh

DEOENC_ VIDEOENC_OPT

Option Instruction

223/339
Option Instruction

Struct
Video encode parameter
description

typedef struct tagCFG_VIDEOENC_OPT

bool abVideoEnable;

bool abAudioEnable;

bool abSnapEnable;

bool abAudioAdd;

bool abAudioFormat;
Struct
BOOL bVideoEnable;

CFG_VIDEO_FORMAT stuVideoFormat;

BOOL bAudioEnable;

BOOL bSnapEnable;

BOOL bAudioAddEnable;

CFG_AUDIO_ENCODE_FORMAT stuAudioFormat;

} CFG_VIDEOENC_OPT;

abVideoEnable

used to indicate whether bVideoEnable is valid.

in obtaining, it used to indentify whether supporting video enabled or not

in setting, it used to indicate whether supporting video enabled or not

abAudioEnable

used to indicate whether bAudioEnable is valid.

Member in obtaining, it used to indentify whether supporting audio enabled or not

in setting, it used to indicate whether supporting audio enabled or not

abSnapEnable

used to indicate whether abSnapEnable is valid.

in obtaining, it used to indentify whether supporting timer snapshot or not

in setting, it used to indicate whether supporting timer snapshot or not

abAudioAdd

224/339
Option Instruction

used to indicate whether bAudioAddEnableis valid.

in obtaining, it used to indentify whether supporting audio add enabled or not

in setting, it used to indicate whether supporting audio add or not

abAudioFormat

used to indicate whether stuAudioFormatvalid.

in obtaining, it used to indentify whether supporting audio format or not

in setting, it used to indicate whether supporting audio format or not

sbVideoEnable

Video enable, used matched with abVideoEnable

stuVideoFormat

Video format, see struct CFG_VIDEO_FORMAT for details

bAudioEnable

Audio enable, used matched with abAudioEnable

bSnapEnable

Schedule snapshot enable, used matched with abSnapEnable

bAudioAddEnable

Audio add enable, used matched with abAudioAdd

stuAudioFormat

Audio format, used matched with abAudioFormat, see struct

CFG_AUDIO_ENCODE_FORMAT for details.

CFG_VIDEO_FORMAT

Option Instruction

Struct
Video format struct
description

typedef struct tagCFG_VIDEO_FORMAT

{
Struct
bool abCompression;

bool abWidth;

225/339
Option Instruction

bool abHeight;

bool abBitRateControl;

bool abBitRate;

bool abFrameRate;

bool abIFrameInterval;

bool abImageQuality;

bool abFrameType;

bool abProfile;

CFG_VIDEO_COMPRESSION emCompression;

int nWidth;

int nHeight;

CFG_BITRATE_CONTROL emBitRateControl;

int nBitRate;

float nFrameRate;

int nIFrameInterval;

CFG_IMAGE_QUALITY emImageQuality;

int nFrameType;

CFG_H264_PROFILE_RANK emProfile;

} CFG_VIDEO_FORMAT;

abCompression

TRUEemCompression is valid; FALSEemCompression is invalid

The parameter is read only, and subject to obtaining. Not recommended to

be modified.

abWidth
Member
TRUEnWidth is valid ; FALSEnWidth is invalid

The parameter is read only, and subject to obtaining. Not recommended to

be modified.

abHeight

TRUEnHeight is validFALSEnHeight is invalid

226/339
Option Instruction

The parameter is read only, and subject to obtaining. Not recommended to

be modified.

abBitRateControl

TRUEemBitRateControl is validFALSEemBitRateControl is invalid

The parameter is read only, and subject to obtaining. Not recommended to

be modified.

abBitRate

TRUEnBitRate is validFALSEnBitRate is invalid

The parameter is read only, and subject to obtaining. Not recommended to

be modified.

abFrameRate

TRUEnFrameRate is validFALSEnFrameRate is invalid

The parameter is read only, and subject to obtaining. Not recommended to

be modified.

abIFrameInterval

TRUEnIFrameInterval is validFALSEnIFrameInterval is invalid

The parameter is read only, and subject to obtaining. Not recommended to

be modified.

abImageQuality

TRUEemImageQuality is validFALSEemImageQuality is invalid

The parameter is read only, and subject to obtaining. Not recommended to

be modified.

abFrameType

TRUEnFrameType is validFALSEnFrameType is invalid

The parameter is read only, and subject to obtaining. Not recommended to

be modified.

abProfile

TRUEemProfile is validFALSEemProfile is invalid

The parameter is read only, and subject to obtaining. Not recommended to

227/339
Option Instruction

be modified.

emCompression

Video compression mode

If this parameter is valid is decided by abCompression, see enum

CFG_VIDEO_COMPRESSION for details.

nWidth

video width

Whether this parameter valid or not is decided by abCompression

nHeight

video height

Whether this parameter valid or not is decided by abHeight

emBitRateControl

stream control mode

Whether this parameter valid or not is decided by abBitRateControl,see enum

CFG_BITRATE_CONTROL for details.

nBitRate

video stream (kbps)

Whether this parameter valid or not is decided by abBitRate

nFrameRate

video frame rate

Whether this parameter valid or not is decided by abFrameRate

nIFrameInterval

I frame interval(1-100). For example, 50 means there is I frame in each 49 B

frame or P frame.

Whether this parameter valid or not is decided by abIFrameInterval

emImageQuality

Video quality

Whether this parameter valid or not is decided by abImageQuality, see enum

CFG_IMAGE_QUALITY for details.

228/339
Option Instruction

nFrameType

Sniffer mode,0-DHAV,1-"PS"

Whether this parameter valid or not is decided by abFrameType

emProfile

H.264 Encode level

Whether this parameter valid or not is decided by abProfile, see enum

CFG_H264_PROFILE_RANK for details.

CFG_AUDIO_ENCODE_FORMAT
Option Instruction

Struct
Audion format
description

typedef struct tagCFG_AUDIO_FORMAT

bool abCompression;

bool abDepth;

bool abFrequency;

bool abMode;

bool abFrameType;

Struct bool abPacketPeriod;

CFG_AUDIO_FORMAT emCompression;

AV_int32 nDepth;

AV_int32 nFrequency;

AV_int32 nMode;

AV_int32 nFrameType;

AV_int32 nPacketPeriod;

} CFG_AUDIO_ENCODE_FORMAT;

abCompression
Member
TRUEemCompression is valid;FALSEemCompression is invalid

229/339
Option Instruction

The parameter is read only, and subject to obtaining. Not recommended to

be modified.

abDepth

TRUEnDepth is valid;FALSEnDepth is invalid

The parameter is read only, and subject to obtaining. Not recommended to

be modified.

abFrequency

TRUEnFrequency is valid;FALSEnFrequency is invalid

The parameter is read only, and subject to obtaining. Not recommended to

be modified.

abMode

TRUEnMode is valid; FALSEnMode is invalid

The parameter is read only, and subject to obtaining. Not recommended to

be modified.

abFrameType

TRUEnFrameType is valid;FALSEnFrameType is invalid

The parameter is read only, and subject to obtaining. Not recommended to

be modified.

abPacketPeriod

TRUEnPacketPeriod is valid;FALSEnPacketPeriod is invalid

The parameter is read only, and subject to obtaining. Not recommended to

be modified.

emCompression

Audio compression mode

Whether this parameter valid or not is decided by abCompression, see enum

CFG_AUDIO_FORMAT for details.

nDepth

Audio sampling depth

Whether this parameter valid or not is decided by abDepth.

230/339
Option Instruction

nFrequency

Audio sampling frequency

Whether this parameter valid or not is decided by abFrequency

nMode

Audio encode mode

Whether this parameter valid or not is decided by abMode

nFrameType

audio pack mode, 0-DHAV, 1-PS Audio pack mode

Whether this parameter valid or not is decided by abFrameType

nPacketPeriod

Audio pack period(unit: ms)

Whether this parameter valid or not is decided by abPacketPeriod

CFG_VIDEO_COVER

Option Instruction

Struct
Multiple-zone mask configuration
description

typedef struct tagCFG_VIDEO_COVER

int nTotalBlocks;
Struct
int nCurBlocks;

CFG_COVER_INFO stuCoverBlock[MAX_VIDEO_COVER_NUM];

} CFG_VIDEO_COVER;

nTotalBlocks

The supported privacy mask zone amount

nCurBlocks
Member
The amount of zones already set.

stuCoverBlock

The mask zone, see struct CFG_COVER_INFO for details

231/339
Option Instruction

CFG_COVER_INFO

Option Instruction

Struct
Privacy mask information
description

typedef struct tagCFG_COVER_INFO

bool abBlockType;

bool abEncodeBlend;

bool abPreviewBlend;

Struct CFG_RECT stuRect;

CFG_RGBA stuColor;

int nBlockType;

int nEncodeBlend;

int nPreviewBlend;

} CFG_COVER_INFO;

abBlockType

TRUEnBlockType is valid; FALSEnBlockType is invalid

The parameter is read only, and subject to obtaining. Not recommended to

be modified.

abEncodeBlend

Member TRUEnEncodeBlend is valid; FALSEnEncodeBlend is invalid

The parameter is read only, and subject to obtaining. Not recommended to

be modified.

abPreviewBlend

TRUEnPreviewBlend is valid; FALSEnPreviewBlend is invalid

The parameter is read only, and subject to obtaining. Not recommended to

232/339
Option Instruction

be modified.

stuRect

The position (coordinates) of the mask zone, see struct CFG_RECT for

details.

stuColor

The mask color, see struct CFG_RGBA for details.

nBlockType

The mask mode ;0-black block,1-Mosaic

Whether this parameter valid or not is decided by abBlockType.

nEncodeBlend

Encode-level privacy mask;1-enable,0-disable

Whether this parameter valid or not is decided by abEncodeBlend.

nPreviewBlend

Preview mask;1-enable,0-disable

Whether this parameter valid or not is decided by abPreviewBlend.

CFG_RECT

Option Instruction

Struct
Zone information
description

typedef struct tagCFG_RECT

int nLeft;

Struct int nTop;

int nRight;

int nBottom;

} CFG_RECT;

nLeft
Member
left side of the zone

233/339
Option Instruction

nTop

top of the zone

nRight

right side of the zone

nBottom

buttom of the zone

CFG_RGBA

Option Instruction

Struct
RGBA information
description

typedef struct tagCFG_RGBA

int nRed;

Struct int nGreen;

int nBlue;

int nAlpha;

} CFG_RGBA;

nRed

red

nGreen

green
member
nBlue

blue

nAlpha

pellucidity

CFG_ENCODE_INFO

Option Instruction

234/339
Option Instruction

Struct
Video channel property information
description

typedef struct tagCFG_ENCODE_INFO

int nChannelID;

char szChnName[MAX_CHANNELNAME_LEN];

CFG_VIDEOENC_OPT stuMainStream[MAX_VIDEOSTREAM_NUM];

CFG_VIDEOENC_OPT stuExtraStream[MAX_VIDEOSTREAM_NUM];

CFG_VIDEOENC_OPT stuSnapFormat[MAX_VIDEOSTREAM_NUM];

DWORD dwCoverAbilityMask;
Struct
DWORD dwCoverEnableMask;

CFG_VIDEO_COVER stuVideoCover;

CFG_OSD_INFO stuChnTitle;

CFG_OSD_INFO stuTimeTitle;

CFG_COLOR_INFO stuVideoColor;

CFG_AUDIO_FORMAT emAudioFormat;

int nProtocolVer;

} CFG_ENCODE_INFO;

nChannelID

Channel number(Begins with 0)

valid when obtaining, invalid when setting

szChnName

invalid parameter

Member stuMainStream

main stream property information

stuMainStream[0]-General record property information

stuMainStream[1]-Motion detect record property information

stuMainStream[2]-alarm record property information

see struct CFG_VIDEOENC_OPT for details

235/339
Option Instruction

stuExtraStream

sub-stream property information

stuExtraStream[0]-General record property information

stuExtraStream[1]-Motion detect record property information

stuExtraStream[2]-alarm record property information

see struct CFG_VIDEOENC_OPT for details.

stuSnapFormat

snapshot property information

stuSnapFormat[0]0-General snapshot property information

stuSnapFormat[1]Motion detect snapshot property information

stuSnapFormat[2]alarm snapshot property information

see struct CFG_VIDEOENC_OPT for details

dwCoverAbilityMask

invalid parameter

dwCoverEnableMask

invalid parameter

stuVideoCover

invalid parameter

stuChnTitle

invalid parameter

stuTimeTitle

invalid parameter

stuVideoColor

invalid parameter

emAudioFormat

invalid parameter

nProtocolVer

Protocol Version No., read only

valid when obtaining, invalid when setting

236/339
SNAP_PARAMS

Option Instruction

Struct
Snapshot parameter structure
description

typedef struct _snap_param

unsigned int Channel;

unsigned int Quality;

unsigned int ImageSize;

Struct
unsigned int mode;

unsigned int InterSnap;

unsigned int CmdSerial;

unsigned int Reserved[4];

} SNAP_PARAMS, *LPSNAP_PARAMS;

Channel

Snapshot channel

Quality

Image quality: evel 1 to level 6,the bigger the value is, the better quality the

image is

ImageSize

Invalide parameter
Member
Mode

Snapshot mode

-1:stop snapshotting

0:request one frame

1:send out requestion regularly

2: Request consecutively

InterSnap

237/339
Option Instruction

Snapshot interval(unit: s)

If mode=1, it means send out requestion regularly. Only certain special

device(such as mobile device) sets snapshot interval through this parameter.

Other device is suggested to realize related function through setting

parameter tuSnapFormat[nSnapMode].stuVideoFormat.nFrameRate in

configure CFG_CMD_ENCODE

CmdSerial

Snapshot Request serial number, valid range 0~65535, over this range will be

cut to unsigned short.

Reserved

reserved

DH_VERSION_INFO

Option Instruction

Struct Device software version information. The higher 16-bit means the main version

description number and low 16-bit means second version number.

typedef struct

DWORD dwSoftwareVersion;

DWORD dwSoftwareBuildDate;

DWORD dwDspSoftwareVersion;

DWORD dwDspSoftwareBuildDate;
Struct
DWORD dwPanelVersion;

DWORD dwPanelSoftwareBuildDate;

DWORD dwHardwareVersion;

DWORD dwHardwareDate;

DWORD dwWebVersion;

DWORD dwWebBuildDate;

238/339
Option Instruction

} DH_VERSION_INFO, *LPDH_VERSION_INFO;

dwSoftwareVersion

software version

dwSoftwareBuildDate

software version build date

dwDspSoftwareVersion

dsp software version

dwDspSoftwareBuildDate

dsp software version build date

dwPanelVersion

not used
Member
dwPanelSoftwareBuildDate

not used

dwHardwareVersion

hardware version

dwHardwareDate

not used

dwWebVersion

web version

dwWebBuildDate

web version build date

DH_DSP_ENCODECAP
Option Instruction

Struct
DSP capacity description
description

typedef struct

Struct {

DWORD dwVideoStandardMask;

239/339
Option Instruction

DWORD dwImageSizeMask;

DWORD dwEncodeModeMask;

DWORD dwStreamCap;

DWORD dwImageSizeMask_Assi[8];

DWORD dwMaxEncodePower;

WORD wMaxSupportChannel;

WORD wChannelMaxSetSync;

} DH_DSP_ENCODECAP, *LPDH_DSP_ENCODECAP;

dwVideoStandardMask

video format mask. Bit stands for the video format device supported.

dwImageSizeMask

Resolution mask, Bit stands for the resolution setup devices supported, see

below:

0 704*576(PAL) 704*480(NTSC)

1 352*576(PAL) 352*480(NTSC)

2 704*288(PAL) 704*240(NTSC)

3 352*288(PAL) 352*240(NTSC)

4 176*144(PAL) 176*120(NTSC)
Member
5 640*480

6 320*240

7 480*480

8 160*128

9 800*592

10 1024*768

11 1280*800

12 1600*1024

13 1600*1200

240/339
Option Instruction

14 1920*1200

15 240*192

16 1280*720

17 1920*1080

18 1280*960

19 1872*1408

20 3744*1408

21 2048*1536

22 2432*2050

23 1216*1024

24 1408*1024

25 3296*2472

26 2560*1920(5M)

27 960*576(PAL) 960*480(NTSC)

28 960*720

dwEncodeModeMask

Encode mode mask bit. Bit stands for the encode mode devices supported.

dwStreamCap

The multiple-media function the devices supported.

The first bit:main stream

The second bit:extra stream 1

The third bit:extra stream 2

The fifth bit: snapshot in .jpg format

dwImageSizeMask_Assi

When the main stream is the corresponding resolution, the supported extra

stream resolution mask.

dwMaxEncodePower

241/339
Option Instruction

The highest encode capacity DSP supported

wMaxSupportChannel

The max video channel amount each DSP supported.

wChannelMaxSetSync

Max encode bit setup in each DSP channel are synchronized or not ;0:does

not synchronized,1:synchronized

242/339
Appendix 2 Enum definition

NET_DEVICE_TYPE
Option Instruction

Enum description Enum of device type,used to different device type.

Enum definition typedef enum tagNET_DEVICE_TYPE

NET_PRODUCT_NONE = 0,

NET_DVR_NONREALTIME_MACE, // Non real-time MACE

NET_DVR_NONREALTIME, // Non real-time

NET_NVS_MPEG1, // Network video server

NET_DVR_MPEG1_2, // MPEG1 2-ch DVR

NET_DVR_MPEG1_8, // MPEG1 8-ch DVR

NET_DVR_MPEG4_8, // MPEG4 8-ch DVR

NET_DVR_MPEG4_16, // MPEG4 16-ch DVR

NET_DVR_MPEG4_SX2, // LB series DVR

NET_DVR_MEPG4_ST2, // GB series DVR

NET_DVR_MEPG4_SH2, // HB series DVR

NET_DVR_MPEG4_GBE, // GBE series DVR

NET_DVR_MPEG4_NVSII, // II network video server

NET_DVR_STD_NEW, //New standard configuration protocol

NET_DVR_DDNS, // DDNS server

NET_DVR_ATM, // ATM series

NET_NB_SERIAL, // 2nd non real-time NB series DVR

NET_LN_SERIAL, // LN series

NET_BAV_SERIAL, // BAV series

NET_SDIP_SERIAL, // SDIP series

NET_IPC_SERIAL, //IPCseries

NET_NVS_B, // NVS B series

243/339
Option Instruction

NET_NVS_C, // NVS H series

NET_NVS_S, // NVS S series

NET_NVS_E, // NVS E series

NET_DVR_NEW_PROTOCOL, //Search device type from QueryDevState.

it is in string format.

NET_NVD_SERIAL, // NVD

NET_DVR_N5, // N5

NET_DVR_MIX_DVR, // HDVR

NET_SVR_SERIAL, // SVR series

NET_SVR_BS, //SVR-BS

NET_NVR_SERIAL, // NVR series

NET_DVR_N51, // N51

NET_ITSE_SERIAL, // ITSE Intelligent Analysis Box

NET_ITC_SERIAL, //Intelligent traffic

camera equipment

NET_HWS_SERIAL, // radar speedometer HWS

NET_PVR_SERIAL, // portable video record

NET_IVS_SERIAL, // IVS(intelligent video

server series)

NET_IVS_B, // universal intelligent

detect video server series

NET_IVS_F, // face recognisation server

NET_IVS_V, //video quality diagnosis server

NET_MATRIX_SERIAL, // matrix

NET_DVR_N52, // N52

NET_DVR_N56, // N56

NET_ESS_SERIAL, // ESS

NET_IVS_PC, // number statistic server

NET_PC_NVR, // pc-nvr

244/339
Option Instruction

NET_DSCON, // screen controller

NET_EVS, //network video storage server

NET_EIVS, //an embedded intelligent video analysis

system

NET_DVR_N6, // DVR-N6

NET_UDS, // K-Lite Codec Pack

NET_AF6016, // Bank alarm host

NET_AS5008, //Video network alarm host

NET_AH2008, //Network alarm host

NET_A_SERIAL, // Alarm host series

NET_BSC_SERIAL, //Access control series

of products

NET_NVS_SERIAL, //NVS series product

NET_VTO_SERIAL, //VTO series product

NET_VTNC_SERIAL, // VTNC series product

NET_TPC_SERIAL, //TPC series product,

it is the thermal device.

}NET_DEVICE_TYPE ;

EM_LOGIN_SPAC_CAP_TYPE

Option Instruction

Enum Enum of login type,used to select different ways to login.

description

Enum definition typedef enum tagEM_LOGIN_SPAC_CAP_TYPE

EM_LOGIN_SPEC_CAP_TCP = 0, // TCP login, default

EM_LOGIN_SPEC_CAP_ANY = 1, // No criteria login

EM_LOGIN_SPEC_CAP_SERVER_CONN=2, //auto sign up login

EM_LOGIN_SPEC_CAP_MULT ICAST=3, //multicast login, default

245/339
Option Instruction

EM_LOGIN_SPEC_CAP_UDP=4, //UDP method login

EM_LOGIN_SPEC_CAP_MAIN_CONN_ONLY=6, //only main connection

login

EM_LOGIN_SPEC_CAP_SSL=7, //SSL encryption login

EM_LOGIN_SPEC_CAP_INTELLIGENT_BOX=9, //login IVS box remote

device

EM_LOGIN_SPEC_CAP_NO_CONFIG=10, //login device do

not config

EM_LOGIN_SPEC_CAP_U_LOGIN=11, //USB key device login

EM_LOGIN_SPEC_CAP_LDAP =12, //LDAP login

EM_LOGIN_SPEC_CAP_AD=13, //AD(ActiveDirectory)

login

EM_LOGIN_SPEC_CAP_RADIUS=14, //Radius login

EM_LOGIN_SPEC_CAP_SOCKET_5=15, //Socks5 login

EM_LOGIN_SPEC_CAP_CLOUD =16, //cloud login

EM_LOGIN_SPEC_CAP_AUT H_TWICE=17,//dual authentication loin

EM_LOGIN_SPEC_CAP_TS=18, //TS stream client login

EM_LOGIN_SPEC_CAP_P2P=19, //web private login

EM_LOGIN_SPEC_CAP_MOBILE=20, //mobile client login

EM_LOGIN_SPEC_CAP_INVALID // invalid login

}EM_LOGIN_SPAC_CAP_TYPE;

DH_RealPlayType

Option Instruction

Enum description Preview type, correspond with CLIENT_RealPlayEx and

CLIENT_StartRealPlay interfaces

Enum definition typedef enum _RealPlayType

DH_RType_Realplay = 0, // Real-time preview

246/339
Option Instruction

DH_RType_Multiplay, // Multiple-channel preview

DH_RType_Realplay_0, //Real-time monitor-main stream. It is the same as

DH_RType_Realplay

DH_RType_Realplay_1, //1 Real-time monitor---extra stream 1

DH_RType_Realplay_2, //2 Real-time monitor-- extra stream 2

DH_RType_Realplay_3, //3 Real-time monitor -- extra stream 3

DH_RType_Multiplay_1, //Multiple-channel

preview-- 1-window

DH_RType_Multiplay_4, //Multiple-channel preview--4-window

DH_RType_Multiplay_8, //Multiple-channel preview--8-window

DH_RType_Multiplay_9, //Multiple-channel preview--9-window

DH_RType_Multiplay_16, //Multiple-channel preview--16-window

DH_RType_Multiplay_6, //Multiple-channel preview--6-window

DH_RType_Multiplay_12, //Multiple-channel preview--12-window

DH_RType_Multiplay_25, //Multiple-channel preview--25-window

DH_RType_Multiplay_36, //Multiple-channel preview--36-window

} DH_RealPlayType;

EM_QUERY_RECORD_TYPE

Option Instruction

Enum description Type of video search

Enum definition typedef enum tagEmQueryRecordType

EM_RECORD_TYPE_ALL=0, //All the recorded video

EM_RECORD_TYPE_ALARM=1, //The video of

external alarm

EM_RECORD_TYPE_MOTION_DETECT=2, //The video of dynamic

detection alarm

EM_RECORD_TYPE_ALARM_ALL=3, //All the alarmed video

247/339
Option Instruction

EM_RECORD_TYPE_CARD=4, //query by the card number

EM_RECORD_TYPE_CONDITION=5, //query by condition

EM_RECORD_TYPE_JOIN=6, //combination query

EM_RECORD_TYPE_CARD_PICTURE=8, //query pictures by the card

number,used by HB-U or NVS

EM_RECORD_TYPE_PICTURE=9, //query pictures,used by HB-U

or NVS

EM_RECORD_TYPE_FIELD=10, //query by field

EM_RECORD_TYPE_INTELLI_VIDEO =11, //Smart record search

EM_RECORD_TYPE_TRANS_DATA=16, //query the video of

serial data

EM_RECORD_TYPE_IMPORTANT=17, //query the important video

EM_RECORD_TYPE_TALK_DATA =18, //query the recording file

EM_RECORD_TYPE_INVALID = 256, // invalid query type

}EM_QUERY_RECORD_TYPE;

EM_USEDEV_MODE

Option Instruction

Enum description Audio talk way(not describe some extensive data type)

Enum definition typedef enum __EM_USEDEV_MODE

DH_TALK_CLIENT_MODE, // Set client-end mode to begin audio

talk

DH_TALK_SERVER_MODE, // Set server mode to begin audio

talk

DH_TALK_ENCODE_TYPE, // Set encode format for

audio talk

DH_ALARM_LISTEN_MODE, // Set alarm subscribe way

DH_CONFIG_AUTHORITY_MODE, // Set user right to realize

248/339
Option Instruction

configuration management

DH_TALK_TALK_CHANNEL, // Set talking

channel(0~MaxChannel-1)

DH_RECORD_STREAM_TYPE, // Set the stream type of the record

for query(0-both main and extra

stream,1-only main stream,2-only

extra stream)

DH_TALK_SPEAK_PARAM, // Set speaking

parameter,corresponding to

NET_SPEAK_PARAM

DH_RECORD_TYPE, // Set by time video playback and

download the video file TYPE (see.net

RECORD TYPE)

DH_TALK_MODE3, // Set voice intercom parameters of

three generations of equipment and the

corresponding structure NET TALK the

EX

DH_PLAYBACK_REALTIME_MODE , //Set real time playback

function(0-off,1-on)

DH_TALK_TRANSFER_MODE, //Judge the voice intercom if it was a

forwarding mode, (corresponding to

NET_TALK_TRANSFER_PARAM)

DH_TALK_VT_PARAM, //Set VT talk parameter,

corresponding to

NET_VT_TALK_PARAM structure

DH_TARGET_DEV_ID, //Set target device identifier for

searching system capacity

information, (not zero - locate device

forwards the information)

249/339
Option Instruction

} EM_USEDEV_MODE;

EM_SUPPORT_FOCUS_MODE
Option Instruction

Enum description Enum of focus mode supported

Enum definition typedef enum tagSUPPORT_FOCUS_MODE

ENUM_SUPPORT_FOCUS_CAR= 1, //See the car mode

ENUM_SUPPORT_FOCUS_PLATE= 2, //See the license plate

number mode

ENUM_SUPPORT_FOCUS_PEOPLE= 3, //See people mode

ENUM_SUPPORT_FOCUS_FACE= 4, //See the face mode

}EM_SUPPORT_FOCUS_MODE;

DH_PTZ_ControlType

Option Instruction

Enum description Enum of General PTZ control command

Enum definition typedef enum _PTZ_ControlType

DH_PTZ_UP_CONTROL = 0, // Up

DH_PTZ_DOWN_CONTROL, // Down

DH_PTZ_LEFT_CONTROL, // Left

DH_PTZ_RIGHT_CONTROL, // Right

DH_PTZ_ZOOM_ADD_CONTROL, // +Zoom in

DH_PTZ_ZOOM_DEC_CONTROL, // -Zoom out

DH_PTZ_FOCUS_ADD_CONTROL, // +Zoom in

DH_PTZ_FOCUS_DEC_CONTROL, // -Zoom out

DH_PTZ_APERTURE_ADD_CONTROL, // + Aperture

250/339
Option Instruction

DH_PTZ_APERTURE_DEC_CONTROL, // -Aperture

DH_PTZ_POINT_MOVE_CONTROL, // Go to preset

DH_PTZ_POINT_SET_CONTROL, // Set

DH_PTZ_POINT_DEL_CONTROL, // Delete

DH_PTZ_POINT_LOOP_CONTROL, // Tour

DH_PTZ_LAMP_CONTROL // Light and wiper

} DH_PTZ_ControlType;

DH_EXTPTZ_ControlType
Option Instruction

Enum description PTZ control extensive command

Enum definition typedef enum _EXTPTZ_ControlType

DH_EXTPTZ_LEFTTOP = 0x20, // Upper left

DH_EXTPTZ_RIGHTTOP, // Upper right

DH_EXTPTZ_LEFTDOWN, // Down left

DH_EXTPTZ_RIGHTDOWN, // Down right

DH_EXTPTZ_ADDTOLOOP, // Add preset to tour

Tour Preset value

DH_EXTPTZ_DELFROMLOOP, // Delete preset in tour

Tour Preset value

DH_EXTPTZ_CLOSELOOP, // Delete tour tour

DH_EXTPTZ_STARTPANCRUISE, // Begin pan rotation

DH_EXTPTZ_STOPPANCRUISE, // Stop pan rotation

DH_EXTPTZ_SETLEFTBORDER, // Set left limit

DH_EXTPTZ_SETRIGHTBORDER, // Set right limit

DH_EXTPTZ_STARTLINESCAN, // Begin scanning

DH_EXTPTZ_CLOSELINESCAN, // Stop scanning

DH_EXTPTZ_SETMODESTART, // Start mode Mode line

251/339
Option Instruction

DH_EXTPTZ_SETMODESTOP, // Stop mode Mode line

DH_EXTPTZ_RUNMODE, // Enable mode Mode line

DH_EXTPTZ_STOPMODE, // Disable mode Mode line

DH_EXTPTZ_DELETEMODE, // Delete mode Mode line

DH_EXTPTZ_REVERSECOMM, // Flip

DH_EXTPTZ_FASTGOTO, // 3D position X address(8192)

Y address(8192)zoom(4)

DH_EXTPTZ_AUXIOPEN, // auxiliary open Auxiliary point

DH_EXTPTZ_AUXICLOSE, // Auxiliary close Auxiliary point

DH_EXTPTZ_OPENMENU = 0x36,// Open dome menu

DH_EXTPTZ_CLOSEMENU, // Close menu

DH_EXTPTZ_MENUOK, // Confirm menu

DH_EXTPTZ_MENUCANCEL, // Cancel menu

DH_EXTPTZ_MENUUP, // menu up

DH_EXTPTZ_MENUDOWN, // menu down

DH_EXTPTZ_MENULEFT, // menu left

DH_EXTPTZ_MENURIGHT, // Menu right

DH_EXTPTZ_ALARMHANDLE = 0x40, // Alarm activate PTZ parm1:Alarm

input channel;parm2:Alarm activation type 1-preset 2-scan 3-tour;parm

3:activation value,such as preset value.

DH_EXTPTZ_MATRIXSWITCH = 0x41, // Matrix switch parm1:monitor

number(video output number);parm2:video input number;parm3:matrix

number

DH_EXTPTZ_LIGHTCONTROL, // Light controller

DH_EXTPTZ_EXACTGOTO, // 3D accurately positioning parm1:Pan

degree(0~3600); parm2: tilt coordinates(0~900); parm3:zoom(1~128)

DH_EXTPTZ_RESETZERO, // Reset 3D positioning as zero

DH_EXTPTZ_MOVE_ABSOLUTELY, //Absolute motion control

commands,param4 corresponding struct

252/339
Option Instruction

PTZ_CONTROL_ABSOLUTELY

DH_EXTPTZ_MOVE_CONTINUOUSLY, // Continuous motion control

commands,param4 corresponding struct

PTZ_CONTROL_CONTINUOUSLY

DH_EXTPTZ_GOTOPRESET, // PTZ control command, at a certain speed

to preset locus,parm4 corresponding

struct PTZ_CONTROL_GOTOPRESET

DH_EXTPTZ_SET_VIEW_RANGE = 0x49, //Set to horizon(param4

corresponding struct PTZ_VIEW_RANGE_INFO)

DH_EXTPTZ_FOCUS_ABSOLUTELY = 0x4A, // Absolute focus

(param4 corresponding struct PTZ_FOCUS_ABSOLUTELY)

DH_EXTPTZ_HORSECTORSCAN = 0x4B, //Level fan sweep

(param4 corresponding PTZ_CONTROL_SECTORSCAN,

param1param2param3 is invalid)

DH_EXTPTZ_VERSECTORSCAN = 0x4C, // Vertical sweep fan

(param4correspondingPTZ_CONTROL_SECTORSCAN,

param1param2param3 is invalid)

DH_EXTPTZ_SET_ABS_ZOOMFOCUS = 0x4D, // Set absolute focus,

focus on value, param1 for focal length, range: [0255], param2

as the focus, scope: [0255], param3, param4 is invalid

DH_EXTPTZ_SET_FISHEYE_EPTZ = 0x4E, //Control fish eye

PTZ,param4corresponding to structure

PTZ_CONTROL_SET_FISHEYE_EPTZ

DH_EXTPTZ_UP_TELE = 0x70, // Up + TELE param1=speed(1-8) ,

similarly hereinafter

DH_EXTPTZ_DOWN_TELE, // Down + TELE

DH_EXTPTZ_LEFT_TELE, // Left + TELE

DH_EXTPTZ_RIGHT_TELE, // Right + TELE

DH_EXTPTZ_LEFTUP_TELE, // Upper left + TELE

253/339
Option Instruction

DH_EXTPTZ_LEFTDOWN_TELE, // Down left + TELE

DH_EXTPTZ_TIGHTUP_TELE, // Upper right + TELE

DH_EXTPTZ_RIGHTDOWN_TELE, // Down right + TELE

DH_EXTPTZ_UP_WIDE, // Up + WIDE param1=speed (1-8),

similarly hereinafter

DH_EXTPTZ_DOWN_WIDE, // Down + WIDE

DH_EXTPTZ_LEFT_WIDE, // Left + WIDE

DH_EXTPTZ_RIGHT_WIDE, // Right + WIDE

DH_EXTPTZ_LEFTUP_WIDE, // Upper left + WIDE

DH_EXTPTZ_LEFTDOWN_WIDE, // Down left+ WIDE

DH_EXTPTZ_TIGHTUP_WIDE, // Upper right + WIDE

DH_EXTPTZ_RIGHTDOWN_WIDE, // Down right + WIDE

DH_EXTPTZ_TOTAL, // max command value

} DH_EXTPTZ_ControlType;

DH_TALK_CODING_TYPE

Option Instruction

Enum description Audio encode type

Enum definition typedef enum __TALK_CODING_TYPE

DH_TALK_DEFAULT = 0, // No-head PCM

DH_TALK_PCM = 1, // With head PCM

DH_TALK_G711a, // G711a

DH_TALK_AMR, // AMR

DH_TALK_G711u, // G711u

DH_TALK_G726, // G726

DH_TALK_G723_53, // G723_53

DH_TALK_G723_63, // G723_63

DH_TALK_AAC, // AAC

254/339
Option Instruction

DH_TALK_OGG, // OGG

DH_TALK_G729 = 10, // G729

DH_TALK_MPEG2, // MPEG2

DH_TALK_MPEG2_Layer2, // MPEG2-Layer2

DH_TALK_G722_1, // G.722.1

DH_TALK_ADPCM = 21, // ADPCM

DH_TALK_MP3 = 22, // MP3

} DH_TALK_CODING_TYPE;

CtrlType

Option Instruction

Enum description Audio encode type

Enum definition typedef enum _CtrlType

DH_CTRL_REBOOT = 0, // Reboot device

DH_CTRL_SHUTDOWN, // Shut down device

DH_CTRL_DISK, // HDD management

DH_KEYBOARD_POWER = 3, // Network keyboard

DH_KEYBOARD_ENTER,

DH_KEYBOARD_ESC,

DH_KEYBOARD_UP,

DH_KEYBOARD_DOWN,

DH_KEYBOARD_LEFT,

DH_KEYBOARD_RIGHT,

DH_KEYBOARD_BTN0,

DH_KEYBOARD_BTN1,

DH_KEYBOARD_BTN2,

DH_KEYBOARD_BTN3,

DH_KEYBOARD_BTN4,

255/339
Option Instruction

DH_KEYBOARD_BTN5,

DH_KEYBOARD_BTN6,

DH_KEYBOARD_BTN7,

DH_KEYBOARD_BTN8,

DH_KEYBOARD_BTN9,

DH_KEYBOARD_BTN10,

DH_KEYBOARD_BTN11,

DH_KEYBOARD_BTN12,

DH_KEYBOARD_BTN13,

DH_KEYBOARD_BTN14,

DH_KEYBOARD_BTN15,

DH_KEYBOARD_BTN16,

DH_KEYBOARD_SPLIT,

DH_KEYBOARD_ONE,

DH_KEYBOARD_NINE,

DH_KEYBOARD_ADDR,

DH_KEYBOARD_INFO,

DH_KEYBOARD_REC,

DH_KEYBOARD_FN1,

DH_KEYBOARD_FN2,

DH_KEYBOARD_PLAY,

DH_KEYBOARD_STOP,

DH_KEYBOARD_SLOW,

DH_KEYBOARD_FAST,

DH_KEYBOARD_PREW,

DH_KEYBOARD_NEXT,

DH_KEYBOARD_JMPDOWN,

DH_KEYBOARD_JMPUP,

DH_KEYBOARD_10PLUS,

256/339
Option Instruction

DH_KEYBOARD_SHIFT,

DH_KEYBOARD_BACK,

DH_KEYBOARD_LOGIN , // new network keyboard function

DH_KEYBOARD_CHNNEL , // switch video channel

DH_TRIGGER_ALARM_IN = 100, // Activate alarm input

DH_TRIGGER_ALARM_OUT, // Activate alarm output

DH_CTRL_MATRIX, // Matrix control

DH_CTRL_SDCARD, // SD card control(for IPC series).

Please refer to HDD control

DH_BURNING_START, // Burner control:begin burning

DH_BURNING_STOP, // Burner control:stop burning

DH_BURNING_ADDPWD, // Burner control:overlay password

(The string ended with '\0'. Max length is 8 bits. )

DH_BURNING_ADDHEAD, // Burner control:overlay head title

(The string ended with '\0'. Max length is

1024 bytes. Use '\n' to Enter.)

DH_BURNING_ADDSIGN, // Burner control:overlay dot to the burned

information(No parameter)

DH_BURNING_ADDCURSTOMINFO, // Burner control:self-defined overlay

(The string ended with '\0'. Max length is 1024

bytes. Use '\n' to Enter)

DH_CTRL_RESTOREDEFAULT, //restore device default setup

DH_CTRL_CAPTURE_START, //Activate device snapshot

DH_CTRL_CLEARLOG, // Clear log

DH_TRIGGER_ALARM_WIRELESS = 200, // Activate wireless

alarm (IPC series)

DH_MARK_IMPORTANT_RECORD, //Mark important record

DH_CTRL_DISK_SUBAREA, // Network hard disk partition

DH_BURNING_ATTACH, // Annex burning

257/339
Option Instruction

DH_BURNING_PAUSE, // Burn Pause

DH_BURNING_CONTINUE, // Burn Resume

DH_BURNING_POSTPONE, // Burn Postponed

DH_CTRL_OEMCTRL, // OEM control

DH_BACKUP_START, // Start to device backup

DH_BACKUP_STOP, // Stop to device backup

DH_VIHICLE_WIF I_ADD, // Add WIFI configuration manually

for car device

DH_VIHICLE_WIF I_DEC, // Delete WIFI configuration

manually for car device

DH_BUZZER_START, // Start to buzzer control

DH_BUZZER_STOP, // Stop to buzzer control

DH_REJECT_USER, // Reject User

DH_SHIELD_USER, // Shield User

DH_RAINBRUSH, // Rain Brush

DH_MANUAL_SNAP, // manual snap (struct

MANUAL_SNAP_PARAMETER)

DH_MANUAL_NTP_TIMEADJUST, // manual ntp time adjust

DH_NAVIGATION_SMS, // navigation info and note

DH_CTRL_ROUTE_CROSSING, // route info

DH_BACKUP_FORMAT, // backup device format

DH_DEVICE_LOCALPREVIEW_SLIPT, // local preview split(struct

DEVICE_LOCALPREVIEW_SLIPT_PARAMETER)

DH_CTRL_INIT_RAID, // RAID init

DH_CTRL_RAID, // RAID control

DH_CTRL_SAPREDISK, // sapredisk control

DH_WIFI_CONNECT, // wifi connect

(struct WIFI_CONNECT)

DH_WIFI_DISCONNECT, // wifi disconnect

258/339
Option Instruction

(struct WIFI_CONNECT)

DH_CTRL_ARMED, // Arm/disarm operation

DH_CTRL_IP_MODIFY, // IP modify

(struct DHCTRL_IPMODIFY_PARAM)

DH_CTRL_WIFI_BY_WPS, // wps connect wifi(struct

DHCTRL_CONNECT_WIFI_BYWPS)

DH_CTRL_FORMAT_PATITION, // format pattion

(struct DH_FORMAT_PATITION)

DH_CTRL_EJECT_STORAGE, //eject storage device

(struct DH_EJECT_STORAGE_DEVICE)

DH_CTRL_LOAD_STORAGE, // load storage device

(struct DH_LOAD_STORAGE_DEVICE)

DH_CTRL_CLOSE_BURNER, // close burner

(struct NET_CTRL_BURNERDOOR) need wait 6s

DH_CTRL_EJECT_BURNER, // eject burner

(struct NET_CTRL_BURNERDOOR) need wait 4s

DH_CTRL_CLEAR_ALARM, // alarm elimination corresponding

structure NET (CTRL CLEAR ALARM)

DH_CTRL_MONITORWALL_TVINFO, // TV wall information display

corresponding structure NET (CTRL

MONITORWALL TVINFO)

DH_CTRL_START_VIDEO_ANALYSE, //start Intelligent VIDEO analysis

(corresponding structure

NET CTRL START VIDEO ANALYSE)

DH_CTRL_STOP_VIDEO_ANALYSE, // STOP intelligent VIDEO analysis

corresponding structure NET (CTRL STOP

VIDEO ANALYSE)

DH_CTRL_UPGRADE_DEVICE, //Controlled start equipment

upgrades, independently complete the upgrade process

259/339
Option Instruction

by the equipment do not need to upgrade file

DH_CTRL_MULTIPLAYBACK_CHANNALES, //Multi-channel preview

playback channel switching corresponding structure NET (CTRL

MULTIPLAYBACK CHANNALES)

DH_CTRL_SEQPOWER_OPEN,// Turn on the switch power supply timing

device output corresponding.

net (CTRL SEQPOWER PARAM)

DH_CTRL_SEQPOWER_CLOSE, // Close the switch power supply timing

device output corresponding.

net (CTRL SEQPOWER PARAM)

DH_CTRL_SEQPOWER_OPEN_ALL, // Power timing group open the

switch quantity output corresponding.

net (CTRL SEQPOWER PARAM)

DH_CTRL_SEQPOWER_CLOSE_ALL, // Power sequence set close the

switch quantity output corresponding.net (CTRL

SEQPOWER PARAM)

DH_CTRL_PROJECTOR_RISE, // PROJECTOR up

corresponding.net (CTRL PROJECTOR PARAM)

DH_CTRL_PROJECTOR_FALL, // PROJECTOR drop

(corresponding to the.net CTRL PROJECTOR PARAM)

DH_CTRL_PROJECTOR_STOP, // PROJECTOR stop

(corresponding to the.net CTRL PROJECTOR PARAM)

DH_CTRL_INFRARED_KEY, // INFRARED buttons

(corresponding to the.net CTRL INFRARED KEY PARAM)

DH_CTRL_START_PLAYAUDIO, // Device START playback of audio

file corresponding structure NET

(CTRL START PLAYAUDIO)

DH_CTRL_STOP_PLAYAUDIO, // Equipment stop playback of audio

file

260/339
Option Instruction

DH_CTRL_START_ALARMBELL, // Corresponding structure NET open

alarm (CTRL ALARMBELL)

DH_CTRL_STOP_ALARMBELL, // Close the warning signal

corresponding structure NET (CTRL ALARMBELL)

DH_CTRL_ACCESS_OPEN, // OPEN ACCESS control -

corresponding structure NET (CTRL ACCESS OPEN)

DH_CTRL_SET_BYPASS, //Corresponding structure NET

BYPASS function (CTRL SET BYPASS)

DH_CTRL_RECORDSET_INSERT, // Add records to record set number

(corresponding to the.net CTRL you INSERT PARAM)

DH_CTRL_RECORDSET_UPDATE, // Update a record of the number

(corresponding to the.net CTRL you PARAM)

DH_CTRL_RECORDSET_REMOVE, // According to the record set

number to delete a record (corresponding to

the.net CTRL you PARAM)

DH_CTRL_RECORDSET_CLEAR, // Remove all RECORDSET

information corresponding.net (CTRL you PARAM)

DH_CTRL_ACCESS_CLOSE, // Entrance guard control -

CLOSE corresponding structure NET (CTRL ACCESS CLOSE)

DH_CTRL_ALARM_SUBSYSTEM_ACT IVE_SET, // Alarm sub system

activation setup(corresponding structure

NET_CTRL_ALARM_SUBSYSTEM_SETACT IVE)

DH_CTRL_FORBID_OPEN_STROBE, //Disable device open

gateway(corresponding to structure

NET_CTRL_FORBID_OPEN_STROBE)

DH_CTRL_OPEN_STROBE, //Enable gateway (corresponding

to structure NET_CTRL_OPEN_STROBE)

DH_CTRL_TALKING_REFUSE, // Talk no response (corresponding

to structure NET_CTRL_TALKING_REFUSE)

261/339
Option Instruction

DH_CTRL_ARMED_EX, //arm-disarm operation

(corresponding to structure CTRL_ARM_DISARM_PARAM_EX),

CTRL_ARM_DISARM_PARAM upgrade,recommended

DH_CTRL_NET_KEYBOARD = 400, // Net keyboard

control(corresponding to structure DHCTRL_NET_KEYBOARD)

DH_CTRL_AIRCONDITION_OPEN, //Open air conditioner

(corresponding to structure NET_CTRL_OPEN_AIRCONDITION)

DH_CTRL_AIRCONDITION_CLOSE, //Close air-conditioner

(corresponding to structure NET_CTRL_CLOSE_AIRCONDITION)

DH_CTRL_AIRCONDITION_SET_TEMPERATURE, // Set temperature

(corresponding to structure

NET_CTRL_SET_TEMPERATURE)

DH_CTRL_AIRCONDITION_ADJUST_TEMPERAT URE, //Adjust

temperature(corresponding to structure

NET_CTRL_ADJUST_TEMPERATURE)

DH_CTRL_AIRCONDITION_SETMODE, //Set air work mode

(corresponding to structure NET_CTRL_ADJUST_TEMPERATURE)

DH_CTRL_AIRCONDITION_SETWINDMODE, // Set fan mode

(corresponding to structure

NET_CTRL_AIRCONDITION_SETMODE)

DH_CTRL_RESTOREDEFAULT_EX ,

// Recover device default and set new protocol(corresponding to

structure NET_CTRL_RESTORE_DEFAULT)

// Recover config and use this enumeration first, if port failed,and

CLIENT_GetLastError return NET_UNSUPPORTED,

try again DH_CTRL_RESTOREDEFAULT restore config.

DH_CTRL_NOTIFY_EVENT, // send event to device (corresponding

to structure NET_NOTIFY_EVENT_DATA)

DH_CTRL_SILENT_ALARM_SET, // mute alarm setup

262/339
Option Instruction

DH_CTRL_START_PLAYAUDIOEX, //device start sound

report(corresponding to structure

NET_CTRL_START_PLAYAUDIOEX)

DH_CTRL_STOP_PLAYAUDIOEX, //device stop sound report

DH_CTRL_CLOSE_STROBE, //close gateway (corresponding to

structure NET_CTRL_CLOSE_STROBE)

DH_CTRL_SET_ORDER_STATE, //set parking reservation status

(corresponding to structure NET_CTRL_SET_ORDER_STATE)

DH_CTRL_RECORDSET_INSERTEX, // add record,get record collection

no.(corresponding to

NET_CTRL_RECORDSET_INSERT_PARAM)

DH_CTRL_RECORDSET_UPDATEEX, // update record set nos

record(corresponding to NET_CTRL_RECORDSET_PARAM)

DH_CTRL_CAPTURE_FINGER_PRINT, // fingerprint collection

(corresponding to structure NET_CTRL_CAPTURE_FINGER_PRINT)

DH_CTRL_ECK_LED_SET, // Parking lot entrance/exit

controller LED setup(corresponding structure

NET_CTRL_ECK_LED_SET_PARAM)

DH_CTRL_ECK_IC_CARD_IMPORT, // Intelligent parking system in/out

device IC card info import (corresponding structure

NET_CTRL_ECK_IC_CARD_IMPORT_PARAM)

DH_CTRL_ECK_SYNC_IC_CARD, // Intelligent parking system in/out

device IC card info sync command, receive this command, device will

delete original IC card info(corresponding structure

NET_CTRL_ECK_SYNC_IC_CARD_PARAM)

DH_CTRL_LOWRATEWPAN_REMOVE, // Delete specific wireless

device(corresponding structure

NET_CTRL_LOWRATEWPAN_REMOVE)

DH_CTRL_LOWRATEWPAN_MODIFY, // Modify wireless device

263/339
Option Instruction

info(corresponding structure

NET_CTRL_LOWRATEWPAN_MODIFY)

DH_CTRL_ECK_SET_PARK_INFO, // Set up the vehicle spot

information of the machine at the passageway of the

intelligent parking system (corresponding to

NET_CTRL_ECK_SET_PARK_INFO_PARAM)

DH_CTRL_VTP_DISCONNECT, // hang up the video phone

(corresponding to NET_CTRL_VTP_DISCONNECT)

DH_CTRL_UPDATE_FILES, // the update of the remote

multimedia files (corresponding to NET_CTRL_UPDATE_FILES)

DH_CTRL_MATRIX_SAVE_SWITCH, // Save up the relationship

between the hyponymy matrixes (corresponding to

NET_CTRL_MATRIX_SAVE_SWITCH)

DH_CTRL_MATRIX_RESTORE_SWITCH, // recover the relationship

between the hyponymy matrixes (corresponding to

NET_CTRL_MATRIX_RESTORE_SWITCH)

DH_CTRL_VTP_DIVERTACK, // video talk phone divert ack

(corresponding to NET_CTRL_VTP_DIVERTACK)

DH_CTRL_RAINBRUSH_MOVEONCE, // Rain-brush brush one time,

efficient when set as manual mode(corresponding to

NET_CTRL_RAINBRUSH_MOVEONCE)

DH_CTRL_RAINBRUSH_MOVECONTINUOUSLY, // Rain-brush brush

cyclic, efficient when set as manal mode(corresponding to

NET_CTRL_RAINBRUSH_MOVECONTINUOUSLY)

DH_CTRL_RAINBRUSH_STOPMOVE, // Rain-brush stop, efficient when

set as manal mode(corresponding to

NET_CTRL_RAINBRUSH_STOPMOVE)

DH_CTRL_ALARM_ACK, // affirm the alarm event

(corresponding to NET_CTRL_ALARM_ACK)

264/339
Option Instruction

// DH_CTRL_ALARM_ACK DO NOT call this method in

callback interface

DH_CTRL_RECORDSET_IMPORT, // Batch import record set info

(Corresponding to NET_CTRL_RECORDSET_PARAM)

DH_CTRL_ACCESS_USE_DOOR, // Disable and enable door

(Corresponding to structure NET_CTRL_ACCESS_USE_DOOR)

DH_CTRL_ACCESS_SHUT_LOCK, // The latch and the cancellation of

the lock, can not pass through the door(Corresponding to

structure NET_CTRL_ACCESS_SHUT_LOCK)

DH_CTRL_OPEN_DOOR_CONTINUE, //Continuous unlocking

instruction (Corresponding to structure

NET_CTRL_OPEN_DOOR_CONTINUE)

//The following commands are only for

CLIENT_ControlDeviceEx

DH_CTRL_THERMO_GRAPHY_ENSHUTTER = 0x10000,

// Enable or disable thermal shutter,

//pInBuf= NET_IN_THERMO_EN_SHUTTER*,

//pOutBuf= NET_OUT_THERMO_EN_SHUTTER *

DH_CTRL_RADIOMETRY_SETOSDMARK,

// NET_IN_RADIOMETRY_SETOSDMARK*,

//pOutBuf= NET_OUT_RADIOMETRY_SETOSDMARK *

DH_CTRL_AUDIO_REC_START_NAME,

// Enable audio record and get audio name,

//pInBuf = NET_IN_AUDIO_REC_MNG_NAME *,

//pOutBuf = NET_OUT_AUDIO_REC_MNG_NAME *

DH_CTRL_AUDIO_REC_STOP_NAME,

// Close audio file and return file name,

//pInBuf ,NET_IN_AUDIO_REC_MNG_NAME *,

//pOutBuf = NET_OUT_AUDIO_REC_MNG_NAME *

265/339
Option Instruction

DH_CTRL_SNAP_MNG_SNAP_SHOT,

//Manual snap, pInBuf = NET_IN_SNAP_MNG_SHOT *,

//pOutBuf = NET_OUT_SNAP_MNG_SHOT *

DH_CTRL_LOG_STOP,

// Forcedly sync buffer data to the database and close the database,

//pInBuf = NET_IN_LOG_MNG_CTRL *,

//pOutBuf = NET_OUT_LOG_MNG_CTRL *

DH_CTRL_LOG_RESUME,

// Resume database, pInBuf = NET_IN_LOG_MNG_CTRL *,

// pOutBuf = NET_OUT_LOG_MNG_CTRL *

DH_CTRL_POS_ADD,

// Add a POS device, pInBuf = NET_IN_POS_ADD *,

//pOutBuf = NET_OUT_POS_ADD *

DH_CTRL_POS_REMOVE,

// Del a POS device, pInBuf = NET_IN_POS_REMOVE *,

//pOutBuf = NET_OUT_POS_REMOVE *

DH_CTRL_POS_REMOVE_MULTI,

// Del several POS device,

//pInBuf = NET_IN_POS_REMOVE_MULT I *,

//pOutBuf = NET_OUT_POS_REMOVE_MULTI *

DH_CTRL_POS_MODIFY,

// Modify a POS device, pInBuf = NET_IN_POS_ADD *,

//pOutBuf = NET_OUT_POS_ADD *

DH_CTRL_SET_SOUND_ALARM,

//Trigger alarm with sound,

//pInBuf = NET_IN_SOUND_ALARM *,

//pOutBuf = NET_OUT_SOUND_ALARM *

DH_CTRL_AUDIO_MATRIX_SILENCE,

//audiomatrix silence,

266/339
Option Instruction

//pInBuf = NET_IN_AUDIO_MATRIX_SILENCE*,

//pOutBuf = NET_OUT_AUDIO_MATRIX_SILENCE*

DH_CTRL_MANUAL_UPLOAD_PICT URE,

// manual upload picture,

//pInBuf = NET_IN_MANUAL_UPLOAD_PICTURE *,

//pOutBUf = NET_OUT_MANUAL_UPLOAD_PICTURE *

DH_CTRL_REBOOT_NET_DECODING_DEV,

// reboot network decoding device,

//pInBuf = NET_IN_REBOOT_NET_DECODING_DEV *,

//pOutBuf = NET_OUT_REBOOT_NET_DECODING_DEV *

} CtrlType;

CFG_VIDEO_COMPRESSION

Enum description Instruction

Enum definition Video compression format type

Enum description typedef enum tagCFG_VIDEO_COMPRESSION

VIDEO_FORMAT_MPEG4, // MPEG4

VIDEO_FORMAT_MS_MPEG4, // MS-MPEG4

VIDEO_FORMAT_MPEG2, // MPEG2

VIDEO_FORMAT_MPEG1, // MPEG1

VIDEO_FORMAT_H263, // H.263

VIDEO_FORMAT_MJPG, // MJPG

VIDEO_FORMAT_FCC_MPEG4, // FCC-MPEG4

VIDEO_FORMAT_H264, // H.264

VIDEO_FORMAT_H265, // H.265

} CFG_VIDEO_COMPRESSION;

267/339
CFG_BITRATE_CONTROL

Option Instruction

Enum description Bit rate control

Enum definition typedef enum tagCFG_BITRATE_CONTROL

BITRATE_CBR, //Fixed bit rate

BITRATE_VBR, //variable bit rate

} CFG_BITRATE_CONTROL;

CFG_IMAGE_QUALITY

Option Instruction

Enum description Bit rate control

Enum definition typedef enum tagCFG_IMAGE_QUALITY

IMAGE_QUALITY_Q10 = 1, // 10 percent image quality

IMAGE_QUALITY_Q30, // 30 percent image quality

IMAGE_QUALITY_Q50, // 50 percent image quality

IMAGE_QUALITY_Q60, // 60 percent image quality

IMAGE_QUALITY_Q80, // 80 percent image quality

IMAGE_QUALITY_Q100, // 100 percent image quality

} CFG_IMAGE_QUALITY;

CFG_H264_PROFILE_RANK

Option Instruction

Enum description H264 encode rank

Enum definition typedef enum tagCFG_H264_PROFILE_RANK

PROFILE_BASELINE=1, //Provide I/P Frame,only support progressive

scanning and CAVLC

268/339
Option Instruction

PROFILE_MAIN, //Provide I/P/B Frame,support progressive and

interlaced,provide CAVLC and CABAC

PROFILE_EXTENDED, //Provide I/P/B/SP/SI Frame, only support

progressive scanning and CAVLC

PROFILE_HIGH, //Based on FRExt,Main_Profile, new add: 8x8

intra prediction, custom

//quant, lossless video coding,and many more yuv

formats.

}CFG_H264_PROFILE_RANK;

CFG_AUDIO_FORMAT

Option Instruction

Enum description Audio encode format

Enum definition typedef enum tatCFG_AUDIO_FORAMT

AUDIO_FORMAT_G711A, // G711a

AUDIO_FORMAT_PCM, // PCM

AUDIO_FORMAT_G711U, // G711u

AUDIO_FORMAT_AMR, // AMR

AUDIO_FORMAT_AAC, // AAC

} CFG_AUDIO_FORMAT;

EM_REALPLAY_DISCONNECT_EVENT_TYPE

Option Instruction

Enum description Realplay disconnect event type

Enum definition typedef enum_EM_REALPLAY_DISCONNECT_EVENT_TYPE

DISCONNECT_EVENT_REAVE, //resources is taken by

269/339
Option Instruction

advanced user

DISCONNECT_EVENT_NETFORBID, //forbidden

DISCONNECT_EVENT_SUBCONNECT, //sublink disconnect

}EM_REALPLAY_DISCONNECT_EVENT_TYPE;

270/339
Appendix 3 Interface definition

CLIENT_Init

Option Instruction

Interface Interface for SDK initialization,call it when application programs need to be

description initialized.

Precondition None

Function BOOL CLIENT_Init(

fDisConnect cbDisConnect,

LDWORD dwUser

);

Parameter cbDisConnect

[in] callback function used when device gets disconnected,when online

device is offline,SDK will notify user by this callback, info includes login

ID,device IP,login port etc,please refer to 3.1fDisConnectfor details.when

function is set to 0,it means to prohibit the callback.

dwUser

[in]user data,when callback function cbDisConnect is not 0,SDK will send

data to user via this function for further operation.

Return value Succeeded return TRUE,otherwise return FALSE.

Example // Its not recommended to call SDK interface in callback function, unless call

CLIENT_GetLastError to get error code in current process.

// callback function used when device gets disconnected.

//When online device gets offline,SDK will call this callback function set by

CLINET_Init.

void CALLBACK DisConnectFunc(LONG lLoginID, char *pchDVRIP, LONG

nDVRPort, DWORD dwUser)

printf("Call DisConnectFunc\n");

271/339
Option Instruction

printf("lLoginID[0x%x]", lLoginID);

if (NULL != pchDVRIP)

printf("pchDVRIP[%s]\n", pchDVRIP);

printf("nDVRPort[%d]\n", nDVRPort);

printf("dwUser[%p]\n", dwUser);

printf("\n");

************ Above are callback function definition, the underneath are

interface using examples. **************

//SDK initialization

g_bNetSDKInitFlag = CLIENT_Init(DisConnectFunc, 0);

if (FALSE == g_bNetSDKInitFlag)

printf("Initialize client SDK failed; \n");

return;

else

printf("Initialize client SDK done; \n");

Note Before call other SDK interface, call this interface firstly.

If call this interface repeatedly,the first time is valid.

CLIENT_Cleanup
Option Instruction

Interface Interface for SDK clearance.

description

272/339
Option Instruction

Precondition Have called CLIENT_Init interface.

Function void CLIENT_Cleanup( );

Parameter None

Return value None

Example // release initialization resources

printf("CLIENT_Cleanup! \n");

CLIENT_Cleanup();

Note When application program is closed , call this interface to release resources at

last.

CLIENT_GetSDKVersion
Option Instruction

Interface Interface for getting SDK version information.

description

Precondition Have called CLIENT_Init interface.

Function DWORD CLIENT_GetSDKVersion( );

Parameter None

Return value Return value is version,for example 34219000 corresponding to version 3.42

19000.

Example //Get SDK version info

DWORD dwNetSdkVersion = CLIENT_GetSDKVersion( );

printf("NetSDK version is [%d]\n", dwNetSdkVersion);

Note None

CLIENT_GetLastError
Option Instruction

Interface Interface for getting error code after failed calling interface,get current thread

description error code.

Precondition Have called CLIENT_Init interface.

273/339
Function DWORD CLIENT_GetLastError(void);

Parameter None

Return value Current thread error code

Example // according to error code, you can find corresponding explanation in

dhnetsdk.h. It is to print hexadecimal here, not decimal shows in header file,

please be careful with conversion.

//Example: #define NET_NOT_SUPPORTED_EC(23)

//Now SDK does not support this function, error code is 0x80000017, Decimal

number 23 is hexadecimal 0x17.

printf("Last Error[%x]\n" , CLIENT_GetLastError());

Note Call this interface after failed calling interface.

Because of too much error code, it is not illustrate here,user can search the

following fields in dhnetsdk.h:

//error code, corresponds with return value from CLIENT_GetLastError

interface.

#define _EC(x) (0x80000000|x)

To find instruction of corresponding error code.

CLIENT_SetAutoReconnect
Option Instruction

Interface Interface for setting reconnection callback function after disconnection,when

description device gets offline, SDK will reconnect internally.

Precondition Have called CLIENT_Init interface.

Function void CLIENT_SetAutoReconnect(

HaveReConnect cbAutoConnect,

DWORD dwUser

);

Parameter [in] cbAutoConnect

Callback function set after the device reconnected successfully. After

device reconnects successfully,SDK call this interface to note the user

274/339
Option Instruction

reconnection successful.

[in] dwUser

User data, set by user. Return to user for further use by callback function

cbAutoConnect.

Return value None

Example //Not recommended to call SDK interface in SDK callback function,unless get

current thread error code via CLIENT_GetLastError.

//Callback function set after the device reconnected successfully.

//When offline device is reconnected successfully,SDKwill call this function,

set the callback function in CLIENT_SetAutoReconnect.

void CALLBACK HaveReConnect(LLONG lLoginID, char *pchDVRIP, LONG

nDVRPort, LDWORD dwUser)

printf("Call HaveReConnect\n");

printf("lLoginID[0x%x]", lLoginID);

if (NULL != pchDVRIP)

printf("pchDVRIP[%s]\n", pchDVRIP);

printf("nDVRPort[%d]\n", nDVRPort);

printf("dwUser[%p]\n", dwUser);

printf("\n");

************ Above are callback function definition, the underneath are

interface using examples.**************

//Set CLIENT_SetAutoReconnect interface.Once HaveReConnect is set,

when device gets offline, SDK will reconnect internally.

CLIENT_SetAutoReconnect(&HaveReConnect, 0);

Note After setting callback function cbAutoConnect, once device gets

275/339
Option Instruction

disconnected, SDK will try to reconnect to device constantly. If reconnection is

successful, SDK will inform user via the callback function.

If the interface is not called or callback function cbAutoConnect in the

interface is NULL , when device-end gets disconnected, SDK will not try to

reconnect to device.

CLIENT_SetConnectTime

Option Instruction

Interface Interface for setting device connection timeout value and trial times.

description

Precondition Have called CLIENT_Init interface.

Function void CLIENT_SetConnectTime(

int nWaitTime,

int nTryTimes

);

Parameter nWaitTime

[in] The timeout time means waiting time for devices answer in every login.

nTryTimes

[in]The trial time means the times of trying to connect device in every login.

Return value None

Example // Set device connection timeout time and trial times.

//This is optional.

int nWaitTime = 5000; // timeout time is 5 seconds

int nTryTimes = 3; //If timeout,it will try to log in three times.

CLIENT_SetConnectTime(nWaitTime, nTryTimes);

Note If CLIENT_SetConnectTime interface is not called, nWaitTime is 5000 as

default and nTryTimes is 1 as default.

276/339
CLIENT_SetNetworkParam

Option Instruction

Interface Interface for setting log in network environment.

description

Precondition Have called CLIENT_Init interface.

Function void CLIENT_SetNetworkParam(

NET_PARAM *pNetParam

);

Parameter pNetParam

[in]used to provide net login parameter,please refer to structure

NET_TIME

Return value None

Example //Set the network login parameters,include login timeout time and trial times.

NET_PARAM stuNetParm = {0};

stuNetParm.nWaittime = 10000; //Change login timeout value to 10sother

parameters still use default values.

CLIENT_SetNetworkParam(&stuNetParm);

Note None

CLIENT_LoginEx2

Option Instruction

Interface Extensive interface 2 for login, used to register user to device,could define

description device capacity user supported.

Precondition Have called CLIENT_Init interface.

Function LLONG CLIENT_LoginEx2(

const char *pchDVRIP,

WORD wDVRPort,

const char *pchUserName,

const char *pchPassword,

277/339
Option Instruction

EM_LOGIN_SPAC_CAP_TYPE emSpecCap,

void* pCapParam,

LPNET_DEVICEINFO_Ex lpDeviceInfo,

int *error = 0

);

Parameter pchDVRIP

[in]device IP.

IP address of login device,not allowed over 128 bytes.

wDVRPort

[in] device port which used to login device.

pchUserName

[in] User name

Not allow over 64 bytes.

pchPassword

[in] User password

Not allow over 64 bytes.

emSpecCap

[in] supported capacity of device,please refer to enum

EM_LOGIN_SPAC_CAP_TYPE.

pCapParam

[in]Additional parameter to emSpecCap,work in with emSpecCap,please

refer to enum EM_LOGIN_SPAC_CAP_TYPE If emSpecCap value not has

corresponding parameter instruction about pCapParam,it will input NULL.

lpDeviceInfo

[out]If device login successfully, save part information of login device;If

not,save part information of relevant login ,such as the remaining login

times,please refer to structure NET_DEVICEINFO.

error

[out] (If function returns success,this parameter value is

278/339
Option Instruction

insignificance),return login error code.

For example

1- erroneous password

2- not exist user name

3-login timeout

4-account logged in

5- account locked

6- account is blacklisted

7-system is busy,resource is not enough.

8-failed subconnection

9-failed main connection

10-over max connections

11- only support the third agreement

12- there is no USB in device

13- client's Ip don't have power login.

Return value Succeeded return device ID,otherwise return 0.

After login successfully,device ID can cooperate with SDK interface to operate

equipment.

Example //Login device

NET_DEVICEINFO_Ex stDevInfoEx = {0};

int nError = 0;

g_lLoginHandle=CLIENT_LoginEx2(g_szDevIp,g_nPort,g_szUserName,

g_szPasswd,EM_LOGIN_SPEC_CAP_TCP,NULL,&stDevInfoEx, &nError);

if(0 == g_lLoginHandle)

// according to error code, you can find corresponding explanatio n in

dhnetsdk.h. It is to print hexadecimal here, not decimal showns in header

file, please be careful with conversion.

//Example: #define NET_NOT_SUPPORTED_EC(23)

279/339
Option Instruction

//Now SDK does not support this function, error code is 0x80000017,

Decimal number 23 is hexadecimal 0x17.

printf("CLIENT_LoginEx2 %s[%d]Failed!Last Error[%x]\n" , g_szDevIp ,

g_nPort , CLIENT_GetLastError());

else

printf("CLIENT_LoginEx2 %s[%d] Success\n" , g_szDevIp , g_nPort);

Note After successful initialization,call this interface to register to designated device.

If succeed, device handle will be returned for relevant function to call.

Recommended client to use emSpecCap = EM_LOGIN_SPEC_CAP_TCP

which means login under TCP mode.

CLIENT_Logout

Option Instruction

Interface Interface for logout.

description

Function BOOL CLIENT_Logout(LLONG lLoginID);

Parameter lLoginID

[in]device login handle ID.

Return value of CLIENT_LoginEx2 interface.

Return value Succeeded return TRUE,otherwise return FALSE.

Example printf("CLIENT_Logout! \n");

if(!CLIENT_Logout(g_lLoginHandle))

printf("CLIENT_Logout Failed!Last Error[%x]\n",

CLIENT_GetLastError());

280/339
 //Please refer to example code of sync login in device login.

Note When logout device,related businesses will stop ,such as real-time preview

etc.

CLIENT_RealPlayEx
Option Instruction

Interface Extensive interface for real-time monitoring,realize get real-time monitoring

description data stream from logined device.

Precondition Have called login interface CLIENT_LoginEx2.

Function LLONG CLIENT_RealPlayEx(

LLONG lLoginID,

int nChannelID,

HWND hWnd,

DH_RealPlayType rType = DH_RType_Realplay

);

Parameter lLoginID

[in] device login ID.

Return value of corresponding device login interface CLIENT_LoginEx2.

nChannelID

[in] real-time monitoring channel number which starts from 0.

hWnd

[in] window handle,when value is 0, data is not decoded and image is not

displayed.

rType

[in] real-time monitoring type.

Default type is DH_RType_Realplay,please refer to definition of enum

DH_RealPlayType.

Return value Failed return 0,otherwise return real-time monitoring ID(real-time monitoring

handle) and used as related function parameter.

Example typedef HWND (WINAPI *PROCGETCONSOLEWINDOW)();

281/339
Option Instruction

PROCGETCONSOLEWINDOW GetConsoleWindow;

//Get the console window handle.

HMODULE hKernel32 = GetModuleHandle("kernel32");

GetConsoleWindow =

(PROCGETCONSOLEWINDOW)GetProcAddress(hKernel32,"GetConsoleWi

ndow");

HWND hWnd = GetConsoleWindow();

//Start real-time monitoring.

int nChannelID = 0; // preview channel NO.

DH_RealPlayType emRealPlayType = DH_RType_Realplay;

g_lRealHandle = CLIENT_RealPlayEx(g_lLoginHandle, nChannelID, hWnd,

emRealPlayType);

if (g_lRealHandle == 0)

printf("CLIENT_RealPlayEx: failed! Error code: %x.\n",

CLIENT_GetLastError());

Note NVR device fills nChannelID as video output channel number in multiplay

preview.

According to device information got when login, you can open any real-time

monitoring and display it in any designated window by calling this in terface. If

succeeded, real-time monitoring ID is returned for more operation and control.

CLIENT_StopRealPlayEx

Option Instruction

Interface Extensive interface for stopping real-time monitoring , stop getting real-time

description monitoring data stream from logined device.

Precondition Have called interface for getting real-time monitoring data stream ,such as

CLIENT_RealPlayEx interface.

282/339
Option Instruction

Function BOOL CLIENT_StopRealPlayEx (

LLONG lRealHandle

);

Parameter lRealHandle

[in] real-time monitoring handle.

Return value of getting real-time monitoring data stream interface as

CLIENT_RealPlayEx etc.

Return value Succeeded return TRUE,otherwise return FALSE.

Example if (!CLIENT_StopRealPlayEx(g_lRealHandle))

printf("CLIENT_StopRealPlayEx Failed, g_lRealHandle[%x]!Last

Error[%x]\n" , g_lRealHandle, CLIENT_GetLastError());

Note None

CLIENT_SetRealDataCallBackEx

Option Instruction

Interface Extensive interface for setting real-time monitoring data callback function.

description

Precondition Have called get real-time monitoring data stream interface as

CLIENT_RealPlayEx etc.

Function BOOL CLIENT_SetRealDataCallBackEx(

LLONG lRealHandle,

fRealDataCallBackEx cbRealData,

LDWORD dwUser,

DWORD dwFlag

);

Parameter lRealHandle

283/339
Option Instruction

[in] real-time monitoring handle.

Return value of getting real-time monitoring data stream interface as

CLIENT_RealPlayEx etc.

cbRealData

[in] real-time monitoring data callback function

If cbRealData value is 0,not call back real-time monitoring data;

If cbRealData value is not 0,call back real-time monitoring data via callback

function cbRealData,please refer to callback function

(fRealDataCallBackEx) for details.

dwUser

[in] User data,SDK sends the data to user for further use via callback

function fRealDataCallBackEx.

dwFlag

[in] flag of callback data selection

we can recall data selectively as needed, do not recall data type which is not

set,different value corresponds to different data type:

dwFlag Data type

0x00000001 Equal with original data

0x00000002 Standard data of MPEG4/H264

0x00000004 YUV data

0x00000008 PCM data

0x00000010 Original audio data

0x0000001f The above five types of data

Return value If succeeded,return TRUE,otherwise return FALSE.

Example // Its not recommended to call SDK interface in callback function, unless call

CLIENT_GetLastError to get error code in current process.

//prototype of real-time monitor data callback function --extensive

//The callback function is set by CLIENT_ SetRealDataCallBackEx, When

284/339
Option Instruction

real-time data is received, SDK will call function.

//Recommend users only save data in this callback, In the other word:copy

data to your storage, and encode or decode data after leaving callback.

//Not recommend users encode or decode data directly in callback function.

void CALLBACK RealDataCallBackEx(LLONG lRealHandle, DWORD

dwDataType, BYTE *pBuffer, DWORD dwBufSize, LONG param, LDWORD

dwUser)

if (lRealHandle == g_lRealHandle)

switch(dwDataType)

case 0:

//original A/V hybrid data

printf("receive real data,param:lRealHandle[%p],

dwDataType[%d],pBuffer[%p],dwBufSize[%d],

param[%p],dwUser[%p]\n",lRealHandle, dwDataType,

pBuffer, dwBufSize, param, dwUser);

break;

case 1:

// standard video data

break;

case 2:

//yuv data

break;

case 3:

//pcm audio data

break;

case 4:

285/339
Option Instruction

//original audio data

break;

default:

break;

************ Above are callback function definition, the underneath are interface

using examples. **************

DWORD dwFlag = 0x00000001;

if(!CLIENT_SetRealDataCallBackEx(g_lRealHandle,&RealDataCallBackEx,

NULL, dwFlag))

printf("CLIENT_SetRealDataCallBackEx: failed! Error code: %x.\n",

CLIENT_GetLastError());

Note Add a callback data type flag- dwFlag, we can recall data selectively as

needed, do not recall data type which is not set.

CLIENT_FindFile
Option Instruction

Interface Interface for opening record query handle.

description

Precondition Have called login interface CLIENT_LoginEx2.

Function LLONG CLIENT_FindFile(

LLONG lLoginID,

int nChannelId,

int nRecordFileType,

286/339
Option Instruction

char* cardid,

LPNET_TIME time_start,

LPNET_TIME time_end,

BOOL bTime,

int waittime

);

Parameter lLoginID

[in]device login ID.

Return value of login interface CLIENT_LoginEx2.

nChannelId

[in] channel ID,start from 0.

nRecordFileType

[in] Record file type.

Different value corresponds with different record file type,please refer to

enum EM_QUERY_RECORD_TYPE

cardid

[in] extensive parameter,works in with nRecordFileType.

nRecordFileType cardid

EM_RECORD_TYPE_CARD card number

EM_RECORD_TYPE_CONDI card number &&transaction

TION type&&transaction amount

(such as wish to skip a

empty word)

EM_RECORD_TYPE_CARD_ card number

PICTURE

EM_RECORD_TYPE_FIELD FELD1&&FELD2&&

FELD3&&( such as wish to skip a

empty word,corresponding position

287/339
Option Instruction

is null)

In addition to the above situation, cardid value is null.

tmStart

[in] start time of query record.

Please refer to structure NET_TIME.

tmEnd

[in] end time of query record.

Please refer to structure NET_TIME.

bTime

[in] whether query by time

This parameter is invalid now,recommend to input FALSE.

waittime

[in] wait time.

Return value Succeeded return record query handle,otherwise return 0.

Example NET_TIME StartTime = {0};

NET_TIME StopTime = {0};

StartTime.dwYear = 2015;

StartTime.dwMonth = 9;

StartTime.dwDay = 20;

StartTime.dwHour = 0;

StartTime.dwMinute = 0;

StopTime.dwYear = 2015;

StopTime.dwMonth = 9;

StopTime.dwDay = 21;

StopTime.dwHour = 15;

NET_RECORDFILE_INFO netFileInfo[30] = {0};

int nFileCount = 0;

//Get record query handle.

if(!CLIENT_FindFile (lLoginHandle, nChannelID,

288/339
Option Instruction

(int)EM_RECORD_TYPE_ALL, NULL, &StartTime, &StopTime, FALSE, 5000))

printf("CLIENT_FindFile: failed! Error code: %x.\n",

CLIENT_GetLastError());

Note You can call this interface for querying video record before playback,then call

CLIENT_FindNextFile function to return a detailed video record for

playing,after query is finished,call CLIENT_FindClose to close query handle.

CLIENT_FindNextFile

Option Instruction

Interface Interface for searching record file.

description

Precondition Have called get record query handle interface as CLIENT_FindFile.

Function int CLIENT_FindNextFile(

LLONG lFindHandle,

LPNET_RECORDFILE_INFO lpFindData

);

Parameter lFindHandle

[in] record query handle.

Correspond with return value of CLIENT_FindFile interface.

lpFindData

[out]buffer of record file information.

Used to output queried record file information ,please refer to structure

NET_RECORDFILE_INFO.

Return value 1:take back a video record successfully.

0:Video record has been exhausted.

-1:parameter error.

Example NET_RECORDFILE_INFO struFileData = {0};

289/339
Option Instruction

int result = CLIENT_FindNextFile(lFindHandle, & struFileData);

if(result == 1) //Take back a record file information.

//Save record file.

else if(result == 0) // Data of record file information has been exhausted.

else //Parameter error.

printf("CLIENT_FindNextFile: failed! Error code:0x%x.\n",

CLIENT_GetLastError());

Note Call CLIENT_FindFile for opening query handle before call this interface.

One call returns one video record information.

CLIENT_FindClose

Option Instruction

Interface Interface for closing record query handle.

description

Precondition Have called get record query handle interface as CLIENT_FindFile.

Function BOOL CLIENT_FindClose(

LLONG lFindHandle

);

Parameter lFindHandle

[in] record query handle.

Correspond with return value of CLIENT_FindFile interface.

Return value Succeeded return TRUE,otherwise return FALSE.

290/339
Option Instruction

Example if(!CLIENT_FindClose (lFindHandle))

printf("CLIENT_FindNextFile: failed! Error code:0x%x.\n",

CLIENT_GetLastError());

Note Call CLIENT_FindFile for opening query handle,after query is finished,it is

needed to call this function to close query handle,and release resources.

CLIENT_PlayBackByTimeEx

Option Instruction

Interface Extensive interface for playing back by time

description

Precondition Have called login interface CLIENT_LoginEx2.

Function LLONG CLIENT_PlayBackByTimeEx(

LLONG lLoginID,

int nChannelID,

LPNET_TIME lpStartTime,

LPNET_TIME lpStopTime,

HWND hWnd,

fDownLoadPosCallBack cbDownLoadPos,

LDWORD dwPosUser,

fDataCallBack fDownLoadDataCallBack,

LDWORD dwDataUser

);

Parameter lLoginID

[in] device login ID.

Corresponding with return value of login interface CLIENT_LoginEx2.

nChannelID

[in] channel ID, start from 0.

291/339
Option Instruction

lpStartTime

[in] start time of playback.

Please refer to structure NET_TIME for details.

lpStopTime

[in]end time of playback.

Please refer to structure NET_TIME for details.

hWnd

[in] playback window.

cbDownLoadPos

[in] progress callback of user parameter

If cbDownLoadPos value is 0,not call back playback data process;

If cbDownLoadPos value is not 0,call back playback data process via

callback function cbDownLoadPos,please refer to fDownLoadPosCallBack

callback function for details.

dwPosUser

[in] user data.

SDK sends the data to user for further use via callback function

fDownLoadPosCallBack.

fDownLoadDataCallBack

[in] record data callback function.

If fDownLoadDataCallBack value is 0,not call back record playback data;If

fDownLoadDataCallBack value is not 0,call back record playback data via

callback function fDownLoadDataCallBack,please refer to fDataCallBack for

details.

dwDataUser

[in] user data.

SDK sends the data to user for further use via callback function

fDownLoadDataCallBack.

Return value If succeeded,return record playback handle ID,otherwise return 0.

292/339
Option Instruction

Example // this demo decoding by playsdk library

typedef HWND (WINAPI *PROCGETCONSOLEWINDOW)();

PROCGETCONSOLEWINDOW GetConsoleWindow;

// Get console window handle

HMODULE hKernel32 = GetModuleHandle("kernel32");

GetConsoleWindow =

(PROCGETCONSOLEWINDOW)GetProcAddress(hKernel32,"GetConsoleWi

ndow");

HWND hWnd = GetConsoleWindow();

int nChannelID = 0; //channel NO

NET_TIME stuStartTime = {0};

stuStartTime.dwYear = 2015;

stuStartTime.dwMonth = 9;

stuStartTime.dwDay = 3;

NET_TIME stuStopTime = {0};

stuStopTime.dwYear = 2015;

stuStopTime.dwMonth = 9;

stuStopTime.dwDay = 12;

g_lPlayHandle = CLIENT_PlayBackByTimeEx(g_lLoginHandle, nChannelID,

&stuStartTime, &stuStopTime, hWnd, NULL, NULL, NULL, NULL);

if (g_lPlayHandle == 0)

printf("CLIENT_PlayBackByTimeEx: failed! Error code: 0x%x.\n",

CLIENT_GetLastError());

Note Parameter hWnd and fDownLoadDataCallBack can not be NULL at the same

time,otherwise interface will return 0.

293/339
CLIENT_StopPlayBack

Option Instruction

Interface Interface for stopping record playback.

description

Precondition Have called get record playback handle interface as

CLIENT_PlayBackByTimeEx etc.

Function BOOL CLIENT_StopPlayBack(

LLONG lPlayHandle

);

Parameter lPlayHandle

[in] record playback handle.

Correspond with return value of CLIENT_PlayBackByTimeEx interface etc.

Return value Succeeded return TRUE,otherwise return FALSE.

Example if (!CLIENT_StopPlayBack(g_lPlayHandle))

printf("CLIENT_StopPlayBack Failed, g_lPlayHandle[%x]!Last

Error[%x]\n" , g_lPlayHandle, CLIENT_GetLastError());

Note users get record playback handle via CLIENT_PlayBackByTimeEx interface

etc,and close record playback handle via CLIENT_StopPlayBack.

CLIENT_GetPlayBackOsdTime

Option Instruction

Interface Interface for getting playback OSD time.

description Only when parameter hWnd in record playback interface is valid, can

parameter got by this interface be valid,otherwise it is insignificant.

Precondition Have called get record playback handle interface as

CLIENT_PlayBackByTimeEx etc.

Function BOOL CLIENT_GetPlayBackOsdTime(

294/339
Option Instruction

LLONG lPlayHandle,

LPNET_TIME lpOsdTime,

LPNET_TIME lpStartTime,

LPNET_TIME lpEndTime

);

Parameter lPlayHandle

[in]record playback handle.

Correspond with return value of CLIENT_PlayBackByTimeEx interface etc.

lpOsdTime

[out] OSD time

Please refer to structure NET_TIME for details.

lpStartTime

[out]start time of playback.

Please refer to structure NET_TIME for details.

lpEndTime

[out] end time of playback.

Please refer to structure NET_TIME for details.

Return value Succeeded return TRUE,otherwise return FALSE.

Example NET_TIME stuOsdTime = {0};

NET_TIME stuStartTime = {0};

NET_TIME stuEndTime = {0};

if (!CLIENT_GetPlayBackOsdTime (g_lPlayHandle, &stuOsdTime,

&stuStartTime, &stuEndTime))

printf("CLIENT_ GetPlayBackOsdTime Failed, g_lPlayHandle[%x]!Last

Error[%x]\n" , g_lPlayHandle, CLIENT_GetLastError());

Note Only when parameter hWnd in record playback interface is valid, can

parameter got by this interface be valid,otherwise it is insignificant.

295/339
CLIENT_QueryRecordFile

Option Instruction

Interface Interface for querying all files in pointed time period.

description

Precondition Have called login interface CLIENT_LoginEx2.

Function BOOL CLIENT_QueryRecordFile(

LLONG lLoginID,

int nChannelId,

int nRecordFileType,

LPNET_TIME tmStart,

LPNET_TIME tmEnd,

char* pchCardid,

LPNET_RECORDFILE_INFO nriFileinfo,

int maxlen,

int *filecount,

int waittime=1000,

BOOL bTime = FALSE

);

Parameter lLoginID

[in] device login ID.

Correspond with return value of login interface CLIENT_LoginEx2.

nChannelId

[in] channel ID,start from 0.

nRecordFileType

[in] record file type.

Different value corresponds with different record file type,please refer to

enum EM_QUERY_RECORD_TYPE.

tmStart

[in] start time of record query.

296/339
Option Instruction

Please refer to structure NET_TIME.

tmEnd

[in] end time of record query.

Please refer to structure NET_TIME.

pchCardid

[in] extensive parameter,work in with nRecordFileType.

nRecordFileType pchCardid

EM_RECORD_TYPE_CARD card number

EM_RECORD_TYPE_CONDITION card number &&transaction

type&&transaction amount

(such as wish to skip a empty

word)

EM_RECORD_TYPE_CARD_PICTURE card number

EM_RECORD_TYPE_FIELD FELD1&&FELD2&&FELD3

&&( such as wish to skip a

empty word,corresponding

position is null)

In addition to the above situation, pchCardid value is null.

nriFileinfo

[out] record file information of returned.

This is a pointer of structure array of NET_RECORDFILE_INFO,please

refer to structure NET_RECORDFILE_INFO for details.

maxlen

[in]max length of nriFileinfo buffer.

(unit:byte,recommend length:

(100~200)*sizeof(NET_RECORDFILE_INFO)

filecount

[out] file count of returned.

297/339
Option Instruction

Output parameter only querys to the biggest video record which buffer is full.

waittime

[in] wait time.

bTime

[in] whether query by time

This parameter is invalid now,recommended to input FALSE.

Return value Succeeded return TRUE,otherwise return FALSE.

Example NET_TIME StartTime = {0};

NET_TIME StopTime = {0};

StartTime.dwYear = 2015;

StartTime.dwMonth = 9;

StartTime.dwDay = 20;

StartTime.dwHour = 0;

StartTime.dwMinute = 0;

StopTime.dwYear = 2015;

StopTime.dwMonth = 9;

StopTime.dwDay = 21;

StopTime.dwHour = 15;

NET_RECORDFILE_INFO netFileInfo[30] = {0};

int nFileCount = 0;

//query record file

if(!CLIENT_QueryRecordFile(lLoginHandle, nChannelID,

(int)EM_RECORD_TYPE_ALL, &StartTime, &StopTime, NULL,

&netFileInfo[0], sizeof(netFileInfo), &nFileCount,5000, FALSE))

printf("CLIENT_QueryRecordFile: failed! Error code: %x.\n",

CLIENT_GetLastError());

Note Before playback by file,its needed to call this interface to query video record. If

298/339
Option Instruction

video record info of input time slot queried is greater than defined buffer size,

return video record which size is defined buffer size,and can continue querying

as needed.

CLIENT_DownloadByTimeEx

Option Instruction

Interface
Extensive interface for downloading record by time
description

Precondition Have called login interface CLIENT_LoginEx2.

LLONG CLIENT_DownloadByTimeEx(

LLONG lLoginID,

int nChannelId,

int nRecordFileType,

LPNET_TIME tmStart,

LPNET_TIME tmEnd,

Function char *sSavedFileName,

fTimeDownLoadPosCallBack cbTimeDownLoadPos,

LDWORD dwUserData,

fDataCallBack fDownLoadDataCallBack,

LDWORD dwDataUser,

void* pReserved = NULL

);

lLoginID

[in] logined device ID

Return value of login interface CLIENT_LoginEx2.

Parameter nChannelId

[in] channel NO., start from 0.

nRecordFileType

[in] record file type

299/339
Option Instruction

See enum EM_QUERY_RECORD_TYPE for details

tmStart

[in] record download start time

See struct NET_TIME for details

tmEnd

[in] record download end time

See struct NET_TIME for details

sSavedFileName

[in] name of the record file to be saved

Recommended to use the full path name

cbTimeDownLoadPos

[in] download progress callback function

See callback function fTimeDownLoadPosCallBack for details.

dwUserData

[in] user data of download progress callback function

SDK send the data to user for further use via callback function

fTimeDownLoadPosCallBack

fDownLoadDataCallBack

[in] download data callback function

See callback function fDataCallBack for details.

dwDataUser

[in] user data of download data callback function

SDK send the data to user for further use via callback function

fDataCallBack

pReserved

[in]reserved parameter

Used for further extension, meaningless until now, default value is NULL.

Return value succeed return download ID, failed return 0.

Example int nChannelID = 0; // channel NO.

300/339
Option Instruction

NET_TIME stuStartTime = {0};

stuStartTime.dwYear = 2015;

stuStartTime.dwMonth = 9;

stuStartTime.dwDay = 17;

NET_TIME stuStopTime = {0};

stuStopTime.dwYear = 2015;

stuStopTime.dwMonth = 9;

stuStopTime.dwDay = 18;

// start record download.

// at least one of the two formal parameters sSavedFileName and

fDownLoadDataCallBack is valid.

g_lDownloadHandle = CLIENT_DownloadByTimeEx(g_lLoginHandle,

nChannelID, EM_RECORD_TYPE_ALL, &stuStartTime, &stuStopTime,

"test.dav", TimeDownLoadPosCallBack, NULL, DataCallBack, NULL);

if (g_lDownloadHandle == 0)

printf("CLIENT_DownloadByTimeEx: failed! Error code: %x.\n",

CLIENT_GetLastError());

sSavedFileName is not NULL, record data is written to the corresponding file.

fDownLoadDataCallBack is not NULL, record data is returned via this callback

Note
function.

After download, call CLIENT_StopDownload to close download handle.

CLIENT_StopDownload

Option Instruction

Interface
Interface for stopping record download
description

Precondition Have called record download interface as CLIENT_DownloadByTimeEx etc.

301/339
Option Instruction

BOOL CLIENT_StopDownload(

Function LLONG lFileHandle

);

lFileHandle

[in]download handle
Parameter
Return value of record download interface as

CLIENT_DownloadByTimeEx etc.

Value Succeed return TRUE, failed return FALSE

// stop download,we can call this interface after download end or during

download.

if (g_lDownloadHandle)

if (!CLIENT_StopDownload(g_lDownloadHandle))

Example {

printf("CLIENT_StopDownload

Failed, g_lDownloadHandle[%x]

!Last Error[%x]\n" , g_lDownloadHandle, CLIENT_GetLastError());

Note We can stop download after download end or during download as needed.

CLIENT_PlayBackByRecordFileEx

Option Instruction

Interface
Extensive interface for playing back by file
description

Precondition Have called login interface CLIENT_LoginEx2.

LLONG CLIENT_PlayBackByRecordFileEx(

Function LLONG lLoginID,

LPNET_RECORDFILE_INFO lpRecordFile,

302/339
Option Instruction

HWND hWnd,

fDownLoadPosCallBack cbDownLoadPos,

LDWORD dwPosUser,

fDataCallBack fDownLoadDataCallBack,

LDWORD dwDataUser

);

lLoginID

[in] logined device ID

Return value of login interface CLIENT_LoginEx2.

lpRecordFile

[in] record file information

Obtained by record information search interface as CLIENT_FindNextFile.

See struct NET_RECORDFILE_INFO for details.

hWnd

[in] playback window handle

cbDownLoadPos

[in] record progress callback function

Parameter If cbDownLoadPos is 0, not call back playback data progress.

If cbDownLoadPos is not 0, call back playback data progress via callback

function cbDownLoadPos, see callback function fDownLoadPosCallBack

for details.

dwPosUser

[in] user data

SDK send the data to user for further use via callback function

fDownLoadPosCallBack

fDownLoadDataCallBack

[in] record data callback function

If fDownLoadDataCallBack is 0, not call back playback data.

If fDownLoadDataCallBack is not 0, call back playback data progress via

303/339
Option Instruction

callback function fDownLoadDataCallBack, see callback function

fDataCallBackfor details.

dwDataUser

[in] user data

SDK send the data to user for further use via callback function

fDownLoadDataCallBack

Return value Succeed return playback handle, failed return 0.

// formal parameter hWnd must be valid.

//stuNetFileInfo information is obtained by together of three interfaces

CLIENT_FindFile,CLIENT_FindNextFile and CLIENT_FindClose.

g_lPlayHandle = CLIENT_PlayBackByRecordFileEx(g_lLoginHandle,

&stuNetFileInfo, hWnd, NULL, NULL, NULL, NULL);

Example
if (g_lPlayHandle == 0)

printf("CLIENT_PlayBackByRecordFileEx: failed! Error code: %x.\n",

CLIENT_GetLastError());

Parameter hWnd and fDownLoadDataCallBack can not be NULL at the

Note
same time, otherwise the interface will be failed.

CLIENT_PausePlayBack
Option Instruction

Interface for pause or restoring playback

Interface
Only when the parameter hWnd in open record playback interface is valid,
description
can parameters this interface obtained be valid, otherwise it is no meaning.

Hava called interface as CLIENT_PlayBackByTimeEx etc. to obtain record

Precondition
playback handle.

Function BOOL CLIENT_PausePlayBack(LLONG lPlayHandle, BOOL bPause);

Parameter lPlayHandle

304/339
Option Instruction

[in] record playback handle

Return value of interface as CLIENT_PlayBackByTimeEx etc.

bPause

[in] flag of pause or restore playing

TRUE :pause FALSE :restore playing

Return value Succeed return TRUE, failed return FALSE.

if (!CLIENT_ PausePlayBack (g_lPlayHandle))

Example printf("CLIENT_ PausePlayBack Failed, g_lPlayHandle[%x]!Last

Error[%x]\n" , g_lPlayHandle, CLIENT_GetLastError());

Only when the parameter hWnd in open record playback interface is valid,
Note
can parameters this interface obtained be valid, otherwise it is no meaning.

CLIENT_SeekPlayBack
Option Instruction

Interface
Interface for positioning record playback start point
description

Hava called interface as CLIENT_PlayBackByTimeEx etc. to obtain record

Precondition
playback handle.

BOOL CLIENT_SeekPlayBack(

LLONG lPlayHandle,

Function unsigned int offsettime,

unsigned int offsetbyte

);

lPlayHandle

[in] record playback handle

Parameter
Return value of interface as CLIENT_PlayBackByTimeEx etc.

offsettime

305/339
Option Instruction

[in] relative offset of start time(unit : s)

offsetbyte

[in] this parameter is abolished

Set to 0xffffffff.

Return value Succeed return TRUE, failed return FALSE.

int nOffsetSeconds = 2 * 60 * 60; // drag to 2*60*60s after stuStartTime to start

play.

if (FALSE == CLIENT_SeekPlayBack (g_lPlayHandle, nOffsetSeconds,

0xffffffff))
Example
{

printf("CLIENT_SeekPlayBack Failed, g_lPlayHandle[%x]!Last

Error[%x]\n" , g_lPlayHandle, CLIENT_GetLastError());

Note None

CLIENT_FastPlayBack

Option Instruction

Interface for fast play. Increasing frame rate by 1x

Interface
Only when the parameter hWnd in open record playback interface is valid, can
description
parameters this interface obtained be valid, otherwise it is no meaning.

Hava called interface as CLIENT_PlayBackByTimeEx etc. to obtain record

Precondition
playback handle.

BOOL CLIENT_FastPlayBack(

Function LLONG lPlayHandle

);

lPlayHandle

Parameter [in] record playback handle

Return value of interface as CLIENT_PlayBackByTimeEx etc.

306/339
Option Instruction

Return value Succeed return TRUE, failed return FALSE.

if (!CLIENT_ FastPlayBack (g_lPlayHandle))

Example printf("CLIENT_ FastPlayBack Failed, g_lPlayHandle[%x]!Last

Error[%x]\n" , g_lPlayHandle, CLIENT_GetLastError());

Can not fast forward without limit, currently the max frame is 200, greater than

this will return FALSE. if the record is with sound, fast forward is not

Note supported.

Only when the parameter hWnd in open record playback interface is valid, can

parameters this interface obtained be valid, otherwise it is no meaning.

CLIENT_SlowPlayBack
Option Instruction

Interface
Interface for slow play. Decreasing frame rate by 1x
description

Hava called interface as CLIENT_PlayBackByTimeEx etc. to obtain record

Precondition
playback handle.

BOOL CLIENT_SlowPlayBack (

Function LLONG lPlayHandle

);

lPlayHandle

Parameter [in] record playback handle

Return value of interface as CLIENT_PlayBackByTimeEx etc.

Return value Succeed return TRUE, failed return FALSE.

if (!CLIENT_SlowPlayBack (g_lPlayHandle))

Example {

printf("CLIENT_SlowPlayBack Failed, g_lPlayHandle[%x]!Last

307/339
Option Instruction

Error[%x]\n" , g_lPlayHandle, CLIENT_GetLastError());

The min frame is 1, less than 1 will return FALSE.

when the parameter hWnd in open record playback interface is 0 and device

supports playback speed control, SDK can send speed control command to

device.
Note
when the parameter hWnd in open record playback interface is a valid value

and device supports playback speed control, SDK can send speed control

command to device and call the command to playsdk library which display

records.

CLIENT_NormalPlayBack

Option Instruction

Interface
Interface for restoring normal play speed
description

Hava called interface as CLIENT_PlayBackByTimeEx etc. to obtain record

Precondition
playback handle.

BOOL CLIENT_NormalPlayBack(

Function LLONG lPlayHandle

);

lPlayHandle

Parameter [in] record playback handle

Return value of interface as CLIENT_PlayBackByTimeEx etc.

Return value Succeed return TRUE, failed return FALSE.

if (!CLIENT_NormalPlayBack (g_lPlayHandle))

Example printf("CLIENT_NormalPlayBack Failed, g_lPlayHandle[%x]!Last

Error[%x]\n" , g_lPlayHandle, CLIENT_GetLastError());

308/339
Option Instruction

when the parameter hWnd in open record playback interface is 0 and device

supports playback speed control, SDK can send speed control command to

device.

Note when the parameter hWnd in open record playback interface is a valid value

and device supports playback speed control, SDK can send speed control

command to device and call the command to playsdk library which display

records.

CLIENT_DownloadByRecordFileEx
Option Instruction

Interface
Extensive interface for downloading record by file
description

Precondition Have called login interface CLIENT_LoginEx2.

LLONG CLIENT_DownloadByRecordFileEx(

LLONG lLoginID,

LPNET_RECORDFILE_INFO lpRecordFile,

char *sSavedFileName,

fDownLoadPosCallBack cbDownLoadPos,
Function
LDWORD dwUserData,

fDataCallBack fDownLoadDataCallBack,

LDWORD dwDataUser,

void* pReserved = NULL

);

lLoginID

[in] logined device ID

Return value of login interface CLIENT_LoginEx2.

Parameter
lpRecordFile

[in] record file information pointer

Obtained by record search interface CLIENT_QueryRecordFile, see

309/339
Option Instruction

NET_RECORDFILE_INFO for details.

sSavedFileName

[in] name of the record file to be saved

Recommended to use the full path name

cbDownLoadPos

[in] record progress callback function

If cbDownLoadPos is 0, not call back playback data progress.

If cbDownLoadPos is not 0, call back playback data progress via callback

function cbDownLoadPos, see callback function fDownLoadPosCallBack

for details.

dwPosUser

[in] user data

SDK send the data to user for further use via callback function

fDownLoadPosCallBack

fDownLoadDataCallBack

[in] record data callback function

If fDownLoadDataCallBack is 0, not call back playback data.

If fDownLoadDataCallBack is not 0, call back playback data progress via

callback function fDownLoadDataCallBack, see callback function

fDataCallBackfor details.

dwDataUser

[in] user data

SDK send the data to user for further use via callback function

fDownLoadDataCallBack

pReserved

[in]reserved parameter

Used for further extension, invalid until now, default value is NULL.

Return value Succeed return TRUE, failed return FALSE.

Example // at least one of the two formal parameters sSavedFileName and

310/339
Option Instruction

fDownLoadDataCallBack is valid.

g_lDownloadHandle = CLIENT_DownloadByRecordFileEx(g_lLoginHandle,

&stuNetFileInfo, "test.dav", DownLoadPosCallBack, NULL, DataCallBack,

NULL);

if (g_lDownloadHandle == 0)

printf("CLIENT_DownloadByRecordFileEx: failed!

Error code: %x.\n", CLIENT_GetLastError());

sSavedFileName is not NULL, record data is written to the corresponding file.

fDownLoadDataCallBack is not NULL, record data is returned via this callback

Note
function.

After download, call CLIENT_StopDownload to close download handle.

CLIENT_ParseData

Option Instruction

Interface
Interface for analyzing the obtained config info
description

Precondition Have called login interface CLIENT_LoginEx2.

BOOL CLIENT_ParseData(

char* szCommand,

char* szInBuffer,

Function LPVOID lpOutBuffer,

DWORD dwOutBufferSize,

void* pReserved

);

szCommand

Parameter [in] command parameter

See note below for details.

311/339
Option Instruction

szInBuffer

[in] input buffer

To be analyzed json string

lpOutBuffer

[out] output buffer

Different command parameter correspond to different struct type.

dwOutBufferSize

[in] output buffer size

pReserved

[in] reserved parameter

Return value Succeed return TRUE, failed return FALSE.

CFG_PTZ_PROTOCOL_CAPS_INFO stuPtzCapsInfo =

{sizeof(stuPtzCapsInfo)};

if (FALSE == CLIENT_ParseData(CFG_CAP_CMD_PTZ, pBuffer,

&stuPtzCapsInfo, sizeof(stuPtzCapsInfo), NULL))

Example
{

printf("CLIENT_ParseData Failed, cmd[CFG_CAP_CMD_PTZ],

Last Error[%x]\n" , CLIENT_GetLastError());

Command parameter

#define CFG_CAP_CMD_PTZ "ptz.getCurrentProtocolCaps"

// obtain PTZ capacity set (CFG_PTZ_PROTOCOL_CAPS_INFO)

Note
#define CFG_CMD_ENCODE "Encode" // image channel

property configure (corresponds to CFG_ENCODE_INFO)

See header file dhconfigsdk.h for more command parameters.

CLIENT_DHPTZControlEx2
Option Instruction

Interface Extensive interface for private PTZ control. Support 3-D quick positioning and

312/339
Option Instruction

description fish-eye.

Precondition Have called login interface CLIENT_LoginEx2.

BOOL CLIENT_DHPTZControlEx2(

LLONG lLoginID,

int nChannelID,

DWORD dwPTZCommand,

LONG lParam1,
Function
LONG lParam2,

LONG lParam3,

BOOL dwStop ,

void* param4 = NULL

);

lLoginID

[in] logined device ID

Return value of login interface CLIENT_LoginEx2.

nChannelId

[in] channel NO., start from 0.

dwPTZCommand

[in] dome control command

See enum DH_PTZ_ControlType and enum DH_EXT PTZ_ControlType for

Parameter details.

lParam1

[in] ancillary parameter 1

Used matched with other parameter, different control command has different

lParam1.

lParam2

[in] ancillary parameter 2

Used matched with other parameter, different control command has different

lParam2

313/339
Option Instruction

lParam3

[in] ancillary parameter3

Used matched with other parameter, different control command has different

lParam3

dwStop

[in] stop or not

Valid when operating PTZ eight direction and lens, otherwise in when

operating others the parameter is set to FALSE.

lParam4

[in] ancillary parameter4, NULL as default.

Used matched with other parameter, different control command has different

lParam4

Return value Succeed return TRUE, failed return FALSE.

if (!CLIENT_DHPTZControlEx2(g_lLoginHandle, nChannelId,

DH_PTZ_UP_CONTROL, 0, 0, 0, FALSE, NULL))

Example printf("CLIENT_DHPTZControlEx2 Failed,

nChoose[DH_PTZ_UP_CONTROL]!Last Error[%x]\n" ,

CLIENT_GetLastError());

More Information of Param ,please refer to the CLIENT_DHPTZControlEx2

Note
interface in Network SDK Development Manual.chm .

CLIENT_QueryNewSystemInfo
Option Description

Interface Interface for obtaining new system capacity set (take the form of Json, see

description config SDK for details )

Precondition Have called login interface CLIENT_LoginEx2.

314/339
Option Description

BOOL CLIENT_QueryNewSystemInfo(

LLONG lLoginID,

char* szCommand,

int nChannelID,

Function char* szOutBuffer,

DWORD dwOutBufferSize,

int *error,

int waittime=1000

);

lLoginID

[in] logined device ID

Return value of login interface CLIENT_LoginEx2.

szCommand

[in] search command

See Note for details

nChannelID

[in] search channel

Channel NO. is start from 0.

set to -1 means searching all the channels, partial commands not support
Parameter
setting to -1.

szOutBuffer

[in] buffer zone used to store data

Used to store the queried json string data

dwOutBufferSize

[in] buffer size

error

[out] returned error code

When failed obtaining, netsdk will write corresponding error code to this

pointer address.

315/339
Option Description

waittime

[in] timeout time

Timeout time of waiting command returned, take 1000ms as default

Return value Succeed return TRUE, failed return FALSE.

char* pBuffer = new char[2048];

if (NULL == pBuffer)

return;

int nError = 0;

if (FALSE == CLIENT_QueryNewSystemInfo(g_lLoginHandle,

CFG_CAP_CMD_PTZ, 0, pBuffer, 2048, &nError))

{
Example
printf("CLIENT_QueryNewSystemInfo

Failed, cmd[CFG_CAP_CMD_PTZ], Last Error[%x]\n" ,

CLIENT_GetLastError());

if (pBuffer)

delete [] pBuffer;

pBuffer = NULL;

return;

The json string obtained by this interface must be analyzed by

CLIENT_ParseData interface,otherwise can not be used.

Note The capacity set corresponds to CLIENT_QueryNewSystemInfo are as

follows:

#define CFG_CAP_CMD_PTZ "ptz.getCurrentProtocolCaps" //

316/339
Option Description

obtaining PTZ capacity set (CFG_PTZ_PROTOCOL_CAPS_INFO)

See header file dhconfigsdk.h for more command parameters.

CLIENT_SetDeviceMode

Option Instruction

Interface Interface for setting work mode such as audio intercom, playback, right and

description etc.

Precondition Have called login interface CLIENT_LoginEx2.

BOOL CLIENT_SetDeviceMode(

LLONG lLoginID,

Function EM_USEDEV_MODE emType,

void* pValue

);

lLoginID

[in] logined device ID

Return value of login interface CLIENT_LoginEx2.

emType

[in] working mode type

Parameter
See enum EM_USEDEV_MODE for details

pValue

[in] extensive parameter

Different emType corresponds to different pValue,see enum

EM_USEDEV_MODE for details.

Return value Succeed return TRUE, failed return FALSE.

//set playback stream type

int nStreamType = 0; // 0-main/sub stream,1-main stream,2-sub stream

Example if(!CLIENT_SetDeviceMode(g_lLoginHandle,

DH_RECORD_STREAM_TYPE, &nStreamType))

317/339
Option Instruction

printf("CLIENT_ SetDeviceMode: failed! Error code: 0x%x.\n",

CLIENT_GetLastError());

Note None

CLIENT_StartSearchDevices

Option Instruction

Interface
Interface for async searching for IPC, NVS and etc. within same segment
description

Precondition Have called CLIENT_Init interface

LLONG CLIENT_StartSearchDevices(

fSearchDevicesCB cbSearchDevices,

Function void* pUserData,

char* szLocalIp=NULL

);

cbSearchDevices

[in] device search callback function

When there are response package returned from device-end, NetSDK will

analyze them to valid information and inform user via callback function, see

callback function fSearchDevicesCB for details.

pUserData
Parameter
[in] user data

NetSDK will return the value to user for further user via callback function

fSearchDevicesCB.

szLocalIp

[in] local IP

NULL as default if this parameter is not set.

Return value Succeed return handle, failed return FALSE.

Example // start async searching for same-segment device

318/339
Option Instruction

g_lSearchHandle = CLIENT_StartSearchDevices(SearchDevicesCB,

&g_lDeviceList);

if (NULL == g_lSearchHandle)

printf("CLIENT_StartSearchDevices Failed!Last Error[%x]\n",

CLIENT_GetLastError());

return;

This interface is for searching device in the same segment, search

Note
cross-segment device interface is CLIENT_SearchDevicesByIPs.

CLIENT_QueryDevState

Option Instruction

Interface
Interface for searching device status
description

Precondition Have called login interface CLIENT_LoginEx2.

BOOL CLIENT_QueryDevState(

LLONG lLoginID,

int nType,

char *pBuf,
Function
int nBufLen,

int *pRetLen,

int waittime=1000

);

lLoginID

[in] logined device ID

Parameter Return value of login interface CLIENT_LoginEx2.

nType

[in] search type

319/339
Option Instruction

See note below for details.

pBuf

[out] output buffer zone

Used to store the queried device infor, used matched with nType, see

note below for details.

nBufLen

[in] buffer zone size

pRetLen

[out] lenth of queried data(unit : BYTE)

waittime

[in] searching waiting time , 1000ms as default

Return value Succeed return TRUE, failed return FALSE.

//Get audio intercom encode type supported by front-end device

DHDEV_TALKFORMAT_LIST stulstTalkEncode;

int retlen = 0;

bSuccess = CLIENT_QueryDevState(g_lLoginHandle,

DH_DEVSTATE_TALK_ECTYPE, (char*)&stulstTalkEncode,

Example sizeof(stulstTalkEncode), &retlen, 3000);

if (!(bSuccess && retlen == sizeof(stulstTalkEncode)))

printf("CLIENT_QueryDevState cmd[%d] Failed!Last Error[%x]\n" ,

DH_DEVSTATE_TALK_ECTYPE, CLIENT_GetLastError());

Supported searching type is shown in below:

#define DH_DEVSTATE_TALK_ECTYPE 0x0009

Note //searching audiointercom type list device supported, see struct

DHDEV_TALKFORMAT_LIST for details.

See dhnetsdk.h header file for more command parameter.

320/339
CLIENT_StartTalkEx

Option Instruction

Interface
Extensive interface for opening audio intercom
description

Precondition Have called login interface CLIENT_LoginEx2.

LLONG CLIENT_StartTalkEx(

LLONG lLoginID,

Function pfAudioDataCallBack pfcb,

LDWORD dwUser

);

lLoginID

[in] logined device ID

Return value of login interface CLIENT_LoginEx2.

pfcb

[in] audio intercom audio data callback function

Parameter
See callback function pfAudioDataCallBack for details.

dwUser

[in] user data

SDK will call back the data to user for further use via callback function

pfAudioDataCallBack

Return value Succeed return audio intercom handle, failed return FALSE.

g_lTalkHandle = CLIENT_StartTalkEx(g_lLoginHandle, AudioDataCallBack,

(DWORD)NULL);

if(0 == g_lTalkHandle)

Example {

printf("CLIENT_StartTalkEx Failed!Last Error[%x]\n",

CLIENT_GetLastError());

Note None

321/339
CLIENT_StopTalkEx

Option Instruction

Interface
Extensive interface for stopping audio intercom
description

Precondition Have called open audio intercom interface as CLIENT_StartTalkEx etc.

BOOL CLIENT_StopTalkEx(

Function LLONG lTalkHandle

);

lTalkHandle

Parameter [in] audio intercom handle

Corresponding to return value of interface as CLIENT_StartTalkEx etc.

Return value Succeed return TRUE, failed return FALSE.

if(!CLIENT_StopTalkEx(g_lTalkHandle))

printf("CLIENT_StopTalkEx Failed!Last Error[%x]\n",

CLIENT_GetLastError());

Example }

else

g_lTalkHandle = 0;

Note None

CLIENT_RecordStartEx
Option Instruction

Interface Extensive interface for starting PC-end recording(extension of

description CLIENT_RecordStart())

Precondition Have called login interface CLIENT_LoginEx2.

Function BOOL CLIENT_RecordStartEx(

322/339
Option Instruction

LLONG lLoginID

);

lLoginID

Parameter [in] logined device ID

Return value of login interface CLIENT_LoginEx2.

Return value Succeed return TRUE, failed return FALSE.

BOOL bSuccess = CLIENT_RecordStartEx(g_lLoginHandle);

if(!bSuccess)

{
Example
printf("CLIENT_RecordStartEx Failed!

Last Error[%x]\n", CLIENT_GetLastError());

Note None

CLIENT_RecordStopEx

Option Instruction

Interface Extensive interface for stopping PC-end recording(extension of

description CLIENT_RecordStop())

Precondition Have called open local recording interface as CLIENT_RecordStartEx etc.

BOOL CLIENT_RecordStopEx(

Function LLONG lLoginID

);

lLoginID

Parameter [in] logined device ID

Return value of login interface CLIENT_LoginEx2.

Return value Succeed return TRUE, failed return FALSE.

// stop local recording

Example
if (g_RecordFlag)

323/339
Option Instruction

if (!CLIENT_RecordStopEx(g_lLoginHandle))

printf("CLIENT_RecordStop Failed!

Last Error[%x]\n", CLIENT_GetLastError());

else

g_RecordFlag = FALSE;

CLIENT_RecordStopEx interface needs to be used corresponding to

Note
CLIENT_RecordStartEx

CLIENT_TalkSendData

Option Instruction

Interface
Interface for sending audio data to device
description

Precondition Have called login interface CLIENT_LoginEx2.

LONG CLIENT_TalkSendData(

LLONG lTalkHandle,

Function char *pSendBuf,

DWORD dwBufSize

);

lTalkHandle

[in] audio intercom handle

Parameter Corresponding to return value of interface as CLIENT_StartTalkEx etc.

pSendBuf

[in] send buffer zone

324/339
Option Instruction

Store data to be sent

dwBufSize

[in]buffer size

Length of data to be sent(unit: BYTE)

Return value Succeed return data length has been transferred practically, failed return -1.

LONG lSendLen = CLIENT_TalkSendData(lTalkHandle, pDataBuf,

dwBufSize);

if(lSendLen != (long)dwBufSize)

Example {

printf("CLIENT_TalkSendData Failed!Last Error[%x]\n" ,

CLIENT_GetLastError());

Send the data which is called back by callback function set in

Note
CLIENT_StartTalkEx to device

CLIENT_AudioDecEx

Option Instruction

Interface
Extensive interface for decoding audio data
description

Precondition Have called login interface CLIENT_LoginEx2.

BOOL CLIENT_AudioDecEx(

LLONG lTalkHandle,

Function char *pAudioDataBuf,

DWORD dwBufSize

);

lTalkHandle

[in] audio intercom handle

Parameter
Corresponding to return value of interface as CLIENT_StartTalkEx etc.

pAudioDataBuf

325/339
Option Instruction

[in] audio buffer zone

The audio data to be decoded.

dwBufSize

[in] buffer size

Length of audio data to be decoded (unit : BYTE)

Return value Succeed return TRUE, failed return FALSE.

// send the audio data which received from device-end to SDK to decode and

play.

if (!CLIENT_AudioDecEx(lTalkHandle, pDataBuf, dwBufSize))

Example {

printf("CLIENT_AudioDecEx Failed!Last Error[%x]\n" ,

CLIENT_GetLastError());

Note Decode the data sent by device in audio intercom

CLIENT_SetDVRMessCallBack

Option Instruction

Interface
Interface for setting alarm callback function.
description

Precondition Have called login interface CLIENT_LoginEx2.

void CLIENT_SetDVRMessCallBack(

fMessCallBack cbMessage,
Function
LDWORD dwUser

);

cbMessage

[in] alarm callback function.

Parameter Please refer to fMessCallBack for details.

dwUser

[in] user data, SDK sends the data to user for further use via real-time

326/339
Option Instruction

monitoring data callback function fMessCallBack.

Return value None

//Set alarm event callback function.

Example
CLIENT_SetDVRMessCallBack(MessCallBack , NULL);

Call CLIENT_SetDVRMessCallBack before alarm subscription. The events

Note
received by the callback function set dont contain picture event.

CLIENT_StartListenEx

Option instruction

Interface
Extensive interface for subscribing alarm event from device
description

Precondition Have called login interface CLIENT_LoginEx2.

BOOL CLIENT_StartListenEx(

Function LLONG lLoginID

);

lLoginID

Parameter [in] logined device ID

Return value of login interface CLIENT_LoginEx2.

Return value Succeeded return TRUE, failed return FALSE.

// subscribe alarm event from device

if( CLIENT_StartListenEx(g_lLoginHandle))

g_bStartListenFlag = TRUE;

Example printf("Listen Success! \nJust Wait Event....\n");

else

printf("CLIENT_StartListenEx Failed!Last

327/339
Option instruction

Error[%x]\n" , CLIENT_GetLastError());

All the device alarm events are sent to user via callback function set in
Note
interface CLIENT_SetDVRMessCallBack.

CLIENT_StopListen

Option Instruction

Interface
Interface for stopping subscribing alarm
description

Precondition Have called alarm report subscription interface as CLIENT_StartListenEx etc.

BOOL CLIENT_StopListen(

Function LLONG lLoginID

);

lLoginID

Parameter [in] logined device ID

Return value of login interface CLIENT_LoginEx2.

Return value Succeeded return TRUE, failed return FALSE.

// stop subscribing alarm from device

if (g_bStartListenFlag)

if (!CLIENT_StopListen(g_lLoginHandle))

printf("CLIENT_StopListen Failed!Last
Example
Error[%x]\n", CLIENT_GetLastError());

else

g_bStartListenFlag = FALSE;

328/339
Option Instruction

Note None

CLIENT_StopSearchDevices
Option Instruction

Interface Interface for stopping async search for IPC, NVS and etc. within same

description segment.

Precondition Have called async search interface as CLIENT_StartSearchDevices etc.

BOOL CLIENT_StopSearchDevices(

Function LLONG lSearchHandle

);

lSearchHandle

[in] async search for device ID

Parameter
Corresponding to return value of async search for device interface as

CLIENT_StartSearchDevices etc.

Return value Succeeded return TRUE, failed return FALSE.

// stop async search for device within same segment

if (NULL != g_lSearchHandle)

if (FALSE == CLIENT_StopSearchDevices(g_lSearchHandle))

Example {

printf("CLIENT_StopSearchDevices Failed!Last Error[%x]\n",

CLIENT_GetLastError());

Note This interface is used with CLIENT_StartSearchDevices as a pair.

329/339
CLIENT_SearchDevicesByIPs

Option Instruction

Interface
Interface for sync searching for cross-segment device
description

Precondition Have called CLIENT_Init interface.

BOOL CLIENT_SearchDevicesByIPs(

DEVICE_IP_SEARCH_INFO* pIpSearchInfo,

fSearchDevicesCB cbSearchDevices,

Function LDWORD dwUserData,

char* szLocalIp,

DWORD dwWaitTime

);

pIpSearchInfo

[in] information of device to be searched for.

IP of device to be searched for. See header file dhnetsdk.h for more

information about DEVICE_IP_SEARCH_INFO.

cbSearchDevices

[in] searching for device callback function

When there are response package returned from device-end, SDK will

analyze them to valid information and inform user via callback function, see

Parameter callback function fSearchDevicesCB for details.

dwUserData

[in] user data

SDK send the data to user for further use via callback function

fSearchDevicesCB

szLocalIp

[in] local IP

NULL as default if this parameter is not set.

dwWaitTime

330/339
Option Instruction

[in] time for searching

User can set the parameter as needed, as this is a sync interface, only

when the time set here is out, can the interface have a return .

Return value Succeeded return TRUE, failed return FALSE.

DWORD dwWaitTime = 5000;

// please note that only when the time set here is out, can the interface have a

return.user can decide the timeout time according to net condition.

if (FALSE == CLIENT_SearchDevicesByIPs(&stuTmp, SearchDevicesCB,

(LDWORD)&g_lDeviceList, szLocalIp, dwWaitTime))

Example
{

printf("CLIENT_SearchDevicesByIPs Failed!Last Error[%x]\n",

CLIENT_GetLastError());

return;

As this is a sync interface, only when the time set here is out, can the interface
Note
have a return . user can decide the timeout time according to net condition.

CLIENT_RealLoadPictureEx
Option Instruction

Interface Interface for intelligent picture alarm subscription.

description

Precondition Have called login interface CLIENT_LoginEx2.

Function LLONG CLIENT_RealLoadPictureEx(

LLONG lLoginID,

int nChannelID,

DWORD dwAlarmType,

BOOL bNeedPicFile,

fAnalyzerDataCallBack cbAnalyzerData,

LDWORD dwUser,

331/339
Option Instruction

void* Reserved

);

Parameter lLoginID

[in] device login ID.

Correspond with return value of login interface CLIENT_LoginEx2.

nChannelID

[in]channel number of intelligent picture alarm subscription,

start from 0.

dwAlarmType

[in] Alarm type of expected subscription .

Example: EVENT_IVS_ALL // subscription all event

See header file dhnetsdk.h for more command parameters.

bNeedPicFile

[in] whether subscribe picture file.

TRUE:means subscribe picture file,return intelligent picture info in the

callback function.

FALSE:means not subscribe picture file,not return intelligent picture info in

the callback function(reduce network flux when do not need to picture info).

cbAnalyzerData

[in] intelligent picture alarm callback function.

When device has intelligent picture alarm to report,SDK will call this function

to recall data for users.

dwUser

[in] user data, SDK sends the data to user for further use via intelligent

picture alarm callback function fAnalyzerDataCallBack.

Reserved

[in] reserved parameter.

Recommended to be set to NULL.

Return value Failed return 0,otherwise return ID of intelligent picture alarm subscription to

332/339
Option Instruction

be used as parameters of relatited function

Example //subscribe intelligent picture alarm.

LDWORD dwUser = 0;

g_lRealLoadHandle = CLIENT_RealLoadPictureEx(g_lLoginHandle, 0,

EVENT_IVS_ALL, TRUE, AnalyzerDataCallBack, dwUser, NULL);

if (0 == g_lRealLoadHandle)

printf("CLIENT_RealLoadPictureEx Failed!Last Error[%x]\n",

CLIENT_GetLastError());

return;

Note Each subscription corresponds to one channel, and corresponds to a type of

event.

If a user wants to set all types of event for one channel, the parameter

dwAlarmType should be set to EVENT_IVS_ALL.

If you want to set two types of events for one channel,please call

CLIENT_RealLoadPictureEx twice and set different event type.

You can cancel subscription by CLIENT_StopLoadPic.

CLIENT_ControlDeviceEx

Option Instruction

Interface Extensive interface for device control.

description

Precondition Have called login interface CLIENT_LoginEx2.

Function BOOL CLIENT_ControlDeviceEx(

LLONG lLoginID,

CtrlType emType,

void* pInBuf,

void* pOutBuf = NULL,

333/339
Option Instruction

int nWaitTime = 1000

);

Parameter lLoginID

[in] device login ID.

Correspond with return value of login interface CLIENT_LoginEx2.

emType

[in]control type.

Work in with pInBuf and pOutBufdifferent emType,pInBuf and pOutBuf

point to different structures,please refer to enum CtrlType for datails.

pInBuf

[in] input parameter of device control.

Work in with emTypedifferent emType and pInBuf point to different

structure,please refer to enum CtrlType for datails. If the value of emType

did not indicate what struct pInBuf is in enum instruction, set the parameter

to NULL.

pOutBuf

[in] output parameter of device control,the default is NULL.

Work in with emTypedifferent emType and pOutBuf point to different

structures,please refer to enum CtrlType for datails. If the value of emType

did not indicate what struct pOutBuf is in enum instruction, set the

parameter to NULL.

nWaitTime

[in] timeout time of waiting for device returns,unit is ms.

The default value is 1000ms.

Return value Succeeded return TRUE,otherwise return FALSE.

Example MANUAL_SNAP_PARAMETER stuSanpParam = {0};

stuSanpParam.nChannel = 0;

memcpy(stuSanpParam.bySequence, "just for test",

sizeof(stuSanpParam.bySequence) - 1);

334/339
Option Instruction

// manually snapshot trigger alarm function, this function is only valid for ITC

device

if (FALSE == CLIENT_ControlDeviceEx(g_lLoginHandle,

DH_MANUAL_SNAP, &stuSanpParam))

printf("CLIENT_ControlDeviceEx Failed!Last Error[%x]\n",

CLIENT_GetLastError());

break;

Note None

CLIENT_StopLoadPic

Option Instruction

Interface Interface for stopping subscribing intelligent picture alarm.

description

Precondition Have called intelligent picture alarm subscription interface as

CLIENT_RealLoadPictureEx etc.

Function BOOL CLIENT_StopLoadPic(

LLONG lAnalyzerHandle

);

Parameter lAnalyzerHandle

[in] intelligent picture alarm subscription ID.

Correspond with return value of intelligent picture alarm subscription

interface as CLIENT_RealLoadPictureEx.

Return value Succeeded return TRUE,otherwise return FALSE.

Example //stop subscribing picture alarm

335/339
Option Instruction

if (0 != g_lRealLoadHandle)

if (FALSE == CLIENT_StopLoadPic(g_lRealLoadHandle))

printf("CLIENT_StopLoadPic Failed!Last Error[%x]\n",

CLIENT_GetLastError());

else

g_lRealLoadHandle = 0;

Note None.

CLIENT_GetDownloadPos

Option Instruction

Interface
Interface for searching record download process,uint is KB.
description

Precondition Have called record download interface as CLIENT_DownloadByTimeEx etc.

Function BOOL CLIENT_GetDownloadPos(

LLONG lFileHandle,

int *nTotalSize,

int *nDownLoadSize

);

Parameter lFileHandle

[in] download handle.

Correspond with return value of download record interface as

CLIENT_DownloadByTimeEx.

nTotalSize

336/339
Option Instruction

[out] total size of download,unit is KB.

nDownLoadSize

[out] Downloaded Size,unit is KB.

Return value Succeeded return TRUE,otherwise return FALSE.

Example int nTotal = 0;

int nDownLoad = 0;

if (FALSE == CLIENT_GetDownloadPos(g_lDownloadHandle, &nTotal,

&nDownLoad))

printf("CLIENT_GetDownloadPos Failed!Last Error[%x]\n",

CLIENT_GetLastError());

Note None

CLIENT_SetSnapRevCallBack
Option Instruction

Interface Interface for setting front-end snapshot callback function.

description

Precondition Have called login interface CLIENT_LoginEx2.

Function void CLIENT_SetSnapRevCallBack(

fSnapRev OnSnapRevMessage,

LDWORD dwUser

);

Parameter OnSnapRevMessage

[in] front-end snapshot callback function.

Please refer to fSnapRev callback function.

dwUser

[in] user data, SDK returns data to user by front-end snapshot callback

function (fSnapRev) for further use.

337/339
Option Instruction

Return value None

Example // set front-end snapshot callback function.

CLIENT_SetSnapRevCallBack(SnapRev, NULL);

Note CLIENT_SetSnapRevCallBack interface needs to be called before front-end

snapshot interface.

CLIENT_SnapPictureEx

Option Instruction

Interface Extensive interface for snapshot request.

description

Precondition Have called login interface CLIENT_LoginEx2.

Function BOOL CLIENT_SnapPictureEx(

LLONG lLoginID,

SNAP_PARAMS *par,

int *reserved = 0

);

Parameter lLoginID

[in] device login ID.

Correspond with return value(dwUser) of login interface CLIENT_LoginEx2.

par

[in]snapshot parameter.

Please refer to structure SNAP_PARAMS.

reserved

[in]reserved field.

Return value Succeeded return TRUE,otherwise return FALSE.

Example // send snapshot command to front-end device.

SNAP_PARAMS stuSnapParams;

338/339
Option Instruction

stuSnapParams.Channel = nChannelId;

stuSnapParams.mode = nSnapType;

stuSnapParams.CmdSerial = ++g_nCmdSerial;

//request SN,valid range: 0~65535,over this range will be cut as unsigned

short.

if (FALSE == CLIENT_SnapPictureEx(g_lLoginHandle, &stuSnapParams))

printf("CLIENT_SnapPictureEx Failed!Last Error[%x]\n",

CLIENT_GetLastError());

return;

else

printf("CLIENT_SnapPictureEx succ\n");

Note None

339/339