Avonic CM7 IP Series User manual

HTTP API for CM7x-IP series
CM70-IP/CM71-IP/CM73-IP
www.avonic.com | User Manual | Version 1.1

Disclaimer, Contact and liability
Disclaimer
All text, graphics, photographs, trademarks, logos, artwork and computer code (collectively, “Content”),
including but not limited to the design, structure, selection, coordination, expression, “look and feel” and
arrangement of such Content, contained in this Manual is owned, controlled or licensed by or to Avonic, and is
protected by trade dress, copyright, patent and trademark laws, and various other intellectual property rights
and unfair competition laws.
Except as expressly provided in these Terms of Use, no Content of this Manual may be copied, reproduced,
republished, uploaded, posted, publicly displayed, encoded, translated, transmitted or distributed in any way
(including “mirroring”) to any other computer, server, Web site or other medium for publication or distribution
or for any commercial enterprise, without the prior written consent of Avonic.
Copyright © 2022 AVONIC All Rights Reserved.
The information contained in this Manual is subject to change without notice.
Contact Info
For any questions or suggestions, contact your reseller or local distributor of Avonic.
Visit the Avonic website www.avonic.com to find your local Avonic distributor or to download the most recent
version of the documentation.
Join Avonic on Social Media
www.Facebook.com/
avonicPTZ
www.LinkedIn.com/company/
avonic
www.twitter.com/
avonic
Liability
Avonic will NOT be held responsible for any damage or injury caused by unqualified persons carrying out these
tasks, or by not following the instructions in this Manual.
Symbols Used in This Manual
Symbol Meaning Description
Danger Not following the instructions associated with this symbol may lead to personal
injury and / or serious damage to the Product.
Electrical Shock Not following the instructions associated with this symbol may lead to life-
threatening situations and / or serious damage to the Product.
Important The information associated with this symbol requires special attention.
Information The information associated with symbol refers to a general remark or a
reference to other documentation.
Instruction This symbol refers to one or more user instructions.
Recycling Specific parts of the Product can be re-used.
User Manual | www.avonic.com ii

Contents
Disclaimer, Contact and liability.................................................................................................ii
Symbols Used in This Manual.......................................................................................... ii
Introduction............................................................................................................................. 4
Purpose of This Manual.................................................................................................. 4
Target Audience..............................................................................................................4
Document Structure........................................................................................................ 4
Appendix C - HTTP API............................................................................................................5
How to use HTTP API.....................................................................................................5
Curl....................................................................................................................... 6
{"GetEnv"}............................................................................................................ 7
HTTP API code list..........................................................................................................8
IR Remote Control.................................................................................................8
PTZ....................................................................................................................... 8
Audio...................................................................................................................10
Video...................................................................................................................11
Network...............................................................................................................19
System................................................................................................................ 20
User Manual | www.avonic.com iii

Introduction
Purpose of This Manual
This Manual describes the instructions and programming codes of the HTTP API functionality of the CM70
camera, which you could use to control the camera over IP.
Target Audience
This manual is developed for IT professionals who are responsible for operating the Product.
Document Structure
The Manual is subdivided into the following Chapters:
1. Introduction
2. Appendix A - VISCA Settings and Command List
User Manual | www.avonic.com 4

Appendix C - HTTP API
With the HTTP API you can control the camera by using a web browser like Microsoft Edge or Google Chrome
for example. It is possible to change multiple settings at once using this feature. This document is available as
an Appendix in the CM7x manual and as a separate document that can be downloaded on the product website.
How to use HTTP API
To use the HTTP API you need the following link:
http://192.168.5.126/ajaxcom?szCmd=
Follow instructions below:
1. Click on the link above, or copy and paste it to your browser.
2. Note that the IP Address in this link is an example of an IP address. Change this IP Address to
the one you use for your camera. See Network > Ethernet > IP Address.
3. Copy the code from the list. Remember that some codes are documented over multiple lines
and that you need to copy this from the first to the last bracket! See the example below:
4. Paste the code at the end of HTTP link. It will look like this:
5. Change the settings in the link. In this case:
6. Press ENTER. If correct, you get in return:
If failed, you get in return.
User Manual | www.avonic.com 5

