Avonic CM70-NDI User manual

USER MANUAL
HTTP API for CM70-NDI
CM70-NDI
www.avonic.com • © May 2023 • Version 1.4

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 © 2023 AVONIC All Rights Reserved.
The information contained in this Manual is subject to change without notice. Visit regularly www.avonic.com to
download the latest version of the user documentation. Download at least every half year a new version to stay
up to date (however, we recommended to do this more often).
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.
Join Avonic on Social Media
www.Facebook.com/avonicPTZ www.instagram.com/avonicPTZ
www.LinkedIn.com/company/avonic www.youtube.com/channels/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.
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"}........................................................................................................................... 6
HTTP API code list........................................................................................................................7
PTZ.................................................................................................................................................7
PTZ speed...........................................................................................................................8
Speed by Zoom................................................................................................................ 8
Image Freezing..................................................................................................................8
Low power mode............................................................................................................. 8
Zoom Speed......................................................................................................................8
Preset Pan Speed............................................................................................................. 8
Preset Tilt Speed................................................................................................................ 8
Preset Zoom Speed.......................................................................................................... 8
Focus Mode.......................................................................................................................9
Preset.................................................................................................................................. 9
Audio..........................................................................................................................................10
Video..........................................................................................................................................10
Video encoder................................................................................................................10
Video Streaming............................................................................................................. 12
(RTP) Multicast Streaming...............................................................................................12
Camera Settings............................................................................................................. 13
Video OSD....................................................................................................................... 17
Output Format.................................................................................................................18
SRT.....................................................................................................................................18
Network......................................................................................................................................19
Network configure and port settings............................................................................ 19
Ethernet............................................................................................................................ 19
DNS................................................................................................................................... 20
NDI.............................................................................................................................................. 20
System........................................................................................................................................ 21
License............................................................................................................................. 21
Time.................................................................................................................................. 21
User................................................................................................................................... 22
Update............................................................................................................................. 23
Default and Reboot....................................................................................................... 23
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 C - HTTP API
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. It
is possible to change multiple settings at once using this feature. This document is available as an Appendix in the
CM70 series manual and as a separate document that can be downloaded on the product website.
How to use HTTP API
All codes in the HTTP API code list are clickable. Do NOT click left on these codes!
Follow instructions below:
1. Click right and click (left) to COPY the link.
2. Paste the link in your browser like this (Note that all the brackets are replaced by percentages. This is
normal, ignore it):
3. 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.
4. Change the settings in the link. In this case:
5. Press ENTER. If correct, you get in return:
If failed, you get in return.
6. In case of a failed return, check the following:
• 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 entered the correct IP address of the camera.
7. If you have done it correct, you can check the settings you have changed in the WebGUI of the
camera.
5

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 from the HTTP API code list (for example: http://192.168.5.126/
ajaxcom?szCmd={"GetEnv":{"VideoParam":{"nChannel":-1}}}
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. If correct it
returns: {"nRetVal":0, "szError":""}
{"GetEnv"}
You can use the HTTP API to display the current settings of the camera in your browser or in the Command Prompt
application. You need the {"GetEnv"} codes from the HTTP API code list to do this. If correct you see the following in
your webbrowser, or in Command Prompt:
6

HTTP API code list
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
7

PTZ speed
Set PTZ Speed
Command Code Command Setting
szCmd http://192.168.5.126/ajaxcom?szCmd={"SetEnv":
{"PTZSpeed":{"nPTZSpeed":1}}}
nPTZSpeed 0: Slow 1: High
Speed by Zoom
Set Speed By Zoom
Command Code Command Setting
szCmd http://192.168.5.126/ajaxcom?szCmd={"SetEnv":
{"ArmPtz":{"bSpeedByZoom":0}}}
bSpeedByZoom 1: on 0: off
Image Freezing
Set Image Freezing
Command Code Command Setting
szCmd http://192.168.5.126/ajaxcom?szCmd={"SetEnv":{"ArmPtz":
{"bImageFreezing":0}}}
bImageFreezing 1: on
0: off
Low power mode
Set Low Power Mode
Command Code Command Setting
szCmd http://192.168.5.126/ajaxcom?szCmd={"SetEnv":
{"ArmPtz":{"emLowPowerMode":0}}}
emLowPowerMode 2: on 3: off
Zoom Speed
Set Zoom Speed
Command Code Command Setting
szCmd http://192.168.5.126/ajaxcom?szCmd={"SetEnv":{"ArmPtz":
{"nZoomSpeed":0}}}
nZoomSpeed 0 - 7
Preset Pan Speed
Set Preset Pan Speed
Command Code Command Setting
szCmd http://192.168.5.126/ajaxcom?szCmd={"SetEnv":{"ArmPtz":
{"nPresetPanSpeed":0}}}
nPresetPanSpeed 0 - 24
Preset Tilt Speed
Set Preset Tilt Speed
Command Code Command Setting
szCmd http://192.168.5.126/ajaxcom?szCmd={"SetEnv":{"ArmPtz":
{"nPresetTiltSpeed":0}}}
nPresetTiltSpeed 0 - 20
Preset Zoom Speed
Set Preset Zoom Speed
Command Code Command Setting
szCmd http://192.168.5.126/ajaxcom?szCmd={"SetEnv":{"ArmPtz":
{"nPresetZoomSpeed":0}}}
nPresetZoomSpeed 0 - 7
8

