The below diagram describes a brief API calling reference for basic client application, and users can add in other function modules according to actual application requirements

NetSDK Programming Manual

VERSION 1.4.0.0 (Build 090926)

2009-01-10

 

 

All rights reserved

 

Foreword

Thank you for using our VANGUARD devices. We are going to provide best service for you. This manual may contain spelling grammar and punctuation errors.We will update this manual regularly.

 

 

 

 

 

Modification History

Date Content
2008.10.22 Create
2009.02.12 Add H264_DVR_SearchDevice for search device at LAN
2009.02.18 Add API with talk: H264_DVR_StartVoiceCom_MRЈH264_DVR_VoiceComSendDataЈH264_DVR_StopVoiceComЈH264_DVR_SetTalkMode
2009.09.26 Add API below: H264_DVR_StartDVRRecordЈH264_DVR_StopDVRRecordЈH264_DVR_SetSystemDateTimeЈ H264_DVR_GetDVRWorkStateЈ H264_DVR_ClickKey

 

Catalogue

 

1. §°§ў§»§¦§¦ §Ј§Ј§¦§Ґ§¦§Ї§Є§¦ 5
1.1 §Ј§Ј§¦§Ґ§¦§Ї§Є§¦ 5
1,2 §±§І§Є§®§¦§Ї§Є§®§°§і§ґ§ѕ 5
§±§в§Ъ§Я§и§Ъ§б§н 6
1,3 §±§І§°§¤§І§Ў§®§®§Є§І§°§Ј§Ў§Ї§Є§¦ §°§±§Є§і§Ў§Ї§Є§¦ 6
1,4 API §д§Ц§Э§Ц§ж§а§Я§С§Ю §г§б§в§С§У§а§й§Я§а 7
2 DATA §°§б§Ъ§г§С§Я§Ъ§Ц §г§д§в§е§Ь§д§е§в§н 9
2,1 §Ь§Э§Ъ§Ц§Я§д§г§Ь§Ъ§з §Х§С§Я§Я§н§з §°§б§Ъ§г§С§Я§Ъ§Ц §г§д§в§е§Ь§д§е§в§н 9
2.1.1 §і§д§в§е§Ь§д§е§в§С §Ъ§Я§ж§а§в§Ю§С§и§Ъ§Ъ §а§Т §е§г§д§в§а§Ы§г§д§У§Ц 12
2.1.2 §Ъ§Я§ж§а§в§Ю§С§и§Ъ§с §Ґ§С§д§С 12
2.1.3 §©§С§б§Ъ§г§о §Ъ§Я§ж§а§в§Ю§С§и§Ъ§Ъ §а §ж§С§Ы§Э§Ц 12
2.1.4 §і§д§в§е§Ь§д§е§в§С §Ь§а§Я§ж§Ъ§Ф§е§в§С§и§Ъ§Ъ 16
2.1.5 §і§Ц§д§о §Ь§Э§С§У§Ъ§С§д§е§в§н §а§б§в§Ц§Х§Ц§Э§Ъ§д§о 28
3 API §°§б§в§Ц§Х§Ц§Э§Ц§Я§Ъ§Ц 31
3,1 SDK §Є§Ї§Є§ё§Є§Ў§­§Є§©§Ў§ё§Є§Б 31
3,2 §е§г§д§С§Я§а§У§Ъ§д§о §Т§е§Х§Ъ§Э§о§Я§Ъ§Ь 32
3,3 §µ§і§ґ§І§°§«§і§ґ§Ј§° §І§¦§¤§Є§і§ґ§І§Ў§ё§Є§Є 34
3,4 Real-Time Monitor 35
3,5 §У§а§г§б§в§а§Ъ§Щ§У§Ц§Х§Ц§Я§Ъ§Ц §Ъ §Щ§С§Ф§в§е§Щ§Ь§С 37
3,6 §µ§б§в§С§У§Э§Ц§Я§Ъ§Ц §У§а§г§б§в§а§Ъ§Щ§У§Ц§Х§Ц§Я§Ъ§Ц§Ю 40
3,7 PTZ §Ь§а§Я§д§в§а§Э§о 40
3,8 §§°§Ї§¶§Є§¤§µ§І§Ў§ё§Є§Б §і§Є§і§ґ§¦§®§Ѕ 41
3,9 §Ј§·§°§Ґ §µ§±§І§Ў§Ј§­§¦§Ї§Є§Б 42
3,10 §Ґ§Є§і§ґ§Ў§Ї§ё§Є§°§Ї§Ї§°§¦ §µ§±§І§Ў§Ј§­§¦§Ї§Є§Б 43
3,11 §а§Т§Я§а§У§Э§Ц§Я§Ъ§Ц 43
3,11 §Ў§µ§Ґ§Є§° §І§Ў§©§¤§°§Ј§°§І 45
3,12 §І§Ц§Ш§Ъ§Ю §Щ§С§б§Ъ§г§Ъ 47
3,13 §е§г§д§С§Я§а§У§Ь§С §У§в§Ц§Ю§Ц§Я§Ъ 47
3,14 §г§д§С§д§е§г §е§г§д§в§а§Ы§г§д§У§С 48
3,15 §г§Ц§д§Ц§У§С§с §Ь§Э§С§У§Ъ§С§д§е§в§С 48