7. In case of a failed return, check the following:
• Brackets in the code. Have you copy and paste the first and the last bracket?
• Syntax errors in the code/ correct numbers in the key values. Some camera settings are having
a specific range. The SRT key for example has a range of 0 - 32. If you have typed 33 it would
exceed the range of this key.
• No long white spaces between the key values of the code. For example this " code " is error
and this "code" is right.
• If you have typed the correct IP address of the camera.
8. If you have done it correct, you can check the settings you have changed in the WebGUI of the
camera.
Curl
It is also possible to change the camera settings at once by using the Command Prompt from Windows.
Follow instructions below:
1. Click on Start in the left corner of your screen in Windows.
2. Type Notepad and open this application.
3. Copy and paste the following http link: http://192.168.5.126/ajaxcom and the code in the HTTP API
code list in Notepad.
4. Type curl, change the default IP address in the IP Address of your camera, and surround it by
quotation marks.
5. Add --data-raw between the http link and the code.
6. Type szCmd and surround it by quotation marks.
7. Double the quotation marks between the brackets! See the example below.
8. Modify the parameters in the code. In the example above EmAFmode:3 and nChannel:0 See the
HTTP API code list.
9. Click on Start in Windows again, type CMD and press Enter.
10.Copy and paste the link/ code from notepad in Command Prompt and press Enter.
11.If correct it returns: {"nRetVal":0, "szError":""}
User Manual | www.avonic.com 6

{"GetEnv"}
You can also use the HTTP API to display the current settings of the camera in your browser or in the
Command Prompt application. To do this, you need the {"GetEnv"} codes from the HTTP API code list. If correct
you get the following result:
Web browser
Command Prompt
User Manual | www.avonic.com 7

HTTP API code list
IR Remote Control
IR Enable/Disable
Command Code Command Setting
0: ONszCmd {"SetEnv":{"ArmPtz":
{"bIrCtrlEnable":0}}}
bIrCtrlEnable
1: OFF
PTZ
PTZControl
Code: http://192.168.5.126/ajaxcom?szCmd={"SysCtrl":{"PtzCtrl":{"nChanel":0,"szPtzCmd":"left_start","byValue":50}}}
Command Setting Function Command
nChanel 0
byValue 0,100 used to control the speed of ptz
szPtzCmd
left start left_start
left stop left_stop
leftup start leftup_start
leftup stop leftup_stop
leftdown start leftdown_start
leftdown stop leftdown_stop
rightstart right_start
rightstop right_stop
rightup start rightup_start
rightdown start rightdown_start
rightdown stop rightdown_stop
upstart up_start
upstop up_stop
downstart down_start
downstop down_stop
PTZ speed
Set PTZ Speed
Command Code Command Setting
0: SlowszCmd {"SetEnv":{"PTZSpeed":
{"nPTZSpeed":1}}}
nPTZSpeed
1: High
Speed by zoom
Set Speed By Zoom
Command Code Command Setting
szCmd {"SetEnv":{"ArmPtz":{"bSpeedByZoom":0}}} bSpeedByZoom 1: on
0: off
User Manual | www.avonic.com 8

Image Freezing
Set Image Freezing
Command Code Command Setting
szCmd {"SetEnv":{"ArmPtz":{"bImageFreezing":0}}} bImageFreezing 1: on
0: off
Low power mode
Set Low Power Mode
Command Code Command Setting
szCmd {"SetEnv":{"ArmPtz":{"emLowPowerMode":0}}} emLowPowerMode 2: on
3: off
Zoom Speed
Set Zoom Speed
Command Code Command Setting
szCmd {"SetEnv":{"ArmPtz":{"nZoomSpeed":0}}} nZoomSpeed 0 - 7
Preset Pan Speed
Set Preset Pan Speed
Command Code Command Setting
szCmd {"SetEnv":{"ArmPtz":{"nPresetPanSpeed":0}}} nPresetPanSpeed 0 - 24
Preset Tilt Speed
Set Preset Tilt Speed
Command Code Command Setting
szCmd {"SetEnv":{"ArmPtz":{"nPresetTiltSpeed":0}}} nPresetTiltSpeed 0 - 20
Preset Zoom Speed
Set Preset Zoom Speed
Command Code Command Setting
szCmd {"SetEnv":{"ArmPtz":{"nPresetZoomSpeed":0}}} nPresetZoomSpeed 0 - 7
Focus Mode
Focus Mode Commands
Focus Mode
Code {"SetEnv":{"VideoParam":[{"stAF": {“emAFMode”:3},”nChannel”:0}]}}
Command Setting
nChanel 0
emAFMode 2: Auto
3: Manual
4 OnePush
User Manual | www.avonic.com 9