Focus Mode
Focus Mode Commands
Focus Mode
Code http://192.168.5.126/ajaxcom?szCmd={"SetEnv":{"VideoParam":[{"stAF":
{"emAFMode":3},"nChannel":0}]}}
Command Setting
nChanel 0
emAFMode 2: Auto
3: Manual
4 OnePush
Zoom and focus
Code http://192.168.5.126/ajaxcom?szCmd={"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 http://192.168.5.126/ajaxcom?szCmd={"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
9

Audio
Audio Configure
Get audio configure
Code http://192.168.5.126/ajaxcom?szCmd={"GetEnv":{"Audio":{}}}
Set audio configure
Code http://192.168.5.126/ajaxcom?szCmd={"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 http://192.168.5.126/ajaxcom?
szCmd={"SetEnv":{"Audio":
{"bEnable":1}}}
bEnable 0: off
1: on
Encode
Type
http://192.168.5.126/ajaxcom?
szCmd={"SetEnv":{"Audio":
{"nAEncType":7}}}
nAEncType 6: Mp3AAC
7: G.711A
2:
Sample
Rate
http://192.168.5.126/ajaxcom?
szCmd={"SetEnv":{"Audio":
{"nSampleRate":32000}}}
nSampleRate (Only
supporting these sample
rates and gy11a can only
be 8000.)
16000
32000
44100
48000
Sample Bits http://192.168.5.126/ajaxcom?
szCmd={"SetEnv":{"Audio":
{"nSampleBits":16}}}
nSampleBits 16
Bit Rate http://192.168.5.126/ajaxcom?
szCmd={"SetEnv":{"Audio":
{"nBitRate":96}}}
nBitRate 32
48
64
96
128
Channel http://192.168.5.126/ajaxcom?
szCmd={"SetEnv":{"Audio":
{"nChannel":2}}}
nChannel 1: Mono 2: Stereo
Input
Volume
http://192.168.5.126/ajaxcom?
szCmd={"SetEnv":{"Audio":
{"nInpVolume":5}}}
nInpVolume (range 1 to
10)
Exp:[1, 10]
Video
Video encoder
Video Encode
Get video encode parameters
Code http://192.168.5.126/ajaxcom?szCmd={"GetEnv":{"VideoEncode":{"nChannel":-1}}}
Set video encode parameters
Code http://192.168.5.126/ajaxcom?szCmd={"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}]}}
10