XQ Client API

XQ Client API
Reference Manual
Version 1.3
2010.06.15
T.O.M. Technology, Inc.
Revision History
Version 1.0 1.1 1.2 1.3 Date 2009-02-11 2010-05-31 2010-06-03 2010-06-15 XQClient API Guide MPEG-4 & H.264 Codec Support XML Data for DVR Setting XQLive_APIs support for NYX DVR (Only Live stream) History
Contents
1. XQ Client API.......................................................................................................... 7 1.1 XQ Client API Summary....................................................................................... 7 1.2 Special Feature .................................................................................................. 7 1.3 Construction & Contents ...................................................................................... 7 1.3.1 API Construction ........................................................................................ 7 1.3.2 SDK Construction ....................................................................................... 8 1.4 API Architecture ................................................................................................. 8 1.5 Compile and Option Setup ................................................................................... 9 2. XQ Client API Functions ......................................................................................... 10 2.1 XQ Live ........................................................................................................... 10 2.1.1 XQLive_Initialization ................................................................................. 10 2.1.2 XQLive_ Uninitialization............................................................................. 10 2.1.3 XQLive_Connect ....................................................................................... 11 2.1.4 XQLive_Disconnect ................................................................................... 12 2.1.5 XQLive_OnlineState .................................................................................. 12 2.1.6 XQLive_GetNetSpeed................................................................................ 12 2.1.7 XQLive_SetNetSpeed ................................................................................ 13 2.1.8 XQLive_GetPTZState................................................................................. 14 2.1.9 XQLive_SetPTZControl .............................................................................. 14 2.1.10 XQLive_SetDisplayChannel ...................................................................... 15 2.1.11 XQLive_SetFreeze................................................................................... 15 2.1.12 XQLive_GetRecordState .......................................................................... 16 2.1.13 XQLive_GetHDDState.............................................................................. 17 2.1.14 XQLive_SetAlramControl ......................................................................... 17 2.1.15 XQLive_ProcRecvMain ............................................................................. 18 2.1.16 XQLive_RecvMainCallBack ....................................................................... 19 2.1.17 XQLive_ProcRecvVideo ............................................................................ 20 2.1.18 XQLive_RecvVideoCallBack ...................................................................... 20 2.1.19 XQLive_GetStatus................................................................................... 21 2.2 XQ Search ....................................................................................................... 23 2.2.1 XQSearch_Initialization ............................................................................. 23 2.2.2 XQSearch_Uninitialization.......................................................................... 23
2.2.3 XQSearch_Connect ................................................................................... 24 2.2.4 XQSearch_Disconnect ............................................................................... 24 2.2.5 XQSearch_OnlineState .............................................................................. 25 2.2.6 XQSearch_GetDate................................................................................... 25 2.2.7 XQSearch_GetHour................................................................................... 26 2.2.8 XQSearch_GetMinute ................................................................................ 26 2.2.9 XQSearch_GetSelectFrame ........................................................................ 27 2.2.10 XQSearch_GetVideoFrame ....................................................................... 27 2.2.11 XQSearch_SetEventSearch ...................................................................... 28 2.2.12 XQSearch_GetEventSearch ...................................................................... 28 2.2.13 XQSearch_SetBackup.............................................................................. 29 2.2.14 XQSearch_GetBackup ............................................................................. 30 2.2.15 XQSearch_ProcRecvMain ......................................................................... 30 2.2.16 XQSearch_RecvCallBack .......................................................................... 31 2.2.17 XQSearch_GetStatus............................................................................... 32 2.3 XQ Setup......................................................................................................... 33 2.3.1 XQSetup_GetConfig .................................................................................. 33 2.3.2 XQSetup_SetConfig .................................................................................. 33 2.4 Common Function............................................................................................. 34 2.4.1 GetLastError ............................................................................................ 34 3. XQ Client API Structures ........................................................................................ 34 3.1 XQ Live ........................................................................................................... 34 3.1.1 LIVE_CONNECTINFO ................................................................................. 34 3.1.2 LIVE_RECORDSTATE................................................................................. 35 3.1.3 LIVE_RECORDINFO................................................................................... 35 3.1.4 LIVE_HDDSTATE ...................................................................................... 36 3.1.5 LIVE_HDDINFO ........................................................................................ 37 3.1.6 LIVE_VIDEOSOURCE................................................................................. 37 3.1.7 Live_MAINCALLBACK ................................................................................ 38 3.1.8 LIVE_VIDEOCALLBACK.............................................................................. 39 3.2 XQ Search ....................................................................................................... 39 3.2.1 SEARCH_CONNECTINFO............................................................................ 39 3.2.2 SEARCH_DATE ......................................................................................... 40 3.2.3 SEARCH_DATEINFO .................................................................................. 40 3.2.4 SEARCH_HOUR ........................................................................................ 41 3.2.5 SEARCH_HOURINFO ................................................................................. 41
3.2.6 SEARCH_MINUTE ..................................................................................... 42 3.2.7 SEARCH_MINUTEINFO .............................................................................. 42 3.2.8 SEARCH_SELECT...................................................................................... 43 3.2.9 SEARCH_VIDEO ....................................................................................... 43 3.2.10 SEARCH_EVENTITEM .............................................................................. 44 3.2.11 SEARCH_EVENT ..................................................................................... 45 3.2.12 SEARCH_MAINCALLBACK ........................................................................ 46 3.2.13 SEARCH_XQTM ...................................................................................... 46 3.3 XQ Setup......................................................................................................... 47 3.3.1 SETUP_DATA ........................................................................................... 47 3.4 Common Structures .......................................................................................... 48 3.4.1 XQAPI_ABOUT ......................................................................................... 48 3.4.2 XQDVR_ABOUT ........................................................................................ 48 4. Macros................................................................................................................. 50 5. XML Setup............................................................................................................ 51 5.1 XML Architecture .............................................................................................. 51 5.2 XQ Setup Info Structure .................................................................................... 52 5.3 XQ CONFIG XML: INFO...................................................................................... 53 5.3.1 XQ CONFIG XML: INFO/hwspec .................................................................. 56 5.4 XQ CONFIG XML: SYSTEM ................................................................................. 57 5.4.1 XQ CONFIG XML: SYSTEM/sysinfo .............................................................. 58 5.4.2 XQ CONFIG XML: SYSTEM/datetime ........................................................... 59 5.4.3 XQ CONFIG XML: SYSTEM/datetime/userdst ................................................ 60 5.4.4 XQ CONFIG XML: SYSTEM/ntp ................................................................... 61 5.4.5 XQ CONFIG XML: SYSTEM/holiday .............................................................. 62 5.4.6 XQ CONFIG XML: SYSTEM/account ............................................................. 62 5.4.7 XQ CONFIG XML: SYSTEM/account/userlst .................................................. 63 5.5 XQ CONFIG XML: NETWORK .............................................................................. 65 5.5.1 XQ CONFIG XML: NETWORK/ethernet ......................................................... 66 5.5.2 XQ CONFIG XML: NETWORK/ddns .............................................................. 68 5.5.3 XQ CONFIG XML: NETWORK/email ............................................................. 68 5.5.4 XQ CONFIG XML: NETWORK/email/smtp ..................................................... 69 5.5.5 XQ CONFIG XML: NETWORK/email/milst ..................................................... 70 5.5.6 XQ CONFIG XML: NETWORK/callback.......................................................... 70 5.5.7 XQ CONFIG XML: NETWORK/nas ................................................................ 71 5.5.8 XQ CONFIG XML: NETWORK/nas/naslst....................................................... 72
5.6 XQ CONFIG XML: DEVICE .................................................................................. 74 5.6.1 XQ CONFIG XML: DEVICE/camera .............................................................. 75 5.6.2 XQ CONFIG XML: DEVICE/camera/ptz......................................................... 77 5.6.3 XQ CONFIG XML: DEVICE/camera/ptz/serial ................................................ 78 5.6.4 XQ CONFIG XML: DEVICE/alarm................................................................. 80 5.6.5 XQ CONFIG XML: DEVICE/audio ................................................................. 81 5.6.6 XQ CONFIG XML: DEVICE/osd.................................................................... 81 5.6.7 XQ CONFIG XML: DEVICE/monitor.............................................................. 83 5.6.8 XQ CONFIG XML: DEVICE/spot................................................................... 83 5.6.9 XQ CONFIG XML: DEVICE/vga ................................................................... 85 5.6.10 XQ CONFIG XML: DEVICE/misc ................................................................ 86 5.7 XQ CONFIG XML: RECORD ................................................................................. 88 5.7.1 XQ CONFIG XML: RECORD/camera/cam ...................................................... 89 5.8 XQ CONFIG XML: EVENT.................................................................................... 92 5.8.1 XQ CONFIG XML: EVENT/motion ................................................................ 93 5.8.2 XQ CONFIG XML: EVENT/motion/cam/act.................................................... 94 5.8.3 XQ CONFIG XML: EVENT/sensor ................................................................. 97 5.8.4 XQ CONFIG XML: EVENT/vloss ................................................................... 98 5.8.5 XQ CONFIG XML: EVENT/diskfull ...............................................................100 5.8.6 XQ CONFIG XML: EVENT/diskfull/sysact .....................................................100 5.8.7 XQ CONFIG XML: EVENT/diskerr ...............................................................101 5.8.8 XQ CONFIG XML: EVENT/smart .................................................................102 5.9 XQ CONFIG XML: MISC ....................................................................................104 5.10 XQ CLIENT XML .............................................................................................106 5.10.1 XQ CLIENT INFO STRUCTURE..................................................................106 5.10.2 XQ CLIENT XML: NETPTZ ........................................................................106 5.10.3 XQ CLIENT XML: NETMASK .....................................................................107 5.11 Abbreviations of NODE Name ..........................................................................109
1. XQ Client API
1.1 XQ Client API Summary
It provides the interfaces for developers who want to design their own remote application and its expansion and various functions such as Live Screen, Remote Search, and Remote Setup and so on.
1.2 Special Feature