General Introduction

1.1 §Ј§У§Ц§Х§Ц§Я§Ъ§Ц
§ї§д§а§д SDK §Х§Э§с VANGUARD DVR, §г§Ц§д§Ц§У§н§Ц §У§Ъ§Х§Ц§а§г§Ц§в§У§Ц§в§н §Ъ §д.§Х. §д§Ц§Ь§г§д §а§б§Ъ§г§н§У§С§Ц§д §ж§е§Я§Ь§и§Ъ§Ъ §Ъ §Ъ§Я§д§Ц§в§ж§Ц§Ы§г§н, §С §д§С§Ь§Ш§Ц §а§д§Я§а§к§Ц§Я§Ъ§с §Ю§Ц§Ш§Х§е §Я§Ъ§Ю§Ъ. §Ў §д§С§Ь§Ш§Ц §б§в§Ц§Х§а§г§д§С§У§Э§с§Ц§д §б§а§Х§в§а§Т§Я§е§р §Х§Ц§Ю§а§Я§г§д§в§С§и§Ъ§р.
§ї§д§а§д §б§С§Ь§Ц§д §г§а§г§д§а§Ъ§д §Ъ§Щ §Х§У§е§з §й§С§г§д§Ц§Ы: §п§Ь§г§б§Э§е§С§д§С§и§Ъ§с §Ъ §е§б§в§С§У§Э§Ц§Я§Ъ§Ц §а§Т§а§в§е§Х§а§У§С§Я§Ъ§Ц§Ю:
§в§С§Т§а§д§С §г§а§г§д§а§с§Я§Ъ§Ц §б§в§а§г§Э§е§к§Ъ§У§С§Я§Ъ§с §У §в§Ц§Ш§Ъ§Ю§Ц §в§Ц§С§Э§о§Я§а§Ф§а §У§в§Ц§Ю§Ц§Я§Ъ, §б§в§а§г§Ю§а§д§в §У §в§Ц§С§Э§о§Я§а§Ю §У§в§Ц§Ю§Ц§Я§Ъ, §з§С§в§С§Ь§д§Ц§в §а§У§Ц§в§Э§Ц§с §е§б§в§С§У§Э§Ц§Я§Ъ§Ц §Щ§У§е§Ь§а§Ю, §У§а§г§б§в§а§Ъ§Щ§У§Ц§Х§Ц§Я§Ъ§Ц §Щ§С§б§Ъ§г§Ъ §Ъ §Щ§С§Ф§в§е§Щ§Ь§Ъ, §з§в§С§Я§Ц§Я§Ъ§с §Х§С§Я§Я§н§з, PTZ §Ь§а§Я§д§в§а§Э§о, §г§Ъ§Ф§Я§С§Э§Ъ§Щ§С§и§Ъ§с §в§С§Щ§Ю§Ц§л§Ц§Я§Ъ§Ц, §Ф§а§Э§а§г§а§У§а§Ы §Х§Ъ§С§Э§а§Ф, §Ш§е§в§Я§С§Э §е§б§в§С§У§Э§Ц§Я§Ъ§Ц, §е§б§в§С§У§Э§Ц§Я§Ъ§Ц §б§а§Э§о§Щ§а§У§С§д§Ц§Э§с§Ю§Ъ, §Х§Ц§Ы§г§д§У§Ъ§с§б§в§Ъ §д§в§Ц§У§а§Ф§Ц, §б§в§а§Щ§в§С§й§Я§н§Ы §б§а§в§д COM §Ъ §Ъ §д.§Х.
§е§б§в§С§У§Э§Ц§Я§Ъ§Ц §е§г§д§в§а§Ы§г§д§У§С§Ю§Ъ
§е§Х§С§Э§Ц§Я§Я§а§Ф§а §а§Т§Я§а§У§Э§Ц§Я§Ъ§с, §е§Х§С§Э§Ц§Я§Я§а§Ы §б§Ц§в§Ц§Щ§С§Ф§в§е§Щ§Ь§Ъ / §У§н§Ь§Э§р§й§Ц§Я§Ъ§с, §а§Т§а§в§е§Х§а§У§С§Я§Ъ§с§Ї§С§г§д§в§а§Ы§Ь§С §б§С§в§С§Ю§Ц§д§в§а§У, §д§С§Ь§Ъ§з §Ь§С§Ь §а§Т§л§Ъ§Ц, §г§Ъ§Ф§Я§С§Э§Ъ§Щ§С§и§Ъ§с, §Щ§С§б§Ъ§г§о, §б§а§г§Э§Ц§Х§а§У§С§д§Ц§Э§о§Я§н§Ы §б§а§в§д, §Ъ§Щ§а§Т§в§С§Ш§Ц§Я§Ъ§Ц, §Ј§з§а§Х, §е§б§в§С§У§Э§Ц§Я§Ъ§Ц §б§а§Э§о§Щ§а§У§С§д§Ц§Э§с§Ю§Ъ,§е§г§д§в§а§Ы§г§д§У§С §г§Ъ§Я§з§в§а§Я§Ъ§Щ§С§и§Ъ§Ъ, §а§Т§Я§С§в§е§Ш§Ц§Я§Ъ§Ц §Х§У§Ъ§Ш§Ц§Я§Ъ§с, §г§Ц§д§Ъ §Ъ §д.§Х.

