CamMonitor.ocx methods

Connect

Connect(BSTR ip, BSTR login, BSTR password, BSTR arch_password, long param, long port) sets a connection to the server/video gate/backup archive.

• BSTR ip—IP address of the server.
• BSTR login—login to connect to the server (can be blank).
• BSTR password—password to set up a connection to the server (can be blank).

• BSTR arch_password—password to access the archive (that is, admin password, can be blank).

• long param—server role. The parameter is mandatory.
  
  • 0—video server.
  • 1—online archive.

  • 2—video gate.

• long port—port to connect to server. 
  

  • if 0, 1, or 2 are passed, the connection is established with the port 900, 901, or 902, correspondingly.

  • if 100 is passed, the connection is to the port 10504.

  • if any other value is passed, the connection is with the port number "port + 20000". For example, if port=900, the connection is established with server port 20900.

The connection to the server is set up asynchronously.

ShowCam

ShowCam(long cam_id, long compress, long show) shows/hides the camera on the monitor.

• long cam_id—camera ID.
• long compress—level of video compression 0-5 (for local camera =0). If set to -1, video stream is displayed directly from the camera without compression
• long show—checkbox: show/hide camera (1/0)

DoReactMonitor

DoReactMonitor(BSTR react_string)—control monitor/camera behavior.

• BSTR react_string—reaction string view

How to create react_string:

react_string = "MONITOR||ARCH_FRAME_TIME|cam<3>,date<dd-mm-yy>,time<hh:mm:ss>";

CamMonitor1->DoReactMonitor(react_string);

The result of calling the function with this parameter: camera 3 is switched to the archive mode, and the archive is positioned to date "dd-mm-yy" and time "hh:mm:ss" (date and time must be set in this format only).

The mode parameter can take the following values:

0—video gate if it's specified (otherwise, video server).

1—video server.

2—backup archive.

“MONITOR|<id ignored>|ARCH_FRAME_TIME|...”

Example. Show the second stream from camera 14 on monitor 1:

"MONITOR|1|ADD_CAM|cam<14>,cam_id<14>,compress<1>,stream_id<14.2>"

Exapmle. Set FPS = 1 when viewing archive from camera 11:

"MONITOR||CAM_PARAMS|cam<11>;arch_fps<1>"

Example. Get the coordinates of the fisheye camera 1 in the monitor (Monitor 1):

"MONITOR|1|GET_CAM_PARAMS|cam<1>"

RemoveAllCams

RemoveAllCams() : long—remove all cameras from the monitor.

IsConnected

IsConnected() : boolean—method shows if the video server is connected or disconnected.

GetCurIp

GetCurIp() : BSTR—returns the IP address of the server specified when calling Connect.

SendRawMessage

SendRawMessage(BSTR msg)—send the command to be executed to video server.

• BSTR msg—command string view.

How to call a function:

m_Cam.SendRawMessage("CAM|1|REC");

m_Cam.SendRawMessage("CAM|1|REC_STOP");

m_Cam.SendRawMessage("CAM|1|ARM");

m_Cam.SendRawMessage("CAM|1|DISARM");

Disconnect

Disconnect()—disconnect from the video server. 

SetCallBackOptions

SetCallBackOptions(int cam_id, int options)—sets parameters to get video from camera.

• int cam_id—camera ID (number).
• int options—options. The possible values of the options parameter are:
• WithoutVideoFrame = 0x00—do not send frames from the video module.
• WithVideoFrame = 0x01—send frames from the video module.
• WithExtendedParams = 0x02—get frames with extended parameters (time, FPS, captions).
• WithInformationLayout = 0x04—display video in the window with control elements (context menu).
• WithCompressedData = 0x08—display video in the original format without decompression (if any).
• WithoutDecode = 0x10—disable video decoding on the server.
• WithoutSubtitles=0x20—disable subtitles.

SetParam

SetParam(BSTR param_name, BSTR param_value)—sets the number of camera windows in CamMonitor.

• BSTR param_name—a string representation of the length or width.
• BSTR param_value—the number of camera windows.

How to call a function:

m_cam.SetParam("monitor_ch", m_NH);
m_cam.SetParam("monitor_cw", m_NW);