Encoder CGI Program

 

 


In general, only root could set the configuration through URLs in this CGI. If the logon user is not root, all write commands will be treated as read commands.
In DIO_STATUS, DIO_OUTOUT, SERIAL_ASCII and SERIAL_HEX are specifical command which they could be excutable by user level accounts.
The CGI is only available in the Encoder Devices. The URL in this CGI will be forwarded to the specific channel in the multiple channel encoders if there is a CHANNEL commmand.

NOTE:

This CGI is new CGI for replacing mpeg4 CGI.

Quick Link

URLs in ENCODER CGI, Camera Setup URLs, Day/Night Control URLs, Night Time Profile URLs, PTZ URLs, Motion URLs, Event Handler URLs

List of URLs

URL Attribute (R/W, On-Fly) 1
PlatformW PlatformA PlatformT PlatformK PlatformA1 Multiple Channel Encoder 2
Encoder Encoder Encoder Camera Camera Video Server
URLs are the same as them in mpeg4 CGI
VIDEO_STATUS RO,X RO,X RO,X RO,X RO,X RO,X
DIO_OUTPUT WO,V WO,V WO,V WO,V WO,V WO,V
VIDEO_CAMERA_NAME RW,V RW,V RW,V RW,V RW,V RW,V3
VIDEO_BRIGHTNESS RW,V RW,V RW,V RW,V RW,V RW,V3
VIDEO_CONTRAST RW,V RW,V RW,V RW,V RW,V RW,V3
VIDEO_SATURATION RW,V RW,V RW,V RW,V RW,V RW,V3
VIDEO_HUE RW,V RW,V RW,V RW,V None RW,V3
DIO_STATUS RO,X RO,X RO,X RO,X RO,X RO,X
MOTION_STATUS RO,X RO,X RO,X RO,X None RO,X
MOTION_SETTING WO,V WO,V WO,V WO,V None WO,V3
SERIAL_SETTING RW,V RW,V RW,V RW,V None RW,V3
SERIAL_ASCII WO,V WO,V WO,V WO,V None WO,V3
SERIAL_HEX WO,V WO,V WO,V WO,V WO,V WO,V3
RTP_MULTICAST_STREAMING WO,V WO,V WO,V WO,V WO,V WO,V3
VIDEO_RESOLUTION RW,V RW,V RW,V RW,V RW,V RW,V
VIDEO_BITRATE RW,V RW,V RW,V RW,V RW,V RW,V
VIDEO_FPS RW,V RW,V RO,X RO,X None RW,V
VIDEO_VARIABLE_FPS WO,V WO,V None None None WO,V
VIDEO_FPS_NUM RW,V RW,V RW,V RW,V RW,V RW,V
MOTION_ENABLED RW,V RW,V RW,V RW,V None RW,V
MOTION_SENSITIVE WO,V WO,V WO,V WO,V None WO,V3
URLs only avaliable in encoder CGI
V2_VIDEO_RESOLUTION None RW,V RW,V RW,V RW,V RW,V
VIDEO_ENCODER RW,X RW,V RW,V RW,V RW,V RW,V
VIDEO_STREAM RW,X RW,V RW,V RW,V RW,V RW,V
VARIABLE_FPS_NUM RW,V RW,V None None None RW,V
FPS_CAP_QUERY_ALL RO,X RO,X RO,X RO,X RO,X RO,X
SNAPSHOT None RW,V RW,V RW,V RW,V RW,V3
SEND_AUDIO None RO,X RO,X RO,X RO,X None
OSD_FORMAT None WO,V WO,V WO,V WO,V WO,V
QUAD_OSD None None WO,V7 None None None
OSD_ENABLED None RW,V5 None None None None
PRIVACY_REGION None RW,V RW,V RW,V RW,V RW,V
OSG_CONFIG None None None None RW,V None
OSG_IMAGE None None None None WO,V None
VIDEO_MJPEG_QUALITY None RW,V RW,V RW,V RW,V RW,V
VIDEO_MPEG4_QUALITY None RW,V RW,V RW,V None RW,V
VIDEO_H264_QUALITY None None RW,V RW,V RW,V None
VIDEO_MAX_BITRATE None RW,V RW,V RW,V RW,V RW,V
QUAD_SEQUENCE_TIME None RW,V5 None None None None
VIDEO_GOP None RW,V RW,V RW,V RW,V RW,V3
VGA_ASPECT_RATIO None None None None RW,V None
GET_STREAM None WO,V WO,V WO,V WO,V WO,V8
GET_CTRL_MSG XX,X WO,V WO,V WO,V WO,V WO,V3
GET_DI_STATE RO,X RO,X RO,X RO,X RO,X RO,X3
SET_DO WO,X WO,X WO,X WO,X WO,V WO,X3
FISHEYE_INSTALL None None None RW,V None None
FISHEYE_CEILING_ANGLE None None None RW,V None None
FISHEYE_ROTATE None None None RW,V None None
DUMMY WO,X WO,X WO,X WO,X WO,X WO,X
URLs for Camera Setup
VIDEO_WB_MODE None RW,V4 RW,V4 RW,V RW,V None
VIDEO_WB_GAIN None RW,V4 RW,V4 RW,V RW,V None
VIDEO_EXPOSURE_MODE None RW,V4 RW,V4 RW,V RW,V None
EXPOSURE_GAIN_GET None RO,X4 RO,X4 RO,X None None
VIDEO_EXPOSURE_GAIN None RW,V4 RW,V4 RW,V RW,V None
VIDEO_SHUTTER_MODE None RW,V4 RW,V4 RW,V None None
VIDEO_SHUTTER_SPEED None RW,V4 RW,V4 RW,V RW,V None
VIDEO_MAX_SHUTTER None RW,V4 RW,V4 RW,V RW,V None
MAX_AUTO_SHUTTER None RW,V4 RW,V4 RW,V None None
VIDEO_SLOW_SHUTTER None None RW,V4 None None None
SHUTTER_CAP None None None None RO,X None
VIDEO_FLICKLESS None RW,V4 RW,V4 RW,V RW,V None
LINE_FREQ None RW,V4 RW,V RW,V RW,V None
VIDEO_AGC_GAIN None RW,V4 RW,V4 RW,V RW,V None
VIDEO_IRIS None RW,V4 RW,V4 RW,V4 None4 None
IRIS_NUMBER None None None None RW,V4 None
EXPOSURE_MODE_CAP None None4 None4 None4 RO,X None
IRIS_CAP None None4 None4 None4 RO,X None
VIDEO_IRIS_MODE None RW,V4 RW,V4 RW,V4 None None
PIRIS_OPTION None None None RW,V4 None None
VIDEO_DC_LEVEL None RW,V4 RW,V4 RW,V4 None4 None
VIDEO_BLC_MODE None RW,V4 RW,V4 None None None
VIDEO_SENSEUP_LEVEL None RW,V4 None None None None
VIDEO_MIRROR_MODE None RW,V4 RW,V4 RW,V4 RW,V None
VIDEO_FLIP_MODE None RW,V4 RW,V4 RW,V4 RW,V None
VIDEO_DEINTERLACE None None RW,V6 None None None
VIDEO_DNR None None RW,V6 RW,V4 RW,V4 None
VIDEO_3DNR None None RW,V6 RW,V4 RW,V4 None
VIDEO_DEFOG None None None RW,V4 RW,V4 None
VIDEO_BLACKLEVEL None None RW,V6 None None None
VIDEO_SKINTONE None None RW,V6 None None None
VIDEO_WDR None None RW,V6 RW,V4 RW,V4 None
V2_SHARPNESS None None RW,V6 None None None
LENS_COMPENSATION None RW,V4 RW,V4 None None None
VIDEO_SHARPNESS None RW,V4 RW,V4 RW,V4 RW,V4 None
IMAGE_QUALITY_RESET None None None RO,X RO,X None
IMAGE_CAP None None None None RO,X None
URLs for Day/Night Control
VIDEO_DAYNIGHT_MODE None RW,V4 RW,V4 RW,V RW,V None
DAY_NIGHT_STATE RO,X RO,X4 RO,X4 RO,X RO,X RO,X
DAY_GAIN_THD None RW,V4 RW,V4 RW,V RW,V None
NIGHT_GAIN_THD None RW,V4 RW,V4 RW,V None None
VIDEO_DN_IRLED None RW,V4 RW,V4 None None None
VIDEO_DN_IRCUT None RW,V4 RW,V4 None None None
VIDEO_DN_TIMER None RW,V4 RW,V4 None None None
VIDEO_DN_TYPE None RW,V4 RW,V4 RW,V None None
URLs for Night Time Profile
NIGHT_MPEG4_QUALITY None None RW,V9 None None None
NIGHT_H264_QUALITY None None RW,V9 None None None
NIGHT_MJPEG_QUALITY None None RW,V9 None None None
NIGHT_BITRATE None None RW,V9 None None None
NIGHT_MAX_BITRATE None None RW,V9 None None None
NIGHT_GOP None None RW,V9 None None None
NIGHT_FPS_NUM None None RW,V9 None None None
NIGHT_WB_MODE None None RW,V9 None None None
NIGHT_WB_GAIN None None RW,V9 None None None
NIGHT_EXPOSURE_MODE None None RW,V9 None None None
NIGHT_EXPOSURE_GAIN None None RW,V9 None None None
NIGHT_AGC_GAIN None None RW,V9 None None None
NIGHT_SHUTTER_MODE None None RW,V9 None None None
NIGHT_SHUTTER_SPEED None None RW,V9 None None None
NIGHT_MAX_SHUTTER None None RW,V9 None None None
NIGHT_IRIS None None RW,V9 None None None
NIGHT_IRIS_MODE None None RW,V9 None None None
NIGHT_DC_LEVEL None None RW,V9 None None None
NIGHT_SHARPNESS None None RW,V9 None None None
NIGHT_BRIGHTNESS None None RW,V9 None None None
NIGHT_CONTRAST None None RW,V9 None None None
NIGHT_SATURATION None None RW,V9 None None None
URLs for PTZ Control
CAMERA_PRESET None RO,V4 RO,V4 RO,V4 RO,V4 None
ADDR RW,V4 RW,V4 RW,X4 RW,V4 RW,V4 None
PTZ_VENDOR RW,V4 RW,V4 RW,X4 RW,V4 RW,V4 None
ZOOM WO,V4 WO,V4 WO,V4 WO,V4 WO,V4 None
ZOOM_POSITION None RO,X4 RO,X4 RO,X4 RO,X4 None
STEPPED_ZOOM None None None WO,V4 WO,V4 None
ZOOM_CAP_GET None None RO,X4 RO,X4 RO,X4 None
DIGITAL_ZOOM None None None RO,X4 None None
FOCUS None WO,V4 RW,V4 RW,V4 RW,V4 None
FOCUS_POSITION None RO,X4 None RO,X4 RO,X4 None
STEPPED_FOCUS None None None WO,V4 WO,V4 None
FOCUS_CAP_GET None None None RO,X4 RO,X4 None
MOVE WO,V4 WO,V4 WO,V4 WO,V4 WO,V4 None
MOVE_LIMIT None WO,V4 None WO,V4 WO,V4 None
MOVE_LIMIT_GET None RO,X4 RO,X4 RO,X4 RO,X4 None
MOVE_MAX_SPEED_GET RO,X4 RO,X4 RO,X4 RO,X4 RO,X4 None
POSITION WO,V4 WO,V4 WO,V4 WO,V4 WO,V4 None
POSITION_GET RO,X4 RO,X4 RO,X4 RO,X4 RO,X4 None
HOME_POS None None None RW,V4 RW,V4 None
XYZ_POS_GET RO,X4 RO,X4 RO,X4 RO,X4 RO,X4 None
PTZ_PRESET_SET WO,V4 WO,V4 WO,V4 WO,V4 WO,V4 None
PTZ_PRESET_GET RO,X4 RO,X4 RO,X4 RO,X4 RO,X4 None
PTZ_PRESET_GO WO,V4 WO,V4 WO,V4 WO,V4 WO,V4 None
ZOOM_PRESET_SET None None None WO,V4 WO,V4 None
ZOOM_PRESET_GET None None None WO,V4 WO,V4 None
ZOOM_PRESET_GO None None None WO,V4 WO,V4 None
PTZ_TOUR_SET None WO,V4 WO,V4 WO,V4 WO,V4 None
PTZ_TOUR_GET None RO,X4 RO,X4 RO,X4 RO,X4 None
PTZ_TOUR_SCAN None RO,X4 RO,X4 None None None
PTZ_TOUR_STATE RW,V4 RW,V4 RW,V4 RW,V4 RW,V4 None
PTZ_TOUR_NAME None RW,V4 RW,V4 RW,V4 RW,V4 None
PTZ_PARK_CONFIG None RW,V4 None None None None
PTZ_AUTO_SPEED None None RW,V4 RW,V4 None None
PTZ_AUTO_FLIP None None None RW,V4 None None
URLs for Motion Detection
MOTION_CONFIG RW,V RW,V RW,V RW,V RW,V RW,V
MOTION_CONFIG_GET RO,X RO,X RO,X RO,X RO,X RO,X
MOTION_TIMER WO,V WO,V WO,V WO,V None WO,V3
MOTION_OBJ None WO,V WO,V WO,V None WO,V3
PIR_MD_CONFIG None RW,V RW,V None None None
MD_PRESET_CONFIG None None None RW,V4 None None
URLs for Event Handler
HTTP_SERVER None RW,V RW,V RW,V RW,V RW,V
HTTP_PROXY None None None None None None
SMTP_SERVER None RW,V RW,V RW,V RW,V RW,V
FTP_SERVER None RW,V RW,V RW,V RW,V RW,V
EVENT_RSPDO None RW,V RW,V RW,V RW,V RW,V
EVENT_RSPMSGn None RW,V RW,V RW,V RW,V RW,V
EVENT_RSPIMGn None RW,V RW,V RW,V RW,V RW,V
EVENT_RSPGO None RW,V4 RW,V4 None None None
EVENT_TEST None RO,X RO,X RO,X RO,X RO,X
EVENT_CONFIG None RW,V RW,V RW,V RW,V RW,V
EVENT_MANUAL None RW,V RW,V RW,V RW,V RW,V
EVENT_PUSH None RO,X RO,X RO,X RO,X RO,X
EVENT_DIn None RW,V RW,V RW,V RW,V RW,V
EVENT_RSPCMDn None RW,V RW,V RW,V RW,V RW,V
EVENT_RSPMDn None RW,V RW,V RW,V RW,V RW,V
EVENT_RSPMDPIR None RW,V RW,V None None None

Back to

HOME

Foot Note

1 The first part is for Access Mode. It could be RW (Readable and Writeable), RO (Read Only), WO (Write Only) or None (Not Support)
The second part is for On-Fly indication. if the change of URL is effective immediately without save and reboot, It could be V (the URL is on-fly). Otherwise, it is X (the URL is not on-fly).
2 Only be available of 4CH, 8CH and 16CH Video Server with EPL channel modules
3 Return the CHANNEL 1 video server's configuration. If the CHANNEL 1 video server does not connect to router, the error message will be returned
4 Need to check device's specification to know its access attributes. It is helpful to check the Camera Setup Design Specification.
5 Only be available of PlatformA QUAD Video Encoder.
6 Only be available of some encoder which has the specific image processor like VX1129
7 Only for PlatformT QUAD Video Encoder
8 Need to use channel's virtual HTTP port
9 Only take effective when the camera is in the night time mode