§Ј §б§С§Ь§Ц§д §У§з§а§Х§с§д §г§Э§Ц§Х§е§р§л§Ъ§Ц §ж§С§Ы§Э§нЈє

§і§Ц§д§Ц§У§С§с §Т§Ъ§Т§Э§Ъ§а§д§Ц§Ь§С NetSDK Head file
NetSDK.lib Lib file
NetSDK.dll Interface library
§±§а§Ю§а§к§Я§Ъ§Ь H264Play.dll Decode assistant library
DllDeinterlace.dll Decode assistant library
hi_h264dec_w.dll Decode assistant library

§±§в§Ъ§Ю§Ц§Я§с§Ц§Ю§а§г§д§о:

n §±§а§Х§Х§Ц§в§Ш§Ь§С §У§а§г§б§в§а§Ъ§Щ§У§Ц§Х§Ц§Я§Ъ§с §У §в§Ц§С§Э§о§Я§а§Ю §У§в§Ц§Ю§Ц§Я§Ъ §Ю§а§Я§Ъ§д§а§в,, §г§Ъ§Ф§Я§С§Э§Ъ§Щ§С§и§Ъ§с,§µ§Х§С§Э§Ц§Я§Я§С§с §Я§С§г§д§в§а§Ы§Ь§С, §е§б§в§С§У§Э§Ц§Я§Ъ§Ц §Ш§е§в§Я§С§Э§С§Ю§Ъ §Ъ §д§С§Ь §Х§С§Э§Ц§Ц.ЎЈ

n §±§а§Х§Х§Ц§в§Ш§Ь§С TCP §б§Ц§в§Ц§Х§С§й§Ъ §б§а §г§Ц§д§Ъ, §Я§Ц §Т§а§Э§Ц§Ц 10 TCP-§г§а§Ц§Х§Ъ§Я§Ц§Я§Ъ§Ы