Focus Mode Commands
Zoom and focus
Code {"SysCtrl":{"PtzCtrl":{"nChanel":0,"szPtzCmd":"zoomdec_start","byValue":0}}}
Command Setting Function Command
nChanel 0
byValue 0
szPtzCmd
Zoom add start zoomadd_start
Zoom add stop zoomadd_stop
Zoom decrease stop zoomdec_start
Zoom decrease stop zoomdec_stop
Focus add start focusadd_start
Focus add stop focusadd_stop
Focus decrease start focusdec_start
Focus decrease stop focusdec_stop
Preset
Preset Commands
Code {"SysCtrl":{"PtzCtrl":{"nChanel":0,"szPtzCmd":"preset_set","byValue":0}}}
Command Setting Function Command
nChanel 0s
ByValue 0, 254
szPtzCmd
Set preset preset_set
Call preset preset_call
Clean preset preset_clean
Audio
Audio Configure
Get audio configure
Code {"GetEnv":{"Audio":{}}}
Set audio configure
Code {"SetEnv":{"Audio":{"nSampleBits":16,"nAudioSmstMask":
[33554888,33554888,33554433],"bEnable":0,"nInpVolume":4,"nBitRate":64,"nAEncType":7,"byAudioCodecList":
[6,7,2],"nSampleRate":44100,"nChannel":1}}}
Function Code Command Setting
Enable {"SetEnv":{"Audio":{"bEnable":1}}} bEnable 0: off
1: on
Encode Type {"SetEnv":{"Audio":{"nAEncType":7}}} nAEncType 6: Mp3AAC
7: G.711A
2:
User Manual | www.avonic.com 10

Audio Configure
Sample Rate {"SetEnv":{"Audio":{"nSampleRate":32000}}} nSampleRate (Only supporting
these sample rates and gy11a
can only be 8000.)
16000
32000
44100
48000
Sample Bits {"SetEnv":{"Audio":{"nSampleBits":16}}} nSampleBits 16
Bit Rate {"SetEnv":{"Audio":{"nBitRate":96}}} nBitRate 32
48
64
96
128
Channel {"SetEnv":{"Audio":{"nChannel":2}}} nChannel 1: Mono
2: Stereo
Input Volume {"SetEnv":{"Audio":{"nInpVolume":5}}} nInpVolume (range 1 to 10) Exp:[1, 10]
Video
Video encoder
Video Encode
Get video encode parameters
Code {"GetEnv":{"VideoEncode":{"nChannel":-1}}}
Set video encode parameters
Code {"SetEnv":{"VideoEncode":[{"stSlave":{"byIFrameMinQP":20,"byImageQuality":1,
"szStreamName":"live/av1","dwVideoCodecMask":160,"emBitRateCtrl":0, "byImageSizeList":
[26,7,9,27,4,5],"dwMaxBitRate":40960,"nFrameRate":25,"nMaxFrameRate":30,
"emVideoCodec":5,"nIFrameInterval":75,"emImageSize":27,"nBitRate":512,"byProfile":2},
"stMaster":{"byIFrameMinQP":20,"byImageQuality":0,"szStreamName":"live/av0",
"dwVideoCodecMask":160,"emBitRateCtrl":0,"byImageSizeList":[5,4,9],"dwMaxBitRate":40960,
"nFrameRate":25,"nMaxFrameRate":60,"emVideoCodec":5,"nIFrameInterval":75,"emImageSize":5,
"nBitRate":4096,"byProfile":2},"nChannel":0}]}}
Video encode settings
Video Encode Settings
Function Code Command Setting
Compressed Format {"SetEnv":{"VideoEncode":[{"stMaster":
{"emVideoCodec":5},"nChannel":0}]}}
emVideoCodec 5: H.264
7: H.265 (BP profile only)
Profile {"SetEnv":{"VideoEncode":[{"stMaster":
{"byProfile":0},"nChannel":0}]}}
byProfile 0: BP
1: MP
2: HP
{"GetEnv":{"VideoEncode": {"nChannel":-1}}} and
receive its returning value. Compared to webpage
and this, you can know the different value meaning
different image size.
byImageSizeList (Lists
all imagesize, different
products have different
image size)
Image Size {"SetEnv":{"VideoEncode":[{"stMaster":
{"emImageSize":4},"nChannel":0}]}}
emImageSize 5: 1920*1080
4: 1280*720
9: 640*480
27: 320*180
26: 640*360
Rate Control {"SetEnv":{"VideoEncode":[{"stMaster":
{"emBitRateCtrl":1},"nChannel":0}]}}
emBitRateCtrl 0: CBR
1: VBR
User Manual | www.avonic.com 11