Provide APIs for Live and Search function of XQ Client Provide Libraries and Sample for User Custimizing of XQ Client Support all protocols from old XQ Series to new XQH series Apply XML which is changed Setup Method (See section 5.) Support MPEG-4 and H.264 decoding
1.3 Construction & Contents

1.3.1 API Construction
Classfication Major feature API Construction
XQLive_ APIs: Communication Protocol API for Live Function XQSearch_ APIs: Communication Protocol API for Search XQSetup_ APIs: API for Setup Construction and XML transmission XQClient_ API Others
No DirectDraw related feature support in API No DirectSound related feature support in API Above two features provided as sample program
1.3.2 SDK Construction

Classification SDK Construction Bin Folder: DLL Modules for Release Bin_Debug Folder: DLL Modules for Debug Common Folder: Classes for Basic Function Use Define Folder: Macro Definition XQClientAPI_Sample Lib Folder: Lib files which need for Link XQClientAPI_Sample Folder: Sample Program Source (Visual C++) XQ Client APIs User Guide
1.4 API Architecture
XQ Client API forward and delivers result of requested things from its application through DVR & Network communication. For this reason, developer can use this API as a library without understanding DVR communication protocol. Also, it provides callback function as special events of DVR and real time live image, search results data stream and events. API has following 3 parts (XQLive, XQSearch, XQSetup) with prefix. XQLive methods are for real time live image, XQSearch is for user searching, XQSetup is for remote setup configuration.
1.5 Compile and Option Setup

You should install Platform SDK and DirectX SDK for Compilation. In case of DirectX SDK, The installation of SUMMER 2004 Ver. is recommended to avoid the Link Error. You can downlad the SDK (which you need) from below links.
Platform SDK http://www.microsoft.com/msdownload/platformsdk/sdkupdate/psdk-full.htm DirectX SDK (SUMMER 2004) http://www.microsoft.com/downloads/details.aspx?familyid=FD044A42-9912-42A39A9E-D857199F888E&displaylang=en
Please setup Platform SDK and DirectX SDK as below.
2. XQ Client API Functions

2.1 XQ Live
2.1.1 XQLive_Initialization
Prototype
void XQLive_Initialization();
Description
Initialize XQLive related information on XQAPI.
Return Value
No
Parameters
No
Example
// Initialization Work XQLive_Initialization(); ... // Termination XQLive_Uninitialization();
2.1.2 XQLive_ Uninitialization