n §Ј§н §Ю§а§Ш§Ц§д§Ц §Ъ§г§б§а§Э§о§Щ§а§У§С§д§о §п§д§а§д SDK §Х§Э§с §б§а§Х§Ь§Э§р§й§Ц§Я§Ъ§с §Ь §е§г§д§в§а§Ы§г§д§У§е §Х§Э§с §в§С§Щ§в§С§Т§а§д§Ь§Ъ §Ь§Э§Ъ§Ц§Я§д§г§Ь§Ъ§з §б§в§а§Ф§в§С§Ю§Ю, §Ъ§Э§Ъ §У§н §Ю§а§Ш§Ц§д§Ц §Ъ§г§б§а§Э§о§Щ§а§У§С§д§о SDK §Ъ§Я§д§Ц§в§ж§Ц§Ы§г §Х§Э§с §в§С§Щ§в§С§Т§а§д§Ь§Ъ §г§Ц§в§У§Ц§в§Я§н§з §б§в§а§Ф§в§С§Ю§Ю, §д§С§Ь§Ъ§з §Ь§С§Ь §б§а§д§а§Ь §Ю§С§г§г§а§У§а§Ы §Ъ§Я§ж§а§в§Ю§С§и§Ъ§Ъ §б§Ц§в§Ц§Х§С§й§Ъ, §У§а§г§б§в§а§Ъ§Щ§У§Ц§Х§Ц§Я§Ъ§с, §г§Ъ§Ф§Я§С§Э§Ъ§Щ§С§и§Ъ§Ъ §Ъ §д.§Х..

n §Ь§Э§Ъ§Ц§Я§д §б§а§Х§Х§Ц§в§Ш§Ъ§У§С§Ц§д §Ю§е§Э§о§д§Ъ-§Ъ§Щ§а§Т§в§С§Ш§Ц§Я§Ъ§с §в§Ц§Щ§а§Э§р§и§Ъ§Ы, §У§Ь§Э§р§й§С§с QCIFЎўCIFЎў2CIFЎўHalfD1ЎўD1ЈVGAЈЁ640ЎБ480Ј©and etc.

n §¦§г§Э§Ъ SDK §У§а§г§б§в§а§Ъ§Щ§У§Ц§Х§Ъ§д /§г§Ь§С§й§Ъ§У§С§Ц§д, §а§Х§Ъ§Я §У§з§а§Х ID §Я§Ц §Ю§а§Ш§Ц§д §е§б§в§С§У§Э§с§д§о §У§а§г§б§в§а§Ъ§Щ§У§Ц§Х§Ц§Я§Ъ§Ц§Ю §Ъ §Щ§С§Ф§в§е§Щ§Ь§а§Ы §Я§С §а§Х§Я§а§Ю §Ь§С§Я§С§Э§Ц §У §а§Х§Я§а §Ъ §д§а §Ш§Ц §У§в§Ц§Ю§с.

 

Desig of principia

1.1 §°§б§Ъ§г§С§Я§Ъ§Ц §б§в§а§Ф§в§С§Ю§Ъ§в§а§У§С§Я§Ъ§с

n §µ§г§д§С§Я§а§У§Ь§С §Ъ §е§Х§С§Э§Ц§Я§Ъ§Ц

1Ўў§і§Я§С§й§С§Э§С §д§С§Ь §Щ§У§С§Я§Я§н§ЫH264_DVR_Init()§й§д§а §Т§н §е§г§д§С§Я§а§У§Ъ§д§о SDKЈ§Ь§а§Ф§Х§С §б§в§Ъ§Э§а§Ш§Ц§Я§Ъ§Ц §а§д§Ь§в§н§д§а, calling H264_DVR_Cleanup()§й§д§а §Т§н §а§г§У§а§Т§а§Х§Ъ§д§о §У§г§Ц §Щ§С§Я§с§д§н§Ц §в§Ц§г§е§в§г§н.

2Ўў §ў§а§Э§о§к§Ъ§Я§г§д§У§а API §Х§а§Э§Ш§Я§н §Я§С§Щ§н§У§С§д§о§г§сafter H264_DVR_Init(), §б§Ц§в§Ц§Х H264_DVR_Cleanup() Ј§Ї§а H264_DVR_GetLastError §Ю§а§Ш§Ц§д §Т§н§д§о §Я§С§Щ§У§С§Я §У §Э§р§Т§а§Ю §Ю§Ц§г§д§Ц.

