SDK Manual
SDK Manual
Version:2.24
Properties List
1 ShowTitle
Show the title of the video window or not
2 ShowStatus
Show the status of the video window or not
3 ShowToolBar
Show the toolbar of the video window or not
4 ShowOSDName
Show the device name in the video display area or not
5 ShowOSDTime
Show current time in the video display area or not
6 ShowFPS
Show frame rate on the status bar of the video window or not
7 ShowRate
Show the internet speed on the status bar of the video window or not
8 Lan
Language used in ActiveX file
Current support languages
Simple Chinese
English
Traditional Chinese
9 Ver
Current Version of the ActiveX file
Read only Property
10
DevState
The status of current ipcam
Returned
value
Presenting status
-1
No camera added
No work
Camera disconnected
Camera connected
23
VideoRecv
Whether receiving video and audio data.
If set it to false, the activeX also connect the ip camera and receive the alarm notification.
This property is valiable for F series and the TCP mode must be set 1.
24
PTZProtocol
The PTZ decoder protocol. 0 is for no PTZ. 1 is for Pelco-D, 2 is for Pelco-P
*it is valid after AddDev.
25
VideoRate
Set the max video rate.
*it is valid after AddDev and before ConnectAll.
Method List
1 AddDev4
Add IP camera
Parameters Instruction:
Parameter
Type
Instructions
nDevType
whole
bLan
whole
szID
nTCPPort
Whole
Reverseset to 0
szDevName
Alphabetic
string
szAcc
Alphabetic
string
Authorized account
szPwd
Alphabetic
string
Authorized password
nChannelID
whole
Returned value is 0
Types of IP cameras
Types of IP cameras
Definetion
Without appointing
F series
902
Q series
906
V(H3) series
912
H series
918
T,C Series
924
PnP Series
922
2 ConnectAll
Connect the IP cameras
No parameter
No returned value
3 DisConnectAll
Disconnect the IP cameras
No parameter
No returned value
4 DevSet
Display IP camera setting page
No parameter
Returned value
returned
value
Status
-1
-2
5 NetSet
Display network setting page
No parameter
returned value
returned
value
Status
-1
-2
6 ClearDevs
Clean IP camera settings
No parameters
No returned value
7 StartRec
Start recording
Parameter Instruction:
Parameter
Type
Instruction
szFileName
Alphabetic
string
Returned value
Returned
value
Status
-1
-2
normal
8 StopRec
Stop recording
No parameter
Returned value:
Returned
value
Status
-1
Normal
9 Capture
Capture current pictures
Parameter instruction:
Parameter
Type
Instruction
szFileName
Alphabetic
string
Returned value
Returned
value
Status
-1
-2
No picture captured
-3
Normal
10
CaptureTool
Display the capture tool of the plug in
No parameter
Returned value:
Returned
value
Status
-1
Normal
11FullScreen
Display the video window in full screen
No parameter
No returned value
12
PTZ
Pan/Title control
Parameter:
Parameter
Type
Instruction
nPro
int
nAddr
int
nDir
int
nSpeed
int
Speed,1~255
nParam
int
bWithStop
int
No returned value
PTZ actions:
nDir value
-1
0
1
2
3
4
13
5
6
7
8
9
10
14 11
12
13
14
15
16
15 17
18
19
20
action
Stop
Up
Left
Right
Down
Focus+
FocusZoomZoom+
Autoscan on
Autoscan off
ApertureAperture+
Light off
Light on
Goto preset position nParam
Set preset position n
Delete preset position n
Up-left
Down-right
Up-right
Down-left
StartTalk
Start talking
No parameter
No returned value
StopTalk
Stop talking.
No parameter
No returned value
SDPlay
Show the window to play the SD
file
Parameter
Parameter
Type
Instruction
nDevType
Int
szDevName
string
szUrl
string
szAcc
string
szPwd
string
Types of IP cameras:
Types of IP cameras
value
H Series
918
T PnP Series
925
Events:
1 OnAlarm
Called on IP camera alarming.
Parameter:
Parameter
Type
Instruction
bStart
Integer
1 0
Note: It is valid when the F serials is connected with IP address and SN, the E,M serials is
connected with SN.
2 OnVideoConnected
Called when the IP camera is connected.
Parameter:
Parameter
Type
Instruction
BmpInfo
Integer
AudioFmt
Integer
3 OnVideoDisconnect
Called when the IP camera is disconnected.
No parameters.
4 OnVideoSample
Called on receiving a video or audio frame data.
Parameter:
Parameter
Type
Instruction
nFrameID
Integer
IsVideo
Integer
pData
Pointer
nDataLen
Integer
Type
Instruction
nFrameID
Integer
bDecode
Integer
Integer
pData
Pointer
nDataLen
Integer
Instruction
ipcamax.ocx
AudioCodec.dll
Audio process
AviWriter.dll
Record process
Com1024.dll
ddisp.dll
Related to display
ipcamax.lb5
Traditional Chinese
ipcamax.lcn
Simple Chinese
ipcamax.len
English
ijl15.dll
LPng.dll
oemopt.dat
Configuration file
Option.ini
Configuration file
vcore.dll
Related to video
vvfw.dll
Related to video
ZPlayer.exe
ZPlayer.lb5,
ZPlayer.lcn,
ZPlayer.len