xq client api_v1 3_20100615_eng (2)
TRANSCRIPT
![Page 1: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/1.jpg)
XQ Client API Reference Manual
Version 1.3
2010.06.15
T.O.M. Technology, Inc.
![Page 2: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/2.jpg)
2
Revision History
Version Date History
1.0 2009-02-11 XQClient API Guide
1.1 2010-05-31 MPEG-4 & H.264 Codec Support
1.2 2010-06-03 XML Data for DVR Setting
1.3 2010-06-15 XQLive_APIs support for NYX DVR (Only Live stream)
![Page 3: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/3.jpg)
3
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
![Page 4: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/4.jpg)
4
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
![Page 5: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/5.jpg)
5
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
![Page 6: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/6.jpg)
6
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
![Page 7: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/7.jpg)
7
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 API Construction
XQClient_ API
Major feature
� XQLive_ APIs: Communication Protocol API for Live Function
� XQSearch_ APIs: Communication Protocol API for Search
� XQSetup_ APIs: API for Setup Construction and XML
transmission
Others
� No DirectDraw related feature support in API
� No DirectSound related feature support in API
� Above two features provided as sample program
![Page 8: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/8.jpg)
8
1.3.2 SDK Construction Classification SDK Construction
XQClientAPI_Sample
� Bin Folder: DLL Modules for Release
� Bin_Debug Folder: DLL Modules for Debug
� Common Folder: Classes for Basic Function Use
� Define Folder: Macro Definition
� 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.
![Page 9: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/9.jpg)
9
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-42A3-
9A9E-D857199F888E&displaylang=en
Please setup “Platform SDK” and “DirectX SDK” as below.
![Page 10: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/10.jpg)
10
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
![Page 11: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/11.jpg)
11
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 strConnectInfo;
BOOL bStatus;
bStatus = XQLive_Connect(&strConnectInfo);
…
// Disconnect
XQLive_Disconnect();
![Page 12: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/12.jpg)
12
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
![Page 13: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/13.jpg)
13
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;
nSpeed = XQLive_GetNetSpeed();
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;
![Page 14: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/14.jpg)
14
// 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 nCamera;
BOOL bStatus;
// Set channel number 1
nCamera = 0;
bStatus = XQLive_GetPTZState(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
![Page 15: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/15.jpg)
15
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
![Page 16: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/16.jpg)
16
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 bFreezeFlag;
DWORD dwChannel;
bFreezeFlag = TRUE;
for(int i=0; i<MAX_CAMERA_COUNT; i++)
dwChannel |= (0x01 << i);
XQLive_SetFreeze(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
![Page 17: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/17.jpg)
17
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);
![Page 18: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/18.jpg)
18
Description
It’s 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 nAlarmCount;
BOOL bStatus;
// Call
nAlarmCount = 1;
bStatus = TRUE;
XQLive_SetAlarmControl(nAlarmCount, bStatus);
// End
nAlarmCount = 1;
bStatus = FALSE;
XQLive_SetAlarmControl(nAlarmCount, bStatus);
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)
![Page 19: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/19.jpg)
19
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:
{
![Page 20: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/20.jpg)
20
}
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
![Page 21: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/21.jpg)
21
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
![Page 22: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/22.jpg)
22
Example
XQDVR_ABOUT strConfig;
XQLive_GetStatus(&strConfig);
![Page 23: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/23.jpg)
23
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
![Page 24: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/24.jpg)
24
// 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 bStatus;
SEARCH_CONNECTINFO strConnectInfo;
bStatus = XQSearch_Connect(&strConnectInfo);
2.2.4 XQSearch_Disconnect
Prototype
void XQSearch_Disconnect();
Description
Disconnect DVR communication
Return Value
none
![Page 25: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/25.jpg)
25
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
![Page 26: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/26.jpg)
26
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* pSearchHour;
SEARCH_XQTM 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
![Page 27: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/27.jpg)
27
strDateTime
[in] set time search time information on XQTM Pointer Structure as yy/mm/dd.
Example
SEARCH_MINUTE* pSearchMinute;
SEARCH_XQTM 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* pRecvData;
SEARCH_SELECT 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
![Page 28: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/28.jpg)
28
Received image’s pointer value
Parameters
strSelectReq
[in] SEARCH_SELECT Pointer Structure
Example
BYTE* pRecvData;
SEARCH_VIDEO 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);
![Page 29: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/29.jpg)
29
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 bStatus;
// received
bStatus = TRUE;
XQSearch_GetEventSearch(bStatus);
// End Search
bStatus = FALSE;
XQSearch_GetEventSearch(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
![Page 30: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/30.jpg)
30
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 bStatus;
// run
bSatus = FALSE;
XQSearch_GetBackup(bStatus);
// end
bStatus = TURE;
XQSearch_GetBackup(bStatus);
2.2.15 XQSearch_ProcRecvMain
Prototype
void XQSearch_ProcRecvMain(void* pRecvCallBack, void* pThis);
Description
Define CallBack function and call applicable functions in library
![Page 31: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/31.jpg)
31
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
![Page 32: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/32.jpg)
32
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);
![Page 33: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/33.jpg)
33
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
![Page 34: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/34.jpg)
34
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;
szError = GetLastError();
3. XQ Client API Structures
3.1 XQ Live
3.1.1 LIVE_CONNECTINFO
Prototype
typedef struct {
char szAddress[MAX_ADDRESS_LENGTH];
DWORD dwPort;
char szUsername[MAX_ID_LENGTH];
![Page 35: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/35.jpg)
35
char szPassword[MAX_PW_LENGTH];
int 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
![Page 36: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/36.jpg)
36
typedef struct {
unsigned char btChannel;
unsigned char btResolution;
float btFrame;
unsigned char btQuality;
unsigned char 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 nHddCount;
LIVE_HDDINFO 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
![Page 37: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/37.jpg)
37
3.1.5 LIVE_HDDINFO
Prototype
typedef struct {
unsigned char btTemperature;
unsigned char btSMART;
unsigned int dwHDDTotal;
unsigned int dwHDDUse;
} LIVE_HDDINFO, *PLIVE_HDDINFO;
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 nChid;
int nWidth;
int nHeight;
int nFrameSize;
unsigned int nSec;
unsigned int nUsec;
unsigned int nGopid;
BYTE* pVideoSource;
![Page 38: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/38.jpg)
38
} 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 pLiveMainCallBack;
void* pLiveParentWnd;
} LIVE_MAINCALLBACK, *PLIVE_MAINCALLBACK;
Description
Redefind callback function which will receive control information
Members
pLiveMainCallBack
Function pointer value of application to be received
![Page 39: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/39.jpg)
39
pLiveParentWnd
Pointer value of application which called CallBack function.
3.1.8 LIVE_VIDEOCALLBACK
Prototype
typedef struct {
LiveRecvCallBack pLiveVideoCallBack;
void* 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 szAddress[SIZE_ADDRESS];
DWORD dwPort;
char szUsername[MAX_ID_LENGTH];
char szPassword[MAX_PW_LENGTH];
} SEARCH_CONNECTINFO, *PSEARCH_CONNECTINFO;
Description
Necessary item for DVR connection, it saves DVR information
Members
szAddress
![Page 40: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/40.jpg)
40
IP address
dwPort
DVR port number
szUsername
Valid ID (User name)
szPassword
Valid password
3.2.2 SEARCH_DATE
Prototype
typedef struct {
XQTM strFirstTm;
XQTM strLastTm;
unsigned short nDataCount;
SEARCH_DATEINFO strSearchDataInfo[MAX_RECORD_DAY];
} SEARCH_DATE, *PSEARCH_DATE;
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;
![Page 41: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/41.jpg)
41
} 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 nSectionCount;
SEARCH_HOURINFO strSearchHourInfo[MAX_SECTION_COUNT];
} SEARCH_HOUR, *PSEARCH_HOUR;
Description
Save time information.
Members
nSectionCount
number of Section
strSearchHourInfo
SEARCH_HOURINFO Structure value
3.2.5 SEARCH_HOURINFO
Prototype
typedef struct {
DWORD dwSection;
unsigned char nHours[25];
} SEARCH_HOURINFO, *PSEARCH_HOURINFO;
Description
Set time information
Members
![Page 42: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/42.jpg)
42
dwSection
Set section information
7 6 5 4 3 2 1 0
V D R HOUR
V(Vaild) : validity. When ‘0’, ignore it
D(DST) : Set DST section as ‘1’
R(Record) : Set 1, if saved time
HOUR : Hour information (0~23)
nHours
Hour information
3.2.6 SEARCH_MINUTE
Prototype
typedef struct {
unsigned short nSectionCount;
SEARCH_MINUTEINFO 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 dwSection;
unsigned short nChannel[MAX_CAMERA_COUNT][60];
} SEARCH_MINUTEINFO, *PSEARCH_MINUTEINFO;
![Page 43: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/43.jpg)
43
Description
Save minute information
Members
dwSection
Recorded section value
nChannel
minutes information
3.2.8 SEARCH_SELECT
Prototype
typedef struct{
unsigned int dwSection;
unsigned int dwChannel;
SEARCH_XQTM 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 btControl;
unsigned char btJumpCnt;
unsigned int dwChannel;
} SEARCH_SELECT, *PSEARCH_SELECT;
![Page 44: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/44.jpg)
44
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 dwSection;
SEARCH_XQTM stTm;
unsigned short nEventType;
unsigned short nEventSource;
} SEARCH_EVENTITEM, *PSEARCH_EVENTITEM;
Description
Save event item which searched by it’s condition
Members
dwSection
Section value of searched time
stTm
Time information of searched item
nEventType
Type information of searched item
Motion Sensor VideoLoss
0 1 2
nEventSource
![Page 45: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/45.jpg)
45
Channel information of searched item
3.2.11 SEARCH_EVENT
Prototype
typedef struct{
SEARCH_XQTM stStartTm;
SEARCH_XQTM stEndTm;
unsigned int dwMotion;
unsigned int dwSensor;
unsigned int dwVideoLoss;
unsigned int dwTextin;
unsigned int 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)
![Page 46: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/46.jpg)
46
3.2.12 SEARCH_MAINCALLBACK
Prototype
typedef struct {
SearchRecvCallBack pSearchMainCallBack;
void* 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 tm_year;
unsigned char tm_mon;
unsigned char tm_mday;
unsigned char tm_hour;
unsigned char tm_min;
unsigned char tm_sec;
unsigned char isdst;
} SEARCH_CONNECTINFO, *PSEARCH_CONNECTINFO;
Description
Save time information
Members
tm_Year
display year (1900)
tm_Mon
display month (0~11)
![Page 47: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/47.jpg)
47
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* pSetupData
Int nPos;
} SETUP_DATA, *PSETUP_DATA;
Description
Process Setup information
Members
pSetupData
Received or send Setup Data information
nPos
pSetupData size
![Page 48: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/48.jpg)
48
3.4 Common Structures
3.4.1 XQAPI_ABOUT
Prototype
typedef struct {
char szProjectName[SIZE_PROJECT];
char szVersion[SIZE_VERSION];
char szLastUpdate[SIZE_DATE];
char szNetVersion[SIZE_VERSION];
} XQAPI_ABOUT, *PXQAPI_ABOUT;
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 bAuthority
DWORD dwProdVersion;
DWORD dwFirmVersion;
} XQDVR_ABOUT, *PXQDVR_ABOUT;
Description
DVR(Set) version and authority information
![Page 49: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/49.jpg)
49
Members
bAuthority
DVR authority information
dwProdVersion
DVR model information
dwFirmVersion
DVR version information
![Page 50: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/50.jpg)
50
4. Macros
� #define MAX_ADDRESS_LENGTH 128
� #define MAX_ID_LENGTH 32
� #define MAX_PW_LENGTH 16
� #define MAX_CAMERA_COUNT 16
� #define MAX_HDD_COUNT 4
� #define MAX_ABOUT_LENGTH 128
� #define MAX_RECORD_DAY 1000
� #define MAX_SECTION_COUNT 256
� #define COMM_SYSTEM 0x11
� #define COMM_STATUS 0x12
� #define COMM_LIVE_VIDEO 0x15
� #define COMM_LIVE_AUDIO 0x16
� #define COMM_SEARCH_AUDIO 0x46
� #define COMM_SEARCH_EVENT 0x48
� #define COMM_BACKUP_ENABLE 0x53
� #define COMM_BACKUP 0x54
� #define PROD_XQ 0x58510000
� #define PROD_XQL 0x58510100
� #define PROD_XQP 0x58510200
� #define PROD_XQLS 0x58510101
� #define PROD_XQPS 0x58510201
![Page 51: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/51.jpg)
51
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 doesn’t 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 Setup Configration Information on SET
NETCFG Additional Setup Information for Client
Communication
![Page 52: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/52.jpg)
52
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>
![Page 53: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/53.jpg)
53
</DVRCFG>
NOD Setup Values and
Scope
Content
Config Info Container DVRCFG
version XML Format Version Info
INFO Basic Info
- Required when using the client
communication
SYSTEM System Info
NETWORK Network Info
DEVICE Device Info
RECORD Recording Info
MISC 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>
![Page 54: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/54.jpg)
54
<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 Setup Values and
Scope
Content
modified YYYY/MM/DD-
hh:mm:ss
Last Time Setup was Changed (Local time)
model pro / lite / ultra Model
version 2.x.x Main Application Version Info
mac xx:xx:xx:xx:xx:xx Network Mac Adress
video ntsc / pal Video Format
videochannel 4, 8, 9, 16 Maximum Input Channel
audiochannel 4 Maximum Audio Channel
sensor 4, 8, 16 Maximum Sensor Input
![Page 55: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/55.jpg)
55
alarm 1, 4 Maximum Alarm Output
spot 1, 2 Max. Spot Output
0, 1, 2, 3, 4, 5, 6, 7 OEM Classification
0 TOM
1 HISHARP
2 NORTHWOOD
3 ULTRA
4 HISHARP ITALY
5 HISHARP BRAZIL
6 TEST
7 RASION
oem
8 NETPROMAX
english
chiness-tr
chiness-sim
japanese
korean
french
polish
russian
spanish
danish
language
portuguese
Language
![Page 56: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/56.jpg)
56
italian
turkish
czech
videocodec H.264 / MPEG4 Video Codec Info
audiocodec G.723 Audio Codec Info
ata SATA / PATA ata info
hwspec 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 Setup Values and
Scope
Content
endian big, little CPU’ endian info
![Page 57: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/57.jpg)
57
405ep
440ep
cpu
str8133
CPU model
solo6010 codec
solo6110
Codec Chip Info
al260
mdin180
vga
mdin200
VGA chip Info
d720102 usb
vt6212
USB Chip Info
tw2815
tw2864
videodecoder
lg1701
Video decoder Chip Info
ds1337 Rtc
Fm3104
RTC Chip Info
5.4 XQ CONFIG XML: SYSTEM
<SYSTEM>
<sysinfo>
System Info …
</sysinfo>
<datetime>
Date/Time Info …
![Page 58: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/58.jpg)
58
</datetime>
<ntp>
NTP Info …
</ntp>
<holiday>
Holiday Info …
</holiday>
<account>
Account Info …
</account>
</SYSTEM>
NOD Setup values and
Scope
Content
sysinfo System Setup Info
datetime Time output method and TZ info
ntp NTP Info
[holiday] 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>
![Page 59: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/59.jpg)
59
<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 Setup Values and
Scope
Content
crash char, 0~1 Indication of Normal/Abnormal Shutdown
- 0 indication during booting means the
proper shutdown
name string, 31 Name Info
uuid string, 36 System uuid
langid language id Language ID
sysid char, 0~99 DVR ID
Can be used also by Remote
Controller’s 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>
![Page 60: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/60.jpg)
60
User DST Info …
</userdst>
</datetime>
MOD Setup Values and
Scope
Content
char, 0 ~ 2 Date Indication
0 YYYY MM DD
1 MM DD YYYY
dptype
2 DD MM YYYY
zonekey string, 63 zone key info
dst char, 0 ~ 1 zone key’s DST usage selection
[userdst] User Customized DST Info
USER DST can be deactivated
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
![Page 61: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/61.jpg)
61
string, 15
Month:Week:Day-
Time:Min:Sec
DST Start Info
Month 0~11
Week 0~6
Day 1~6
Time 0~23
Min 0~59
dststart
Sec 0~59
string, 15 DST Shutdown Info dstend
Month:Week:Day-
Hour: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>
![Page 62: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/62.jpg)
62
NOD Setup Values and
Scope
Content
en char, 0~1 NTP Usage
svr char, 0~1 NTP Server Management Usage
addr string, 127 NTP Server Address
pt ushort, 0~65536 Server Port
cycle uchar, 1~240 NTP Usage Cycle (hour)
lsync uint 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 Setup Value and
Scope
Content
date string, 10
Max. 32 supported
Holiday’s YYYY/MM/DD Info
5.4.6 XQ CONFIG XML: SYSTEM/account
<account>
![Page 63: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/63.jpg)
63
<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 char, 0~1 LOGIN usage
atlgo char, 0~1 Automatic Logout
atlgotm uchar, 1~180
(Unit : min.)
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>
![Page 64: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/64.jpg)
64
</usr>
<usr>
<id type=”string” size=”31”>liqueury</id>
<pw type=”string” size=”31”>1</pw>
<auth type=”uint”>0xffffffff</auth>
</usr>
…
</userlst>
NOD Setup Values and
Scope
Content
usr User ID/PW/Authorisation
usr/id string, 31 USER ID
usr/pw string, 31 User Password
uint User Authorisation
bit 0 REC (Panic Record)
bit 1 PLAY (no practical use)
bit 2 BACKUP
bit 3 PTZ Control
bit 4 HIDDEN Camera (no practical use)
bit 5 SETUP
bit 6 Camera Control (no practical use)
bit 7 FORMAT
usr/auth
bit 8 UPGRADE
![Page 65: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/65.jpg)
65
bit 9 SHUTDOWN
bit 10 LIVE Video Control (no practical use)
bit 11 SEARCH
bit 12 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>
![Page 66: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/66.jpg)
66
NOD Setup Values and
Scope
Content
ethernet Ethernet related info
- STATIC / DHCP / PPPoE
ddns Dynamic Domain Name Service Account
email E-mail Alarm
callback Events for the callback client information
[nas] 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>
<!-- <fwpt type=”ushort”>9013</fwpt> -->
<adslid type=”string” size=”31”>liqueury</adslid>
![Page 67: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/67.jpg)
67
<adslpw type=”string” size=15”>1234</adslpw>
</ethernet>
NOD Setup Values and
Scope
Content
en char, 1 ethernet usage (must be used)
nrclient char, 1~7 Specified number of Live Connections
char 0~2 Ethernet connection type
0 STATIC
1 DHCP
ethtype
2 PPPoE
ip string, 63 IP used at STATIC
nm string, 63 netmask at STATIC
gw string, 63 gateway IP used at STATIC
dns string, 63 DNS Server IP used at STATIC
rmpt ushort, 0~65535 Client Connection Port
httpt ushort, 0~65535 Webserver Connection Port
[fwpt] ushort, 0~65535 Connection port for firmware Update
(Not Available Yet)
adslid string, 31 ID for ADSL(PPPoE) connection
adslpw string, 15 PW for ADSL(PPPoE) connection
![Page 68: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/68.jpg)
68
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 Setup Values and
Scope
Content
en char, 0~1 DDNS Funtion
char, 0~1 DDNS Server Type
0 EZDDNS
svrtype
1 DynDNS
hostname string, 127 Registered DDNS Host Name
id string, 31 DDNS ID
pw string, 15 DDNS PW
routen char, 0~1 router usage
5.5.3 XQ CONFIG XML: NETWORK/email
<email>
<en type=”char”>1</en>
![Page 69: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/69.jpg)
69
<smtp>
SMTP Server Info …
</smtp>
<mailst>
Mail List …
</mailst>
</email>
NOD Setup Values and
Scope
Content
en char, 0~1 E-mail Notification Function
smtp SMTP Server Info
[mailst] 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
![Page 70: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/70.jpg)
70
Scope
svr string, 127 SMTP Server Address
sndr string, 31 Sending Person Name
lgien char, 0~1 SMTP Server login usage
id string, 127 SMTP Account ID
pw string, 15 SMTP Account PW
5.5.5 XQ CONFIG XML: NETWORK/email/milst
<mailst>
<mail type=”string” size=”63”>[email protected]</mail>
<mail type=”string” size=”63”>[email protected]</mail>
…
</mailst>
NOD Setup Values and
Scope
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>
![Page 71: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/71.jpg)
71
<rcvr type=”string” size=”127”>ezddns.com:9100</rcvr>
…
</callback>
NOD Setup Value and
Scope
Content
en char, 0~1 Callback Function Usage
rcvr string, 127
format=Address:Port
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 Setup Values and
Scope
Content
en char, 0~1 NAS Device Usage
char, 0~1 Backup Method md
0 Backing up all the files that failed Backup
![Page 72: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/72.jpg)
72
1 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 Setup Values and
Scope
Content
dev/ip string, 127 NAS’ IP Address
dev/fd string, 127 NAS Backup root Folder Location
[dev/id] string, 31 NAS’ ID
![Page 73: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/73.jpg)
73
[dev/pw] string, 15 NAS’ PW
[dev/opt] string, 127 NAS connectivity options
![Page 74: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/74.jpg)
74
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>
![Page 75: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/75.jpg)
75
<misc>
Additional Settings
</misc>
</DEVICE>
NOD Setup Values and
Scope
Description
camera Camera Info
alarm Alarm Setup
audio Audi Setup
osd Display Indication Setup
monitor Main Monitor Control
spot Spot out Setup
vga VGA Settings
misc 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>
![Page 76: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/76.jpg)
76
<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 Setup Values and
Scope
DEscription
Camera Info cam
rapid completion id,
0~15
Camera Channel Info
tt string, 31 Camera Name
hid char, 0~1 Camera Hidden Info
brt uchar, 0~255 Camera Brightness Info
hue uchar, 0~255 Camera Hue Info
cont uchar, 0~255 Camera Contrast Info
![Page 77: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/77.jpg)
77
sat uchar, 0~255 Camera Saturation Info
shp uchar, 0~255 Camera Sharpness Information
[aid] char, 0~3,(-1) 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 Setup Values and
Scope
Description
en char, 0~1 PTZ Use
protoid char, 0~127 PTZ Protocol ID number
� 2009.7.8 at present 0~43 supported
ptzid uchar, 0~255 PTZ Address (ID) Technology
spd char, 1~10 PTZ Operation Speed Level
![Page 78: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/78.jpg)
78
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 Setup Values and
Scope
Description
char, 0~18 Serial Port Baudrate Setting
0 BAUD0
1 BAUD50
2 BAUD75
3 BAUD110
4 BAUD134
5 BAUD150
6 BAUD200
7 BAUD300
8 BAUD600
baud
9 BAUD1200
![Page 79: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/79.jpg)
79
10 BAUD1800
11 BAUD2400
12 BAUD4800
13 BAUD9600
14 BAUD19200
15 BAUD38400
16 BAUD57600
17 BAUD115200
18 BAUD230400
char, 0~3 Size of the Serial Port Transmit Data
0 5 bit
1 6 bit
2 7 bit
data
3 8 bit
char, 0~1 Serial Port Stop Bit Size
0 1 bit
stop
1 2 bit
char, 0~2 Serial Port Parity Mode
0 NONE
1 EVEN
parity
2 ODD
![Page 80: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/80.jpg)
80
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 Setup Values and
Scope
Description
Alarm Info almo
rapid completion id,
0~3
Alarm Channel ID
almo/en char, 0~1 Alarm Use
almo/tt string, 31 Alarm Name
char, 0~1 Alarm Mode
0 Normal Open
almo/nc
1 Normal Close
![Page 81: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/81.jpg)
81
5.6.5 XQ CONFIG XML: DEVICE/audio
<audio>
<vol type=”char”>10<vol>
<mute type=”char”>0</mute>
</audio>
NOD Setup Values and
Scope
DEscription
<[vol]> char, 1~100 volume out
char, 0~1 mute status
0 Mute OFF
mute
1 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 Setup Values and
Scope
Description
![Page 82: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/82.jpg)
82
uint, bitfield OSD Display Technology
bit 0 Date
bit 1 Time
bit 2 Backup
bit 3 Cleint connection
bit 4 HDD usage
bit 5 Login user Info
bit 6 mute
bit 7 sequence
bit 8 zoom
bit 9 freeze
osdg
bit 10 page number
uint, bitfield Camera Info Indication
bit 0 Camera Number
bit 1 Camera Name
bit 2 Record Status Info
bit 3 Event Info
bit 4 Audio Conection Info
bit 5 PTZ Connection Info
bit 6 Video Loss Info
osdc
bit 7 Hidden Info
hspc short, 0~30 OSD Info Indication, Empty Spare of
horizontal end point.
![Page 83: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/83.jpg)
83
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>
![Page 84: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/84.jpg)
84
<lncam type=”uint>0x10</lncam>
<!—Future Use <split type=”char”>0</split> -->
</dev>
<dev id=”1”>
…
</dev>
…
<spot>
NOD Setup Values and
Scope
Description
SPOT Info Setup dev
rapid completion id,
0~1
SPOT Monitor Channel
char, 0~2 SPOT monitor Mode Setup
0 Fixed Channel
1 1 ch. sequence
2 Division Mode Sequence (future use)
dev/md
3 Event Popup (future use)
dev/fxcam char, 0~15 Fixed Channel mode output camera channel
dev/seqdw char, 1~30 Sequence Mode DWELL Time
dev/lncam uint, bitfield 1 Channel Sequence: Connected Cameras’
bitfield.
Event Popup: Connected Cameras’ bitfield.
![Page 85: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/85.jpg)
85
char, 0~2 All Channels Division Mode
0 4 division mode
1 9 division mode
<[dev/split]>
2 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 Setup Values and
Scope
Description
brt uchar, 0~255 VGA Brightness
hue uchar, 0~255 VGA Hue
cont uchar, 0~255 VGA Contrast
![Page 86: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/86.jpg)
86
sat uchar, 0~255 VGA Saturation
shp uchar, 0~255 VGA Sharpness
hres short VGA Horizontal Resolution
vres short VGA Vertical Resolution
<[td]> uchar, 0~255 3D Factor
<[di]> uchar, 0~255 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 Setup Values and
Scope
Description
keyctrl/en char, 0~1 Select to use Keyboard Controller
keyctrl/protoid char, 0~2 Keyboard Controller Protocol ID
![Page 87: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/87.jpg)
87
keyctrl/addr uchar, 0~255 DVR Address assigned from Keyboard
Controller
keyctrl/serial identical with ptz/serial
keytone char, 0~1 Select to use Keytone
![Page 88: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/88.jpg)
88
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 Setup Values and
Scope
Description
en char, 0~1 Recording Selection
panic char, 0~1 Emergency Recording Status
recycle char, 0~1 Overwrite Mode Support Selection
retention short, 0~365 Recorded Data Retention Date
camera Camera Setup Info Setup
![Page 89: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/89.jpg)
89
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>
![Page 90: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/90.jpg)
90
<fps type=”char”>10</fps>
</evt>
</cam>
NOD Setup Values and
Scope
Description
id char, 0~15 Channel
char, 0~3 Recording Resolution Setup
0 D1
1 HD1
2 CIF
fx/res
3 OFF
char, 0~4 Recording Mode
0 OFF
1 NORMAL
2 EVENT
3 ALL (N+M)
fx/md
4 SCHED
fx/sched/sun string, 24 Sunday Schedule Recording Setup
fx/sched/mon string, 24 MON
fx/sched/tue string, 24 TUE
fx/sched/wed string, 24 WED
fx/sched/thu string, 24 THU
fx/sched/fir string, 24 FRI
![Page 91: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/91.jpg)
91
fx/sched/sat string, 24 SAT
char, 0~4 Recording Resolution Setup
0 Highest
1 High
2 Middle
3 Low
nor/qty
evt/qty
4 Lowest
nor/fps
evt/fps
char, 0~10 FPS Setup
FPS differs according to NTSC / PAL
regardless of mode
![Page 92: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/92.jpg)
92
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 Setup Values and
Scope
Description
![Page 93: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/93.jpg)
93
motion Motion Setup Info
sensor Sensor Info Setup
vloss Video Loss Info Setup
diskfull Disc FULL Info Setup
diskerr Disc Error Info Setup
smart 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>
![Page 94: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/94.jpg)
94
</cam>
<cam id=”1”>
…
</cam>
…
</motion>
NOD Setting Value and
Scope
Description
Camera Motion Info cam
rapid completion id,
0~15
Camera Channel Info
cam/en char, 0~1 Motion Use Selection
cam/sens char, 1~5 Motion Sensitivity Setting
<[cam/keep]> char, 0~60 Motion Retention Time Setting
<[cam/dly]> char, 0~60 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>
![Page 95: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/95.jpg)
95
<lncam type=”uint”>0x9</lncam>
<prert type=”uchar”>5</prert>
<postrt type=”uchar”>10</postrt>
<!-- 향후 사용 <popath type=”char”>0<popath> --> <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>
![Page 96: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/96.jpg)
96
<cb type=”char”>1</cb>
<flag type=”uchar”>0x0</flag>
</act>
NOD Setup Values and
Scope
Description
lncam uint, bitfield Camera Channel Description (bit) related to
Action
uchar, 0~5 Pre-Recording (sec) related Action
0 No Use
prert
1~5 1~5 sec
postrt uchar, 5~60 Post Recording (sec) related Action
char, 0~1 Designated monitor popup related to Action
0 Main Monitor Application
<[popath]>
1 SPOT monitor Channel Application
popcam char, 0~15 POPUP applied Camera related to Action
char, 0~30 POPUP DWELL Application Time related to
Action
0 No Use
popdw
1~30 1~30 sec. applied
<[preset/pset]> uchar, 0~255 PTZ Reset No. of the Camera related to
Action
<[spot/pt]> char, 0~15 Camera Spot Out Setup related to Action
lnalmo uint, Bitfield Alarm Channel Settings according to Action
![Page 97: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/97.jpg)
97
char, 0~30 Alarm Retention Time related to Action
0 No Use
almdw
1~30 1~30 sec. applied
char, 0~30 Buzzer Retention Time related to Action
0 No Use
bzdw
1~30 1~30 sec. applied
email char, 0~1 Email Notification related to Action
cb char, 0~1 Callback Function related to Action
flag uchar, Bitfield Saving Log Info according to Action
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”>
![Page 98: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/98.jpg)
98
…
</sin>
…
</sensor>
NOD Setting Values and
Scope
Description
Sensor Input Info sin
Rapid completion id,
0~15
Sensor Channel Info
sin/en char, 0~1 Sensor Use
<[sin/keep]> char, 0~60 Sensor Input Retention Time
<[sin/dly]> char, 0~60 Latency time between Sensor Input and
ACTION performance
char, 0~1 Sensor Type
0 Normal Open
sin/nc
1 Normal Close
sin/tt string, 31 Sensor Name
sin/act identical with motion/act
5.8.4 XQ CONFIG XML: EVENT/vloss
<vloss>
<cam id=”0”>
![Page 99: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/99.jpg)
99
<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 Setting Values and
Scope
Description
Camera Video Loss Info cam
Rapid completion id,
0~15
Camera Channel Info
cam/en char, 0~1 Video Loss Use (always 1)
<[cam/keep]> char, 0~60 Video Loss Retention Time
<[cam/dly]> char, 0~60 Latency timebetween Temperature
Retention Time and ACTION performance
cam/act identical with motion/act
![Page 100: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/100.jpg)
100
5.8.5 XQ CONFIG XML: EVENT/diskfull
<diskfull>
<en type=”char”>1</en>
<sysact>
SYSTEM ACTION Description
</sysact>
</diskfull>
NOD Setting Values and
Scope
Description
en char, 0~1 Use Disc Full Event
sysact 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
![Page 101: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/101.jpg)
101
Scope
lnalmo uint, bitfield Alarm Channel setting related to Action
char, 0~30 Alarm Retention Time related to Action
0 NO USE
almdw
1~30 1~30 sec. applied
char, 0~30 Buzzer Retention Time related to Action
0 No Use
bzdw
1~30 1~30 sec. applied
email char, 0~1 Email Notification according to Action
cb char, 0~1 Callback function related to Action
flag uchar, bitfield 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 Setting Values and
Scope
Description
en char, 0~1 DISC ERROR EVENT USE
![Page 102: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/102.jpg)
102
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 Setting Values and
Scope
Description
en char, 0~1 SMART EVENT USE
<[sif/temp]> char, 0~100 HDD Temperature Limit for ACTION
performance.
<[sif/keep]> char, 0~60 Temperature Retention Time
<[sif/dly]> char, 0~60 Latency timebetween Temperature
![Page 103: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/103.jpg)
103
Retention Time and ACTION performance
sysact identical with diskfull/sysact
![Page 104: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/104.jpg)
104
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>
![Page 105: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/105.jpg)
105
-->
</MISC>
NOD Setting Values and
Scope
Description
lv/md char, 0~9 Layout Mode
0 1 division
1 4 division
2 1-5 division
3 3-4 division
4 1-7 division
5 9 division
6 2-8 division
7 1-12 division (1)
8 1-12 division (2)
9 16 division
lv/pg char, 0~15 Page number according to the division mode
lv/layout/lo string, 26 arrange channel numbers according to each
mode
<[pb]> identical with lv , use during playback
![Page 106: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/106.jpg)
106
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 Setting Values and
Scope
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>
![Page 107: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/107.jpg)
107
</ptzcam>
<ptzcam>
…
</ptzcam>
…
</PTZINFO>
NOD Setting Values and
Scope
Description
ptzcam/protoid short, 0~43 PTZ Cmara protocol id
ushort, bitfield Support Functions (bitfield)
bit 0 PAN
bit 1 TILT
bit 2 FOCUS
bit 3 ZOOM
bit 4 IRIS
bit 5 PRESET
ptzcam/cap
bit 6 MENU
ptzcam/name string, 63 PTZ Protocol Name
5.10.3 XQ CLIENT XML: NETMASK
<NETMASK>0x1fff</NETMASK>
![Page 108: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/108.jpg)
108
NOD Setting Value and
Scope
Description
NETMASK uint, bitfield changed config id
bit 0 XQ_CONFIG_SYS_INFO
bit 1 XQ_CONFIG_SYS_DATETIME
bit 2 XQ_CONFIG_SYS_ACCOUNT
bit 3 XQ_CONFIG_NET_ETHER
bit 4 XQ_CONFIG_NET_MODEM
bit 5 XQ_CONFIG_NET_DDNS
bit 6 XQ_CONFIG_NET_EMAL
bit 7 XQ_CONFIG_NET_CALLBACK
bit 8 XQ_CONFIG_DEV_CAMERA
bit 9 XQ_CONFIG_DEV_ALARM
bit 10 XQ_CONFIG_DEV_AUDIO
bit 11 XQ_CONFIG_DEV_DISPLAY
bit 12 XQ_CONFIG_DEV_MONITOR
bit 13 XQ_CONFIG_DEV_SPOT
bit 14 XQ_CONFIG_DEV_VGA
bit 15 XQ_CONFIG_DEV_MISC
bit 16 XQ_CONFIG_REC_POLICY,
bit 17 XQ_CONFIG_REC_ALL,
bit 18 XQ_CONFIG_EVT_MOTION
bit 19 XQ_CONFIG_EVT_SENSOR
![Page 109: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/109.jpg)
109
bit 20 XQ_CONFIG_EVT_VLOSS
bit 21 XQ_CONFIG_EVT_TEXTIN
bit 22 XQ_CONFIG_EVT_SYSTEM
bit 23 XQ_CONFIG_MISC
bit 24 XQ_CONFIG_NAS
5.11 Abbreviations of NODE Name
Abbr. Origin Abrr. Origin
aa area lgi login
act action lgo logout
addr address ln link
aid audio id lnalmo link alarm out
almo alarm out lo location
alrate alpha rate lst list
at auto lsync lastsync
atype alarm type lv live
brt bright md mode
bz buzzer nm netmask
cam camera nor normal
cb callback nr number
cfg config osdc osd camera
cont contrast osdg osd grobal
ctrl control pb playback
![Page 110: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/110.jpg)
110
di de-interlace pg page
dly delay pop popup
dp display pt port
dw dwell qty quility
en enable rcvr receiver
eth Ethernet res resolution
evt event rm remote
fd folder rt rec time
fps frame per sec sat saturation
fw firmware sched schedule
fx fix sens sensitivity
gw gateway seq sequence
hid hidden shp sharp
hres horizontal resolution sin sensor in
hspc horizontal space spt spot port
if information sndr sender
lg log spd speed
stype sensor type
svr server
td 3D(three dimensional)
temp temperature
tm time
tt title
![Page 111: XQ Client API_v1 3_20100615_ENG (2)](https://reader034.vdocuments.net/reader034/viewer/2022050920/552bf1334a7959097d8b45e1/html5/thumbnails/111.jpg)
111
usr user
vol volume
vres vertical resolution
vspc vertical space