n §Ј§з§а§Х §Ъ §У§н§з§а§Х

§±§Ц§в§Ц§Х §У§з§а§Х§а§Ю §У §Х§Ц§У§С§Ы§г, §У§н §Х§а§Э§Ш§Я§н §У§У§Ц§г§д§Ъ H264_DVR_Login() login first, §Щ§С§д§Ц§Ю §У§н §Х§а§Э§Ш§Я§н §У§У§Ц§г§д§Ъ H264_DVR_LoginEx(). §¦§г§Э§Ъ §У§з§а§Х §б§в§а§к§Ц§Э §е§г§б§Ц§к§Я§а, §У§Ц§в§Я§Ъ§д§Ц§г§о §Ь (§Ф§Э§а§Т§С§Э§о§Я§а§Ы §в§е§й§Ь§Ц), §в§е§й§Ь§С §п§д§а §Ц§г§г§Ъ§а§Я§Я§н§Ы §Ь§С§Я§С§Э, §Ь§а§д§а§в§н§Ы §У§н §Ю§а§Ш§Ц§д§Ц §Ъ§г§б§а§Э§о§Щ§а§У§С§д§о §б§в§Ъ §а§б§Ц§в§С§и§Ъ§Ъ §г §Х§Ц§У§С§Ы§г§а§Ю. §Ј§У§Ц§Х§Ъ§д§ЦH264_DVR_Logout() §й§д§а §Т§н §Щ§С§Ь§в§н§д§о §п§д§е §г§Ц§г§г§Ъ§р.

 

n §¶§е§Я§Ь§и§Ъ§с §а§Т§в§С§д§Я§а§Ф§а §У§н§Щ§а§У§С

§¶§е§Я§Ь§и§Ъ§с §а§Т§в§С§д§Я§а§Ф§а §У§н§Щ§а§У§С §Ъ§Ю§Ц§Ц§д §б§С§в§С§Ю§Ц§д§в§н: dwUser, it is elf-define parameter, you can define your owner data. §і§С§Ю§а§а§б§в§Ц§Х§Ц§Э§Ц§Я§Я§н§Ц §б§С§в§С§Ю§Ц§д§в§н, §Ј§н §Ю§а§Ш§Ц§д§Ц §а§б§в§Ц§Х§Ц§Э§Ъ§д§о §б§С§в§С§Ю§Ц§д§в§н §У§Э§С§Х§Ц§Э§о§и§С.


API Calling Reference

The below diagram describes a brief API calling reference for basic client application, and users can add in other function modules according to actual application requirements.

A. Initialization

SDK Initialization H264_DVR_Init ()

 

B. Set callback for alarm message

Set callback H264_DVR_SetDVRMessCallBack ()

 

C. Login in

Login in H264_DVR_Login () H264_DVR_LoginEx () Subscribe for alarm message H264_DVR_SetupAlarmChan ()

 

D. Operation of device ,get and set parameter configuration

Parameter configuration H264_DVR_GetDevConfig () H264_DVR_SetDevConfig () Log searching H264_DVR_FindDVRLog () PTZ control H264_DVR_PTZControl () H264_DVR_PTZControlEx ()

 

E. Real-time preview

Open and close monitor channel H264_DVR_RealPlay () H264_DVR_StopRealPlay () Callback for saving monitor data H264_DVR_SetRealDataCallBack ()

 

F. Playback/Download

Record searching H264_DVR_FindFile () Playback control H264_DVR_PlayBackByName() H264_DVR_PlayBackControl() H264_DVR_StopPlayBack() Download H264_DVR_GetFileByName () H264_DVR_GetDownloadPos() H264_DVR_StopGetFile ()

 


 

G. Remote control

Upgrade H264_DVR_Upgrade() H264_DVR_GetUpgradeState() H264_DVR_CloseUpgradeHandle() Reboot /Clear log H264_DVR_ControlDVRЈЁЈ©

 

H. Login out

Cancel subscribe for alarm message H264_DVR_CloseAlarmChan () Disconnect H264_DVR_Logout ()

 

I. Release SDK resource

SDK exit H264_DVR_Cleanup ()