Advertisement

Quick Links

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

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the CM7 IP Series and is the answer not in the manual?

Questions and answers

Summary of Contents for Avonic CM7 IP Series

  • Page 1 HTTP API for CM7x-IP series CM70-IP/CM71-IP/CM73-IP www.avonic.com | User Manual | Version 1.1...
  • Page 2: Disclaimer, Contact And Liability

    “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.
  • Page 3: Table Of Contents

    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...
  • Page 4: Introduction

    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: Introduction Appendix A - VISCA Settings and Command List User Manual | www.avonic.com...
  • Page 5: Appendix C - Http Api

    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...
  • Page 6: Curl

    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...
  • Page 7: 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...
  • Page 8: Http Api Code List

    PTZ speed Set PTZ Speed Command Code Command Setting szCmd {"SetEnv":{"PTZSpeed": nPTZSpeed 0: Slow {"nPTZSpeed":1}}} 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...
  • Page 9 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 emAFMode 2: Auto 3: Manual 4 OnePush User Manual | www.avonic.com...
  • Page 10: Audio

    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 User Manual | www.avonic.com...
  • Page 11: Video

    Image Size {"SetEnv":{"VideoEncode":[{"stMaster": emImageSize 5: 1920*1080 {"emImageSize":4},"nChannel":0}]}} 4: 1280*720 9: 640*480 27: 320*180 26: 640*360 Rate Control {"SetEnv":{"VideoEncode":[{"stMaster": emBitRateCtrl 0: CBR {"emBitRateCtrl":1},"nChannel":0}]}} 1: VBR User Manual | www.avonic.com...
  • Page 12 2: srt 3: rtmp Host Address {"SetEnv":{"StreamPublish":[{"stMaster": szHostUrl user-defined {"wHostPort":1935,"nProtolType":3",szHostUrl": "192.168.5.12"},"nChannel":0}]}} Host Port {"SetEnv":{"StreamPublish":[{"stMaster": wHostPort [0,65535] {"wHostPort":19355,"nProtolType":3},"nChannel":0}]}} Stream Name {"SetEnv":{"StreamPublish":[{"stMaster": szStreamName user-defined {"wHostPort":19355,"nProtolType":3,"szStreamName":"live/1213"}, "nChannel":0}]}} User Name {"SetEnv":{"StreamPublish":[{"stMaster": szUserName user-defined {"wHostPort":19355,"nProtolType":3,"szUserName":"123"}, "nChannel":0}]}} Password {"SetEnv":{"StreamPublish":[{"stMaster": szPassword user-defined {"wHostPort":19355,"nProtolType":3,"szPassword":"123"}, "nChannel":0}]}} User Manual | www.avonic.com...
  • Page 13 {"bEnable":1,"wMultiCastPort":4004},"nChannel":0}]}} Camera Settings Video Parameters Get video parameters Code {"GetEnv":{"VideoParam":{"nChannel":-1}}} Set video parameters Focus Function Code Command Setting Focus Mode {"SetEnv": emAFMode Auto {"VideoParam": Manual [{"stAF": OnePush {"emAFMode":2},"nChannel":0}]}} AF-Zone {"SetEnv": emAFZone {"VideoParam": Center [{"stAF": Bottom {"emAFZone":1},"nChannel":0}]}} User Manual | www.avonic.com...
  • Page 14 {"SetEnv":{"VideoParam":[{"stExp": [0, 8] {"drc":6},"nChannel":0}]}} Exposure: Manual shutter {"SetEnv":{"VideoParam": nShutter [0, 16] [{"stExp":{"stShutter": {"nShutter":16}},"nChannel":0}]}} Iris {"SetEnv":{"VideoParam":[{"stExp":{"stIris": nIris [0, 12] {"nIris":12}},"nChannel":0}]}} {"SetEnv":{"VideoParam":[{"stExp": [0, 8] {"drc":8},"nChannel":0}]}} Exposure: SAE shutter {"SetEnv":{"VideoParam": nShutter [0, 16] [{"stExp":{"stShutter": {"nShutter":16}},"nChannel":0}]}} {"SetEnv":{"VideoParam":[{"stExp": [0, 8] {"drc":7},"nChannel":0}]}} User Manual | www.avonic.com...
  • Page 15 7000K Manual OnePush {"SetEnv":{"VideoParam": rgaintuning [0, 20] Tuning [{"stColor": {"rgaintuning":0},"nChannel":0}]}} {"SetEnv":{"VideoParam": bgaintuning [0, 20] Tuning [{"stColor": {"bgaintuning":20},"nChannel":0}]}} Saturation {"SetEnv":{"VideoParam": saturation [0, 14] [{"stColor": {"saturation":0},"nChannel":0}]}} {"SetEnv":{"VideoParam": [0, 14] [{"stColor": {"hue":14},"nChannel":0}]}} {"SetEnv":{"VideoParam": awbsens Sensitivity [{"stColor": Middle {"awbsens":0},"nChannel":0}]}} High User Manual | www.avonic.com...
  • Page 16 NR-3D {"SetEnv":{"VideoParam":[{"stNR": noise3D [0, 8] 0: OFF {"noise3D":0},"nChannel":0}]}} 8: Auto Dynamic Hot {"SetEnv":{"VideoParam":[{"stNR": dhotpixel [0, 5] 0: OFF Pixel {"dhotpixel":3},"nChannel":0}]}} Style {"SetEnv":{"VideoParam":[{"stColor": nStyleInx [0, 4] 0: Default {"nStyleInx":0},"nChannel":0}]}} 1: Normal 2: Clarity 3: Bright 4: Soft User Manual | www.avonic.com...
  • Page 17 Time: {"SetEnv":{"VideoOsd":[{"stTime": nXPos [0, 10000] {"nXPos":9200},"nChannel":0}]}} Title: {"SetEnv":{"VideoOsd":[{"stTitle": {"nXPos":9200},"nChannel":0}]}} OSD Offsety pos Time: {"SetEnv":{"VideoOsd":[{"stTime": nYPos [0, 10000] {"nYPos":1200},"nChannel":0}]}} Title: {"SetEnv":{"VideoOsd":[{"stTitle": {"nYPos":1200},"nChannel":0}]}} 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...
  • Page 18 1080P29.97 720P59.94 720P29.97 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...
  • Page 19: Network

    {"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"}]}}} 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...
  • Page 20: System

    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...
  • Page 21 Function Code Command Setting Authority nUserType 0: admin 1: user1 or user 2 User Name szUserName user-defined: no white space Password szPassword user-defined, no white space. This command must set three users at the same time. User Manual | www.avonic.com...
  • Page 22 {"SysCtrl":{"Default":{}}} Reboot Code {"SysCtrl":{"Reboot":{}}} The URL supports to set all params at one time and also can set one of them through split URL into one other command. Different commands can be found at different settings. User Manual | www.avonic.com...
  • Page 23 HTTP API for CM7x-IP series CM70-IP/CM71-IP/CM73-IP Version 1.1 © March 2022...

This manual is also suitable for:

Cm70-ipCm71-ipCm73-ip

Table of Contents