Video Encode Settings
Function Code Command Setting
Image Quality {"SetEnv":{"VideoEncode":[{"stMaster":
{"byImageQuality":5},"nChannel":0}]}}
byImageQuality 0: worst quality
1: between
2: between
3: between
4: between
5: Best quality
Bit Rate
(kb/s)
{"SetEnv":{"VideoEncode":[{"stMaster":
{"dwMaxBitRate":200},"nChannel":0}]}}
dwMaxBitRate [64, 40960]
Frame Rate
(F/S)
{"SetEnv":{"VideoEncode":[{"stMaster":
{"nFrameRate":25},"nChannel":0}]}}
nFrameRate [5, 60]
Frame
Interval
{"SetEnv":{"VideoEncode":[{"stMaster":
{"nIFrameInterval":70},"nChannel":0}]}}
nIFrameInterval [1, 300]
Frame Min QP {"SetEnv":{"VideoEncode":[{"stMaster":
{"byIFrameMinQP":70},"nChannel":0}]}}
byIFrameMinQP [10, 51]
Stream Name {"SetEnv":{"VideoEncode": [{"stMaster":
{"szStreamName":"live/av01"},"nChannel":0}]}}
szStreamName user-defined
Video Streaming
Stream Publish
Get stream publish parameters
Code {"GetEnv":{"StreamPublish":{"nChannel":-1}}}
Set stream publish parameters
Code {"SetEnv":{"StreamPublish":[{"stSlave":{"wHostPort":1935,"szHostUrl":"192.168.5.11",
"nProtolType":2,szStreamName":"live/
av1","bEnable":0,"nAbProtolMask":1,"szSrtKey":"","wSrtKeyLen":0,"szUserName":"","szPassword":""},”stMaster”:
{"wHostPort":1935, "szHostUrl":"192.168.5.11",”nProtolType":3,"szStreamName":"live/
av0","bEnable":0, "nAbProtolMask":1,"szSrtKey":"1111111111","wSrtKeyLen":0,"szUserName":"",
"szPassword":""},"nChannel":0}]}}
NOTE: When modifying one param, you should take along wHostPort. Otherwise, the host port will be zero.
Function Code Command Setting
Enable {"SetEnv":{"StreamPublish":[{"stMaster":
{"wHostPort":1935,"bEnable":1,"nProtolType":3},"nChannel":0}]}}
bEnable 0: off
1: on
Protol Type nProtolType 2: srt
3: rtmp
Host Address {"SetEnv":{"StreamPublish":[{"stMaster":
{"wHostPort":1935,"nProtolType":3",szHostUrl":
"192.168.5.12"},"nChannel":0}]}}
szHostUrl user-defined
Host Port {"SetEnv":{"StreamPublish":[{"stMaster":
{"wHostPort":19355,"nProtolType":3},"nChannel":0}]}}
wHostPort [0,65535]
Stream Name {"SetEnv":{"StreamPublish":[{"stMaster":
{"wHostPort":19355,"nProtolType":3,"szStreamName":"live/1213"},
"nChannel":0}]}}
szStreamName user-defined
User Name {"SetEnv":{"StreamPublish":[{"stMaster":
{"wHostPort":19355,"nProtolType":3,"szUserName":"123"},
"nChannel":0}]}}
szUserName user-defined
Password {"SetEnv":{"StreamPublish":[{"stMaster":
{"wHostPort":19355,"nProtolType":3,"szPassword":"123"},
"nChannel":0}]}}
szPassword user-defined
User Manual | www.avonic.com 12

Stream Publish
SrtKey (SRT
Effectie)
{"SetEnv":{"StreamPublish":[{"stMaster":
{"wHostPort":19355,"nProtolType":3,"szSrtKey":"0123456789"},
"nChannel":0}]}}
szSrtKey user-defined
SrtKeyLen
(SRTEffectie)
{"SetEnv":{"StreamPublish":[{"stMaster":
{"wHostPort":19355,"nProtolType":3,"wSrtKeyLen":"0"},
"nChannel":0}]}}
wSrtKeyLen [0-32]
(RTP) Multicast Streaming
RTP Multicast
Get rtp multicast parameters
Code {"GetEnv":{"StreamRTPMulticast":{"nChannel":-1}}}
Set rtp multicast parameters
Code {"SetEnv":{"StreamRTPMulticast":[{"stSlave":
{"nProtolType":0,"bEnable":0,"wMultiCastPort":4002,
"szMultiCastUrl":"224.1.2.3"},"stMaster":
{"nProtolType":1,"bEnable":0,"wMultiCastPort":4000,
"szMultiCastUrl":"224.1.2.3"},"nChannel":0}]}}
NOTE: When modifying one param you should take along bEnable and awMultiCastPort. Otherwise, it will be set to 0.
Suggesting that when setting env, you can distinguish the stMaster and stSlave.
RTP Multicast Settings
RTP Multicast Settings
Function Code Command Setting
Enable {"SetEnv":{"StreamRTPMulticast":[{"stMaster":
{"bEnable":1,"wMultiCastPort":4004},"nChannel":0}]}}
bEnable 0: off
1: on
Protol Type {"SetEnv":{"StreamRTPMulticast":[{"stMaster":
{"bEnable":1,"nProtolType":1,"wMultiCastPort":4004},
"nChannel":0}]}}
nProtolType 0: RTP
1: TS
Multicast Address {"SetEnv":{"StreamRTPMulticast":[{"stMaster":
{"bEnable":0,"szMultiCastUrl":"224.1.2.23","wMultiCastPort":
4004}, "nChannel":0}]}}
SzMultiCastUrl 224.0.0.0~
255.255.255.0
Multicast Port {"SetEnv":{"StreamRTPMulticast":[{"stMaster":
{"bEnable":1,"wMultiCastPort":4004},"nChannel":0}]}}
wMultiCastPort Even [0, 65535]
Camera Settings
Video Parameters
Get video parameters
Code {"GetEnv":{"VideoParam":{"nChannel":-1}}}
Set video parameters
Focus
Function Code Command Setting
Focus Mode {"SetEnv":
{"VideoParam":
[{"stAF":
{"emAFMode":2},"nChannel":0}]}}
emAFMode 2:
3:
4:
Auto
Manual
OnePush
AF-Zone {"SetEnv":
{"VideoParam":
[{"stAF":
{"emAFZone":1},"nChannel":0}]}}
emAFZone 0:
1:
2:
3:
Top
Center
Bottom
All
User Manual | www.avonic.com 13

Video Parameters
AF-Sensitivity {"SetEnv":
{"VideoParam":
[{"stAF":
{"nSensitivity":1},"nChannel":0}]}}
nSensitivity 1:
2:
3:
High
Middle
Low
Exposure
Camera Settings
Exposure
Mode {"SetEnv":{"VideoParam":[{"stExp":{"stExpMode":
{"emExpMode":0}},
"nChannel":0}]}}
emExpMode 0:
3:
10:
11:
13:
Auto
Manual
SAE
AAE
Bright
Exposure: Auto
EV {"SetEnv":{"VideoParam":[{"stExp":
{"expcomp_mode":2},"nChannel":0}]}}
expcomp_mode 2:
3:
ON
OFF
EV
Level
{"SetEnv":{"VideoParam":[{"stExp":
{"expcomp":8},"nChannel":0}]}}
expcomp [0, 14]
BLC {"SetEnv":{"VideoParam":[{"stExp":
{"backlight":2},"nChannel":0}]}}
backlight 2:
3:
ON
OFF
Camera Settings
Exposure: Auto
Function Code Command Setting
Flicker {"SetEnv":{"VideoParam":[{"stExp":
{"antiflicker":0},"nChannel":0}]}}
antiflicker 0:
1:
2:
OFF
50HZ
60HZ
G.Limit {"SetEnv":{"VideoParam":[{"stExp":
{"gainLimit":5},"nChannel":0}]}}
gainLimit [0, 15]
DRC {"SetEnv":{"VideoParam":[{"stExp":
{"drc":6},"nChannel":0}]}}
drc [0, 8]
Exposure: Manual
shutter {"SetEnv":{"VideoParam":
[{"stExp":{"stShutter":
{"nShutter":16}},"nChannel":0}]}}
nShutter [0, 16]
Iris {"SetEnv":{"VideoParam":[{"stExp":{"stIris":
{"nIris":12}},"nChannel":0}]}}
nIris [0, 12]
DRC {"SetEnv":{"VideoParam":[{"stExp":
{"drc":8},"nChannel":0}]}}
drc [0, 8]
Exposure: SAE
shutter {"SetEnv":{"VideoParam":
[{"stExp":{"stShutter":
{"nShutter":16}},"nChannel":0}]}}
nShutter [0, 16]
DRC {"SetEnv":{"VideoParam":[{"stExp":
{"drc":7},"nChannel":0}]}}
drc [0, 8]
User Manual | www.avonic.com 14

Camera Settings
Exposure: AEE
Flicker {"SetEnv":{"VideoParam":[{"stExp":
{"antiflicker":0},"nChannel":0}]}}
Antiflicker 0:
1:
2:
OFF
50HZ
60HZ
G.Limit {"SetEnv":{"VideoParam":[{"stExp":
{"gainLimit":5},"nChannel":0}]}}
gainLimit [0, 15]
Iris {"SetEnv":{"VideoParam":[{"stExp":{"stIris":
{"nIris":12}},"nChannel":0}]}}
nIris [0, 12]
DRC {"SetEnv":{"VideoParam":[{"stExp":
{"drc":6},"nChannel":0}]}}
drc [0, 8]
Exposure: Bright
Bright {"SetEnv":{"VideoParam":[{"stExp":
{"bright":0},"nChannel":0}]}}
bright [0, 23]
Flicker, G.Limit, DRC You can find the same configure at AAE
Color and Image
Camera Settings
Color
Function Code Command Setting
WB
Mode
{"SetEnv":{"VideoParam":
[{"stColor":{"stWbMode":
{"emWbMode":0}},"nChannel":0}]}}
emWbMode 0:
1:
7:
2:
8:
4:
9:
10:
6:
11:
5:
3:
Auto
3000K
3500K
4000K
4500K
5000K
5500K
6000K
6500K
7000K
Manual
OnePush
RG
Tuning
{"SetEnv":{"VideoParam":
[{"stColor":
{"rgaintuning":0},"nChannel":0}]}}
rgaintuning [0, 20]
BG
Tuning
{"SetEnv":{"VideoParam":
[{"stColor":
{"bgaintuning":20},"nChannel":0}]}}
bgaintuning [0, 20]
Saturation {"SetEnv":{"VideoParam":
[{"stColor":
{"saturation":0},"nChannel":0}]}}
saturation [0, 14]
Hue {"SetEnv":{"VideoParam":
[{"stColor":
{"hue":14},"nChannel":0}]}}
hue [0, 14]
AWB
Sensitivity
{"SetEnv":{"VideoParam":
[{"stColor":
{"awbsens":0},"nChannel":0}]}}
awbsens 0:
1:
2:
Low
Middle
High
User Manual | www.avonic.com 15

Camera Settings
Image
Bright {"SetEnv":
{"VideoParam":[{"stImg":
{"luminance":0},"nChannel":0}]}}
luminance [0, 4]
Contrast {"SetEnv":
{"VideoParam":[{"stImg":
{"contrast":0},"nChannel":0}]}}
contrast [0, 14]
Sharpness {"SetEnv":
{"VideoParam":[{"stImg":
{"sharpness":1},"nChannel":0}]}}
sharpness [0, 15]
Gamma {"SetEnv":
{"VideoParam":[{"stImg":
{"gamma":0},"nChannel":0}]}}
gamma [0, 4] 0: Default
1: 0.45
2: 0.50
3: 0.55
4: 0.63
DCI {"SetEnv":
{"VideoParam":[{"stImg":
{"dci":0},"nChannel":0}]}}
dci [0, 8]
0:
OFF
B&W
Mode
{"SetEnv":
{"VideoParam":[{"stImg":
{"nBWMode":0},"nChannel":0}]}}
nBWMode 0:
4:
Color
B & W
Flip-H {"SetEnv":
{"VideoParam":[{"stImg":
{"nFlipH":3},"nChannel":0}]}}
nFlipH 2:
3:
ON
OFF
Camera Settings
Image
Function Code Command Setting
Flip-V {"SetEnv":{"VideoParam":[{"stImg":
{"nFlipV":2},"nChannel":0}]}}
nFlipV 2:
3:
ON
OFF
AutoFlip {"SetEnv":{"VideoParam":[{"stImg":
{"nAutoFlipV":2},"nChannel":0}]}}
nAutoFlipV ON
OFF
DZoom {"SetEnv":{"VideoParam": [{"stImg":
{"nEZoom":3},"nChannel":0}]}}
nEZoom 2:
3:
ON
OFF
Noise Reduction
Camera Settings
NR-2D {"SetEnv":{"VideoParam":[{"stNR":
{"noise2D":0},"nChannel":0}]}}
noise2D [0, 8]
NR-3D {"SetEnv":{"VideoParam":[{"stNR":
{"noise3D":0},"nChannel":0}]}}
noise3D [0, 8] 0: OFF
8: Auto
Dynamic Hot
Pixel
{"SetEnv":{"VideoParam":[{"stNR":
{"dhotpixel":3},"nChannel":0}]}}
dhotpixel [0, 5] 0: OFF
Style {"SetEnv":{"VideoParam":[{"stColor":
{"nStyleInx":0},"nChannel":0}]}}
nStyleInx [0, 4] 0: Default
1: Normal
2: Clarity
3: Bright
4: Soft
User Manual | www.avonic.com 16

Video OSD
Video OSD
Get video parameters
Code {"GetEnv":{"VideoOsd":{"nChannel":-1}}}
Set set video parameters
Code {"SetEnv":{"VideoOsd":[{"stTime":{"bEnable":1,"nIndex":0,"nXPos":0,"szText":"","nYPos":10000,
"stFtColor":{"byAlpha":128,"byRed":255,"byGreen":255,"byBlue":255},"stBkColor":{"byAlpha":0,
"byRed":0,"byGreen":0,"byBlue":0}},"stTitle":{"bEnable":0,"nIndex":0,"nXPos":0,"szText":"",
"nYPos":0,"stFtColor":{"byAlpha":128,"byRed":255,"byGreen":255,"byBlue":255},"stBkColor":
{"byAlpha":0,"byRed":0,"byGreen":0,"byBlue":0}},"nChannel":0}]}}
NOTE: All params can be saved by this command and also you can set one param alone.
Function Code Command Setting
Show Time {"SetEnv":{"VideoOsd":[{"stTime":
{"bEnable":1},"nChannel":0}]}}
bEnable 0: Not show
1: Show
Show Title {"SetEnv":{"VideoOsd":[{"stTitle":
{"bEnable":1},"nChannel":0}]}}
bEnable 0: Not Show
1: Show
Video OSD
Set video parameters
Function Code Command Setting
byAlpha 128
white rgb (255,255,255)
black rgb (0,0,0)
yellow rgb (255,255,0)
red rgb (255,0,0)
Time FontColor {"SetEnv":{"VideoOsd":[{"stTime":{"stFtColor":
{"byAlpha":128,"byRed":255,"byGreen":255,"byBlue":0}},
"nChannel":0}]}}
blue rgb (0,0,255)
byAlpha 128
white rgb (255,255,255)
black rgb (0,0,0)
yellow rgb (255,255,0)
red rgb (255,0,0)
Title FontColor {"SetEnv":{"VideoOsd":[{"stTitle":{"stFtColor":
{"byAlpha":128,"byRed":255,"byGreen":255,"byBlue":0}},
"nChannel":0}]}}
blue rgb (0,0,255)
Time: {"SetEnv":{"VideoOsd":[{"stTime":
{"nXPos":9200},"nChannel":0}]}}
OSD Offsetx pos
Title: {"SetEnv":{"VideoOsd":[{"stTitle":
{"nXPos":9200},"nChannel":0}]}}
nXPos [0, 10000]
Time: {"SetEnv":{"VideoOsd":[{"stTime":
{"nYPos":1200},"nChannel":0}]}}
OSD Offsety pos
Title: {"SetEnv":{"VideoOsd":[{"stTitle":
{"nYPos":1200},"nChannel":0}]}}
nYPos [0, 10000]
OSD Font Size
Get OSD font size parameters
Code {"GetEnv":{"TTFFontSize":{"nChannel":-1}}}
Set video parameters
Code {"SetEnv":{"TTFFontSize":{"nFontSize":[48,48],"bAutoSize":1}}}
User Manual | www.avonic.com 17

OSD Font Size
Function Code Command Setting
bAutoSize 0: off,1: on
nFontSize [8,200]
Output Format
(Video) Output Format
Get video out parameters
Code {"GetEnv":{"VideoOut":{"nChannel":-1}}}
Set video out parameters
Code {"SetEnv":{"VideoOut":{"nNetMode":2,"emVoutFormat":9,"byFormatList":
[10,9,4,3,8,7,6,5,26,25,20,21,22,23,24]}}}
Function Code Command Setting
nNetMode:
default value 2, do not
modify it
– HD output
– HD output + SD network
– SD output + HD network
emVoutFormat:
Setting the current video
out format.
10:
9:
4:
3:
1080P60
1080P50
1080P30
1080P25
8: 1080I60
7: 1080I50
6: 720P60
5: 720P50
26: 720P30
25: 720P25
20: 1080P59.94
21: 1080I59.94
22: 1080P29.97
23: 720P59.94
24: 720P29.97
SRT
SRT
Get network SRT parameters
Code {"GetEnv":{"NetWork":{"nChannel":-1}}}
Set network SRT parameters
Code {"SetEnv":{"NetWork":{"stSrt":{"wSrtLen":0,"wSrtPort":9000,"szSrtPin":"xxxxxxxxxx"}}}}
Function Code Command Setting
crypto key length in bytes wSrtLen [0-32]
Port SRT wSrtPort Default 9000
Password stream encryption szSrtPin user-defined
User Manual | www.avonic.com 18

Network
Network configure and port settings
Network Configure
Get network port parameters
Code {"GetEnv":{"NetWork":{"nChannel":-1}}}
Set network port parameters
{"SetEnv":{"NetWork":{"stNetPort":
{"wPortSoap":1936,"wPortData":3000,"wPortWeb":80,"wPortRtsp":554,"wPortVisca":
1259,"wPortOnvif":2000,"wPortRtmp":1935}}}}
Code
You can also set one of these parameters like this:
{"SetEnv":{"NetWork":{"stNetPort":{"wPortSoap":1936}}}}
Port Settings
Function Code Command Setting
Port Data wPortData [0, 65535]
Port Web wPortWeb [0, 65535]
Port Onvif wPortOnvif [0, 65535]
Port Soap wPortSoap [0, 65535]
Port Rtmp wPortRtmp [0, 65535]
Port Rtsp wPortRtsp [0, 65535]
Port Visca wPortVisca [0, 65535]
Ethernet
Ethernet
Get Ethernet parameters
Code {"GetEnv":{"NetWork":{"nChannel":-1}}}
Set Ethernet parameters
Code "SetEnv":{"NetWork":{"stEth":
[{"byValid":5,"szIPAddr":"192.168.5.126","szSubMask":"255.255.255.0","szMacAddr":"E4:77:D4:01:8A:49",
"szGateway":"192.168.5.1","bDefault":1}]}}}
Function Code Command Setting
DHCP {"SetEnv":{"NetWork":{"stEth":[{"byValid":5}]}}} byValid 5:off
7:on
IP Address {"SetEnv":{"NetWork":{"stEth":[{"szIPAddr":"192.168.5.127"}]}}}
Subnet Mask {"SetEnv":{"NetWork":{"stEth":[{"szSubMask":"255.255.255.0"}]}}}
Default Gateway {"SetEnv":{"NetWork":{"stEth":[{"szGateway":"192.168.5.1"}]}}}
DNS
DNS
Get dns parameters
Code {"GetEnv":{"NetWork":{"nChannel":-1}}}
Set dns parameters
Code {"SetEnv":{"NetWork":{"stDns":{"szDns1":"8.8.8.8","szDns2":"0.0.0.0"}}}}
User Manual | www.avonic.com 19