Prototype
void XQLive_Uninitialization();
Description
Uninitialize XQLive related information on XQAPI
Return Value
None
10
Parameters
None
Example
// Initialize XQLive_Initialization(); ... // Terminate XQLive_Uninitialization();
2.1.3 XQLive_Connect
Prototype
BOOL XQLive_Connect(LIVE_CONNECTINFO* strUserInfo);
Description
Connect DVR with user information
Return Value
TRUE : Success FALSE : Fail : check information at GetLastError()
Parameters
strUserInfo [in] LIVE_CONNECTINFO Structure Pointer
Example
// Connect LIVE_CONNECTINFO BOOL bStatus; strConnectInfo;
bStatus = XQLive_Connect(&strConnectInfo); // Disconnect XQLive_Disconnect();
11
2.1.4 XQLive_Disconnect
Prototype
void XQLive_Disconnect()
Description
Disconnect connected DVR
Return Value
None
Parameters
None.
Example
XQLive_Disconnect();
2.1.5 XQLive_OnlineState
Prototype
BOOL XQLive_OnlineState();
Description
Check current connection status
Return Value
TRUE : Connected on DVR (On-Line) FALSE : Disconnected on DVR (Off-Line)
Parameters
None
Example
BOOL bStatus;
bStatus = XQLive_OnlineState();
2.1.6 XQLive_GetNetSpeed
Prototype
12
int XQLive_GetNetSpeed();
Description
Check current network transmit speed setup value. Hi speed : Full-Frame Transmit Low speed : I-Frame Transmit
Return Value
0 : Hi speed 1 : Low Speed
Parameters
None
Example
Int nSpeed = XQLive_GetNetSpeed(); nSpeed;
2.1.7 XQLive_SetNetSpeed
Prototype
void XQLive_SetNetSpeed(int nSpeed)
Description
Adjust network speed from DVR to Client. Hi Speed : Full-Frame Transmit Low Speed : I-Frame Transmit
Return Value
None
Parameters
nSpeed [in] Set speed(low or High) 0 : Hi speed 1 : Low speed
Example
Int nNetSpeed;
13
// HI speed setup nNetSpeed = 0; XQLive_SetNetSpeed(nNetSpeed);
2.1.8 XQLive_GetPTZState
Prototype
BOOL XQLive_GetPTZState(int nCamera);
Description
Check PTZ setup information of selected camera
Return Value
TRUE : able to PTZ setup FALSE : not able to PTZ setup
Parameters
nCamera [in] Number of camear
Example
Int BOOL // Set channel number 1 nCamera = 0; bStatus = XQLive_GetPTZState(nCamera); bStatus; nCamera;
2.1.9 XQLive_SetPTZControl
Prototype
void XQLive_SetPTZControl(PTZCONTROL* strPtzControl);
Description
Set direction, Zoom, Focus, Iris & preset of selected camera
Return Value
none
14
Parameters
strPtzControl [in] LIVE_PTZCONTROL Structure Pointer
Example
LIVE_PTZCONTROL strPTZControl;
XQLive_SetPTZControl(&strPTZControl);
2.1.10 XQLive_SetDisplayChannel
Prototype
void XQLive_SetDisplayChannel(DWORD dwChannel);
Description
Set display image on screen
Return Value
none.
Parameters
dwChannel [in] Bit value of display channel (Ex : 0000000000000001 => channel1)
Example
DWORD dwChannel;
for(int i=0; i<MAX_CAMERA_COUNT; i++) dwChannel |= (0x01<<i); XQLive_SetDisplayChannel(dwChannel);
2.1.11 XQLive_SetFreeze
Prototype
void XQLive_SetFreeze(BOOL bFreeze, DWORD dwChannel);
Description
Pause and Resume Live display image
Return Value
15
none.
Parameters
bFreeze [in] Live Set status of live image as freeze or not TRUE: freeze live image FALSE: back to normal live dwChannel [in] Bit value of display channel (ex : 0000000000000001 => channel 1)
Example
BOOL DWORD bFreezeFlag = TRUE; for(int i=0; i<MAX_CAMERA_COUNT; i++) dwChannel |= (0x01 << i); XQLive_SetFreeze(bFreezeFlag, dwChannel); bFreezeFlag; dwChannel;
2.1.12 XQLive_GetRecordState
Prototype
void XQLive_GetRecordState(LIVE_RECORDSTATE* strRecordState, BOOL bStatusFlag);
Description
Check recording status.
Return Value
none
Parameters
strRecordState [out] Save recording status information as Structure pointer of LIVE_RECORDSTATE bStatusFlag [in] Set run or Stop of Record information. TRUE : Run FALSE : Stop
16
Example
// call LIVE_RECORDSTATUS strRecordState; XQLive_GetRecordState(&strRecordState, TRUE); // End XQLive_GetRecordState(&strRecordState, FALSE);
2.1.13 XQLive_GetHDDState
Prototype
void XQLive_GetHDDState(LIVE_HDDSTATE* strHDDState, BOOL bStatusFlag);
Description
Check HDD information of connected DVR
Return Value
None.
Parameters
strHDDState [out] get HDD status information as Structure pointer of LIVE_HDDSTATE bStatusFlag [in] Set run and stop of HDD information. TRUE : Run FALSE : Stop
Example
// call LIVE_HDDSTATUS strHddStatus; XQLive_GetHDDState(&strHddStatus, TREU); // end XQLive_GetHDDState(&strHddStatus, FALSE);
2.1.14 XQLive_SetAlramControl
Prototype
void XQLive_SetAlramControl(int nAlram, BOOL bAction);
17
Description
Its a part of alarm control. Set On/Off.
Return Value
None
Parameters
nAlram [in] Alarm number to control bAction [in] Set alarm use or not. TRUE : Set Alarm On FALSE : Set Alarm Off
Example
Int BOOL // Call nAlarmCount = 1; bStatus = TRUE; XQLive_SetAlarmControl(nAlarmCount, bStatus); // End nAlarmCount = 1; bStatus = FALSE; XQLive_SetAlarmControl(nAlarmCount, bStatus); bStatus; nAlarmCount;
2.1.15 XQLive_ProcRecvMain
Prototype
void XQLive_ProcRecvMain(void* pRecvMainCallBack, void* pThis);
Description
Define CallBack function and call the functions from library Defined Call back function format in API typedef void (*LiveRecvCallBack)(int nComm, void* pRecvData, void* pParent)
18
Return Value
none
Parameters
pRecvMainCallBack [in] CallBack Function Definition from Library to Main Frame pThis [in] Pointer value of Main frame
Example
XQLive_ProcRecvMain(XQLive_RecvMainCallBack, (void*)this);
2.1.16 XQLive_RecvMainCallBack
Prototype
void XQLive_RecvMainCallBack(int nComm, void* pRecvData, void* pParent);
Description
Process received data from DVR As user define function (not Dll internal function) and define function pointer of XQLive_ProcRecvMain
pRecvMainCallBack (user can change)
Return Value
None.
Parameters
nComm [out] Main Command value pRecvData [out] Received data from server pParent [out] Pointer value of Application
Example
switch(nComm) { case COMM_SYSTEM: {
19
} Case COMM_STATUS: { } }
2.1.17 XQLive_ProcRecvVideo
Prototype
void XQLive_ProcRecvVideo(void* pRecvLiveCallBack, void* pThis);
Description
Define CallBack function and call functions from library Callback function format defined on API typedef void (*LiveRecvCallBack)(int nComm, void* pRecvData, void* pParent)
Return Value
none.
Parameters
pRecvLiveCallBack [in] Define function to callback from Library to mainframe. pThis [in] Pointer value of main frame
Example
XQLive_ProcRecvVideo(XQLive_RecvVideoCallBack, (void*)this);
2.1.18 XQLive_RecvVideoCallBack
Prototype
void XQLive_RecvVideoCallBack(int nComm, void* pRecvData);
Description
Receive Live data which delivered from DVR
20
As user define function (not Dll internal function) and define function pointer of XQLive_ProcRecvLive
pRecvLiveCallBack. (user can change)
Return Value
none.
Parameters
nComm [out] Main Command value pRecvData [out] Data which delivered from server
Example
switch(nComm) { case COMM_LIVE_VIDEO: { } case COMM_LIVE_AUDIO: { } }
2.1.19 XQLive_GetStatus
Prototype
void XQLive_GetStatus(XQAPI_CONFIG* strLiveConfig);
Description
Check version and authority information of DVR Set
Return Value
none.
Parameters
strLiveConfig [out] XQAPI_CONFIG Pointer Structure
21
Example
XQDVR_ABOUT strConfig; XQLive_GetStatus(&strConfig);
22
2.2 XQ Search
2.2.1 XQSearch_Initialization
Prototype
void XQSearch_Initialization();
Description
Initialize search related information on XQAPI
Return Value
none
Parameters
none
Example
// Initialization XQSearch_Initialization(); // Un-initialization XQSearch_Uninitialization();
2.2.2 XQSearch_Uninitialization
Prototype
void XQSearch_Uninitialization();
Description
Un-initialize search related information in XQAPI
Return Value
none
Parameters
none
Example
23
// Initialization XQSearch_Initialization(); ... // Uninitialization XQSearch_Uninitialization();
2.2.3 XQSearch_Connect
Prototype
BOOL XQSearch_Connect(SEARCH_CONNECTINFO* strUserInfo);
Description
Connect to DVR
Return Value
TRUE : Success FALSE : Fail : check information from GetLastError()
Parameters
strUserInfo SEARARCH_CONNECTINFO Pointer value
Example
BOOL SEARCH_CONNECTINFO bStatus; strConnectInfo;
bStatus = XQSearch_Connect(&strConnectInfo);
2.2.4 XQSearch_Disconnect
Prototype
void XQSearch_Disconnect();
Description
Disconnect DVR communication
Return Value
none
24
Parameters
none.
Example
XQSearch_Disconnect();
2.2.5 XQSearch_OnlineState
Prototype
BOOL XQSearch_OnlineState();
Description
Check current online status.
Return Value
TRUE : online staus FALSE : offline status
Parameters
none.
Example
BOOL bStatus;
bStatus = XQSearch_OnlineState();
2.2.6 XQSearch_GetDate
Prototype
SEARCH_DATE* XQSearch_GetDate();
Description
Get date information from DVR
Return Values
Return value of setup date information on DVR as SEARCH_DATE Pointer structure type.
Parameters
25
none.
Example
SEARCH_DATE* pSearchData;
pSearchDate = XQSearch_GetDate();
2.2.7 XQSearch_GetHour
Prototype
SEARCH_HOUR* XQSearch_GetHour(SEARCH_XQTM* strDateTime);
Description
Get requested time information of DVR
Parameters
strDateTime [in] XQTM Set date search information on Pointer Structure
Return Values
Return configured time information on DVR as SEARCH_HOUR Pointer Structure.
Example
SEARCH_HOUR* SEARCH_XQTM pSearchHour; sendTime;
pSearchHour = XQSearch_GetHour(&sendTime);
2.2.8 XQSearch_GetMinute
Prototype
SEARCH_MINUTE* XQSearch_GetMinute(SEARCH_XQTM* strDateTime);
Description
Get miniute information from DVR
Return Values
Return configured time information on DVR as SEARCH_MINUTE Pointer Structure.
Parameters
26
strDateTime [in] set time search time information on XQTM Pointer Structure as yy/mm/dd.
Example
SEARCH_MINUTE* SEARCH_XQTM pSearchMinute; sendTime;
pSearchMinute = XQSearch_GetMinute(&sendTime);
2.2.9 XQSearch_GetSelectFrame
Prototype
BYTE* XQSearch_GetSelectFrame(SEARCH_SELECT* strSelectReq);
Description
Display the first frame of image on screen selected Date/time/minute information. Only display the first frame.
Return Values
Received pointer value of image information
Parameters
strSelectReq [in] SEARCH_SELECT Pointer Structure
Example
BYTE* SEARCH_SELECT pRecvData; sendSelect;
pRecvData = XQSearch_GetSelectFrame(&sendSelect);
2.2.10 XQSearch_GetVideoFrame
Prototype
BYTE* XQSearch_GetVideoFrame(SEARCH_VIDEO* strVideoReq);
Description
Get image information when performs Play Option(Play/Reverse/Fast Forward)
Return Values
27
Received images pointer value
Parameters
strSelectReq [in] SEARCH_SELECT Pointer Structure
Example
BYTE* SEARCH_VIDEO pRecvData; sendVideo;
XQSearch_GetVideoFrame(&sendVideo);
2.2.11 XQSearch_SetEventSearch
Prototype
void XQSearch_SetEventSearch(SEARCH_EVENT* strEventReq);
Description
Set event information to search on connected DVR
Return Values
none
Parameters
strEventReq [in] SEARCHEVENT_REQ Pointer Structure
Example
// Event search setup SEARCH_EVENT strSearchEvent;
XQSearch_SetEventSearch(&strSearchEvent); ... // Search by setup value XQSearch_GetEventSearch(bFlag);
2.2.12 XQSearch_GetEventSearch
Prototype
void XQSearch_GetEventSearch(BOOL bFlag);
28
Description
Get configured event information as callback function
Return Values
none
Parameters
bFlag [in] set whether you get searched event information continuously or not (Max 10 events at a time) TRUE : keep receiving FALSE : End search
Example
BOOL // received bStatus = TRUE; XQSearch_GetEventSearch(bStatus); // End Search bStatus = FALSE; XQSearch_GetEventSearch(bStatus); bStatus;
2.2.13 XQSearch_SetBackup
Prototype
void XQSearch_SetBackup(BACKUP_CONFIG* strBackupReq);
Description
Run backup information of connected DVR
Return Values
none
Parameters
strBackupReq [in] BACKUP_CONFIG Pointer Structure
Example
29
BACKUP_CONFIG
strBackup;
XQSearch_SetBackup(&strBackup);
2.2.14 XQSearch_GetBackup
Prototype
void XQSearch_GetBackup(BOOL bFlag);
Description
Run backup with configured backup information. Information will be transferred as callbacku function
Return Values
none
Parameters
bFlag [in] Setup run or complete Backup process. TRUE : complete backup FALSE : Run backup
Example
BOOL // run bSatus = FALSE; XQSearch_GetBackup(bStatus); // end bStatus = TURE; XQSearch_GetBackup(bStatus); bStatus;
2.2.15 XQSearch_ProcRecvMain
Prototype
void XQSearch_ProcRecvMain(void* pRecvCallBack, void* pThis);
Description
Define CallBack function and call applicable functions in library
30
Process Event information and Backup information, Audio information Defined Callback function in API typedef void (*SearchRecvCallBack)(int nComm, void* pRecvData, void* pParent)
Return Values
none.
Parameters
pRecvCallBack [in] Callback Function Definition which can created from Library to Main Frame pThis [in] Pointer Value of Main Frame
Example
XQSearch_ProcRecvMain(XQSearch_RecvMainCallBack, (void*)this);
2.2.16 XQSearch_RecvCallBack
Prototype
void XQSearch_RecvCallBack(int nComm, void* pRecvData);
Description
Process received data from DVR As user define function, it defines function pointer of pRecvCallBack of XQSearch_ProcRecv.(
Return Values
none.
Parameters
nComm [out] Main command value pRecvData [out] Transferred data from
Example
31
switch(nComm) { case COMM_SYSTEM: { } case COMM_SEARCH_AUDIO: { } case COMM_SEARCH_EVENT: { } case COMM_BACKUP_ENABLE: { } case COMM_BACKUP: { }
2.2.17 XQSearch_GetStatus
Prototype
void XQSearch_GetStatus(XQAPI_CONFIG* strSearchConfig);
Description
Check Version & Authority information of DVR Set.
Return Value
none.
Parameters
strSearchConfig [out] XQAPI_CONFIG Pointer Structure
Example
XQDVR_ABOUT strConfig; XQSearch_GetStatus(&strConfig);
32
2.3 XQ Setup
2.3.1 XQSetup_GetConfig
Prototype
void XQSetup_GetConfig(SETUP_DATA * strSetupData);
Description
Check setup information on DVR XQConfig.h(refer this file)
Return Values
none.
Parameters
strSetupData As [out] SETUP_DATA Pointer Structure, returns Setup value
Example
SETUP_DATA strSetupData;
XQSetup_GetConfig(&strSetupData);
2.3.2 XQSetup_SetConfig
Prototype
void XQSetup_SetConfig(SETUP_DATA* strSetupData);
Description
Set each information on DVR XQConfig.h (refer this file)
Return Values
none.
Parameters
strSetupData as [in] SETUP_Data Pointer Structure, it sets Setup information
33
Example
SETUP_DATA strSetupData;
XQSetup_SetConfig(&strSetupData);
2.4 Common Function

2.4.1 GetLastError
Prototype
char* GetLastError();
Description
Check last occurred problem.
Return Values
Send Error information
Parameters
none.
Example
Char* szError = GetLastError(); szError;
3. XQ Client API Structures

3.1 XQ Live
3.1.1 LIVE_CONNECTINFO
Prototype
typedef struct { char DWORD char szAddress[MAX_ADDRESS_LENGTH]; dwPort; szUsername[MAX_ID_LENGTH];
34
char int
szPassword[MAX_PW_LENGTH]; nDVRType;
} LIVE_CONNECTINFO, *PLIVE_CONNECTINFO;
Description
Save DVR information as necessary item when connect DVR.
Members
szAddress DVR IP address dwPort connection port number szUsername Valid ID (user name) szPassword Valid password nDVRType Specify the DVR type. There are two types: DVR_TYPE_XQ and DVR_TYPE_NYX. Especially, NYX DVR supports only LIVE stream.
3.1.2 LIVE_RECORDSTATE
Prototype
typedef struct{ LIVE_RECORDINFO strLive_RecordInfo[MAX_CAMERA_COUNT];
} LIVE_RECORDSTATE, *PLIVE_RECORDSTATE;
Description
Save recording status of each camera
Members
strLive_RecordInfo LIVE_RECORDINFO Structure
3.1.3 LIVE_RECORDINFO
Prototype
35
typedef struct { unsigned char unsigned char float unsigned char unsigned char btChannel; btResolution; btFrame; btQuality; btAudio;
} LIVE_RECORDINFO, *PLIVE_RECORDINFO;
Description
Save each channel information
Member
btChannel Channel information btResolution Resolution information btQuality Picture quality btAudio Audio
3.1.4 LIVE_HDDSTATE
Prototype
typedef struct{ unsigned char LIVE_HDDINFO nHddCount; strHddInfo[MAX_HDD_COUNT];
} LIVE_HDDSTATE, *PLIVE_HDDSTATE;
Description
Save HDD information and status of connected DVR
Members
nHddCount HDD number of connected DVR strHddInfo LIVE_HDDINFO Structure
36
3.1.5 LIVE_HDDINFO
Prototype
typedef struct { unsigned char unsigned char unsigned int unsigned int } LIVE_HDDINFO, *PLIVE_HDDINFO; btTemperature; btSMART; dwHDDTotal; dwHDDUse;
Description
Save each HDD information
Members
btTemperature HDD temperature information btSMART SMART status dwHDDTotal HDD total use information (MB) dwHDDUse HDD Use information (MB)
3.1.6 LIVE_VIDEOSOURCE
Prototype
typedef struct { int int int int unsigned int unsigned int unsigned int BYTE* nChid; nWidth; nHeight; nFrameSize; nSec; nUsec; nGopid; pVideoSource;
37
} LIVE_VIDEOSOURCE, *PLIVE_VIDEOSOURCE;
Description
Image information & pointer value of received iamge
Members
nChid received channel information nWidth Horizontal size of received image nHeight Vertical size of received imge nFrameSize Size of received image nSec Time information of received image nUsec
nGopid Received image Gopid information pVideoSource Received image information
3.1.7 Live_MAINCALLBACK
Prototype
typedef struct { LiveRecvCallBack void* pLiveMainCallBack; pLiveParentWnd;
} LIVE_MAINCALLBACK, *PLIVE_MAINCALLBACK;
Description
Redefind callback function which will receive control information
Members
pLiveMainCallBack Function pointer value of application to be received
38
pLiveParentWnd Pointer value of application which called CallBack function.
3.1.8 LIVE_VIDEOCALLBACK
Prototype
typedef struct { LiveRecvCallBack void* pLiveVideoCallBack; pLiveParentWnd;
} LIVE_VIDEOCALLBACK, *PLIVE_VIDEOCALLBACK;
Description
Redefind callback function which will receive image information
Members
pLiveMainCallBack Function pointer value of application to be received pLiveParentWnd Pointer value of application which called CallBack function.
3.2 XQ Search
3.2.1 SEARCH_CONNECTINFO
Prototype
typedef struct { char DWORD char char szAddress[SIZE_ADDRESS]; dwPort; szUsername[MAX_ID_LENGTH]; szPassword[MAX_PW_LENGTH];
} SEARCH_CONNECTINFO, *PSEARCH_CONNECTINFO;
Description
Necessary item for DVR connection, it saves DVR information
Members
szAddress
39
IP address dwPort DVR port number szUsername Valid ID (User name) szPassword Valid password
3.2.2 SEARCH_DATE
Prototype
typedef struct { XQTM XQTM unsigned short SEARCH_DATEINFO } SEARCH_DATE, *PSEARCH_DATE; strFirstTm; strLastTm; nDataCount; strSearchDataInfo[MAX_RECORD_DAY];
Description
Save date information which recorded on DVR
Members
strFirstTm First recording time of DVR strLastTm Last recording time of DVR nDateCount number of recorded date strSearchDateInfo SEARCH_DATEINFO Structure value
3.2.3 SEARCH_DATEINFO
Prototype
typedef struct { SEARCH_XQTM strTm;
40
} SEARCH_DATEINFO, *PSEARCH_DATEINFO;
Description
Save date information
Members
stTm Save & display date/time information as a structure of XQTM
3.2.4 SEARCH_HOUR
Prototype
typedef struct { unsigned short SEARCH_HOURINFO } SEARCH_HOUR, *PSEARCH_HOUR; nSectionCount; strSearchHourInfo[MAX_SECTION_COUNT];
Description
Save time information.
Members
nSectionCount number of Section strSearchHourInfo SEARCH_HOURINFO Structure value
3.2.5 SEARCH_HOURINFO
Prototype
typedef struct { DWORD unsigned char dwSection; nHours[25];
} SEARCH_HOURINFO, *PSEARCH_HOURINFO;
Description
Set time information
Members
41
dwSection Set section information 7 V 6 D 5 R 4 3 2 HOUR 1 0
V(Vaild) : validity. When 0, ignore it D(DST) : Set DST section as 1
R(Record) : Set 1, if saved time HOUR nHours Hour information : Hour information (0~23)
3.2.6 SEARCH_MINUTE
Prototype
typedef struct { unsigned short SEARCH_MINUTEINFO nSectionCount; strSearchMinuteInfo[MAX_SECTION_COUNT];
} SEARCH_MINUTE, *PSEARCH_MINUTE;
Description
Save minute information
Members
nSectionCount Section
strSearchMinuteInfo SEARCH_MINUTEINFO Structure value
3.2.7 SEARCH_MINUTEINFO
Prototype
typedef struct{ DWORD unsigned short dwSection; nChannel[MAX_CAMERA_COUNT][60];
} SEARCH_MINUTEINFO, *PSEARCH_MINUTEINFO;
42
Description
Save minute information
Members
dwSection Recorded section value nChannel minutes information
3.2.8 SEARCH_SELECT
Prototype
typedef struct{ unsigned int unsigned int SEARCH_XQTM dwSection; dwChannel; strTm;
} SEARCH_SELECT, *PSEARCH_SELECT;
Description
Request the first frame in initial connection
Members
dwSection Requested section value dwChannel requested channel information (ex : 0000000000000001 <= channel 1) strTm Set time
3.2.9 SEARCH_VIDEO
Prototype
typedef struct{ unsigned char unsigned char unsigned int btControl; btJumpCnt; dwChannel;
} SEARCH_SELECT, *PSEARCH_SELECT;
43
Description
Setup value of receiving image data continuously in playback, 1frame playback, Fast Playback etc.
Members
btControl Set playback type (playback/1frame playback/F.Playback/R.Playback/F.Rev playback/Stop) btJumpCnt Set playback speed value when F.Fwd and F.Rev playback mode dwChannel Channel information setup (ex : 0000000000000001 <= Channel 1)
3.2.10 SEARCH_EVENTITEM
Prototype
typedef struct{ unsigned int SEARCH_XQTM unsigned short unsigned short dwSection; stTm; nEventType; nEventSource;
} SEARCH_EVENTITEM, *PSEARCH_EVENTITEM;
Description
Save event item which searched by its condition
Members
dwSection Section value of searched time stTm Time information of searched item nEventType Type information of searched item Motion 0 Sensor 1 VideoLoss 2
nEventSource
44
Channel information of searched item
3.2.11 SEARCH_EVENT
Prototype
typedef struct{ SEARCH_XQTM SEARCH_XQTM unsigned int unsigned int unsigned int unsigned int unsigned int stStartTm; stEndTm; dwMotion; dwSensor; dwVideoLoss; dwTextin; dwChannel;
} SEARCH_EVENTITEM, *PSEARCH_EVENTITEM;
Description
Enter event condition to be searched
Members
stStartTm Search start time stEndTm Search end time dwMotion Motion select in search (ex: 0000000000000001 <= Channel 1) dwSensor Sensor select in search (ex: 0000000000000001 <= Channel 1) dwVideoLoss VideoLoss select in search (ex: 0000000000000001 <= Channel 1) dwTextin Text in select in search dwChannel Channel search information (ex: 0000000000000001 <= Channel 1)
45
3.2.12 SEARCH_MAINCALLBACK
Prototype
typedef struct { SearchRecvCallBack void* pSearchMainCallBack; pSearchParentWnd;
} SEARCH_MAINCALLBACK, *PSEARCH_MAINCALLBACK;
Description
Redefind callback function which will receive Control information
Members
pSearchMainCallBack Function pointer value of application will be received pSearchParentWnd Pointer value of Application which called Callback function.
3.2.13 SEARCH_XQTM
Prototype
typedef struct { unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char unsigned char tm_year; tm_mon; tm_mday; tm_hour; tm_min; tm_sec; isdst;
} SEARCH_CONNECTINFO, *PSEARCH_CONNECTINFO;
Description
Save time information
Members
tm_Year display year (1900) tm_Mon display month (0~11)
46
tm_Day display day (1~31) tm_Hour display time (0~23) tm_Min display minutes (0~59) tm_Sec display seconds (0~59) isDST Dislay DST section information. 0 : out of DST section 1 : in DST section
3.3 XQ Setup
3.3.1 SETUP_DATA
Prototype
typedef struct { BYTE* Int } SETUP_DATA, *PSETUP_DATA; pSetupData nPos;
Description
Process Setup information
Members
pSetupData Received or send Setup Data information nPos pSetupData size
47
3.4 Common Structures

3.4.1 XQAPI_ABOUT
Prototype
typedef struct { char char char char } XQAPI_ABOUT, *PXQAPI_ABOUT; szProjectName[SIZE_PROJECT]; szVersion[SIZE_VERSION]; szLastUpdate[SIZE_DATE]; szNetVersion[SIZE_VERSION];
Description
Save program and network information
Members
szProjectName XQAPI Project name szVersion XQAPI version information szLastUpdate Last update information szNetVersion Network version information of connected DVR
3.4.2 XQDVR_ABOUT
Prototype
typedef struct { BOOL DWORD DWORD } XQDVR_ABOUT, *PXQDVR_ABOUT; bAuthority dwProdVersion; dwFirmVersion;
Description
DVR(Set) version and authority information
48
Members
bAuthority DVR authority information dwProdVersion DVR model information dwFirmVersion DVR version information
49
4. Macros
#define MAX_ADDRESS_LENGTH
#define MAX_ID_LENGTH #define MAX_PW_LENGTH #define MAX_CAMERA_COUNT #define MAX_HDD_COUNT #define MAX_ABOUT_LENGTH #define MAX_RECORD_DAY #define MAX_SECTION_COUNT #define COMM_SYSTEM #define COMM_STATUS #define COMM_LIVE_VIDEO #define COMM_LIVE_AUDIO #define COMM_SEARCH_AUDIO #define COMM_SEARCH_EVENT #define COMM_BACKUP_ENABLE #define COMM_BACKUP #define PROD_XQ #define PROD_XQL #define PROD_XQP #define PROD_XQLS #define PROD_XQPS 0x53 0x54 0x58510000 0x58510100 0x58510200 0x58510101 0x58510201 0x11 0x12 0x15 0x16 0x46 0x48 128 32 16 16 4 128 1000 256
50
5. XML Setup
Almost XQ DVRs can be configured the settings by XML data if the DVR version has more than 2.0.x.x. Therefore, in this section, it provides where to change DVR configuration from XML element. This SDK doesnt support the sample code using XML.
5.1 XML Architecture

The data construction (in relation to the setup of XQ Series) is same as below: <?xml version=1.0 encoding=UTF-8?> <DVRXML version=2.0> <DVRCFG> Setup Information ... </DVRCFG> <NETCFG> Client Delivery Contents ... </NETCFG> </DVRXML>
Node
Setup Value and Its Scope
Description
DVRXML
Root Element which includes all XML construction
DVRCFG NETCFG
Setup Configration Information on SET Additional Setup Information for Client Communication
51
5.2 XQ Setup Info Structure

<DVRCFG> <INFO> Info Data </INFO> <SYSTEM> System Setup Info </SYSTEM> <NETWORK> Network Setup Info </NETWORK> <DEVICE> Device Info </DEVICE> <RECORD> Recording Setup Info </RECORD> <EVENT> Event Setup Info </EVENT> <MISC> Additional Setup Info </MISC>
52
</DVRCFG>
NOD
Setup Values and Scope
Content
DVRCFG version INFO
Config Info Container XML Format Version Info Basic Info - Required when using the client communication
SYSTEM NETWORK DEVICE RECORD MISC
System Info Network Info Device Info Recording Info Additional Info
5.3 XQ CONFIG XML: INFO

<INFO> <modified>YYYY/MM/DD-hh:mm:ss</modified> <model>pro</model> <version>2.0.0</version> <mac>xx:xx:xx:xx:xx:xx</mac> <video>ntsc</video> <videochannel>16</videochannel> <audiochannel>4</audiochannel>
53
<sensor>16</sensor> <alarm>4</alarm> <spot>2</spot> <oem>0<oem> <language>english</language> <videocodec>H.264</videocodec> <audiocodec>G.723</audiocodec> <ata>SATA</ata> <hwspec> ... </hwspec> </INFO>
NOD
Content
modified
YYYY/MM/DDhh:mm:ss
Last Time Setup was Changed (Local time)
model version mac video videochannel audiochannel sensor
pro / lite / ultra 2.x.x xx:xx:xx:xx:xx:xx ntsc / pal 4, 8, 9, 16 4 4, 8, 16
Model Main Application Version Info Network Mac Adress Video Format Maximum Input Channel Maximum Audio Channel Maximum Sensor Input
54
alarm spot oem
1, 4 1, 2 0, 1, 2, 3, 4, 5, 6, 7 0 1 2 3 4 5 6 7 8
Maximum Alarm Output Max. Spot Output OEM Classification TOM HISHARP NORTHWOOD ULTRA HISHARP ITALY HISHARP BRAZIL TEST RASION NETPROMAX Language
language
english chiness-tr chiness-sim japanese korean french polish russian spanish danish portuguese
55
italian turkish czech videocodec audiocodec ata hwspec H.264 / MPEG4 G.723 SATA / PATA Video Codec Info Audio Codec Info ata info Hardware Specification
5.3.1 XQ CONFIG XML: INFO/hwspec

<hwspec> <endian>big</endian> <cpu>ppc440</cpu> <codec>solo6010</codec> <vga>mdin200</vga> <usb>d720102</usb> <ata>sil3114</ata> <videodecoder>tw2815</videodecoder> <rtc>ds1337</rtc> </hwspec>
NOD
Content
endian
big, little
CPU endian info
56
cpu
405ep 440ep str8133
CPU model
codec
solo6010 solo6110
Codec Chip Info
vga
al260 mdin180 mdin200
VGA chip Info
usb
d720102 vt6212
USB Chip Info
videodecoder
tw2815 tw2864 lg1701
Video decoder Chip Info
Rtc
ds1337 Fm3104
RTC Chip Info
5.4 XQ CONFIG XML: SYSTEM

<SYSTEM> <sysinfo> System Info </sysinfo> <datetime> Date/Time Info
57
</datetime> <ntp> NTP Info </ntp> <holiday> Holiday Info </holiday> <account> Account Info </account> </SYSTEM>
NOD
Setup values and Scope
Content
sysinfo datetime ntp [holiday]
System Setup Info Time output method and TZ info NTP Info Holiday Info Can be deactivated if not used
account
Account Info
5.4.1 XQ CONFIG XML: SYSTEM/sysinfo

<sysinfo> <crash type=char>1</crash>
58
<name type=string size=31>DVR</name> <uuid type=string size=36>6ec4b09e-a11f-4ec4-a025-88e68ee554ab</uuid> <langid type=char>0</langid> <sysid type=char>0</sysid> </sysinfo>
NOD
Content
crash
char, 0~1
Indication of Normal/Abnormal Shutdown - 0 indication during booting means the proper shutdown
name uuid langid sysid
string, 31 string, 36 language id char, 0~99
Name Info System uuid Language ID DVR ID Can be used also by Remote Controllers ID
5.4.2 XQ CONFIG XML: SYSTEM/datetime

<datetime> <dptype type=char>0</dptype> <zonekey type=string size=63>seoul</zonekey> <dst type=char>0</dst> <userdst>
59
User DST Info </userdst> </datetime>
MOD
Content
dptype
char, 0 ~ 2 0 1 2
Date Indication YYYY MM DD MM DD YYYY DD MM YYYY zone key info zone keys DST usage selection User Customized DST Info USER DST can be deactivated
zonekey dst [userdst]
string, 63 char, 0 ~ 1
5.4.3 XQ CONFIG XML: SYSTEM/datetime/userdst

<userdst> <dststart type=string size=15>03:1:0-00:00:00</dststart> <dstend type=string size=15>10:1:0-00:00:00</dstend> </userdst>
NOD
Setup Value and Scope
Content
60
dststart
string, 15 Month:Week:DayTime:Min:Sec Month Week Day Time Min Sec
DST Start Info
0~11 0~6 1~6 0~23 0~59 0~59 DST Shutdown Info
dstend
string, 15 Month:Week:DayHour:Min:Sec
5.4.4 XQ CONFIG XML: SYSTEM/ntp

<ntp> <en type=char>1</en> <svr type=char>0</svr> <addr type=string size=127>pool.ntp.org</addr> <pt type=ushort>123</pt> <cycle type=uchar>24</cycle> <lsync type=uint>128900012</lsync> </ntp>
61
NOD
Content
en svr addr pt cycle lsync
char, 0~1 char, 0~1 string, 127 ushort, 0~65536 uchar, 1~240 uint
NTP Usage NTP Server Management Usage NTP Server Address Server Port NTP Usage Cycle (hour) Time update
5.4.5 XQ CONFIG XML: SYSTEM/holiday

<holiday> <date type=string size=10>2009/07/08</date> <date type=string size=10>2009/10/09</date> </holiday>
NOD
Content
date
string, 10 Max. 32 supported
Holidays YYYY/MM/DD Info
5.4.6 XQ CONFIG XML: SYSTEM/account

<account>
62
<lgien type=char>0</lgien> <atlgo type=char>0</atlgo> <atlgotm type=uchar>180</atlgotm> <userlst> User Account Information ... </userlst> </account>
NOD
Setting Values and Scope
Content
lgien atlgo atlgotm
char, 0~1 char, 0~1 uchar, 1~180 (Unit : min.)
LOGIN usage Automatic Logout Automatic logout time without user input
userlst
User Account
at least one admin account is required Admin account of User
5.4.7 XQ CONFIG XML: SYSTEM/account/userlst

<userlst> <usr> <id type=string size=31>admin</id> <pw type=string size=31>1</pw> <auth type=uint>0xffffffff</auth>
63
</usr> <usr> <id type=string size=31>liqueury</id> <pw type=string size=31>1</pw> <auth type=uint>0xffffffff</auth> </usr> </userlst>
NOD
Content
usr usr/id usr/pw usr/auth string, 31 string, 31 uint bit 0 bit 1 bit 2 bit 3 bit 4 bit 5 bit 6 bit 7 bit 8
User ID/PW/Authorisation USER ID User Password User Authorisation REC (Panic Record) PLAY (no practical use) BACKUP PTZ Control HIDDEN Camera (no practical use) SETUP Camera Control (no practical use) FORMAT UPGRADE
64
bit 9 bit 10 bit 11 bit 12
SHUTDOWN LIVE Video Control (no practical use) SEARCH NETWORK
5.5 XQ CONFIG XML: NETWORK

<NETWORK> <ethernet> Ethernet Info </ethernet> <ddns> DDNS Info </ddns> <email> E-Mail Info </email> <callback> Callback Info </callback> <nas> NAS Device Info </nas> </NETWORK>
65
NOD
Content
ethernet
Ethernet related info - STATIC / DHCP / PPPoE
ddns email callback [nas]
Dynamic Domain Name Service Account E-mail Alarm Events for the callback client information Extended storage backup information
5.5.1 XQ CONFIG XML: NETWORK/ethernet

<ethernet> <en type=char>1</en> <nrclient type=char>7</nrclient> <ethtype type=char>1</ethtype> <ip type=string size=63>192.168.6.108</ip> <nm type=string size=63>255.255.0.0</nm> <gw type=string size=63>192.168.6.1</gw> <dns type=string size=63>168.126.63.1</dns> <dns type=string size=63>168.126.63.2</dns> <rmpt type=ushort>9013</rmpt> <httpt type=ushort>80</httpt>  <adslid type=string size=31>liqueury</adslid>
66
<adslpw type=string size=15>1234</adslpw> </ethernet>
NOD
Content
en nrclient ethtype
char, 1 char, 1~7 char 0~2 0 1 2
ethernet usage (must be used) Specified number of Live Connections Ethernet connection type STATIC DHCP PPPoE IP used at STATIC netmask at STATIC gateway IP used at STATIC DNS Server IP used at STATIC Client Connection Port Webserver Connection Port Connection port for firmware Update (Not Available Yet)
ip nm gw dns rmpt httpt [fwpt]
string, 63 string, 63 string, 63 string, 63 ushort, 0~65535 ushort, 0~65535 ushort, 0~65535
adslid adslpw
string, 31 string, 15
ID for ADSL(PPPoE) connection PW for ADSL(PPPoE) connection
67
5.5.2 XQ CONFIG XML: NETWORK/ddns

<ddns> <en type=char>1</en> <svrtype type=char>0</svrtype> <hostname type=string size=127>test-muckl.ezddns.com</hostname> <id type=string size=31>liqueury</id> <pw type=string size=15>1234</pw> <routen type=char>1</routen> </ddns>
NOD
Content
en svrtype
char, 0~1 char, 0~1 0 1
DDNS Funtion DDNS Server Type EZDDNS DynDNS Registered DDNS Host Name DDNS ID DDNS PW router usage
hostname id pw routen
string, 127 string, 31 string, 15 char, 0~1
5.5.3 XQ CONFIG XML: NETWORK/email

<email> <en type=char>1</en>
68
<smtp> SMTP Server Info </smtp> <mailst> Mail List </mailst> </email>
NOD
Content
en smtp [mailst]
char, 0~1
E-mail Notification Function SMTP Server Info E-mail Receiver List
5.5.4 XQ CONFIG XML: NETWORK/email/smtp

<smtp> <svr type=string size=127>mail.tomtech.co.kr</svr> <sndr type=string size=31>DVRNAME</sndr> <lgien type=char>1</lgien> <id type=string size=127>liqueury</id> <pw type=string size=15>1234</pw> </smtp>
NOD
Setup Values and
Content
69
Scope svr sndr lgien id pw string, 127 string, 31 char, 0~1 string, 127 string, 15 SMTP Server Address Sending Person Name SMTP Server login usage SMTP Account ID SMTP Account PW
5.5.5 XQ CONFIG XML: NETWORK/email/milst

<mailst> <mail type=string size=63>liqueury@tomtech.co.kr</mail> <mail type=string size=63>tomson@abc.co.kr</mail> </mailst>
NOD
Content
mail
string, 63
E-mail list transmittance
Up to 7 supported
5.5.6 XQ CONFIG XML: NETWORK/callback

<callback> <en type=char>1</en> <rcvr type=string size=127>192.168.6.100:9100</rcvr>
70
<rcvr type=string size=127>ezddns.com:9100</rcvr> </callback>
NOD
Content
en rcvr
char, 0~1 string, 127 format=Address:Port
Callback Function Usage Event Callback List Transmit
Up to 7 supported
5.5.7 XQ CONFIG XML: NETWORK/nas

<nas> <en type=char>1</en> <md type=char>0</md> <naslst> NAS Device List ... </naslst> </nas>
NOD
Content
en md
char, 0~1 char, 0~1 0
NAS Device Usage Backup Method Backing up all the files that failed Backup
71
Block files that are generated from the current process
naslst
NAS Device Info
5.5.8 XQ CONFIG XML: NETWORK/nas/naslst

<naslst> <dev> <ip type=string size=127>192.168.5.100</ip> <fd type=string size=127>backup</fd> <id type=string size=31>admin</id> <pw type=string size=15>1234</pw> <opt type=string size=127></opt> </dev> <dev> </dev> </naslst>
NOD
Content
dev/ip dev/fd [dev/id]
string, 127 string, 127 string, 31
NAS IP Address NAS Backup root Folder Location NAS ID
72
[dev/pw] [dev/opt]
string, 15 string, 127
NAS PW NAS connectivity options
73
5.6 XQ CONFIG XML: DEVICE

<DEVICE> <camera> Camera Info </camera> <alarm> Alarm Info </alarm> <audio> Audio Info </audio> <osd> OSD(Monitor) Indication Info </osd> <monitor> Monitor Out </monitor> <spot> Spot Out Info </spot> <vga> VGA Setup </vga>
74
<misc> Additional Settings </misc> </DEVICE>
NOD
Description
camera alarm audio osd monitor spot vga misc
Camera Info Alarm Setup Audi Setup Display Indication Setup Main Monitor Control Spot out Setup VGA Settings Additional Settings
5.6.1 XQ CONFIG XML: DEVICE/camera

<camera> <cam id=0> <tt type=string size=31>ch1</tt> <hid type=char>0</hid> <brt type=uchar>0x80</brt> <hue type=uchar>0x80</hue>
75
<cont type=uchar>0x80</cont> <sat type=uchar>0x80</sat> <shp type=uchar>0x80</shp> <aid type=char>0</aid> <ptz> PTZ Info </ptz> </cam> <cam id=1> </cam> </camera>
NOD
DEscription
cam rapid completion id, 0~15 tt hid brt hue cont string, 31 char, 0~1 uchar, 0~255 uchar, 0~255 uchar, 0~255
Camera Info Camera Channel Info
Camera Name Camera Hidden Info Camera Brightness Info Camera Hue Info Camera Contrast Info
76
sat shp [aid]
uchar, 0~255 uchar, 0~255 char, 0~3,(-1)
Camera Saturation Info Camera Sharpness Information Audio Channel ID connected to camera If omitted no camera is connected to Audio
[ptz]
PTZ Info
5.6.2 XQ CONFIG XML: DEVICE/camera/ptz

<ptz> <en type=char>1</en> <protoid type=char>31</protoid> <ptzid type=uchar>3</ptzid> <spd type=char>7<spd> <serial> Serial Port Info </serial> </ptz>
NOD
Description
en protoid
char, 0~1 char, 0~127
PTZ Use PTZ Protocol ID number 2009.7.8 at present 0~43 supported
ptzid spd
uchar, 0~255 char, 1~10
PTZ Address (ID) Technology PTZ Operation Speed Level
77
serial
PTZ Operation Serial Port Setup
5.6.3 XQ CONFIG XML: DEVICE/camera/ptz/serial

<serial> <baud type=char>7</baud> <data type=char>3</data> <stop type=char>0</stop> <parity type=char>0</parity> <serial>
NOD
Description
baud
char, 0~18 0 1 2 3 4 5 6 7 8 9
Serial Port Baudrate Setting BAUD0 BAUD50 BAUD75 BAUD110 BAUD134 BAUD150 BAUD200 BAUD300 BAUD600 BAUD1200
78
10 11 12 13 14 15 16 17 18 data char, 0~3 0 1 2 3 stop char, 0~1 0 1 parity char, 0~2 0 1 2
BAUD1800 BAUD2400 BAUD4800 BAUD9600 BAUD19200 BAUD38400 BAUD57600 BAUD115200 BAUD230400 Size of the Serial Port Transmit Data 5 bit 6 bit 7 bit 8 bit Serial Port Stop Bit Size 1 bit 2 bit Serial Port Parity Mode NONE EVEN ODD
79
5.6.4 XQ CONFIG XML: DEVICE/alarm

<alarm> <almo id=0> <tt type=string size=31>ALARM1</tt> <nc type=char>0</nc> </almo> <almo id=1> </almo> </alarm>
NOD
Description
almo rapid completion id, 0~3 almo/en almo/tt almo/nc char, 0~1 string, 31 char, 0~1 0 1
Alarm Info Alarm Channel ID
Alarm Use Alarm Name Alarm Mode Normal Open Normal Close
80
5.6.5 XQ CONFIG XML: DEVICE/audio

<audio> <vol type=char>10<vol> <mute type=char>0</mute> </audio>
NOD
DEscription
<[vol]> mute
char, 1~100 char, 0~1 0 1
volume out mute status Mute OFF Mute ON
5.6.6 XQ CONFIG XML: DEVICE/osd

<osd> <osdg type=uint>0xffffffff</osdg> <osdc type=uint>0xffffffff</osdc> <hspc type=short>20</hspc> <vspc type=short>20</vspc> <alrate type=char>100</alrate> </osd>
NOD
Description
81
osdg
uint, bitfield bit 0 bit 1 bit 2 bit 3 bit 4 bit 5 bit 6 bit 7 bit 8 bit 9 bit 10
OSD Display Technology Date Time Backup Cleint connection HDD usage Login user Info mute sequence zoom freeze page number Camera Info Indication bit 0 bit 1 bit 2 bit 3 bit 4 bit 5 bit 6 bit 7 Camera Number Camera Name Record Status Info Event Info Audio Conection Info PTZ Connection Info Video Loss Info Hidden Info OSD Info Indication, Empty Spare of horizontal end point.
osdc
uint, bitfield
hspc
short, 0~30
82
vspc
short, 0~20
OSD Info, Empty Spare of horizontal end point.
[alrate]
char, 0~100
OSD Alpha blending value description
5.6.7 XQ CONFIG XML: DEVICE/monitor

<monitor> <seqdw type=char>5</seqdw> <popen type=char>1</popen> </monitor>
NOD
Setup Values and scope
Description
seqdw
char, 1~30
Division Mode Sequence DWELL Time Setup(sec)
popen
char, 0~1
Select Event Popup
5.6.8 XQ CONFIG XML: DEVICE/spot

<spot> <dev id=0> <md type=char>0</md> <fxcam type=char>3</fxcam> <seqdw type=char>5</seqdw>
83
<lncam type=uint>0x10</lncam> <!Future Use <split type=char>0</split> --> </dev> <dev id=1> </dev> <spot>
NOD
Description
dev rapid completion id, 0~1 dev/md char, 0~2 0 1 2 3 dev/fxcam dev/seqdw dev/lncam char, 0~15 char, 1~30 uint, bitfield
SPOT Info Setup SPOT Monitor Channel
SPOT monitor Mode Setup Fixed Channel 1 ch. sequence Division Mode Sequence (future use) Event Popup (future use) Fixed Channel mode output camera channel Sequence Mode DWELL Time 1 Channel Sequence: Connected Cameras bitfield. Event Popup: Connected Cameras bitfield.
84
<[dev/split]>
char, 0~2 0 1 2
All Channels Division Mode 4 division mode 9 division mode 16 division mode
5.6.9 XQ CONFIG XML: DEVICE/vga

<vga> <brt type=uchar>0x80</brt> <hue type=uchar>0x80</hue> <cont type=uchar>0x80</cont> <sat type=uchar>0x80</sat> <shp type=uchar>0x80</shp> <hres type=short>1024</hres> <vres type=short>768</vres> <!Future Use <td type=uchar>0x80</td> --> <!Future Use <di type=uchar>0x80</di> --> </vga>
NOD
Description
brt hue cont
uchar, 0~255 uchar, 0~255 uchar, 0~255
VGA Brightness VGA Hue VGA Contrast
85
sat shp hres vres <[td]> <[di]>
uchar, 0~255 uchar, 0~255 short short uchar, 0~255 uchar, 0~255
VGA Saturation VGA Sharpness VGA Horizontal Resolution VGA Vertical Resolution 3D Factor De-interlace Factor
5.6.10 XQ CONFIG XML: DEVICE/misc

<misc> <keyctrl> <en type=char>1<en> <protoid type=char>0</protoid> <addr type=uchar>10</addr> <serial> Serial Port Info Description </serial> </keyctrl> <keytone type=char>0</keytone> </misc>
NOD
Description
keyctrl/en keyctrl/protoid
char, 0~1 char, 0~2
Select to use Keyboard Controller Keyboard Controller Protocol ID
86
keyctrl/addr
uchar, 0~255
DVR Address assigned from Keyboard Controller
keyctrl/serial keytone char, 0~1
identical with ptz/serial Select to use Keytone
87
5.7 XQ CONFIG XML: RECORD

<RECORD> <en type=char>1</en> <panic type=char>0</panic> <recycle type=char>1</recycle> <retention type=short>365</retention> <camera> <cam> Camera Recording Setup Info Description ... </cam> <cam> ... </cam> ... <camera> </RECORD>
NOD
Description
en panic recycle retention camera
char, 0~1 char, 0~1 char, 0~1 short, 0~365
Recording Selection Emergency Recording Status Overwrite Mode Support Selection Recorded Data Retention Date Camera Setup Info Setup
88
5.7.1 XQ CONFIG XML: RECORD/camera/cam

<cam> <id type=char>0</id> <fx> <res type=char>0</res> <md type=char>0</md> <sched> <sun type=string size=24>MMMMMMMMMMMMMMMMMMMMMMMM</sun> <mon type=string size=24>NNNNNNNNNNNNNNNNNNNNNNN</mon> <tue type=string size=24>EEEEEEEEEEEEEEEEEEEEEEEE</tue> <wed type=string size=24>OOOOOOOOOOOOOOOOOOOOOOOO</wed> <thu type=string size=24></thu> <fir type=string size=24></fir> <sat type=string size=24></sat> </sched> </fx> <nor> <qty type=char>0</qty> <fps type=char>10</fps> </nor> <evt> <qty type=char>0</qty>
89
<fps type=char>10</fps> </evt> </cam>
NOD
Description
id fx/res
char, 0~15 char, 0~3 0 1 2 3
Channel Recording Resolution Setup D1 HD1 CIF OFF Recording Mode 0 1 2 3 4 OFF NORMAL EVENT ALL (N+M) SCHED Sunday Schedule Recording Setup MON TUE WED THU FRI
fx/md
char, 0~4
fx/sched/sun fx/sched/mon fx/sched/tue fx/sched/wed fx/sched/thu fx/sched/fir
string, 24 string, 24 string, 24 string, 24 string, 24 string, 24
90
fx/sched/sat nor/qty evt/qty
string, 24 char, 0~4 0 1 2 3 4
SAT Recording Resolution Setup Highest High Middle Low Lowest FPS Setup FPS differs according to NTSC / PAL regardless of mode
nor/fps evt/fps
char, 0~10
91
5.8 XQ CONFIG XML: EVENT

<EVENT> <motion> Motion Info Setup </motion> <sensor> Sensor Info Setup </sensor> <vloss> VIDEO LOSS Info Setup </vloss> <diskfull> Disc FULL Info Setup </diskfull> <diskerr> Disc Error Info Setup </diskerr> <smart> Smart Info Setup </smart> </EVENT>
NOD
Description
92
motion sensor vloss diskfull diskerr smart
Motion Setup Info Sensor Info Setup Video Loss Info Setup Disc FULL Info Setup Disc Error Info Setup Smart Info Setup
5.8.1 XQ CONFIG XML: EVENT/motion

<motion> <cam id=0> <en type=char>1</en> <sens type=char>3</sens> <!Future Use <keep type=char>1</keep> --> <!Future Use <dly type=char>1</dly> --> <area> <aa type=uint>0x3ff</aa> <aa type=uint>0x3ff</aa> <aa type=uint>0x3ff</aa> <area> <act> ACTION Technology </act>
93
</cam> <cam id=1> </cam> </motion>
NOD
Setting Value and Scope
Description
cam rapid completion id, 0~15 cam/en cam/sens <[cam/keep]> <[cam/dly]> char, 0~1 char, 1~5 char, 0~60 char, 0~60
Camera Motion Info Camera Channel Info
Motion Use Selection Motion Sensitivity Setting Motion Retention Time Setting Latency time between Motion Alert and ACTION performance
cam/area/aa
uint, birfield
Bitfield of Screem Motion Multiple Matrix Configuration
act
action setup according to event
5.8.2 XQ CONFIG XML: EVENT/motion/cam/act

<act>
94
<lncam type=uint>0x9</lncam> <prert type=uchar>5</prert> <postrt type=uchar>10</postrt> 
<popcam type=char>1</popcam> <popdw type=char>5<popdw> <!Future Use <preset> <pset type=uchar>0</pset> <pset type=uchar>0</pset> <pset type=uchar>0</pset> </preset> <spot> <pt type=char>0</pt> <pt type=char>0</pt> <pt type=char>0</pt> </spot> --> <lnalmo type=uint>0x9</lnalmo> <almdw type=char>5</almdw> <bzdw type=char>5</bzdw> <email type=char>1</email>
95
<cb type=char>1</cb> <flag type=uchar>0x0</flag> </act>
NOD
Description
lncam
uint, bitfield
Camera Channel Description (bit) related to Action
prert
uchar, 0~5 0 1~5
Pre-Recording (sec) related Action No Use 1~5 sec Post Recording (sec) related Action Designated monitor popup related to Action 0 1 Main Monitor Application SPOT monitor Channel Application POPUP applied Camera related to Action POPUP DWELL Application Time related to Action 0 1~30 No Use 1~30 sec. applied PTZ Reset No. of the Camera related to Action
postrt <[popath]>
uchar, 5~60 char, 0~1
popcam popdw
char, 0~15 char, 0~30
<[preset/pset]>
uchar, 0~255
<[spot/pt]> lnalmo
char, 0~15 uint, Bitfield
Camera Spot Out Setup related to Action Alarm Channel Settings according to Action
96
almdw
char, 0~30 0 1~30
Alarm Retention Time related to Action No Use 1~30 sec. applied Buzzer Retention Time related to Action 0 1~30 No Use 1~30 sec. applied Email Notification related to Action Callback Function related to Action Saving Log Info according to Action
bzdw
char, 0~30
email cb flag
char, 0~1 char, 0~1 uchar, Bitfield
5.8.3 XQ CONFIG XML: EVENT/sensor

<sensor> <sin id=0> <en type=char>1</en> <!Future Use <keep type=char>1</keep> --> <!Future Use <dly type=char>1</dly> --> <nc=char>0</nc> <tt type=string size=31>SENSOR1</tt> <act> ACTION Description </act> </sin> <sin id=1>
97
</sin> </sensor>
NOD
Description
sin Rapid completion id, 0~15 sin/en <[sin/keep]> <[sin/dly]> char, 0~1 char, 0~60 char, 0~60
Sensor Input Info Sensor Channel Info
Sensor Use Sensor Input Retention Time Latency time between Sensor Input and ACTION performance
sin/nc
char, 0~1 0 1
Sensor Type Normal Open Normal Close Sensor Name identical with motion/act
sin/tt sin/act
string, 31
5.8.4 XQ CONFIG XML: EVENT/vloss

<vloss> <cam id=0>
98
<en type=char>1</en> <!Future Use <keep type=char>1</keep> --> <!Future Use <dly type=char>1</dly> --> <act> ACTION Technology </act> </cam> <cam id=1> </cam> </vloss>
NOD
Description
cam Rapid completion id, 0~15 cam/en <[cam/keep]> <[cam/dly]> char, 0~1 char, 0~60 char, 0~60
Camera Video Loss Info Camera Channel Info
Video Loss Use (always 1) Video Loss Retention Time Latency timebetween Temperature Retention Time and ACTION performance
cam/act
identical with motion/act
99
5.8.5 XQ CONFIG XML: EVENT/diskfull

<diskfull> <en type=char>1</en> <sysact> SYSTEM ACTION Description </sysact> </diskfull>
NOD
Description
en sysact
char, 0~1
Use Disc Full Event Action related with system
5.8.6 XQ CONFIG XML: EVENT/diskfull/sysact

<sysact> <lnalmo type=uint>0x9</lnalmo> <almdw type=char>5</almdw> <bzdw type=char>5</bzdw> <email type=char>1</email> <cb type=char>1</cb> <flag type=uchar>0x0</flag> </sysact>
NOD
Setting Values and
Description
100
Scope lnalmo almdw uint, bitfield char, 0~30 0 1~30 bzdw char, 0~30 0 1~30 email cb flag char, 0~1 char, 0~1 uchar, bitfield Alarm Channel setting related to Action Alarm Retention Time related to Action NO USE 1~30 sec. applied Buzzer Retention Time related to Action No Use 1~30 sec. applied Email Notification according to Action Callback function related to Action Saving Log Info according to Action
5.8.7 XQ CONFIG XML: EVENT/diskerr

<diskerr> <en type=char>1</en> <sysact> SYSTEM ACTION TECHNOLOGY </sysact> </diskerr>
NOD
Description
en
char, 0~1
DISC ERROR EVENT USE
101
sysact
identical with diskfull/sysact
5.8.8 XQ CONFIG XML: EVENT/smart

<smart> <en type=char>1</en> <!FUTURE USE <sif> <temp type=char>60</temp> <keep type=char>1</keep> <dly type=char>1</dly> </sif> --> <sysact> SYSTEM ACTION DESCRIPTION </sysact> </smart>
NOD
Description
en <[sif/temp]>
char, 0~1 char, 0~100
SMART EVENT USE HDD Temperature Limit for ACTION performance.
<[sif/keep]> <[sif/dly]>
char, 0~60 char, 0~60
Temperature Retention Time Latency timebetween Temperature
102
Retention Time and ACTION performance sysact identical with diskfull/sysact
103
5.9 XQ CONFIG XML: MISC

<MISC> <lv> <md type=char>9</md> <pg type=char>0</pg> <layout> <lo type=string size=26>0123456789abcdefxxxxxxxxxx</lo> <lo type=string size=26>0123456789abcdefxxxxxxxxxx</lo> <lo type=string size=26>0123456789abcdefxxxxxxxxxx</lo> </layout> </lv> <!future use <pb> <md type=char>9</md> <pg type=char>0</pg> <layout> <lo type=string size=26>0123456789abcdefxxxxxxxxxx</lo> <lo type=string size=26>0123456789abcdefxxxxxxxxxx</lo> <lo type=string size=26>0123456789abcdefxxxxxxxxxx</lo> </layout> </pb>
104
--> </MISC>
NOD
Description
lv/md
char, 0~9 0 1 2 3 4 5 6 7 8 9
Layout Mode 1 division 4 division 1-5 division 3-4 division 1-7 division 9 division 2-8 division 1-12 division (1) 1-12 division (2) 16 division Page number according to the division mode arrange channel numbers according to each mode
lv/pg lv/layout/lo
char, 0~15 string, 26
<[pb]>
identical with lv , use during playback
105
5.10 XQ CLIENT XML

Additional Information Delivery thru Client
5.10.1 XQ CLIENT INFO STRUCTURE

<NETCFG> <PTZINFO> </PTZINFO> <NETMASK>0XFF</NETMASK> </NETCFG>
NOD
Description
PTZINFO
List of compatible PTZ (only included in S->C)
NETMASK
Changed CONFIG ID (only included in C->S)
5.10.2 XQ CLIENT XML: NETPTZ

<PTZINFO> <ptzcam> <protoid type=short>0</protoid> <cap type=ushort>0x003F</cap> <name type=string size=63>MARK MERCER D150QSPT</name>
106
</ptzcam> <ptzcam> </ptzcam> </PTZINFO>
NOD
Description
ptzcam/protoid ptzcam/cap
short, 0~43 ushort, bitfield bit 0 bit 1 bit 2 bit 3 bit 4 bit 5 bit 6
PTZ Cmara protocol id Support Functions (bitfield) PAN TILT FOCUS ZOOM IRIS PRESET MENU PTZ Protocol Name
ptzcam/name
string, 63
5.10.3 XQ CLIENT XML: NETMASK

<NETMASK>0x1fff</NETMASK>
107
NOD
Setting Value and Scope
Description
NETMASK
uint, bitfield bit 0 bit 1 bit 2 bit 3 bit 4 bit 5 bit 6 bit 7 bit 8 bit 9 bit 10 bit 11 bit 12 bit 13 bit 14 bit 15 bit 16 bit 17 bit 18 bit 19
changed config id XQ_CONFIG_SYS_INFO XQ_CONFIG_SYS_DATETIME XQ_CONFIG_SYS_ACCOUNT XQ_CONFIG_NET_ETHER XQ_CONFIG_NET_MODEM XQ_CONFIG_NET_DDNS XQ_CONFIG_NET_EMAL XQ_CONFIG_NET_CALLBACK XQ_CONFIG_DEV_CAMERA XQ_CONFIG_DEV_ALARM XQ_CONFIG_DEV_AUDIO XQ_CONFIG_DEV_DISPLAY XQ_CONFIG_DEV_MONITOR XQ_CONFIG_DEV_SPOT XQ_CONFIG_DEV_VGA XQ_CONFIG_DEV_MISC XQ_CONFIG_REC_POLICY, XQ_CONFIG_REC_ALL, XQ_CONFIG_EVT_MOTION XQ_CONFIG_EVT_SENSOR
108
bit 20 bit 21 bit 22 bit 23 bit 24
XQ_CONFIG_EVT_VLOSS XQ_CONFIG_EVT_TEXTIN XQ_CONFIG_EVT_SYSTEM XQ_CONFIG_MISC XQ_CONFIG_NAS
5.11 Abbreviations of NODE Name

Abbr. aa act addr aid almo alrate at atype brt bz cam cb cfg cont ctrl Origin area action address audio id alarm out alpha rate auto alarm type bright buzzer camera callback config contrast control Abrr. lgi lgo ln lnalmo lo lst lsync lv md nm nor nr osdc osdg pb Origin login logout link link alarm out location list lastsync live mode netmask normal number osd camera osd grobal playback
109
di dly dp dw en eth evt fd fps fw fx gw hid hres hspc if lg stype svr td temp tm tt
de-interlace delay display dwell enable Ethernet event folder frame per sec firmware fix gateway hidden horizontal resolution horizontal space information log sensor type server 3D(three dimensional) temperature time title
pg pop pt qty rcvr res rm rt sat sched sens seq shp sin spt sndr spd
page popup port quility receiver resolution remote rec time saturation schedule sensitivity sequence sharp sensor in spot port sender speed
110
usr vol vres vspc
user volume vertical resolution vertical space
111

XQ Client API - v1 3 - 20100615 - ENG

Hochgeladen von

Dokumentinformationen

Originaltitel

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

XQ Client API - v1 3 - 20100615 - ENG

Hochgeladen von

Copyright:

Verfügbare Formate

T.O.M. Technology, Inc.

1.2 Special Feature

1.3 Construction & Contents

1.3.2 SDK Construction

1.4 API Architecture

1.5 Compile and Option Setup

Platform SDK http://www.microsoft.com/msdownload/platformsdk/sdkupdate/psdk-full.htm DirectX SDK (SUMMER 2004) http://www.microsoft.com/downloads/details.aspx?familyid=FD044A42-9912-42A39A9E-D857199F888E&displaylang=en

Please setup Platform SDK and DirectX SDK as below.

2. XQ Client API Functions

2.1.2 XQLive_ Uninitialization

bStatus = XQLive_Connect(&strConnectInfo); // Disconnect XQLive_Disconnect();

// HI speed setup nNetSpeed = 0; XQLive_SetNetSpeed(nNetSpeed);

for(int i=0; i<MAX_CAMERA_COUNT; i++) dwChannel |= (0x01<<i); XQLive_SetDisplayChannel(dwChannel);

pRecvMainCallBack (user can change)

pRecvLiveCallBack. (user can change)

// Initialization XQSearch_Initialization(); ... // Uninitialization XQSearch_Uninitialization();

Received images pointer value

XQSearch_SetEventSearch(&strSearchEvent); ... // Search by setup value XQSearch_GetEventSearch(bFlag);

2.4 Common Function

3. XQ Client API Structures

nGopid Received image Gopid information pVideoSource Received image information

pLiveParentWnd Pointer value of application which called CallBack function.

dwSection Set section information 7 V 6 D 5 R 4 3 2 HOUR 1 0

V(Vaild) : validity. When 0, ignore it D(DST) : Set DST section as 1

strSearchMinuteInfo SEARCH_MINUTEINFO Structure value

Channel information of searched item

3.4 Common Structures

5.1 XML Architecture

Setup Value and Its Scope

Root Element which includes all XML construction

5.2 XQ Setup Info Structure

Setup Values and Scope

DVRCFG version INFO

SYSTEM NETWORK DEVICE RECORD MISC

5.3 XQ CONFIG XML: INFO

Setup Values and Scope

Last Time Setup was Changed (Local time)

model version mac video videochannel audiochannel sensor

pro / lite / ultra 2.x.x xx:xx:xx:xx:xx:xx ntsc / pal 4, 8, 9, 16 4 4, 8, 16

alarm spot oem

5.3.1 XQ CONFIG XML: INFO/hwspec

Setup Values and Scope

CPU endian info

405ep 440ep str8133

Codec Chip Info

al260 mdin180 mdin200

VGA chip Info

USB Chip Info

tw2815 tw2864 lg1701

Video decoder Chip Info

RTC Chip Info

5.4 XQ CONFIG XML: SYSTEM

Setup values and Scope

sysinfo datetime ntp [holiday]

5.4.1 XQ CONFIG XML: SYSTEM/sysinfo

Setup Values and Scope

name uuid langid sysid

string, 31 string, 36 language id char, 0~99

5.4.2 XQ CONFIG XML: SYSTEM/datetime

User DST Info </userdst> </datetime>

Setup Values and Scope

zonekey dst [userdst]