DNS
Function Code Command Setting
Preferred DNS Server {"SetEnv":{"NetWork":{"stDns":
{"szDns1":"8.8.8.8"}}}}
Alternative DNS Server {"SetEnv":{"NetWork":{"stDns":
{"szDns2":"8.8.8.8"}}}}
System
System Configure
Get sysattr parameters
Code {"GetEnv":{"SysAttr":{"nChannel":-1}}}
Set sysattr parameters
Code {"SetEnv":{"SysAttr":
{"nLanguage":0,"szDeviceID":"1","emVideoStandard":1,"szDevName":"testname"}}}
Function Code Command Setting
Device Name szDevName user-defined, cannot use white
space
Device ID szDeviceID cannot modify
Language nLanguage 0: Simplified Chinese
2: English
License
License
Get License parameters
Code :{"QueryState":{"QueryLicenseState":{}}}
Set License parameters
Code {"SetEnv":{"LicenseKey":
{"bLicenseEnable":0,"szKeyText":"483B4EB1D0"}}}
Time
SysTime
Get system time parameters
Code {"QueryState":{"QuerySysTime":{}}}
Set system time parameters
Code {"SetEnv":{"SysTime":{"nDateSprtr":2,"nDateFormat":0,"nZone":1,"nHourType":0,"stNtp":
{"bEnable":1,"nHostPort":123,"nUpdateInterval":2,"szHostUrl":"ntp4.aliyun.com"}}}}
Function Code Command Setting
Date Format {"SetEnv":{"SysTime":{"nDateFormat":0}}} nDateFormat 0: YYYY-MM-DD
1: MM-DD-YYYY
2: DD-MM-YYYY
Date Sprtr {"SetEnv":{"SysTime":{"nDateSprtr":0}}} nDateSprtr 0: .
1: -
2: /
User Manual | www.avonic.com 20