API Overview

Bolin API is convenient for developers to interact with devices, such as search and discovery, and obtain basic information of devices (firmware version number, device name and status, etc.). The API interface is based on HTTP protocol, which is a lightweight, stateless interface. The response Data is in JSON format. Through the guide document, you can understand the specific functions and request methods of each API of the device in detail.

Protocol version: 2.0
Published: 1st Aug 2025

1.1 Description of interface conventions

The default port for API following HTTP Port, which can be modified. This port following the WEBGUI (80) port.
The API request is the http protocol.
The API request is a post request, and both the request payload and the response payload are json text, encoded as uft-8.

1.2 Released Note

DateVersionNoted
2025-05-12V2.0Correct Some error information, Modified the Status Codes.

 

 

Discovery

Client multicast address: 239.255.255.250:16001
Client broadcast address: 255.255.255.255:16002

Broadcast or Multicast request to get network parameters, must carry MAC address, used when matching on the device side; must carry Magic, value fixed as “FF3AA4E07C687FE422A3031BC19255A4”, indicating Bolin's broadcast or multicast packet

  • “Magic": ‘2D374C8A39D7485637ADA1CC50EB51CE’//BOLIN
  • “Magic": ‘2D374C8A39D7485637ADA1CC50EB51CA’//Adapter-1
  • “Magic": ‘2D374C8A39D7485637ADA1CC50EB51CB’//Adapter-2
  • “Magic": ‘2D374C8A39D7485637ADA1CC50EB51CD’//Adapter-3

POSTapiv2/discovery

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -d '{\"Cmd\":\"ReqDiscovery\",\"Content\":{\"DeviceInfo\":{\"Magic\":\"FF3AA4E07C687FE422A3031BC19255A4\"}}}' http://example.com/apiv2/discovery

Sample Request

{
    "Cmd": "ReqDiscovery",
    "Content": {
        "DeviceInfo": {
            "Magic": "FF3AA4E07C687FE422A3031BC19255A4"
        }
    }
}

Response

{
    "Cmd": "AswDiscovery",
    "Version": "2.00.000",
    "Content": {
        "Magic": "2D374C8A39D7485637ADA1CC50EB51CE",
        "DeviceInfo": {
            "DeviceName": "BOLIN-B6-420N",
            "ModelName": "00000000000",
            "SerialNumber": "22222222222",
            "NetMAC": "44:03:57:82:88:32",
            "IPAddress": "192.168.0.13",
            "SubnetMask": "255.255.255.0",
            "DeviceVer": "C0X1G00070F101001",
            "DeviceIPVer": "P0X1G00070F102232",
            "APIVersion": "2.0.000",
            "DeviceType": 2,
            "DeviceScheme": 2,
            "SoftwareDate": "20241114",
            "BolinNDIDevice": true,
            "BolinDanteDevice": false
        },
        "Status": 0
    }
}

Parameters

  • Magic
  • DeviceInfo
    Show properties
    • DeviceName(Optional)
    • ModelName(Optional)
    • SerialNumber(Optional)
    • NetMAC(Optional)
    • IPAddress(Optional)
    • SubnetMask(Optional)
    • DeviceVer(Optional)
    • DeviceIPVer(Optional)
    • APIVersion(Optional)
    • DeviceType(Optional)
    • DeviceScheme(Optional)
    • SoftwareDate(Optional)
    • BolinNDIDevice(Optional)
    • BolinDanteDevice(Optional)

API Status Codes

nResultNoted
-1ERROR
0STATUS SUCCESS
1STATUS SUCCESS,REBOOTING
2STATUS TIMEOUT
3STATUS INTERRUPTED
4STATUS TRY AGAIN
5STATUS NOT IMPLEMENTED
6STATUS UNKNOWN ERROR
7STATUS INVALID ARG
8STATUS NO MEMORY
9STATUS UNSUPPORTED
10STATUS FILE BUSY
11STATUS DEVICE BUSY
12STATUS DEVICE LOST
13STATUS IO FAILED
14STATUS READ FAILED
15STATUS WRITE FAILED
16STATUS NOT EXIST
17STATUS TOO MANY
18STATUS TOO LARGE
19STATUS OVERFLOW
20STATUS UNDERFLOW
21STATUS FORMAT ERROR
22STATUS FILE EXIST
23STATUS FILE TYPE ERROR
24STATUS DEVICE TYPE ERROR
25STATUS IS DIRECTORY
26STATUS READ ONLY
27STATUS RANGE ERROR
28STATUS BROKEN PIPE
29STATUS NO SPACE
30STATUS NOT DIRECTORY
31STATUS NOT PERMITTED
32STATUS BAD ADDRESS
33STATUS SEEK ERROR
34STATUS CROSS DEVICE LINK
35STATUS NOT INITIALIED
36STATUS AUTH FAILED
37STATUS NOT LOGGED IN
38STATUS WRONG STATE
39STATUS MISMATCH
40STATUS VERIFY FAILED
41STATUS CONSTRAINT VIOLATION
42STATUS CANCELED
43STATUS IN PROGRESS
44STATUS CONN REFUSED
45STATUS CONN RESET
46STATUS ADDR IN USE
47STATUS NO RESPONSE
48STATUS INFO CHANGED
49STATUS INVALID Data
50STATUS NEED MORE Data
51STATUS NO BUFFER
52STATUS BUFFER TOD SMALL
53STATUS BUFFER IS EMPTY
54STATUS BUFFER IS FULL
101STATUS PENDING
102STATUS TIMEOUT
103STATUS INTERRUPTED
104STATUS TRY AGAIN
105STATUS NOT IMPLEMENTED
106STATUS UNKNOWN ERROR
107STATUS INVALID ARG
108STATUS NO MEMORY
109STATUS UNSUPPORTED
110STATUS FILE BUSY
111STATUS DEVICE BUSY
112STATUS DEVICE LOST
113STATUS IO FAILED
114STATUS READ FAILED
115STATUS WRITE FAILED
116STATUS NOT EXIST
117STATUS TOO MANY
118STATUS TOO LARGE
119STATUS OVERFLOW
120STATUS UNDERFLOW
121STATUS FORMAT ERROR
122STATUS FILE EXISTS
123STATUS FILE TYPE ERROR
124STATUS DEVICE TYPE ERROR
125STATUS IS DIRECTORY
126STATUS READ ONLY
127STATUS RANGE ERROR
128STATUS BROKEN PIPE
129STATUS NO SPACE
130STATUS NOT DIRECTORY
131STATUS NOT PERMITTED
132STATUS BAD ADDRESS
133STATUS SEEK ERROR
134STATUS CROSS DEVICE LINK
135STATUS NOT INITIALIED
136STATUS AUTH FAILED
137STATUS NOT LOGGED IN
138STATUS WRONG STATE
139STATUS MISMATCH
140STATUS VERIFY FAILED
141STATUS CONSTRAINT VIOLATION
142STATUS CANCELED
143STATUS IN PROGRESS
144STATUS CONN REFUSED
145STATUS CONN RESET
146STATUS ADDR IN USE
147STATUS NO RESPONSE
148STATUS INFO CHANGED
149STATUS INVALID DATA
150STATUS MISSING PARAMETERS
151STATUS NO BUFFER
152STATUS BUFFER TOD SMALL
153STATUS BUFFER IS EMPTY
154STATUS BUFFER IS FULL
155STATUS WRONG PASSWORD
156STATUS DIFFERENT NETWORK SEGMENTS
157STATUS PORT CONELICT
158STATUS SRT HP CANNOTSAME
159STATUS SRT SP CANNOTSAME
160STATUS LIST FULL
161STATUS LENGTH ERROR
162STATUS ALREADY EXISTS
163STATUS ALREADY BEING UPDATED
164STATUS UPDATE ERROR
165STATUS INVALID UPLOAD FILE
166STATUS ILLEGAL FILE TYPE
167STATUS FILE SIZE OVERRANGE
168STATUS NOT 32 BIT DEPTH
169STATUS INVALID FILE HEAD
170STATUS NO ALPHA CHANNEL
171STATUS RESOLUTION OVERRANGE
172STATUS INVALID TYPE
173STATUS STRING TOO LONG
174STATUS SAME VALUE
175STATUS ILLEGAL ARG
176STATUS STRING TOO SHORT

API General Parameters

NameTypeMust haveNoted
TokenStringYESThe default Token is required.
CmdStringYESAPI Method
VersionStringYESCurrent request API version

API Request General Path

An API URL Path is an address that allows you to access an API and its various features. 

POST: http://IP:Port/apiv2/"XXX"   ("XXX" is the interface need to implement.)

API Capability Set Data Type

ValTypeValNoted
int0Integer, needs to have Data range min, max
float1Floating point number, needs to have Data range min, max
string2String, utf8 encoding supports multiple Languages
enum3Array enumeration type, utf encoding, supports multiple
Languages, mainly used for drop-down box type selection
parameters, such as white balance mode switching, switch
switching, etc. [{automatic mode},{manual mode},{automatic
tracking},{indoor mode},{outdoor mode},{one-key mode}]
[{on},{off},{auto}]
[{open},{close},{auto}]
etc.
bool40/1,open/close, default 0 is disable, 1 is enable
version9Protocol cluster type, different versions correspond to different
protocol clusters

ReqHttpLogin

When a client requests to log in, it sends Username, Salt, Sign, and the server generates its own Sign based on the Password and Salt it receives and checks it against the Sign sent by the client, and if the check is correct, the log in is considered successful.

*Token uses a sliding time mechanism that starts at the point of last use and expires after 6 hours

Generated Sign:
POSTapiv2/login

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -d '{\"Cmd\":\"ReqHttpLogin\",\"Version\":\"2.0.000\",\"Content\":{\"LoginInfo\":{\"Username\":\"admin\",\"Salt\":\"s9u0gnFjDVs9exu49T83Sl8fERzFDcRS\",\"Sign\":\"d3a2dbdc011958a1f64747ab44824195\"}}}' http://example.com/apiv2/login

Sample Request

{
    "Cmd": "ReqHttpLogin",
    "Version": "2.0.000",
    "Content": {
        "LoginInfo": {
            "Username": "admin",
            "Salt": "s9u0gnFjDVs9exu49T83Sl8fERzFDcRS",
            "Sign": "d3a2dbdc011958a1f64747ab44824195"
        }
    }
}

Response

{
    "Cmd": "AswHttpLogin",
    "Version": "2.00.000",
    "Content": {
        "Status": 0,
        "Token": {
            "Value": "8V8hWpvA18g5bxpGRV8JuV8h9hO6PKzG"
        }
    }
}

Parameters

  • LoginInfo
    Show properties
    • Saltstring(Optional)
      Description: A random string of length 32
    • Signstring(Optional)
      Description: Sign Generation Method MD5(toUpperCase(sha256(password)+Salt))

ReqGetLoginCapabilities

POSTapiv2/login

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -d '{\"Cmd\":\"ReqGetLoginCapabilities\",\"Version\":\"2.00.000\"}' http://example.com/apiv2/login

Sample Request

{
    "Cmd": "ReqGetLoginCapabilities",
    "Version": "2.00.000"
}

Response

{
    "Cmd": "AswGetLoginCapabilities",
    "Version": "2.00.000",
    "Content": {
        "LoginInfo": {
            "Username": {
                "Type": "string",
                "Readonly": false,
                "Description": "UserName",
                "Data": {
                    "MinLen": 1,
                    "MaxLen": 32
                }
            },
            "Salt": {
                "Type": "string",
                "Readonly": false,
                "Description": "A random string of length 32",
                "Data": {
                    "MinLen": 32,
                    "MaxLen": 32
                }
            },
            "Sign": {
                "Type": "string",
                "Readonly": false,
                "Description": "Sign Generation Method MD5(toUpperCase(sha256(password)+Salt))",
                "Data": {
                    "MinLen": 32,
                    "MaxLen": 64
                }
            }
        },
        "Status": 0
    }
}

Parameters

  • LoginInfo
    Show properties
    • Saltstring(Optional)
      Description: A random string of length 32
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • Signstring(Optional)
      Description: Sign Generation Method MD5(toUpperCase(sha256(password)+Salt))
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)

ReqGetSystemCapabilities

POSTapiv2/system

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetSystemCapabilities\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/system

Sample Request

{
    "Cmd": "ReqGetSystemCapabilities",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetSystemCapabilities",
    "Version": "2.00.000",
    "Content": {
        "SystemInfo": {
            "DeviceName": {
                "Type": "string",
                "Readonly": false,
                "Description": "DeviceName",
                "Data": {
                    "MinLen": 1,
                    "MaxLen": 32
                }
            },
            "ModelName": {
                "Type": "string",
                "Readonly": true,
                "Description": "ModelName",
                "Data": {
                    "MinLen": 1,
                    "MaxLen": 32
                }
            },
            "FirmwareVersion": {
                "Type": "string",
                "Readonly": true,
                "Description": "FirmwareVersion",
                "Data": {
                    "MinLen": 1,
                    "MaxLen": 64
                }
            },
            "SerialNumber": {
                "Type": "string",
                "Readonly": true,
                "Description": "SerialNumber",
                "Data": {
                    "MinLen": 1,
                    "MaxLen": 32
                }
            },
            "IPEncoderVersion": {
                "Type": "string",
                "Readonly": true,
                "Description": "IPEncoderVersion",
                "Data": {
                    "MinLen": 1,
                    "MaxLen": 64
                }
            },
            "MCUVersion": {
                "Type": "string",
                "Readonly": true,
                "Description": "MCUVersion",
                "Data": {
                    "MinLen": 1,
                    "MaxLen": 64
                }
            },
            "FPGAVersion": {
                "Type": "string",
                "Readonly": true,
                "Description": "FPGAVersion",
                "Data": {
                    "MinLen": 1,
                    "MaxLen": 64
                }
            }
        },
        "SystemTimeInfo": {
            "TimeSyncMode": {
                "Type": "enum",
                "Readonly": false,
                "Description": "TimeSyncMode",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "Manual Set"
                    },
                    {
                        "Value": 1,
                        "Description": "Sync NTP Server"
                    }
                ]
            },
            "DateMode": {
                "Type": "enum",
                "Readonly": false,
                "Description": "DateMode",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "Y-M-D"
                    },
                    {
                        "Value": 1,
                        "Description": "D/M/Y"
                    }
                ]
            },
            "TimeMode ": {
                "Type": "enum",
                "Readonly": false,
                "Description": "TimeMode",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "24H:H-M-S"
                    },
                    {
                        "Value": 1,
                        "Description": "12H:H-M-S"
                    },
                    {
                        "Value": 2,
                        "Description": "24H:H-M-S-MS"
                    },
                    {
                        "Value": 3,
                        "Description": "12H:H-M-S—MS"
                    }
                ]
            },
            "TimeZone ": {
                "Type": "enum",
                "Readonly": false,
                "Description": "TimeZone",
                "Data": [
                    {
                        "Value": "Etc/GMT+12",
                        "Description": "(UTC-12:00) International Date Line West"
                    },
                    {
                        "Value": "Etc/GMT+11",
                        "Description": "(UTC-11:00) Coordinated Universal Time-11"
                    },
                    {
                        "Value": "US/Aleutian",
                        "Description": "(UTC-10:00) Aleutian Islands"
                    },
                    {
                        "Value": "US/Hawaii",
                        "Description": "(UTC-10:00) Hawaii"
                    },
                    {
                        "Value": "Pacific/Marquesas",
                        "Description": "(UTC-09:30) Marquesas Islands"
                    },
                    {
                        "Value": "US/Alaska",
                        "Description": "(UTC-09:00) Alaska"
                    },
                    {
                        "Value": "Etc/GMT+9",
                        "Description": "(UTC-09:00) Coordinated Universal Time-09"
                    },
                    {
                        "Value": "US/Pacific",
                        "Description": "(UTC-08:00) Pacific Time (US & Canada)"
                    },
                    {
                        "Value": "Mexico/BajaNorte",
                        "Description": "(UTC-08:00) Baja California"
                    },
                    {
                        "Value": "Etc/GMT+8",
                        "Description": "(UTC-08:00) Coordinated Universal Time-08"
                    },
                    {
                        "Value": "America/Mazatlan",
                        "Description": "(UTC-07:00) La Paz, Mazatlan"
                    },
                    {
                        "Value": "US/Mountain",
                        "Description": "(UTC-07:00) Mountain Time (US & Canada)"
                    },
                    {
                        "Value": "US/Arizona",
                        "Description": "(UTC-07:00) Arizona"
                    },
                    {
                        "Value": "Canada/Yukon",
                        "Description": "(UTC-07:00) Yukon"
                    },
                    {
                        "Value": "Chile/EasterIsland",
                        "Description": "(UTC-06:00) Easter Island"
                    },
                    {
                        "Value": "America/Mexico_City",
                        "Description": "(UTC-06:00) Guadalajara, Mexico City, Monterrey"
                    },
                    {
                        "Value": "Canada/Saskatchewan",
                        "Description": "(UTC-06:00) Saskatchewan"
                    },
                    {
                        "Value": "US/Central",
                        "Description": "(UTC-06:00) Central Time (US & Canada)"
                    },
                    {
                        "Value": "America/Bogota",
                        "Description": "(UTC-05:00) Bogota, Lima, Quito, Rio Branco"
                    },
                    {
                        "Value": "US/Eastern",
                        "Description": "(UTC-05:00) US/Eastern"
                    },
                    {
                        "Value": "America/Havana",
                        "Description": "(UTC-05:00) America/Havana"
                    },
                    {
                        "Value": "America/Port-au-Prince",
                        "Description": "(UTC-05:00) America/Port-au-Prince"
                    },
                    {
                        "Value": "Etc/GMT+5",
                        "Description": "(UTC-05:00) Etc/GMT+5"
                    },
                    {
                        "Value": "America/Grand_Turk",
                        "Description": "(UTC-05:00) America/Grand_Turk"
                    },
                    {
                        "Value": "US/East-Indiana",
                        "Description": "(UTC-05:00) US/East-Indiana"
                    },
                    {
                        "Value": "Canada/Atlantic",
                        "Description": "(UTC-04:00) Canada/Atlantic"
                    },
                    {
                        "Value": "America/Caracas",
                        "Description": "(UTC-04:00) America/Caracas"
                    },
                    {
                        "Value": "America/Cuiaba",
                        "Description": "(UTC-04:00) America/Cuiaba"
                    },
                    {
                        "Value": "America/Manaus",
                        "Description": "(UTC-04:00) Georgetown, La Paz, Manaus, San Juan"
                    },
                    {
                        "Value": "America/Santiago",
                        "Description": "(UTC-04:00) Santiago"
                    },
                    {
                        "Value": "America/Asuncion",
                        "Description": "(UTC-04:00) Asuncion"
                    },
                    {
                        "Value": "Canada/Newfoundland",
                        "Description": "(UTC-03:30) Newfoundland"
                    },
                    {
                        "Value": "America/Araguaina",
                        "Description": "(UTC-03:00) Araguaina"
                    },
                    {
                        "Value": "America/Sao_Paulo",
                        "Description": "(UTC-03:00) Brasilia"
                    },
                    {
                        "Value": "America/Argentina/Buenos_Aires",
                        "Description": "(UTC-03:00) City of Buenos Aires"
                    },
                    {
                        "Value": "America/Cayenne",
                        "Description": "(UTC-03:00) Cayenne, Fortaleza"
                    },
                    {
                        "Value": "America/Montevideo",
                        "Description": "(UTC-03:00) Montevideo"
                    },
                    {
                        "Value": "America/Punta_Arenas",
                        "Description": "(UTC-03:00) Punta Arenas"
                    },
                    {
                        "Value": "America/Bahia",
                        "Description": "(UTC-03:00) Salvador"
                    },
                    {
                        "Value": "America/Miquelon",
                        "Description": "(UTC-03:00) Saint Pierre and Miquelon"
                    },
                    {
                        "Value": "America/Nuuk",
                        "Description": "(UTC-02:00) Greenland"
                    },
                    {
                        "Value": "Etc/GMT+2",
                        "Description": "(UTC-02:00) Coordinated Universal Time-02"
                    },
                    {
                        "Value": "Atlantic/Azores",
                        "Description": "(UTC-01:00) Azores"
                    },
                    {
                        "Value": "Atlantic/Cape_Verde",
                        "Description": "(UTC-01:00) Cabo Verde Is."
                    },
                    {
                        "Value": "Etc/UTC",
                        "Description": "(UTC+00:00) Coordinated Universal Time"
                    },
                    {
                        "Value": "Europe/London",
                        "Description": "(UTC+00:00) Dublin, Edinburgh, Lisbon, London"
                    },
                    {
                        "Value": "Africa/Monrovia",
                        "Description": "(UTC+00:00) Monrovia, Reykjavik"
                    },
                    {
                        "Value": "Africa/Sao_Tome",
                        "Description": "(UTC+00:00) Sao Tome"
                    },
                    {
                        "Value": "Europe/Amsterdam",
                        "Description": "(UTC+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna"
                    },
                    {
                        "Value": "Europe/Belgrade",
                        "Description": "(UTC+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague"
                    },
                    {
                        "Value": "Europe/Brussels",
                        "Description": "(UTC+01:00) Brussels, Copenhagen, Madrid, Paris"
                    },
                    {
                        "Value": "Europe/Sarajevo",
                        "Description": "(UTC+01:00) Sarajevo, Skopje, Warsaw, Zagreb"
                    },
                    {
                        "Value": "Africa/Algiers",
                        "Description": "(UTC+01:00) West Central Africa"
                    },
                    {
                        "Value": "Asia/Beirut",
                        "Description": "(UTC+02:00) Beirut"
                    },
                    {
                        "Value": "Africa/Tripoli",
                        "Description": "(UTC+02:00) Tripoli"
                    },
                    {
                        "Value": "Africa/Harare",
                        "Description": "(UTC+02:00) Harare, Pretoria"
                    },
                    {
                        "Value": "Europe/Helsinki",
                        "Description": "(UTC+02:00) Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius"
                    },
                    {
                        "Value": "Europe/Kaliningrad",
                        "Description": "(UTC+02:00) Kaliningrad"
                    },
                    {
                        "Value": "Asia/Gaza",
                        "Description": "(UTC+02:00) Gaza, Hebron"
                    },
                    {
                        "Value": "Africa/Khartoum",
                        "Description": "(UTC+02:00) Khartoum"
                    },
                    {
                        "Value": "Africa/Cairo",
                        "Description": "(UTC+02:00) Cairo"
                    },
                    {
                        "Value": "Africa/Windhoek",
                        "Description": "(UTC+02:00) Windhoek"
                    },
                    {
                        "Value": "Europe/Athens",
                        "Description": "(UTC+02:00) Athens, Bucharest"
                    },
                    {
                        "Value": "Asia/Jerusalem",
                        "Description": "(UTC+02:00) Jerusalem"
                    },
                    {
                        "Value": "Africa/Juba",
                        "Description": "(UTC+02:00) Juba"
                    },
                    {
                        "Value": "Asia/Amman",
                        "Description": "(UTC+03:00) Amman"
                    },
                    {
                        "Value": "Asia/Baghdad",
                        "Description": "(UTC+03:00) Baghdad"
                    },
                    {
                        "Value": "Asia/Damascus",
                        "Description": "(UTC+03:00) Damascus"
                    },
                    {
                        "Value": "Europe/Volgograd",
                        "Description": "(UTC+03:00) Volgograd"
                    },
                    {
                        "Value": "Asia/Kuwait",
                        "Description": "(UTC+03:00) Kuwait, Riyadh"
                    },
                    {
                        "Value": "Europe/Minsk",
                        "Description": "(UTC+03:00) Minsk"
                    },
                    {
                        "Value": "Europe/Moscow",
                        "Description": "(UTC+03:00) Moscow, St. Petersburg"
                    },
                    {
                        "Value": "Africa/Nairobi",
                        "Description": "(UTC+03:00) Nairobi"
                    },
                    {
                        "Value": "Asia/Istanbul",
                        "Description": "(UTC+03:00) Istanbul"
                    },
                    {
                        "Value": "Asia/Tehran",
                        "Description": "(UTC+03:30) Tehran"
                    },
                    {
                        "Value": "Asia/Muscat",
                        "Description": "(UTC+04:00) Abu Dhabi, Muscat"
                    },
                    {
                        "Value": "Europe/Astrakhan",
                        "Description": "(UTC+04:00) Astrakhan, Ulyanovsk"
                    },
                    {
                        "Value": "Asia/Yerevan",
                        "Description": "(UTC+04:00) Yerevan"
                    },
                    {
                        "Value": "Asia/Baku",
                        "Description": "(UTC+04:00) Baku"
                    },
                    {
                        "Value": "Asia/Tbilisi",
                        "Description": "(UTC+04:00) Tbilisi"
                    },
                    {
                        "Value": "Indian/Mauritius",
                        "Description": "(UTC+04:00) Port Louis"
                    },
                    {
                        "Value": "Europe/Saratov",
                        "Description": "(UTC+04:00) Saratov"
                    },
                    {
                        "Value": "Europe/Samara",
                        "Description": "(UTC+04:00) Izhevsk, Samara"
                    },
                    {
                        "Value": "Asia/Kabul",
                        "Description": "(UTC+04:30) Kabul"
                    },
                    {
                        "Value": "Asia/Ashgabat",
                        "Description": "(UTC+05:00) Ashgabat, Tashkent"
                    },
                    {
                        "Value": "Asia/Almaty",
                        "Description": "(UTC+05:00) Astana"
                    },
                    {
                        "Value": "Asia/Yekaterinburg",
                        "Description": "(UTC+05:00) Yekaterinburg"
                    },
                    {
                        "Value": "Asia/Karachi",
                        "Description": "(UTC+05:00) Islamabad, Karachi"
                    },
                    {
                        "Value": "Asia/Kolkata",
                        "Description": "(UTC+05:30) Chennai, Kolkata, Mumbai, New Delhi"
                    },
                    {
                        "Value": "Asia/Colombo",
                        "Description": "(UTC+05:30) Sri Lanka"
                    },
                    {
                        "Value": "Asia/Kathmandu",
                        "Description": "(UTC+05:45) Kathmandu"
                    },
                    {
                        "Value": "Asia/Dhaka",
                        "Description": "(UTC+06:00) Dhaka"
                    },
                    {
                        "Value": "Asia/Omsk",
                        "Description": "(UTC+06:00) Omsk"
                    },
                    {
                        "Value": "Asia/Yangon",
                        "Description": "(UTC+06:30) Yangon"
                    },
                    {
                        "Value": "Asia/Barnaul",
                        "Description": "(UTC+07:00) Barnaul, Gorno-Altaysk"
                    },
                    {
                        "Value": "Asia/Hovd",
                        "Description": "(UTC+07:00) Hovd"
                    },
                    {
                        "Value": "Asia/Krasnoyarsk",
                        "Description": "(UTC+07:00) Krasnoyarsk"
                    },
                    {
                        "Value": "Asia/Bangkok",
                        "Description": "(UTC+07:00) Bangkok, Hanoi, Jakarta"
                    },
                    {
                        "Value": "Asia/Tomsk",
                        "Description": "(UTC+07:00) Tomsk"
                    },
                    {
                        "Value": "Asia/Novosibirsk",
                        "Description": "(UTC+07:00) Novosibirsk"
                    },
                    {
                        "Value": "Asia/Shanghai",
                        "Description": "(UTC+08:00) Beijing, Chongqing, Hong Kong, Urumqi, Taipei"
                    },
                    {
                        "Value": "Asia/Kuala_Lumpur",
                        "Description": "(UTC+08:00) Kuala Lumpur, Singapore"
                    },
                    {
                        "Value": "Australia/Perth",
                        "Description": "(UTC+08:00) Perth"
                    },
                    {
                        "Value": "Asia/Ulaanbaatar",
                        "Description": "(UTC+08:00) Ulaanbaatar"
                    },
                    {
                        "Value": "Asia/Irkutsk",
                        "Description": "(UTC+08:00) Irkutsk"
                    },
                    {
                        "Value": "Australia/Eucla",
                        "Description": "(UTC+08:45) Eucla"
                    },
                    {
                        "Value": "Asia/Chita",
                        "Description": "(UTC+09:00) Chita"
                    },
                    {
                        "Value": "Asia/Tokyo",
                        "Description": "(UTC+09:00) Osaka, Sapporo, Tokyo"
                    },
                    {
                        "Value": "Asia/Pyongyang",
                        "Description": "(UTC+09:00) Pyongyang"
                    },
                    {
                        "Value": "Asia/Seoul",
                        "Description": "(UTC+09:00) Seoul"
                    },
                    {
                        "Value": "Asia/Yakutsk",
                        "Description": "(UTC+09:00) Yakutsk"
                    },
                    {
                        "Value": "Australia/Adelaide",
                        "Description": "(UTC+09:30) Adelaide"
                    },
                    {
                        "Value": "Australia/Darwin",
                        "Description": "(UTC+09:30) Darwin"
                    },
                    {
                        "Value": "Australia/Brisbane",
                        "Description": "(UTC+10:00) Brisbane"
                    },
                    {
                        "Value": "Asia/Vladivostok",
                        "Description": "(UTC+10:00) Vladivostok"
                    },
                    {
                        "Value": "Pacific/Guam",
                        "Description": "(UTC+10:00) Guam, Port Moresby"
                    },
                    {
                        "Value": "Australia/Hobart",
                        "Description": "(UTC+10:00) Hobart"
                    },
                    {
                        "Value": "Australia/Sydney",
                        "Description": "(UTC+10:00) Canberra, Melbourne, Sydney"
                    },
                    {
                        "Value": "Australia/Lord_Howe",
                        "Description": "(UTC+10:30) Lord Howe Island"
                    },
                    {
                        "Value": "Pacific/Bougainville",
                        "Description": "(UTC+11:00) Bougainville Island"
                    },
                    {
                        "Value": "Asia/Magadan",
                        "Description": "(UTC+11:00) Magadan"
                    },
                    {
                        "Value": "Pacific/Norfolk",
                        "Description": "(UTC+11:00) Norfolk Island"
                    },
                    {
                        "Value": "Etc/GMT-11",
                        "Description": "(UTC+11:00) Chokurdakh"
                    },
                    {
                        "Value": "Asia/Sakhalin",
                        "Description": "(UTC+11:00) Sakhalin"
                    },
                    {
                        "Value": "Pacific/Noumea",
                        "Description": "(UTC+11:00) Solomon Is., New Caledonia"
                    },
                    {
                        "Value": "Asia/Anadyr",
                        "Description": "(UTC+12:00) Anadyr, Petropavlovsk-Kamchatsky"
                    },
                    {
                        "Value": "Pacific/Auckland",
                        "Description": "(UTC+12:00) Auckland, Wellington"
                    },
                    {
                        "Value": "Pacific/Fiji",
                        "Description": "(UTC+12:00) Fiji"
                    },
                    {
                        "Value": "Etc/GMT-12",
                        "Description": "(UTC+12:00) Coordinated Universal Time+12"
                    },
                    {
                        "Value": "Pacific/Chatham",
                        "Description": "(UTC+12:45) Chatham Islands"
                    },
                    {
                        "Value": "Pacific/Tongatapu",
                        "Description": "(UTC+13:00) Nuku alofa"
                    },
                    {
                        "Value": "Pacific/Samoa",
                        "Description": "(UTC+13:00) Samoa"
                    },
                    {
                        "Value": "Etc/GMT-13",
                        "Description": "(UTC+13:00) Coordinated Universal Time+13"
                    },
                    {
                        "Value": "Etc/GMT-14",
                        "Description": "(UTC+14:00) Kiritimati Island"
                    }
                ]
            },
            "NTPInfo": {
                "Type": "father-node",
                "Readonly": false,
                "Description": "NTPType",
                "ServerAddr": {
                    "Type": "string",
                    "Readonly": false,
                    "Description": "NTPSever Address",
                    "Data": {
                        "MinLen": 1,
                        "MaxLen": 127
                    }
                },
                "Port": {
                    "Type": "range",
                    "Readonly": false,
                    "Description": "NTPSever Port",
                    "Data": {
                        "Min": 1,
                        "Max": 65535
                    }
                }
            },
            "LocalTime": {
                "Type": "father-node",
                "Readonly": false,
                "Description": "LocalTime",
                "Year": {
                    "Type": "range",
                    "Readonly": false,
                    "Description": "Year",
                    "Data": {
                        "Min": 1970,
                        "Max": 2037
                    }
                },
                "Month": {
                    "Type": "range",
                    "Readonly": false,
                    "Description": "Month",
                    "Data": {
                        "Min": 1,
                        "Max": 12
                    }
                },
                "Day": {
                    "Type": "range",
                    "Readonly": false,
                    "Description": "Day",
                    "Data": {
                        "Min": 1,
                        "Max": 31
                    }
                },
                "Hour": {
                    "Type": "range",
                    "Readonly": false,
                    "Description": "Hour",
                    "Data": {
                        "Min": 0,
                        "Max": 23
                    }
                },
                "Minute": {
                    "Type": "range",
                    "Readonly": false,
                    "Description": "Minute",
                    "Data": {
                        "Min": 0,
                        "Max": 59
                    }
                },
                "Second": {
                    "Type": "range",
                    "Readonly": false,
                    "Description": "Second",
                    "Data": {
                        "Min": 0,
                        "Max": 59
                    }
                }
            },
            "UpdateTime": {
                "Type": "enum",
                "Readonly": false,
                "Description": "UpdateTime",
                "Data": [
                    {
                        "Value": 10,
                        "Description": "10 Minutes"
                    },
                    {
                        "Value": 30,
                        "Description": "30 Minutes"
                    },
                    {
                        "Value": 60,
                        "Description": "60 Minutes"
                    },
                    {
                        "Value": 1440,
                        "Description": "1440 Minutes"
                    }
                ]
            }
        },
        "AutoRestartInfo": {
            "Type": {
                "Type": "enum",
                "Readonly": false,
                "Description": "AutoRestart",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "Never"
                    },
                    {
                        "Value": 1,
                        "Description": "Every Day"
                    },
                    {
                        "Value": 2,
                        "Description": "Every Week"
                    },
                    {
                        "Value": 3,
                        "Description": "Every Month"
                    }
                ]
            },
            "Day": {
                "Type": "range",
                "Readonly": false,
                "Description": "Day,When the restart Type is 2, the range is 0-6, representing Sunday and Monday-Saturday, and when the Type is 3, representing the 1st-31st, respectively",
                "Data": {
                    "Min": 0,
                    "Max": 31
                }
            },
            "Hour": {
                "Type": "range",
                "Readonly": false,
                "Description": "Hour",
                "Data": {
                    "Min": 0,
                    "Max": 23
                }
            },
            "Minute": {
                "Type": "range",
                "Readonly": false,
                "Description": "Minute",
                "Data": {
                    "Min": 0,
                    "Max": 59
                }
            }
        },
        "ResetInfo": {
            "Module": {
                "Type": "string",
                "Readonly": false,
                "Description": "ResetInfo",
                "Data": [
                    {
                        "Value": "all_but_net",
                        "Description": "all_but_net"
                    },
                    {
                        "Value": "image",
                        "Description": "image"
                    },
                    {
                        "Value": "network",
                        "Description": "network"
                    },
                    {
                        "Value": "overlay",
                        "Description": "overlay"
                    },
                    {
                        "Value": "audio",
                        "Description": "audio"
                    },
                    {
                        "Value": "encode",
                        "Description": "encode"
                    },
                    {
                        "Value": "all",
                        "Description": "all"
                    }
                ]
            }
        },
        "UserInfo": {
            "Name": {
                "Type": "string",
                "Readonly": false,
                "Description": "Username",
                "Data": {
                    "MinLen": 0,
                    "MaxLen": 16
                }
            },
            "Role": {
                "Type": "enum",
                "Readonly": false,
                "Description": "Role",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "Administrator"
                    },
                    {
                        "Value": 1,
                        "Description": "Operator"
                    }
                ]
            },
            "Permissions": {
                "Type": "enum",
                "Readonly": false,
                "Description": "Permissions",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "No Permissions"
                    },
                    {
                        "Value": 64,
                        "Description": "Update Software"
                    },
                    {
                        "Value": 128,
                        "Description": "PTZ Control"
                    },
                    {
                        "Value": 192,
                        "Description": "PTZ Control & Update Software"
                    }
                ]
            },
            "Password": {
                "Type": "string",
                "Readonly": false,
                "Description": "Password",
                "Data": {
                    "MinLen": 0,
                    "MaxLen": 16
                }
            }
        },
        "ManualRestart": {
            "Type": "null",
            "Readonly": false,
            "Description": " Manual Restart"
        },
        "FirmwareUpdate": {
            "Type": "file",
            "Readonly": false,
            "Description": " File Parameters",
            "Size": "The size of the upgrade package cannot exceed 512MB at most.",
            "Format": "The file extension of the upgrade package is dat format."
        },
        "FirmwareUpdateStatus": {
            "Step": {
                "Type": "range",
                "Readonly": false,
                "Description": "Step",
                "Data": {
                    "Min": 0,
                    "Max": 7
                }
            },
            "StepName": {
                "Type": "enum",
                "Readonly": false,
                "Description": "StepName",
                "Data": [
                    {
                        "Value": "app",
                        "Description": "app"
                    },
                    {
                        "Value": "kernel",
                        "Description": "kernel"
                    },
                    {
                        "Value": "uboot",
                        "Description": "uboot"
                    },
                    {
                        "Value": "miniloader",
                        "Description": "miniloader"
                    },
                    {
                        "Value": "extrootfs",
                        "Description": "extrootfs"
                    },
                    {
                        "Value": "mcu",
                        "Description": "mcu"
                    },
                    {
                        "Value": "fpga",
                        "Description": "fpga"
                    }
                ]
            },
            "StepSum": {
                "Type": "range",
                "Readonly": false,
                "Description": "StepSum",
                "Data": {
                    "Min": 0,
                    "Max": 7
                }
            },
            "WaitFlag": {
                "Type": "bool",
                "Readonly": false,
                "Description": "WaitFlag"
            }
        },
        "Status": 0
    }
}

Parameters

  • SystemInfo
    Show properties
    • DeviceNamestring(Optional)
      Description: DeviceName
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • ModelNamestring(Optional)
      Description: ModelName
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • FirmwareVersionstring(Optional)
      Description: FirmwareVersion
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • SerialNumberstring(Optional)
      Description: SerialNumber
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • IPEncoderVersionstring(Optional)
      Description: IPEncoderVersion
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • MCUVersionstring(Optional)
      Description: MCUVersion
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • FPGAVersionstring(Optional)
      Description: FPGAVersion
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
  • SystemTimeInfo
    Show properties
    • TimeSyncModeenum(Optional)
      Description: TimeSyncMode
      Value: : Manual Set, 1: Sync NTP Server
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • DateModeenum(Optional)
      Description: DateMode
      Value: : Y-M-D, 1: D/M/Y
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • TimeMode enum(Optional)
      Description: TimeMode
      Value: : 24H:H-M-S, 1: 12H:H-M-S, 2: 24H:H-M-S-MS, 3: 12H:H-M-S—MS
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • TimeZone enum(Optional)
      Description: TimeZone
      Value: Etc/GMT+12: (UTC-12:00) International Date Line West, Etc/GMT+11: (UTC-11:00) Coordinated Universal Time-11, US/Aleutian: (UTC-10:00) Aleutian Islands, US/Hawaii: (UTC-10:00) Hawaii, Pacific/Marquesas: (UTC-09:30) Marquesas Islands, US/Alaska: (UTC-09:00) Alaska, Etc/GMT+9: (UTC-09:00) Coordinated Universal Time-09, US/Pacific: (UTC-08:00) Pacific Time (US & Canada), Mexico/BajaNorte: (UTC-08:00) Baja California, Etc/GMT+8: (UTC-08:00) Coordinated Universal Time-08, America/Mazatlan: (UTC-07:00) La Paz, Mazatlan, US/Mountain: (UTC-07:00) Mountain Time (US & Canada), US/Arizona: (UTC-07:00) Arizona, Canada/Yukon: (UTC-07:00) Yukon, Chile/EasterIsland: (UTC-06:00) Easter Island, America/Mexico_City: (UTC-06:00) Guadalajara, Mexico City, Monterrey, Canada/Saskatchewan: (UTC-06:00) Saskatchewan, US/Central: (UTC-06:00) Central Time (US & Canada), America/Bogota: (UTC-05:00) Bogota, Lima, Quito, Rio Branco, US/Eastern: (UTC-05:00) US/Eastern, America/Havana: (UTC-05:00) America/Havana, America/Port-au-Prince: (UTC-05:00) America/Port-au-Prince, Etc/GMT+5: (UTC-05:00) Etc/GMT+5, America/Grand_Turk: (UTC-05:00) America/Grand_Turk, US/East-Indiana: (UTC-05:00) US/East-Indiana, Canada/Atlantic: (UTC-04:00) Canada/Atlantic, America/Caracas: (UTC-04:00) America/Caracas, America/Cuiaba: (UTC-04:00) America/Cuiaba, America/Manaus: (UTC-04:00) Georgetown, La Paz, Manaus, San Juan, America/Santiago: (UTC-04:00) Santiago, America/Asuncion: (UTC-04:00) Asuncion, Canada/Newfoundland: (UTC-03:30) Newfoundland, America/Araguaina: (UTC-03:00) Araguaina, America/Sao_Paulo: (UTC-03:00) Brasilia, America/Argentina/Buenos_Aires: (UTC-03:00) City of Buenos Aires, America/Cayenne: (UTC-03:00) Cayenne, Fortaleza, America/Montevideo: (UTC-03:00) Montevideo, America/Punta_Arenas: (UTC-03:00) Punta Arenas, America/Bahia: (UTC-03:00) Salvador, America/Miquelon: (UTC-03:00) Saint Pierre and Miquelon, America/Nuuk: (UTC-02:00) Greenland, Etc/GMT+2: (UTC-02:00) Coordinated Universal Time-02, Atlantic/Azores: (UTC-01:00) Azores, Atlantic/Cape_Verde: (UTC-01:00) Cabo Verde Is., Etc/UTC: (UTC+00:00) Coordinated Universal Time, Europe/London: (UTC+00:00) Dublin, Edinburgh, Lisbon, London, Africa/Monrovia: (UTC+00:00) Monrovia, Reykjavik, Africa/Sao_Tome: (UTC+00:00) Sao Tome, Europe/Amsterdam: (UTC+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna, Europe/Belgrade: (UTC+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague, Europe/Brussels: (UTC+01:00) Brussels, Copenhagen, Madrid, Paris, Europe/Sarajevo: (UTC+01:00) Sarajevo, Skopje, Warsaw, Zagreb, Africa/Algiers: (UTC+01:00) West Central Africa, Asia/Beirut: (UTC+02:00) Beirut, Africa/Tripoli: (UTC+02:00) Tripoli, Africa/Harare: (UTC+02:00) Harare, Pretoria, Europe/Helsinki: (UTC+02:00) Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius, Europe/Kaliningrad: (UTC+02:00) Kaliningrad, Asia/Gaza: (UTC+02:00) Gaza, Hebron, Africa/Khartoum: (UTC+02:00) Khartoum, Africa/Cairo: (UTC+02:00) Cairo, Africa/Windhoek: (UTC+02:00) Windhoek, Europe/Athens: (UTC+02:00) Athens, Bucharest, Asia/Jerusalem: (UTC+02:00) Jerusalem, Africa/Juba: (UTC+02:00) Juba, Asia/Amman: (UTC+03:00) Amman, Asia/Baghdad: (UTC+03:00) Baghdad, Asia/Damascus: (UTC+03:00) Damascus, Europe/Volgograd: (UTC+03:00) Volgograd, Asia/Kuwait: (UTC+03:00) Kuwait, Riyadh, Europe/Minsk: (UTC+03:00) Minsk, Europe/Moscow: (UTC+03:00) Moscow, St. Petersburg, Africa/Nairobi: (UTC+03:00) Nairobi, Asia/Istanbul: (UTC+03:00) Istanbul, Asia/Tehran: (UTC+03:30) Tehran, Asia/Muscat: (UTC+04:00) Abu Dhabi, Muscat, Europe/Astrakhan: (UTC+04:00) Astrakhan, Ulyanovsk, Asia/Yerevan: (UTC+04:00) Yerevan, Asia/Baku: (UTC+04:00) Baku, Asia/Tbilisi: (UTC+04:00) Tbilisi, Indian/Mauritius: (UTC+04:00) Port Louis, Europe/Saratov: (UTC+04:00) Saratov, Europe/Samara: (UTC+04:00) Izhevsk, Samara, Asia/Kabul: (UTC+04:30) Kabul, Asia/Ashgabat: (UTC+05:00) Ashgabat, Tashkent, Asia/Almaty: (UTC+05:00) Astana, Asia/Yekaterinburg: (UTC+05:00) Yekaterinburg, Asia/Karachi: (UTC+05:00) Islamabad, Karachi, Asia/Kolkata: (UTC+05:30) Chennai, Kolkata, Mumbai, New Delhi, Asia/Colombo: (UTC+05:30) Sri Lanka, Asia/Kathmandu: (UTC+05:45) Kathmandu, Asia/Dhaka: (UTC+06:00) Dhaka, Asia/Omsk: (UTC+06:00) Omsk, Asia/Yangon: (UTC+06:30) Yangon, Asia/Barnaul: (UTC+07:00) Barnaul, Gorno-Altaysk, Asia/Hovd: (UTC+07:00) Hovd, Asia/Krasnoyarsk: (UTC+07:00) Krasnoyarsk, Asia/Bangkok: (UTC+07:00) Bangkok, Hanoi, Jakarta, Asia/Tomsk: (UTC+07:00) Tomsk, Asia/Novosibirsk: (UTC+07:00) Novosibirsk, Asia/Shanghai: (UTC+08:00) Beijing, Chongqing, Hong Kong, Urumqi, Taipei, Asia/Kuala_Lumpur: (UTC+08:00) Kuala Lumpur, Singapore, Australia/Perth: (UTC+08:00) Perth, Asia/Ulaanbaatar: (UTC+08:00) Ulaanbaatar, Asia/Irkutsk: (UTC+08:00) Irkutsk, Australia/Eucla: (UTC+08:45) Eucla, Asia/Chita: (UTC+09:00) Chita, Asia/Tokyo: (UTC+09:00) Osaka, Sapporo, Tokyo, Asia/Pyongyang: (UTC+09:00) Pyongyang, Asia/Seoul: (UTC+09:00) Seoul, Asia/Yakutsk: (UTC+09:00) Yakutsk, Australia/Adelaide: (UTC+09:30) Adelaide, Australia/Darwin: (UTC+09:30) Darwin, Australia/Brisbane: (UTC+10:00) Brisbane, Asia/Vladivostok: (UTC+10:00) Vladivostok, Pacific/Guam: (UTC+10:00) Guam, Port Moresby, Australia/Hobart: (UTC+10:00) Hobart, Australia/Sydney: (UTC+10:00) Canberra, Melbourne, Sydney, Australia/Lord_Howe: (UTC+10:30) Lord Howe Island, Pacific/Bougainville: (UTC+11:00) Bougainville Island, Asia/Magadan: (UTC+11:00) Magadan, Pacific/Norfolk: (UTC+11:00) Norfolk Island, Etc/GMT-11: (UTC+11:00) Chokurdakh, Asia/Sakhalin: (UTC+11:00) Sakhalin, Pacific/Noumea: (UTC+11:00) Solomon Is., New Caledonia, Asia/Anadyr: (UTC+12:00) Anadyr, Petropavlovsk-Kamchatsky, Pacific/Auckland: (UTC+12:00) Auckland, Wellington, Pacific/Fiji: (UTC+12:00) Fiji, Etc/GMT-12: (UTC+12:00) Coordinated Universal Time+12, Pacific/Chatham: (UTC+12:45) Chatham Islands, Pacific/Tongatapu: (UTC+13:00) Nuku alofa, Pacific/Samoa: (UTC+13:00) Samoa, Etc/GMT-13: (UTC+13:00) Coordinated Universal Time+13, Etc/GMT-14: (UTC+14:00) Kiritimati Island
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • NTPInfofather-node(Optional)
      Description: NTPType
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • ServerAddr(Optional)
        Show properties
        • Type(Optional)
        • Readonly(Optional)
        • Description(Optional)
        • Data(Optional)
          Show properties
          • MinLen(Optional)
          • MaxLen(Optional)
      • Port(Optional)
        Show properties
        • Type(Optional)
        • Readonly(Optional)
        • Description(Optional)
        • Data(Optional)
          Show properties
          • Min(Optional)
          • Max(Optional)
    • LocalTimefather-node(Optional)
      Description: LocalTime
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Year(Optional)
        Show properties
        • Type(Optional)
        • Readonly(Optional)
        • Description(Optional)
        • Data(Optional)
          Show properties
          • Min(Optional)
          • Max(Optional)
      • Month(Optional)
        Show properties
        • Type(Optional)
        • Readonly(Optional)
        • Description(Optional)
        • Data(Optional)
          Show properties
          • Min(Optional)
          • Max(Optional)
      • Day(Optional)
        Show properties
        • Type(Optional)
        • Readonly(Optional)
        • Description(Optional)
        • Data(Optional)
          Show properties
          • Min(Optional)
          • Max(Optional)
      • Hour(Optional)
        Show properties
        • Type(Optional)
        • Readonly(Optional)
        • Description(Optional)
        • Data(Optional)
          Show properties
          • Min(Optional)
          • Max(Optional)
      • Minute(Optional)
        Show properties
        • Type(Optional)
        • Readonly(Optional)
        • Description(Optional)
        • Data(Optional)
          Show properties
          • Min(Optional)
          • Max(Optional)
      • Second(Optional)
        Show properties
        • Type(Optional)
        • Readonly(Optional)
        • Description(Optional)
        • Data(Optional)
          Show properties
          • Min(Optional)
          • Max(Optional)
    • UpdateTimeenum(Optional)
      Description: UpdateTime
      Value: 10: 10 Minutes, 30: 30 Minutes, 60: 60 Minutes, 1440: 1440 Minutes
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
  • AutoRestartInfo
    Show properties
    • Typeenum(Optional)
      Description: AutoRestart
      Value: : Never, 1: Every Day, 2: Every Week, 3: Every Month
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • Dayrange(Optional)
      Description: Day,When the restart Type is 2, the range is 0-6, representing Sunday and Monday-Saturday, and when the Type is 3, representing the 1st-31st, respectively
      Value: 0-31
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • Hourrange(Optional)
      Description: Hour
      Value: 0-23
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • Minuterange(Optional)
      Description: Minute
      Value: 0-59
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
  • ResetInfo
    Show properties
    • Modulestring(Optional)
      Description: ResetInfo
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
  • UserInfo
    Show properties
    • Namestring(Optional)
      Description: Username
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • Roleenum(Optional)
      Description: Role
      Value: : Administrator, 1: Operator
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • Permissionsenum(Optional)
      Description: Permissions
      Value: : No Permissions, 64: Update Software, 128: PTZ Control, 192: PTZ Control & Update Software
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • Passwordstring(Optional)
      Description: Password
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
  • ManualRestart
    Show properties
    • Type(Optional)
    • Readonly(Optional)
    • Description(Optional)
  • FirmwareUpdate
    Show properties
    • Type(Optional)
    • Readonly(Optional)
    • Description(Optional)
    • Size(Optional)
    • Format(Optional)
  • FirmwareUpdateStatus
    Show properties
    • Steprange(Optional)
      Description: Step
      Value: 0-7
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • StepNameenum(Optional)
      Description: StepName
      Value: app: app, kernel: kernel, uboot: uboot, miniloader: miniloader, extrootfs: extrootfs, mcu: mcu, fpga: fpga
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • StepSumrange(Optional)
      Description: StepSum
      Value: 0-7
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • WaitFlagbool(Optional)
      Description: WaitFlag
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)

ReqGetSystemInfo

POSTapiv2/system

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetSystemInfo\",\"Version\":\"2.00.000\"}' http://example.com/apiv2/system

Sample Request

{
    "Cmd": "ReqGetSystemInfo",
    "Version": "2.00.000"
}

Response

{
    "Cmd": "AswGetSystemInfo",
    "Version": "2.00.000",
    "Content": {
        "SystemInfo": {
            "FPGAVersion": "P1D0900030F100084",
            "DeviceName": "Bolin-R9-230NX-06D29",
            "ModelName": "R9-230NX",
            "SerialNumber": "9104E005GB2305000125",
            "FirmwareVersion": "C1D37570D0A101086",
            "IPVersion": "P0V1G58070F104021",
            "MCUVersion": "P1D0957020F100106"
        },
        "Status": 0
    }
}

Parameters

  • SystemInfo
    Show properties
    • FPGAVersionstring(Optional)
      Description: FPGAVersion
    • DeviceNamestring(Optional)
      Description: DeviceName
    • ModelNamestring(Optional)
      Description: ModelName
    • SerialNumberstring(Optional)
      Description: SerialNumber
    • FirmwareVersionstring(Optional)
      Description: FirmwareVersion
    • MCUVersionstring(Optional)
      Description: MCUVersion

ReqSetSystemInfo

POSTapiv2/system

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetSystemInfo\",\"Version\":\"2.00.000\",\"Content\":{\"SystemInfo\":{\"DeviceName\":\"Bolin-R9230NX\"}}}' http://example.com/apiv2/system

Sample Request

{
    "Cmd": "ReqSetSystemInfo",
    "Version": "2.00.000",
    "Content": {
        "SystemInfo": {
            "DeviceName": "Bolin-R9230NX"
        }
    }
}

Response

{
    "Cmd": "AswSetSystemInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • SystemInfo
    Show properties
    • DeviceNamestring(Optional)
      Description: DeviceName

ReqGetSystemTimeInfo

POSTapiv2/system

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetSystemTimeInfo\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/system

Sample Request

{
    "Cmd": "ReqGetSystemTimeInfo",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetSystemTimeInfo",
    "Version": "2.00.000",
    "Content": {
        "SystemTimeInfo": {
            "TimeSyncMode": 0,
            "DateMode": 0,
            "TimeMode": 0,
            "TimeZone": "US/Mountain",
            "LocalTime": {
                "Year": 2025,
                "Month": 7,
                "Day": 24,
                "Hour": 1,
                "Minute": 25,
                "Second": 25
            },
            "NTPInfo": {
                "ServerAddr": "0.pool.ntp.org",
                "Port": 123,
                "UpdateTime": 60
            }
        },
        "Status": 0
    }
}

Parameters

  • SystemTimeInfo
    Show properties
    • TimeSyncModeenum(Optional)
      Description: TimeSyncMode
      Value: : Manual Set, 1: Sync NTP Server
    • DateModeenum(Optional)
      Description: DateMode
      Value: : Y-M-D, 1: D/M/Y
    • LocalTimefather-node(Optional)
      Description: LocalTime
      Show properties
      • Year(Optional)
      • Month(Optional)
      • Day(Optional)
      • Hour(Optional)
      • Minute(Optional)
      • Second(Optional)
    • NTPInfofather-node(Optional)
      Description: NTPType
      Show properties
      • ServerAddr(Optional)
      • Port(Optional)
      • UpdateTime(Optional)

ReqSetSystemTimeInfo

POSTapiv2/system

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetSystemTimeInfo\",\"Version\":\"2.00.000\",\"Content\":{\"SystemTimeInfo\":{\"TimeSyncMode\":0,\"DateMode\":0,\"TimeMode\":0,\"TimeZone\":\"US\\/Mountain\",\"LocalTime\":{\"Year\":2025,\"Month\":7,\"Day\":18,\"Hour\":16,\"Minute\":49,\"Second\":6}}}}' http://example.com/apiv2/system

Sample Request

{
    "Cmd": "ReqSetSystemTimeInfo",
    "Version": "2.00.000",
    "Content": {
        "SystemTimeInfo": {
            "TimeSyncMode": 0,
            "DateMode": 0,
            "TimeMode": 0,
            "TimeZone": "US/Mountain",
            "LocalTime": {
                "Year": 2025,
                "Month": 7,
                "Day": 18,
                "Hour": 16,
                "Minute": 49,
                "Second": 6
            }
        }
    }
}

Response

{
    "Cmd": "AswSetSystemTimeInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • SystemTimeInfo
    Show properties
    • TimeSyncModeenum(Optional)
      Description: TimeSyncMode
      Value: : Manual Set, 1: Sync NTP Server
    • DateModeenum(Optional)
      Description: DateMode
      Value: : Y-M-D, 1: D/M/Y
    • LocalTimefather-node(Optional)
      Description: LocalTime
      Show properties
      • Year(Optional)
      • Month(Optional)
      • Day(Optional)
      • Hour(Optional)
      • Minute(Optional)
      • Second(Optional)

ReqGetAutoRestartInfo

POSTapiv2/system

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetAutoRestartInfo\",\"Version\":\"2.00.000\"}' http://example.com/apiv2/system

Sample Request

{
    "Cmd": "ReqGetAutoRestartInfo",
    "Version": "2.00.000"
}

Response

{
    "Cmd": "AswGetAutoRestartInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 0,
        "AutoRestartInfo": {
            "Type": 0,
            "Day": 0,
            "Hour": 0,
            "Minute": 0
        }
    }
}

Parameters

  • AutoRestartInfo
    Show properties
    • Typeenum(Optional)
      Description: AutoRestart
      Value: : Never, 1: Every Day, 2: Every Week, 3: Every Month
    • Dayrange(Optional)
      Description: Day,When the restart Type is 2, the range is 0-6, representing Sunday and Monday-Saturday, and when the Type is 3, representing the 1st-31st, respectively
      Value: 0-31
    • Hourrange(Optional)
      Description: Hour
      Value: 0-23
    • Minuterange(Optional)
      Description: Minute
      Value: 0-59

ReqSetAutoRestartInfo

POSTapiv2/system

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetAutoRestartInfo\",\"Version\":\"2.00.000\",\"Content\":{\"AutoRestartInfo\":{\"Type\":2,\"Day\":1,\"Hour\":12,\"Minute\":30}}}' http://example.com/apiv2/system

Sample Request

{
    "Cmd": "ReqSetAutoRestartInfo",
    "Version": "2.00.000",
    "Content": {
        "AutoRestartInfo": {
            "Type": 2,
            "Day": 1,
            "Hour": 12,
            "Minute": 30
        }
    }
}

Response

{
    "Cmd": "AswSetAutoRestartInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • AutoRestartInfo
    Show properties
    • Typeenum(Optional)
      Description: AutoRestart
      Value: : Never, 1: Every Day, 2: Every Week, 3: Every Month
    • Dayrange(Optional)
      Description: Day,When the restart Type is 2, the range is 0-6, representing Sunday and Monday-Saturday, and when the Type is 3, representing the 1st-31st, respectively
      Value: 0-31
    • Hourrange(Optional)
      Description: Hour
      Value: 0-23
    • Minuterange(Optional)
      Description: Minute
      Value: 0-59

ReqSetManualRestart

POSTapiv2/system

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetManualRestart\",\"Version\":\"2.00.000\"}' http://example.com/apiv2/system

Sample Request

{
    "Cmd": "ReqSetManualRestart",
    "Version": "2.00.000"
}

Response

{
    "Cmd": "AswSetManualRestart",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

ReqReset

POSTapiv2/system

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqReset\",\"Version\":\"2.00.000\",\"Content\":{\"ResetInfo\":{\"Module\":\"all_but_net\"}}}' http://example.com/apiv2/system

Sample Request

{
    "Cmd": "ReqReset",
    "Version": "2.00.000",
    "Content": {
        "ResetInfo": {
            "Module": "all_but_net"
        }
    }
}

Response

{
    "Cmd": "AswReset",
    "Version": "2.00.000",
    "Content": {
        "Status": 1
    }
}

Parameters

ReqGetUserInfo

POSTapiv2/system

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetUserInfo\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/system

Sample Request

{
    "Cmd": "ReqGetUserInfo",
    "Version": "2.0.000"
}

Response

{
    "Version": "2.00.000",
    "Cmd": "AswGetUserInfo",
    "Content": {
        "UserInfo": [
            {
                "Name": "admin",
                "Role": 0,
                "Permissions": 192
            }
        ],
        "Status": 0
    }
}

Parameters

  • UserInfo
    Show properties
    • Namestring(Optional)
      Description: Username
    • Roleenum(Optional)
      Description: Role
      Value: : Administrator, 1: Operator
    • Permissionsenum(Optional)
      Description: Permissions
      Value: : No Permissions, 64: Update Software, 128: PTZ Control, 192: PTZ Control & Update Software

ReqSetUserInfo

POSTapiv2/system

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetUserInfo\",\"Version\":\"2.0.000\",\"Content\":{\"UserInfo\":{\"Action\":\"Add\",\"Name\":\"user1\",\"Role\":1,\"Permissions\":192,\"Password\":\"YWRtaW4xMjMu\"}}}' http://example.com/apiv2/system

Sample Request

{
    "Cmd": "ReqSetUserInfo",
    "Version": "2.0.000",
    "Content": {
        "UserInfo": {
            "Action": "Add",
            "Name": "user1",
            "Role": 1,
            "Permissions": 192,
            "Password": "YWRtaW4xMjMu"
        }
    }
}

Response

{
    "Cmd": "AswSetUserInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • UserInfo
    Show properties
    • Namestring(Optional)
      Description: Username
    • Roleenum(Optional)
      Description: Role
      Value: : Administrator, 1: Operator
    • Permissionsenum(Optional)
      Description: Permissions
      Value: : No Permissions, 64: Update Software, 128: PTZ Control, 192: PTZ Control & Update Software
    • Passwordstring(Optional)
      Description: Password

ReqGetPTZFCapabilities

POSTapiv2/ptzctrl

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -d '{\"Cmd\":\"ReqGetPTZFCapabilities\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/ptzctrl

Sample Request

{
    "Cmd": "ReqGetPTZFCapabilities",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetPTZFCapabilities",
    "Version": "2.00.000",
    "Content": {
        "PTZFMoveInfo": {
            "Mode": {
                "Type": "enum",
                "Readonly": false,
                "Description": "Speed mode, Standard mode, StandardSpeed range is 1-24, Superfine mode, SuperfineSpeed range is 1-255",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "Standard"
                    },
                    {
                        "Value": 1,
                        "Description": "Superfine"
                    },
                    {
                        "Value": 2,
                        "Description": "PanSpeed/TiltSpeed"
                    }
                ]
            },
            "StandardSpeed": {
                "Type": "range",
                "Readonly": false,
                "Description": "StandardSpeed Range",
                "Data": {
                    "Min": 1,
                    "Max": 24
                }
            },
            "SuperfineSpeed": {
                "Type": "range",
                "Readonly": false,
                "Description": "SuperfineSpeed Range",
                "Data": {
                    "Min": 1,
                    "Max": 255
                }
            },
            "PanSpeed": {
                "Type": "range",
                "Readonly": false,
                "Description": "PanSpeed Range",
                "Data": {
                    "Min": 0,
                    "Max": 255
                }
            },
            "TiltSpeed": {
                "Type": "range",
                "Readonly": false,
                "Description": "TiltSpeed Range",
                "Data": {
                    "Min": 0,
                    "Max": 255
                }
            },
            "Direction": {
                "Type": "enum",
                "Readonly": false,
                "Description": "PanTiltDirectoin",
                "Data": [
                    {
                        "Value": "Up",
                        "Description": "Up"
                    },
                    {
                        "Value": "Down",
                        "Description": "Down"
                    },
                    {
                        "Value": "Left",
                        "Description": "Left"
                    },
                    {
                        "Value": "Right",
                        "Description": "Right"
                    },
                    {
                        "Value": "LeftUp",
                        "Description": "LeftUp"
                    },
                    {
                        "Value": "RightUp",
                        "Description": "RightUp"
                    },
                    {
                        "Value": "LeftDown",
                        "Description": "LeftDown"
                    },
                    {
                        "Value": "RightDown",
                        "Description": "RightDown"
                    },
                    {
                        "Value": "Stop",
                        "Description": "Stop"
                    }
                ]
            }
        },
        "PTZFFocusInfo": {
            "Direction": {
                "Type": "enum",
                "Readonly": false,
                "Description": "Focus Action",
                "Data": [
                    {
                        "Value": "Near",
                        "Description": "Near"
                    },
                    {
                        "Value": "Far",
                        "Description": "Far"
                    },
                    {
                        "Value": "Stop",
                        "Description": "Stop"
                    },
                    {
                        "Value": "Manual",
                        "Description": "Manual"
                    },
                    {
                        "Value": "Auto",
                        "Description": "Auto"
                    }
                ]
            },
            "Speed": {
                "Type": "range",
                "Readonly": false,
                "Description": "Focus Speed",
                "Data": {
                    "Min": 1,
                    "Max": 8
                }
            }
        },
        "PTZFZoomInfo": {
            "Direction": {
                "Type": "enum",
                "Readonly": false,
                "Description": "Zoom Action",
                "Data": [
                    {
                        "Value": "Wide",
                        "Description": "Wide"
                    },
                    {
                        "Value": "Tele",
                        "Description": "Tele"
                    },
                    {
                        "Value": "Stop",
                        "Description": "Stop"
                    }
                ]
            },
            "Speed": {
                "Type": "range",
                "Readonly": false,
                "Description": "Zoom Speed",
                "Data": {
                    "Min": 1,
                    "Max": 8
                }
            }
        },
        "MenuInfo": {
            "Action": {
                "Type": "enum",
                "Readonly": false,
                "Description": "Menutoggle",
                "Data": [
                    {
                        "Value": "ON",
                        "Description": "ON"
                    },
                    {
                        "Value": "OFF",
                        "Description": "OFF"
                    },
                    {
                        "Value": "Up",
                        "Description": "Up"
                    },
                    {
                        "Value": "Down",
                        "Description": "Down"
                    },
                    {
                        "Value": "Left",
                        "Description": "Left"
                    },
                    {
                        "Value": "Right",
                        "Description": "Right"
                    },
                    {
                        "Value": "OK",
                        "Description": "OK"
                    },
                    {
                        "Value": "Menutoggle",
                        "Description": "Menutoggle"
                    }
                ]
            }
        },
        "GoHomeInfo": {
            "Action": {
                "Type": "enum",
                "Readonly": false,
                "Description": "GoHome Action",
                "Data": [
                    {
                        "Value": "GoHome",
                        "Description": "GoHome Action"
                    }
                ]
            }
        },
        "PresetInfo": {
            "Name": {
                "Type": "string",
                "Readonly": false,
                "Description": "Preset Name",
                "Data": {
                    "MinLen": 1,
                    "MaxLen": 64
                }
            },
            "Action": {
                "Type": "enum",
                "Readonly": false,
                "Description": "Preset Action",
                "Data": [
                    {
                        "Value": "Set",
                        "Description": "Set"
                    },
                    {
                        "Value": "Call",
                        "Description": "Call"
                    },
                    {
                        "Value": "Delete",
                        "Description": "Delete"
                    }
                ]
            },
            "Number": {
                "Type": "range",
                "Readonly": false,
                "Description": "PresetNum",
                "Data": {
                    "Min": 1,
                    "Max": 255
                }
            }
        },
        "PTZFPresetSpeed": {
            "PresetSpeed": {
                "Type": "range",
                "Readonly": false,
                "Description": "Preset Speed",
                "Data": {
                    "Min": 0,
                    "Max": 5
                }
            }
        },
        "PTZFPosition": {
            "PanPosition": {
                "Type": "range",
                "Readonly": false,
                "Description": "PanPosition",
                "Data": {
                    "Min": -170,
                    "Max": 170
                }
            },
            "TiltPosition": {
                "Type": "range",
                "Readonly": false,
                "Description": "TiltPosition",
                "Data": {
                    "Min": -30,
                    "Max": 90
                }
            },
            "PanTiltSpeed": {
                "Type": "range",
                "Readonly": false,
                "Description": "PanTiltSpeed",
                "Data": {
                    "Min": 1,
                    "Max": 255
                }
            },
            "ZoomPosition": {
                "Type": "range",
                "Readonly": false,
                "Description": "ZoomPosition",
                "Data": {
                    "Min": 0,
                    "Max": 16384
                }
            },
            "ZoomSpeed": {
                "Type": "range",
                "Readonly": false,
                "Description": "ZoomSpeed",
                "Data": {
                    "Min": 1,
                    "Max": 8
                }
            }
        },
        "PTZFRelPosition": {
            "PanPosition": {
                "Type": "range",
                "Readonly": false,
                "Description": "Horizontal relative motion of the head, positive and negative numbers correspond to the corresponding angle of motion",
                "Data": {
                    "Min": -100,
                    "Max": 100
                }
            },
            "TiltPosition": {
                "Type": "range",
                "Readonly": false,
                "Description": "Relative motion of the head in the vertical direction, positive and negative numbers correspond to the corresponding angle of motion",
                "Data": {
                    "Min": -100,
                    "Max": 100
                }
            },
            "PanTiltSpeed": {
                "Type": "range",
                "Readonly": false,
                "Description": "PanTiltSpeed",
                "Data": {
                    "Min": 1,
                    "Max": 255
                }
            }
        },
        "TraceInfo": {
            "Name": {
                "Type": "string",
                "Readonly": false,
                "Description": "Trace Name",
                "Data": {
                    "MinLen": 1,
                    "MaxLen": 64
                }
            },
            "Action": {
                "Type": "enum",
                "Readonly": false,
                "Description": "Trace Action",
                "Data": [
                    {
                        "Value": "StartRecord",
                        "Description": "StartRecord"
                    },
                    {
                        "Value": "EndRecord",
                        "Description": "EndRecord"
                    },
                    {
                        "Value": "Call",
                        "Description": "Call"
                    },
                    {
                        "Value": "Stop",
                        "Description": "Stop"
                    },
                    {
                        "Value": "Delete",
                        "Description": "Delete"
                    }
                ]
            },
            "Number": {
                "Type": "range",
                "Readonly": false,
                "Description": "TraceNum",
                "Data": {
                    "Min": 1,
                    "Max": 4
                }
            }
        },
        "ScanningInfo": {
            "Name": {
                "Type": "string",
                "Readonly": false,
                "Description": "Scanning Name",
                "Data": {
                    "MinLen": 1,
                    "MaxLen": 64
                }
            },
            "Action": {
                "Type": "enum",
                "Readonly": false,
                "Description": "Scanning Action",
                "Data": [
                    {
                        "Value": "LeftLimit",
                        "Description": "LeftLimit"
                    },
                    {
                        "Value": "RightLimit",
                        "Description": "RightLimit"
                    },
                    {
                        "Value": "Call",
                        "Description": "Call"
                    },
                    {
                        "Value": "Stop",
                        "Description": "Stop"
                    },
                    {
                        "Value": "Delete",
                        "Description": "Delete"
                    }
                ]
            },
            "Number": {
                "Type": "range",
                "Readonly": false,
                "Description": "ScanningNum",
                "Data": {
                    "Min": 1,
                    "Max": 4
                }
            },
            "Speed": {
                "Type": "range",
                "Readonly": false,
                "Description": "ScanningSpeed",
                "Data": {
                    "Min": 1,
                    "Max": 255
                }
            }
        },
        "CruiseInfo": {
            "Name": {
                "Type": "string",
                "Readonly": false,
                "Description": "CruiseName",
                "Data": {
                    "MinLen": 1,
                    "MaxLen": 64
                }
            },
            "Action": {
                "Type": "enum",
                "Readonly": false,
                "Description": "CruiseAction",
                "Data": [
                    {
                        "Value": "Set",
                        "Description": "Set"
                    },
                    {
                        "Value": "Call",
                        "Description": "Call"
                    },
                    {
                        "Value": "Stop",
                        "Description": "Stop"
                    },
                    {
                        "Value": "Delete",
                        "Description": "Delete"
                    }
                ]
            },
            "Number": {
                "Type": "range",
                "Readonly": false,
                "Description": "CruiseNum",
                "Data": {
                    "Min": 1,
                    "Max": 12
                }
            },
            "PresetInfo": {
                "Type": "father-node",
                "Readonly": false,
                "Description": "Cruise PersetInfo",
                "Data": {
                    "PresetID": {
                        "Type": "range",
                        "Readonly": false,
                        "Description": "PresetID",
                        "Data": {
                            "Min": 1,
                            "Max": 255
                        }
                    },
                    "RecordingTime": {
                        "Type": "range",
                        "Readonly": false,
                        "Description": "RecordingTime",
                        "Data": {
                            "Min": 1,
                            "Max": 255
                        }
                    }
                }
            }
        },
        "PositionLimitations": {
            "DownLimit": {
                "Type": "bool",
                "Readonly": false,
                "Description": "DownLimit"
            },
            "UpLimit": {
                "Type": "bool",
                "Readonly": false,
                "Description": "UpLimit"
            },
            "LeftLimit": {
                "Type": "bool",
                "Readonly": false,
                "Description": "LeftLimit"
            },
            "RightLimit": {
                "Type": "bool",
                "Readonly": false,
                "Description": "RightLimit"
            }
        },
        "PowerOnActionInfo": {
            "ActionNumber": {
                "Type": "range",
                "Readonly": false,
                "Description": "PowerOnAction",
                "Data": {
                    "Min": 1,
                    "Max": 255
                }
            },
            "ActionType": {
                "Type": "enum",
                "Readonly": false,
                "Description": "PowerOnActionType",
                "Data": [
                    {
                        "Value": "Preset",
                        "Description": "Preset"
                    },
                    {
                        "Value": "Scanning",
                        "Description": "Scanning"
                    },
                    {
                        "Value": "Cruise",
                        "Description": "Cruise"
                    },
                    {
                        "Value": "Trace ",
                        "Description": "Trace "
                    },
                    {
                        "Value": "Off",
                        "Description": "Off"
                    }
                ]
            }
        },
        "AutoScanningInfo": {
            "Speed": {
                "Type": "range",
                "Readonly": false,
                "Description": "AutoScanning",
                "Data": {
                    "Min": 1,
                    "Max": 255
                }
            }
        },
        "Status": 0
    }
}

Parameters

  • PTZFMoveInfo
    Show properties
    • Modeenum(Optional)
      Description: Speed mode, Standard mode, StandardSpeed range is 1-24, Superfine mode, SuperfineSpeed range is 1-255
      Value: : Standard, 1: Superfine, 2: PanSpeed/TiltSpeed
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • StandardSpeedrange(Optional)
      Description: StandardSpeed Range
      Value: 1-24
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • SuperfineSpeedrange(Optional)
      Description: SuperfineSpeed Range
      Value: 1-255
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • PanSpeedrange(Optional)
      Description: PanSpeed Range
      Value: 0-255
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • TiltSpeedrange(Optional)
      Description: TiltSpeed Range
      Value: 0-255
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • Directionenum(Optional)
      Description: PanTiltDirectoin
      Value: Up: Up, Down: Down, Left: Left, Right: Right, LeftUp: LeftUp, RightUp: RightUp, LeftDown: LeftDown, RightDown: RightDown, Stop: Stop
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
  • PTZFFocusInfo
    Show properties
    • Directionenum(Optional)
      Description: Focus Action
      Value: Near: Near, Far: Far, Stop: Stop, Manual: Manual, Auto: Auto
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • Speedrange(Optional)
      Description: Focus Speed
      Value: 1-8
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
  • PTZFZoomInfo
    Show properties
    • Directionenum(Optional)
      Description: Zoom Action
      Value: Wide: Wide, Tele: Tele, Stop: Stop
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • Speedrange(Optional)
      Description: Zoom Speed
      Value: 1-8
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
  • MenuInfo
    Show properties
    • Actionenum(Optional)
      Description: Menutoggle
      Value: ON: ON, OFF: OFF, Up: Up, Down: Down, Left: Left, Right: Right, OK: OK, Menutoggle: Menutoggle
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
  • GoHomeInfo
    Show properties
    • Actionenum(Optional)
      Description: GoHome Action
      Value: GoHome: GoHome Action
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
  • PresetInfo
    Show properties
    • Namestring(Optional)
      Description: Preset Name
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • Actionenum(Optional)
      Description: Preset Action
      Value: Set: Set, Call: Call, Delete: Delete
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • Numberrange(Optional)
      Description: PresetNum
      Value: 1-255
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
  • PTZFPresetSpeed
    Show properties
    • PresetSpeedrange(Optional)
      Description: Preset Speed
      Value: 0-5
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
  • PTZFPosition
    Show properties
    • PanPositionrange(Optional)
      Description: PanPosition
      Value: -170-170
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • TiltPositionrange(Optional)
      Description: TiltPosition
      Value: -30-90
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • PanTiltSpeedrange(Optional)
      Description: PanTiltSpeed
      Value: 1-255
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • ZoomPositionrange(Optional)
      Description: ZoomPosition
      Value: 0-16384
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • ZoomSpeedrange(Optional)
      Description: ZoomSpeed
      Value: 1-8
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
  • PTZFRelPosition
    Show properties
    • PanPositionrange(Optional)
      Description: Horizontal relative motion of the head, positive and negative numbers correspond to the corresponding angle of motion
      Value: -100-100
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • TiltPositionrange(Optional)
      Description: Relative motion of the head in the vertical direction, positive and negative numbers correspond to the corresponding angle of motion
      Value: -100-100
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • PanTiltSpeedrange(Optional)
      Description: PanTiltSpeed
      Value: 1-255
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
  • TraceInfo
    Show properties
    • Namestring(Optional)
      Description: Trace Name
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • Actionenum(Optional)
      Description: Trace Action
      Value: StartRecord: StartRecord, EndRecord: EndRecord, Call: Call, Stop: Stop, Delete: Delete
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • Numberrange(Optional)
      Description: TraceNum
      Value: 1-4
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
  • ScanningInfo
    Show properties
    • Namestring(Optional)
      Description: Scanning Name
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • Actionenum(Optional)
      Description: Scanning Action
      Value: LeftLimit: LeftLimit, RightLimit: RightLimit, Call: Call, Stop: Stop, Delete: Delete
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • Numberrange(Optional)
      Description: ScanningNum
      Value: 1-4
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • Speedrange(Optional)
      Description: ScanningSpeed
      Value: 1-255
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
  • CruiseInfo
    Show properties
    • Namestring(Optional)
      Description: CruiseName
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • Actionenum(Optional)
      Description: CruiseAction
      Value: Set: Set, Call: Call, Stop: Stop, Delete: Delete
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • Numberrange(Optional)
      Description: CruiseNum
      Value: 1-12
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • PresetInfofather-node(Optional)
      Description: Cruise PersetInfo
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • PresetID(Optional)
          Show properties
          • Type(Optional)
          • Readonly(Optional)
          • Description(Optional)
          • Data(Optional)
            Show properties
            • Min(Optional)
            • Max(Optional)
        • RecordingTime(Optional)
          Show properties
          • Type(Optional)
          • Readonly(Optional)
          • Description(Optional)
          • Data(Optional)
            Show properties
            • Min(Optional)
            • Max(Optional)
  • PositionLimitations
    Show properties
    • DownLimitbool(Optional)
      Description: DownLimit
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • UpLimitbool(Optional)
      Description: UpLimit
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • LeftLimitbool(Optional)
      Description: LeftLimit
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • RightLimitbool(Optional)
      Description: RightLimit
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
  • PowerOnActionInfo
    Show properties
    • ActionNumberrange(Optional)
      Description: PowerOnAction
      Value: 1-255
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • ActionTypeenum(Optional)
      Description: PowerOnActionType
      Value: Preset: Preset, Scanning: Scanning, Cruise: Cruise, Trace : Trace , Off: Off
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
  • AutoScanningInfo
    Show properties
    • Speedrange(Optional)
      Description: AutoScanning
      Value: 1-255
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)

ReqSetPTZFMove

POSTapiv2/ptzctrl

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetPTZFMove\",\"Version\":\"2.00.000\",\"Content\":{\"PTZFMoveInfo\":{\"Mode\":1,\"SuperfineSpeed\":255,\"Direction\":\"LeftDown\"}}}' http://example.com/apiv2/ptzctrl

Sample Request

{
    "Cmd": "ReqSetPTZFMove",
    "Version": "2.00.000",
    "Content": {
        "PTZFMoveInfo": {
            "Mode": 1,
            "SuperfineSpeed": 255,
            "Direction": "LeftDown"
        }
    }
}

Response

{
    "Cmd": "AswSetPTZFMove",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • PTZFMoveInfo
    Show properties
    • Modeenum(Optional)
      Description: Speed mode, Standard mode, StandardSpeed range is 1-24, Superfine mode, SuperfineSpeed range is 1-255
      Value: : Standard, 1: Superfine, 2: PanSpeed/TiltSpeed
    • SuperfineSpeedrange(Optional)
      Description: SuperfineSpeed Range
      Value: 1-255
    • Directionenum(Optional)
      Description: PanTiltDirectoin
      Value: Up: Up, Down: Down, Left: Left, Right: Right, LeftUp: LeftUp, RightUp: RightUp, LeftDown: LeftDown, RightDown: RightDown, Stop: Stop

ReqSetPTZFFocus

POSTapiv2/ptzctrl

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetPTZFFocus\",\"Version\":\"2.0.000\",\"Content\":{\"PTZFFocusInfo\":{\"Speed\":1,\"Direction\":\"Near\"}}}' http://example.com/apiv2/ptzctrl

Sample Request

{
    "Cmd": "ReqSetPTZFFocus",
    "Version": "2.0.000",
    "Content": {
        "PTZFFocusInfo": {
            "Speed": 1,
            "Direction": "Near"
        }
    }
}

Response

{
    "Cmd": "AswSetPTZFFocus",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • PTZFFocusInfo
    Show properties
    • Speedrange(Optional)
      Description: Focus Speed
      Value: 1-8
    • Directionenum(Optional)
      Description: Focus Action
      Value: Near: Near, Far: Far, Stop: Stop, Manual: Manual, Auto: Auto

ReqSetPTZFZoom

POSTapiv2/ptzctrl

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetPTZFZoom\",\"Version\":\"2.0.000\",\"Content\":{\"PTZFZoomInfo\":{\"Speed\":1,\"Direction\":\"Wide\"}}}' http://example.com/apiv2/ptzctrl

Sample Request

{
    "Cmd": "ReqSetPTZFZoom",
    "Version": "2.0.000",
    "Content": {
        "PTZFZoomInfo": {
            "Speed": 1,
            "Direction": "Wide"
        }
    }
}

Response

{
    "Cmd": "AswSetPTZFZoom",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • PTZFZoomInfo
    Show properties
    • Speedrange(Optional)
      Description: Zoom Speed
      Value: 1-8
    • Directionenum(Optional)
      Description: Zoom Action
      Value: Wide: Wide, Tele: Tele, Stop: Stop

ReqSetMenu

POSTapiv2/ptzctrl

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetMenu\",\"Version\":\"2.0.000\",\"Content\":{\"MenuInfo\":{\"Action\":\"Menutoggle\"}}}' http://example.com/apiv2/ptzctrl

Sample Request

{
    "Cmd": "ReqSetMenu",
    "Version": "2.0.000",
    "Content": {
        "MenuInfo": {
            "Action": "Menutoggle"
        }
    }
}

Response

{
    "Cmd": "AswSetMenu",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • MenuInfo
    Show properties
    • Actionenum(Optional)
      Description: Menutoggle
      Value: ON: ON, OFF: OFF, Up: Up, Down: Down, Left: Left, Right: Right, OK: OK, Menutoggle: Menutoggle

ReqGoHome

POSTapiv2/ptzctrl

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGoHome\",\"Version\":\"2.00.000\",\"Content\":{\"GoHomeInfo\":{\"Action\":\"GoHome\"}}}' http://example.com/apiv2/ptzctrl

Sample Request

{
    "Cmd": "ReqGoHome",
    "Version": "2.00.000",
    "Content": {
        "GoHomeInfo": {
            "Action": "GoHome"
        }
    }
}

Response

{
    "Cmd": "AswGoHome",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • GoHomeInfo
    Show properties
    • Actionenum(Optional)
      Description: GoHome Action
      Value: GoHome: GoHome Action

ReqGetPTZFPreset

POSTapiv2/ptzctrl

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetPTZFPreset\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/ptzctrl

Sample Request

{
    "Cmd": "ReqGetPTZFPreset",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetPTZFPreset",
    "Version": "2.00.000",
    "Content": {
        "PresetInfo": [
            {
                "Number": 1,
                "Name": "Preset001"
            },
            {
                "Number": 2,
                "Name": "Preset002"
            },
            {
                "Number": 3,
                "Name": "Preset003"
            },
            {
                "Number": 4,
                "Name": "Preset004"
            },
            {
                "Number": 95,
                "Name": "preset95",
                "FixedName": "ex_osd_menu"
            }
        ],
        "Status": 0
    }
}

Parameters

  • PresetInfo
    Show properties
    • Numberrange(Optional)
      Description: PresetNum
      Value: 1-255
    • Namestring(Optional)
      Description: Preset Name

ReqSetPTZFPreset

POSTapiv2/ptzctrl

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetPTZFPreset\",\"Version\":\"2.0.000\",\"Content\":{\"PresetInfo\":{\"Action\":\"Call\",\"Name\":\"preset1\",\"Number\":1}}}' http://example.com/apiv2/ptzctrl

Sample Request

{
    "Cmd": "ReqSetPTZFPreset",
    "Version": "2.0.000",
    "Content": {
        "PresetInfo": {
            "Action": "Call",
            "Name": "preset1",
            "Number": 1
        }
    }
}

Response

{
    "Cmd": "AswSetPTZFPreset",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • PresetInfo
    Show properties
    • Actionenum(Optional)
      Description: Preset Action
      Value: Set: Set, Call: Call, Delete: Delete
    • Namestring(Optional)
      Description: Preset Name
    • Numberrange(Optional)
      Description: PresetNum
      Value: 1-255

ReqGetPTZFPresetSpeed

POSTapiv2/ptzctrl

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetPTZFPresetSpeed\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/ptzctrl

Sample Request

{
    "Cmd": "ReqGetPTZFPresetSpeed",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetPTZFPresetSpeed",
    "Version": "2.00.000",
    "Content": {
        "PTZFPresetSpeed": {
            "PresetSpeed": 5
        },
        "Status": 0
    }
}

Parameters

  • PTZFPresetSpeed
    Show properties
    • PresetSpeedrange(Optional)
      Description: Preset Speed
      Value: 0-5

ReqSetPTZFPresetSpeed

POSTapiv2/ptzctrl

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetPTZFPresetSpeed\",\"Version\":\"2.00.000\",\"Content\":{\"PTZFPresetSpeed\":{\"PresetSpeed\":5}}}' http://example.com/apiv2/ptzctrl

Sample Request

{
    "Cmd": "ReqSetPTZFPresetSpeed",
    "Version": "2.00.000",
    "Content": {
        "PTZFPresetSpeed": {
            "PresetSpeed": 5
        }
    }
}

Response

{
    "Cmd": "AswSetPTZFPresetSpeed",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • PTZFPresetSpeed
    Show properties
    • PresetSpeedrange(Optional)
      Description: Preset Speed
      Value: 0-5

ReqGetPTZFPosition

POSTapiv2/ptzctrl

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetPTZFPosition\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/ptzctrl

Sample Request

{
    "Cmd": "ReqGetPTZFPosition",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetPTZFPosition",
    "Version": "2.00.000",
    "Content": {
        "PTZFPosition": {
            "PanPosition": 0,
            "TiltPosition": 0,
            "ZoomPosition": 0
        },
        "Status": 0
    }
}

Parameters

  • PTZFPosition
    Show properties
    • PanPositionrange(Optional)
      Description: PanPosition
      Value: -170-170
    • TiltPositionrange(Optional)
      Description: TiltPosition
      Value: -30-90
    • ZoomPositionrange(Optional)
      Description: ZoomPosition
      Value: 0-16384

ReqSetPTZFPosition

POSTapiv2/ptzctrl

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetPTZFPosition\",\"Version\":\"2.0.000\",\"Content\":{\"PTZFPosition\":{\"PanPosition\":90,\"TiltPosition\":60,\"ZoomPosition\":2000,\"PanTiltSpeed\":255,\"ZoomSpeed\":1}}}' http://example.com/apiv2/ptzctrl

Sample Request

{
    "Cmd": "ReqSetPTZFPosition",
    "Version": "2.0.000",
    "Content": {
        "PTZFPosition": {
            "PanPosition": 90,
            "TiltPosition": 60,
            "ZoomPosition": 2000,
            "PanTiltSpeed": 255,
            "ZoomSpeed": 1
        }
    }
}

Response

{
    "Cmd": "AswSetPTZFPosition",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • PTZFPosition
    Show properties
    • PanPositionrange(Optional)
      Description: PanPosition
      Value: -170-170
    • TiltPositionrange(Optional)
      Description: TiltPosition
      Value: -30-90
    • ZoomPositionrange(Optional)
      Description: ZoomPosition
      Value: 0-16384
    • PanTiltSpeedrange(Optional)
      Description: PanTiltSpeed
      Value: 1-255
    • ZoomSpeedrange(Optional)
      Description: ZoomSpeed
      Value: 1-8

ReqSetPTZFRelPosition

POSTapiv2/ptzctrl

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetPTZFRelPosition\",\"Version\":\"2.0.000\",\"Content\":{\"PTZFRelPosition\":{\"PanPosition\":-10,\"TiltPosition\":-10,\"PanTiltSpeed\":255}}}' http://example.com/apiv2/ptzctrl

Sample Request

{
    "Cmd": "ReqSetPTZFRelPosition",
    "Version": "2.0.000",
    "Content": {
        "PTZFRelPosition": {
            "PanPosition": -10,
            "TiltPosition": -10,
            "PanTiltSpeed": 255
        }
    }
}

Response

{
    "Cmd": "AswSetPTZFRelPosition",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • PTZFRelPosition
    Show properties
    • PanPositionrange(Optional)
      Description: Horizontal relative motion of the head, positive and negative numbers correspond to the corresponding angle of motion
      Value: -100-100
    • TiltPositionrange(Optional)
      Description: Relative motion of the head in the vertical direction, positive and negative numbers correspond to the corresponding angle of motion
      Value: -100-100
    • PanTiltSpeedrange(Optional)
      Description: PanTiltSpeed
      Value: 1-255

ReqGetTraceInfo

POSTapiv2/ptzctrl

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetTraceInfo\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/ptzctrl

Sample Request

{
    "Cmd": "ReqGetTraceInfo",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetTraceInfo",
    "Version": "2.00.000",
    "Content": {
        "TraceInfo": [
            {
                "Number": 1,
                "Name": "Trace01"
            }
        ],
        "Status": 0
    }
}

Parameters

  • TraceInfo
    Show properties
    • Numberrange(Optional)
      Description: TraceNum
      Value: 1-4
    • Namestring(Optional)
      Description: Trace Name

ReqSetTraceInfo

POSTapiv2/ptzctrl

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetTraceInfo\",\"Version\":\"2.0.000\",\"Content\":{\"TraceInfo\":{\"Action\":\"Call\",\"Number\":1,\"Name\":\"trace1\"}}}' http://example.com/apiv2/ptzctrl

Sample Request

{
    "Cmd": "ReqSetTraceInfo",
    "Version": "2.0.000",
    "Content": {
        "TraceInfo": {
            "Action": "Call",
            "Number": 1,
            "Name": "trace1"
        }
    }
}

Response

{
    "Cmd": "AswSetTraceInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • TraceInfo
    Show properties
    • Actionenum(Optional)
      Description: Trace Action
      Value: StartRecord: StartRecord, EndRecord: EndRecord, Call: Call, Stop: Stop, Delete: Delete
    • Numberrange(Optional)
      Description: TraceNum
      Value: 1-4
    • Namestring(Optional)
      Description: Trace Name

ReqGetScanningInfo

POSTapiv2/ptzctrl

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetScanningInfo\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/ptzctrl

Sample Request

{
    "Cmd": "ReqGetScanningInfo",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetScanningInfo",
    "Version": "2.00.000",
    "Content": {
        "ScanningInfo": [
            {
                "Number": 1,
                "Name": "Scanning01"
            }
        ],
        "Status": 0
    }
}

Parameters

  • ScanningInfo
    Show properties
    • Numberrange(Optional)
      Description: ScanningNum
      Value: 1-4
    • Namestring(Optional)
      Description: Scanning Name

ReqSetScanningInfo

POSTapiv2/ptzctrl

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetScanningInfo\",\"Version\":\"2.0.000\",\"Content\":{\"ScanningInfo\":{\"Action\":\"Call\",\"Number\":1,\"Name\":\"Scanning01\",\"Speed\":255}}}' http://example.com/apiv2/ptzctrl

Sample Request

{
    "Cmd": "ReqSetScanningInfo",
    "Version": "2.0.000",
    "Content": {
        "ScanningInfo": {
            "Action": "Call",
            "Number": 1,
            "Name": "Scanning01",
            "Speed": 255
        }
    }
}

Response

{
    "Cmd": "AswSetScanningInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • ScanningInfo
    Show properties
    • Actionenum(Optional)
      Description: Scanning Action
      Value: LeftLimit: LeftLimit, RightLimit: RightLimit, Call: Call, Stop: Stop, Delete: Delete
    • Numberrange(Optional)
      Description: ScanningNum
      Value: 1-4
    • Namestring(Optional)
      Description: Scanning Name
    • Speedrange(Optional)
      Description: ScanningSpeed
      Value: 1-255

ReqGetPowerOnActionInfo

POSTapiv2/ptzctrl

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetPowerOnActionInfo\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/ptzctrl

Sample Request

{
    "Cmd": "ReqGetPowerOnActionInfo",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetPowerOnActionInfo",
    "Version": "2.00.000",
    "Content": {
        "PowerOnActionInfo": {
            "ActionType": "Off",
            "ActionNumber": 0
        },
        "Status": 0
    }
}

Parameters

  • PowerOnActionInfo
    Show properties
    • ActionTypeenum(Optional)
      Description: PowerOnActionType
      Value: Preset: Preset, Scanning: Scanning, Cruise: Cruise, Trace : Trace , Off: Off
    • ActionNumberrange(Optional)
      Description: PowerOnAction
      Value: 1-255

ReqSetPowerOnActionInfo

POSTapiv2/ptzctrl

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetPowerOnActionInfo\",\"Version\":\"2.0.000\",\"Content\":{\"PowerOnActionInfo\":{\"ActionType\":\"Cruise\",\"ActionNumber\":1}}}' http://example.com/apiv2/ptzctrl

Sample Request

{
    "Cmd": "ReqSetPowerOnActionInfo",
    "Version": "2.0.000",
    "Content": {
        "PowerOnActionInfo": {
            "ActionType": "Cruise",
            "ActionNumber": 1
        }
    }
}

Response

{
    "Cmd": "AswSetPowerOnActionInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • PowerOnActionInfo
    Show properties
    • ActionTypeenum(Optional)
      Description: PowerOnActionType
      Value: Preset: Preset, Scanning: Scanning, Cruise: Cruise, Trace : Trace , Off: Off
    • ActionNumberrange(Optional)
      Description: PowerOnAction
      Value: 1-255

ReqGetCruiseInfo

POSTapiv2/ptzctrl

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetCruiseInfo\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/ptzctrl

Sample Request

{
    "Cmd": "ReqGetCruiseInfo",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetCruiseInfo",
    "Version": "2.00.000",
    "Content": {
        "CruiseInfo": [
            {
                "Number": 1,
                "Name": "Cruise01",
                "PresetInfo": [
                    {
                        "PresetID": 1,
                        "RecordingTime": 5
                    },
                    {
                        "PresetID": 2,
                        "RecordingTime": 5
                    },
                    {
                        "PresetID": 3,
                        "RecordingTime": 5
                    }
                ]
            }
        ],
        "Status": 0
    }
}

Parameters

  • CruiseInfo
    Show properties
    • Numberrange(Optional)
      Description: CruiseNum
      Value: 1-12
    • Namestring(Optional)
      Description: CruiseName
    • PresetInfofather-node(Optional)
      Description: Cruise PersetInfo
      Show properties
      • PresetID(Optional)
      • RecordingTime(Optional)

ReqSetCruiseInfo

POSTapiv2/ptzctrl

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetCruiseInfo\",\"Version\":\"2.00.000\",\"Content\":{\"CruiseInfo\":{\"Action\":\"Set\",\"Number\":3,\"Name\":\"cruise3\",\"PresetInfo\":[{\"PresetID\":1,\"RecordingTime\":5},{\"PresetID\":2,\"RecordingTime\":5},{\"PresetID\":3,\"RecordingTime\":5}]}}}' http://example.com/apiv2/ptzctrl

Sample Request

{
    "Cmd": "ReqSetCruiseInfo",
    "Version": "2.00.000",
    "Content": {
        "CruiseInfo": {
            "Action": "Set",
            "Number": 3,
            "Name": "cruise3",
            "PresetInfo": [
                {
                    "PresetID": 1,
                    "RecordingTime": 5
                },
                {
                    "PresetID": 2,
                    "RecordingTime": 5
                },
                {
                    "PresetID": 3,
                    "RecordingTime": 5
                }
            ]
        }
    }
}

Response

{
    "Cmd": "AswSetCruiseInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • CruiseInfo
    Show properties
    • Actionenum(Optional)
      Description: CruiseAction
      Value: Set: Set, Call: Call, Stop: Stop, Delete: Delete
    • Numberrange(Optional)
      Description: CruiseNum
      Value: 1-12
    • Namestring(Optional)
      Description: CruiseName
    • PresetInfofather-node(Optional)
      Description: Cruise PersetInfo
      Show properties
      • PresetID(Optional)
      • RecordingTime(Optional)

ReqGetPositionLimitations

POSTapiv2/ptzctrl

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetPositionLimitations\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/ptzctrl

Sample Request

{
    "Cmd": "ReqGetPositionLimitations",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetPositionLimitations",
    "Version": "2.00.000",
    "Content": {
        "PositionLimitations": {
            "DownLimit": false,
            "UpLimit": false,
            "LeftLimit": false,
            "RightLimit": false
        },
        "Status": 0
    }
}

Parameters

  • PositionLimitations
    Show properties
    • DownLimitbool(Optional)
      Description: DownLimit
      Value: true/false
    • UpLimitbool(Optional)
      Description: UpLimit
      Value: true/false
    • LeftLimitbool(Optional)
      Description: LeftLimit
      Value: true/false
    • RightLimitbool(Optional)
      Description: RightLimit
      Value: true/false

ReqSetPositionLimitations

POSTapiv2/ptzctrl

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetPositionLimitations\",\"Version\":\"2.0.000\",\"Content\":{\"PositionLimitations\":{\"DownLimit\":true,\"UpLimit\":false,\"LeftLimit\":true,\"RightLimit\":false}}}' http://example.com/apiv2/ptzctrl

Sample Request

{
    "Cmd": "ReqSetPositionLimitations",
    "Version": "2.0.000",
    "Content": {
        "PositionLimitations": {
            "DownLimit": true,
            "UpLimit": false,
            "LeftLimit": true,
            "RightLimit": false
        }
    }
}

Response

{
    "Cmd": "AswSetPositionLimitations",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • PositionLimitations
    Show properties
    • DownLimitbool(Optional)
      Description: DownLimit
      Value: true/false
    • UpLimitbool(Optional)
      Description: UpLimit
      Value: true/false
    • LeftLimitbool(Optional)
      Description: LeftLimit
      Value: true/false
    • RightLimitbool(Optional)
      Description: RightLimit
      Value: true/false

ReqSetAutoScanning

POSTapiv2/ptzctrl

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetAutoScanning\",\"Version\":\"2.0.000\",\"Content\":{\"AutoScanningInfo\":{\"Speed\":255}}}' http://example.com/apiv2/ptzctrl

Sample Request

{
    "Cmd": "ReqSetAutoScanning",
    "Version": "2.0.000",
    "Content": {
        "AutoScanningInfo": {
            "Speed": 255
        }
    }
}

Response

{
    "Cmd": "AswSetAutoScanning",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • AutoScanningInfo
    Show properties
    • Speedrange(Optional)
      Description: AutoScanning
      Value: 1-255

ReqGetImageCapabilities

POSTapiv2/image

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -d '{\"Cmd\":\"ReqGetImageCapabilities\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/image

Sample Request

{
    "Cmd": "ReqGetImageCapabilities",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetImageCapabilities",
    "Version": "2.00.000",
    "Content": {
        "ExposureInfo": {
            "Mode": {
                "Type": "enum",
                "Readonly": false,
                "Description": "ExposureMode",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "Auto"
                    },
                    {
                        "Value": 1,
                        "Description": "Manual"
                    },
                    {
                        "Value": 2,
                        "Description": "ShutterPri"
                    },
                    {
                        "Value": 3,
                        "Description": "IrisPri"
                    }
                ]
            },
            "SlowShutter": {
                "Type": "bool",
                "Readonly": false,
                "Description": "SlowShutter"
            },
            "SlowShutterLimit": {
                "Type": "enum",
                "Readonly": false,
                "Description": "SlowShutterLimit",
                "Data": [
                    {
                        "Value": 1,
                        "Description": "1/30"
                    },
                    {
                        "Value": 2,
                        "Description": "1/15"
                    },
                    {
                        "Value": 3,
                        "Description": "1/8"
                    },
                    {
                        "Value": 4,
                        "Description": "1/4"
                    },
                    {
                        "Value": 5,
                        "Description": "1/2"
                    },
                    {
                        "Value": 6,
                        "Description": "1/1"
                    }
                ]
            },
            "GainLimit": {
                "Type": "enum",
                "Readonly": false,
                "Description": "GainLimit,The high sensitivity open state is limited to 10.7dB 14.3dB 17.9dB 21.4dB 25.0dB 28.6dB 32.1dB 35.7dB 39.3dB 42.9dB 46.4dB 50.0dB;The closure status is limited to 15.0dB 20.0dB 25.0dB 30.0dB 35.0dB 40.0dB 45.0dB 50.0dB 55.0dB 60.0dB 65.0dB 70.0dB",
                "Data": [
                    {
                        "Value": 4,
                        "Description": "10.7dB"
                    },
                    {
                        "Value": 5,
                        "Description": "14.3dB"
                    },
                    {
                        "Value": 6,
                        "Description": "17.9dB"
                    },
                    {
                        "Value": 7,
                        "Description": "21.4dB"
                    },
                    {
                        "Value": 8,
                        "Description": "25.0dB"
                    },
                    {
                        "Value": 9,
                        "Description": "28.6dB"
                    },
                    {
                        "Value": 10,
                        "Description": "32.1dB"
                    },
                    {
                        "Value": 11,
                        "Description": "35.7dB"
                    },
                    {
                        "Value": 12,
                        "Description": "39.3dB"
                    },
                    {
                        "Value": 13,
                        "Description": "42.9dB"
                    },
                    {
                        "Value": 14,
                        "Description": "46.4dB"
                    },
                    {
                        "Value": 15,
                        "Description": "50.0dB"
                    }
                ]
            },
            "Gain": {
                "Type": "enum",
                "Readonly": true,
                "Description": "Gain High sensitivity off state is limited to 0dB 3.6dB 7.1dB 10.7dB 14.3dB 17.9dB 21.4dB 25.0dB 28.6dB 32.1dB 35.7dB 39.3dB 42.9dB 46.4dB 50.0dB;The high sensitivity open state is limited to 0dB 5.0dB 10.0dB 15.0dB 20.0dB 25.0dB 30.0dB 35.0dB 40.0dB 45.0dB 50.0dB 55.0dB 60.0dB 65.0dB 70.0dB",
                "Data": [
                    {
                        "Value": 1,
                        "Description": "0dB"
                    },
                    {
                        "Value": 2,
                        "Description": "3.6dB"
                    },
                    {
                        "Value": 3,
                        "Description": "7.1dB"
                    },
                    {
                        "Value": 4,
                        "Description": "10.7dB"
                    },
                    {
                        "Value": 5,
                        "Description": "14.3dB"
                    },
                    {
                        "Value": 6,
                        "Description": "17.9dB"
                    },
                    {
                        "Value": 7,
                        "Description": "21.4dB"
                    },
                    {
                        "Value": 8,
                        "Description": "25.0dB"
                    },
                    {
                        "Value": 9,
                        "Description": "28.6dB"
                    },
                    {
                        "Value": 10,
                        "Description": "32.1dB"
                    },
                    {
                        "Value": 11,
                        "Description": "35.7dB"
                    },
                    {
                        "Value": 12,
                        "Description": "39.3dB"
                    },
                    {
                        "Value": 13,
                        "Description": "42.9dB"
                    },
                    {
                        "Value": 14,
                        "Description": "46.4dB"
                    },
                    {
                        "Value": 15,
                        "Description": "50.0dB"
                    }
                ]
            },
            "Excomp": {
                "Type": "bool",
                "Readonly": false,
                "Description": "Exposure Compensation"
            },
            "BackLight": {
                "Type": "bool",
                "Readonly": false,
                "Description": "BackLight"
            },
            "SpotLight": {
                "Type": "bool",
                "Readonly": false,
                "Description": "SpotLight"
            },
            "AESpeed": {
                "Type": "range",
                "Readonly": false,
                "Description": "AESpeed",
                "Data": {
                    "Min": 1,
                    "Max": 48
                }
            },
            "ExCompLevel": {
                "Type": "enum",
                "Readonly": false,
                "Description": "ExCompLevel",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "-10.5"
                    },
                    {
                        "Value": 1,
                        "Description": "-9"
                    },
                    {
                        "Value": 2,
                        "Description": "-7.5"
                    },
                    {
                        "Value": 3,
                        "Description": "-6"
                    },
                    {
                        "Value": 4,
                        "Description": "-4.5"
                    },
                    {
                        "Value": 5,
                        "Description": "-3"
                    },
                    {
                        "Value": 6,
                        "Description": "-1.5"
                    },
                    {
                        "Value": 7,
                        "Description": "0"
                    },
                    {
                        "Value": 8,
                        "Description": "+1.5"
                    },
                    {
                        "Value": 9,
                        "Description": "+3"
                    },
                    {
                        "Value": 10,
                        "Description": "+4.5"
                    },
                    {
                        "Value": 11,
                        "Description": "+6"
                    },
                    {
                        "Value": 12,
                        "Description": "+7.5"
                    },
                    {
                        "Value": 13,
                        "Description": "+9"
                    },
                    {
                        "Value": 14,
                        "Description": "+10.5"
                    }
                ]
            },
            "HighSensitivity": {
                "Type": "bool",
                "Readonly": false,
                "Description": "HighSensitivity"
            },
            "ShutterSpeed": {
                "Type": "enum",
                "Readonly": true,
                "Description": "ShutterSpeed",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "1/1"
                    },
                    {
                        "Value": 1,
                        "Description": "1/2"
                    },
                    {
                        "Value": 2,
                        "Description": "1/4"
                    },
                    {
                        "Value": 3,
                        "Description": "1/8"
                    },
                    {
                        "Value": 4,
                        "Description": "1/15"
                    },
                    {
                        "Value": 5,
                        "Description": "1/30"
                    },
                    {
                        "Value": 6,
                        "Description": "1/60"
                    },
                    {
                        "Value": 7,
                        "Description": "1/90"
                    },
                    {
                        "Value": 8,
                        "Description": "1/100"
                    },
                    {
                        "Value": 9,
                        "Description": "1/125"
                    },
                    {
                        "Value": 10,
                        "Description": "1/180"
                    },
                    {
                        "Value": 11,
                        "Description": "1/250"
                    },
                    {
                        "Value": 12,
                        "Description": "1/350"
                    },
                    {
                        "Value": 13,
                        "Description": "1/500"
                    },
                    {
                        "Value": 14,
                        "Description": "1/725"
                    },
                    {
                        "Value": 15,
                        "Description": "1/1000"
                    },
                    {
                        "Value": 16,
                        "Description": "1/1500"
                    },
                    {
                        "Value": 17,
                        "Description": "1/2000"
                    },
                    {
                        "Value": 18,
                        "Description": "1/3000"
                    },
                    {
                        "Value": 19,
                        "Description": "1/4000"
                    },
                    {
                        "Value": 20,
                        "Description": "1/6000"
                    },
                    {
                        "Value": 21,
                        "Description": "1/10000"
                    }
                ]
            },
            "Iris": {
                "Type": "enum",
                "Readonly": true,
                "Description": "Iris",
                "Data": [
                    {
                        "Value": 17,
                        "Description": "F1.6"
                    },
                    {
                        "Value": 16,
                        "Description": "F2.0"
                    },
                    {
                        "Value": 15,
                        "Description": "F2.4"
                    },
                    {
                        "Value": 14,
                        "Description": "F2.8"
                    },
                    {
                        "Value": 13,
                        "Description": "F3.4"
                    },
                    {
                        "Value": 12,
                        "Description": "F4.0"
                    },
                    {
                        "Value": 11,
                        "Description": "F4.8"
                    },
                    {
                        "Value": 10,
                        "Description": "F5.6"
                    },
                    {
                        "Value": 9,
                        "Description": "F6.8"
                    },
                    {
                        "Value": 8,
                        "Description": "F8.0"
                    },
                    {
                        "Value": 7,
                        "Description": "F9.6"
                    },
                    {
                        "Value": 6,
                        "Description": "F11"
                    },
                    {
                        "Value": 5,
                        "Description": "F14"
                    }
                ]
            }
        },
        "WhiteBalanceInfo": {
            "Mode": {
                "Type": "enum",
                "Readonly": false,
                "Description": "WhiteBalance Mode",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "Auto"
                    },
                    {
                        "Value": 1,
                        "Description": "Indoor"
                    },
                    {
                        "Value": 2,
                        "Description": "Outdoor"
                    },
                    {
                        "Value": 3,
                        "Description": "OPW"
                    },
                    {
                        "Value": 4,
                        "Description": "ATW"
                    },
                    {
                        "Value": 5,
                        "Description": "User"
                    },
                    {
                        "Value": 6,
                        "Description": "OutdoorAuto"
                    },
                    {
                        "Value": 7,
                        "Description": "SVLAuto"
                    },
                    {
                        "Value": 8,
                        "Description": "SVL"
                    },
                    {
                        "Value": 9,
                        "Description": "SVLOutdoorAuto"
                    }
                ]
            },
            "RGain": {
                "Type": "range",
                "Readonly": true,
                "Description": "RGain",
                "Data": {
                    "Min": 0,
                    "Max": 255
                }
            },
            "BGain": {
                "Type": "range",
                "Readonly": true,
                "Description": "BGain",
                "Data": {
                    "Min": 0,
                    "Max": 255
                }
            }
        },
        "PictureInfo": {
            "Sharpness": {
                "Type": "range",
                "Readonly": false,
                "Description": "Sharpness",
                "Data": {
                    "Min": 0,
                    "Max": 255
                }
            },
            "2DNR": {
                "Type": "range",
                "Readonly": false,
                "Description": "2DNR",
                "Data": {
                    "Min": 0,
                    "Max": 5
                }
            },
            "3DNR": {
                "Type": "range",
                "Readonly": false,
                "Description": "3DNR",
                "Data": {
                    "Min": 0,
                    "Max": 5
                }
            },
            "Contrast": {
                "Type": "range",
                "Readonly": false,
                "Description": "Contrast",
                "Data": {
                    "Min": 0,
                    "Max": 255
                }
            },
            "ColorGain": {
                "Type": "range",
                "Readonly": false,
                "Description": "ColorGain",
                "Data": {
                    "Min": 0,
                    "Max": 255
                }
            },
            "Hue": {
                "Type": "range",
                "Readonly": false,
                "Description": "Hue",
                "Data": {
                    "Min": 0,
                    "Max": 255
                }
            },
            "ChromaSuppress": {
                "Type": "enum",
                "Readonly": false,
                "Description": "ChromaSuppress",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "OFF"
                    },
                    {
                        "Value": 1,
                        "Description": "Low"
                    },
                    {
                        "Value": 2,
                        "Description": "Middle"
                    },
                    {
                        "Value": 3,
                        "Description": "High"
                    }
                ]
            },
            "DefogMode": {
                "Type": "enum",
                "Readonly": false,
                "Description": "DefogMode",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "OFF"
                    },
                    {
                        "Value": 1,
                        "Description": "Low"
                    },
                    {
                        "Value": 2,
                        "Description": "Middle"
                    },
                    {
                        "Value": 3,
                        "Description": "High"
                    }
                ]
            },
            "Scene": {
                "Type": "enum",
                "Readonly": false,
                "Description": "Scene",
                "Data": [
                    {
                        "Value": 1,
                        "Description": "Standard"
                    },
                    {
                        "Value": 3,
                        "Description": "Bright"
                    },
                    {
                        "Value": 4,
                        "Description": "Clarity"
                    },
                    {
                        "Value": 5,
                        "Description": "Soft"
                    }
                ]
            },
            "HLCMode": {
                "Type": "enum",
                "Readonly": false,
                "Description": "HLCMode",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "OFF"
                    },
                    {
                        "Value": 1,
                        "Description": "Low"
                    },
                    {
                        "Value": 2,
                        "Description": "Middle"
                    },
                    {
                        "Value": 3,
                        "Description": "High"
                    }
                ]
            },
            "Flip": {
                "Type": "bool",
                "Readonly": false,
                "Description": "Flip"
            },
            "Mirror": {
                "Type": "bool",
                "Readonly": false,
                "Description": "Mirror"
            },
            "DeFlicker": {
                "Type": "bool",
                "Readonly": false,
                "Description": "DeFlicker"
            },
            "MagentaGain": {
                "Type": "range",
                "Readonly": false,
                "Description": "MagentaGain",
                "Data": {
                    "Min": 0,
                    "Max": 255
                }
            },
            "RedGain": {
                "Type": "range",
                "Readonly": false,
                "Description": "RedGain",
                "Data": {
                    "Min": 0,
                    "Max": 255
                }
            },
            "YellowGain": {
                "Type": "range",
                "Readonly": false,
                "Description": "YellowGain",
                "Data": {
                    "Min": 0,
                    "Max": 255
                }
            },
            "GreenGain": {
                "Type": "range",
                "Readonly": false,
                "Description": "GreenGain",
                "Data": {
                    "Min": 0,
                    "Max": 255
                }
            },
            "CyanGain": {
                "Type": "range",
                "Readonly": false,
                "Description": "CyanGain",
                "Data": {
                    "Min": 0,
                    "Max": 255
                }
            },
            "BlueGain": {
                "Type": "range",
                "Readonly": false,
                "Description": "BlueGain",
                "Data": {
                    "Min": 0,
                    "Max": 255
                }
            },
            "MagentaHue": {
                "Type": "range",
                "Readonly": false,
                "Description": "MagentaHue",
                "Data": {
                    "Min": 0,
                    "Max": 255
                }
            },
            "RedHue": {
                "Type": "range",
                "Readonly": false,
                "Description": "RedHue",
                "Data": {
                    "Min": 0,
                    "Max": 255
                }
            },
            "YellowHue": {
                "Type": "range",
                "Readonly": false,
                "Description": "YellowHue",
                "Data": {
                    "Min": 0,
                    "Max": 255
                }
            },
            "GreenHue": {
                "Type": "range",
                "Readonly": false,
                "Description": "GreenHue",
                "Data": {
                    "Min": 0,
                    "Max": 255
                }
            },
            "CyanHue": {
                "Type": "range",
                "Readonly": false,
                "Description": "CyanHue",
                "Data": {
                    "Min": 0,
                    "Max": 255
                }
            },
            "BlueHue": {
                "Type": "range",
                "Readonly": false,
                "Description": "BlueHue",
                "Data": {
                    "Min": 0,
                    "Max": 255
                }
            },
            "Effect": {
                "Type": "enum",
                "Readonly": false,
                "Description": "Effect",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "Day"
                    },
                    {
                        "Value": 1,
                        "Description": "Night"
                    }
                ]
            }
        },
        "GammaInfo": {
            "Mode": {
                "Type": "enum",
                "Readonly": false,
                "Description": "GammaInfo",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "Standard"
                    },
                    {
                        "Value": 1,
                        "Description": "Straight"
                    }
                ]
            },
            "Offset": {
                "Type": "range",
                "Readonly": false,
                "Description": "Offset",
                "Data": {
                    "Min": -64,
                    "Max": 64
                }
            },
            "VEorWDR": {
                "Type": "enum",
                "Readonly": false,
                "Description": "VE or WDR",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "OFF"
                    },
                    {
                        "Value": 1,
                        "Description": "VE ON"
                    },
                    {
                        "Value": 2,
                        "Description": "WDR ON"
                    }
                ]
            },
            "Bright": {
                "Type": "range",
                "Readonly": false,
                "Description": "Bright Level",
                "Data": {
                    "Min": 0,
                    "Max": 6
                }
            },
            "BrightComp": {
                "Type": "range",
                "Readonly": false,
                "Description": "BrightComp",
                "Data": {
                    "Min": 0,
                    "Max": 3
                }
            },
            "CompLevel": {
                "Type": "enum",
                "Readonly": false,
                "Description": "CompLevel",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "Low"
                    },
                    {
                        "Value": 1,
                        "Description": "Middle"
                    },
                    {
                        "Value": 2,
                        "Description": "High"
                    }
                ]
            }
        },
        "LensInfo": {
            "FocusMode": {
                "Type": "enum",
                "Readonly": false,
                "Description": "FocusMode",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "Auto"
                    },
                    {
                        "Value": 1,
                        "Description": "Manual"
                    }
                ]
            },
            "SpotFocus": {
                "Type": "bool",
                "Readonly": false,
                "Description": "SpotFocus"
            },
            "AFSensitivity": {
                "Type": "enum",
                "Readonly": false,
                "Description": "AFSensitivity",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "Normal"
                    },
                    {
                        "Value": 1,
                        "Description": "Low"
                    }
                ]
            },
            "DigitalZoom": {
                "Type": "bool",
                "Readonly": false,
                "Description": "DigitalZoom"
            },
            "FocusArea": {
                "Type": "enum",
                "Readonly": false,
                "Description": "FocusArea",
                "Data": [
                    {
                        "Value": 2,
                        "Description": "All"
                    },
                    {
                        "Value": 4,
                        "Description": "Center"
                    }
                ]
            },
            "MFSpeed": {
                "Type": "range",
                "Readonly": false,
                "Description": "MFSpeed",
                "Data": {
                    "Min": 0,
                    "Max": 7
                }
            },
            "Stabilizer": {
                "Type": "enum",
                "Readonly": false,
                "Description": "Stabilizer",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "OFF"
                    },
                    {
                        "Value": 1,
                        "Description": "Super"
                    },
                    {
                        "Value": 2,
                        "Description": "Super+"
                    }
                ]
            },
            "NearLimit": {
                "Type": "enum",
                "Readonly": false,
                "Description": "NearLimit",
                "Data": [
                    {
                        "Value": 1,
                        "Description": "Over"
                    },
                    {
                        "Value": 2,
                        "Description": "12m"
                    },
                    {
                        "Value": 3,
                        "Description": "6m"
                    },
                    {
                        "Value": 4,
                        "Description": "4m"
                    },
                    {
                        "Value": 5,
                        "Description": "3m"
                    },
                    {
                        "Value": 6,
                        "Description": "2.4m"
                    },
                    {
                        "Value": 7,
                        "Description": "2m"
                    },
                    {
                        "Value": 8,
                        "Description": "1.7m"
                    },
                    {
                        "Value": 9,
                        "Description": "1.5m"
                    },
                    {
                        "Value": 10,
                        "Description": "1.3m"
                    },
                    {
                        "Value": 11,
                        "Description": "1.2m"
                    },
                    {
                        "Value": 12,
                        "Description": "61cm"
                    },
                    {
                        "Value": 13,
                        "Description": "33cm"
                    },
                    {
                        "Value": 14,
                        "Description": "20cm"
                    },
                    {
                        "Value": 15,
                        "Description": "10cm"
                    }
                ]
            }
        },
        "PanTiltInfo": {
            "AdaptivePT": {
                "Type": "bool",
                "Readonly": false,
                "Description": "AdaptivePT"
            },
            "PanDirection": {
                "Type": "enum",
                "Readonly": false,
                "Description": "PanDirection",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "Normal"
                    },
                    {
                        "Value": 1,
                        "Description": "Invert"
                    }
                ]
            },
            "TiltDirection": {
                "Type": "enum",
                "Readonly": false,
                "Description": "TiltDirection",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "Normal"
                    },
                    {
                        "Value": 1,
                        "Description": "Invert"
                    }
                ]
            },
            "PresetMemory": {
                "Type": "enum",
                "Readonly": false,
                "Description": "PresetMemory",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "StandardMode"
                    },
                    {
                        "Value": 1,
                        "Description": "ExtendedMode"
                    }
                ]
            },
            "PTSpeed": {
                "Type": "range",
                "Readonly": false,
                "Description": "PTSpeed",
                "Data": {
                    "Min": 0,
                    "Max": 5
                }
            },
            "PresetSpeed": {
                "Type": "range",
                "Readonly": false,
                "Description": "PresetSpeed",
                "Data": {
                    "Min": 0,
                    "Max": 5
                }
            },
            "MotionlessPreset": {
                "Type": "bool",
                "Readonly": false,
                "Description": "MotionlessPreset"
            },
            "ReloadPreset1": {
                "Type": "bool",
                "Readonly": false,
                "Description": "ReloadPreset1"
            }
        },
        "GenlockInfo": {
            "HPhase": {
                "Type": "range",
                "Readonly": false,
                "Description": "HPhase",
                "Data": {
                    "Min": -127,
                    "Max": 127
                }
            },
            "GenlockStatus": {
                "Type": "enum",
                "Readonly": true,
                "Description": "GenlockStatus",
                "Data": [
                    {
                        "Value": 2,
                        "Description": "Active"
                    },
                    {
                        "Value": 3,
                        "Description": "Inactive"
                    }
                ]
            },
            "RefSignal": {
                "Type": "enum",
                "Readonly": true,
                "Description": "RefSignal",
                "Data": [
                    {},
                    {
                        "Value": "525I29.97",
                        "Description": "525I29.97"
                    },
                    {
                        "Value": "625I25",
                        "Description": "625I25"
                    },
                    {
                        "Value": "525P59.94",
                        "Description": "525P59.94"
                    },
                    {
                        "Value": "625P50",
                        "Description": "625P50"
                    },
                    {
                        "Value": "720P60",
                        "Description": "720P60"
                    },
                    {
                        "Value": "720P59.94",
                        "Description": "720P59.94"
                    },
                    {
                        "Value": "720P50",
                        "Description": "720P50"
                    },
                    {
                        "Value": "720P30",
                        "Description": "720P30"
                    },
                    {
                        "Value": "720P29.97",
                        "Description": "720P29.97"
                    },
                    {
                        "Value": "720P25",
                        "Description": "720P25"
                    },
                    {
                        "Value": "720P24",
                        "Description": "720P24"
                    },
                    {
                        "Value": "720P23.98",
                        "Description": "720P23.98"
                    },
                    {
                        "Value": "1080P60",
                        "Description": "1080P60"
                    },
                    {
                        "Value": "1080P59.94",
                        "Description": "1080P59.94"
                    },
                    {
                        "Value": "1080P50",
                        "Description": "1080P50"
                    },
                    {
                        "Value": "1080P30",
                        "Description": "1080P30"
                    },
                    {
                        "Value": "1080P29.97",
                        "Description": "1080P29.97"
                    },
                    {
                        "Value": "1080P25",
                        "Description": "1080P25"
                    },
                    {
                        "Value": "1080P24",
                        "Description": "1080P24"
                    },
                    {
                        "Value": "1080P23.98",
                        "Description": "1080P23.98"
                    },
                    {
                        "Value": "1080I30",
                        "Description": "1080I30"
                    },
                    {
                        "Value": "1080I29.97",
                        "Description": "1080I29.97"
                    },
                    {
                        "Value": "1080I25",
                        "Description": "1080I25"
                    },
                    {
                        "Value": "1080I24",
                        "Description": "1080I24"
                    },
                    {
                        "Value": "1080I23.98",
                        "Description": "1080I23.98"
                    }
                ]
            }
        },
        "OSDSystemInfo": {
            "PelcoID": {
                "Type": "range",
                "Readonly": false,
                "Description": "PelcoID",
                "Data": {
                    "Min": 1,
                    "Max": 255
                }
            },
            "ViscaID": {
                "Type": "range",
                "Readonly": false,
                "Description": "ViscaID",
                "Data": {
                    "Min": 1,
                    "Max": 7
                }
            },
            "IRID": {
                "Type": "range",
                "Readonly": false,
                "Description": "IRID",
                "Data": {
                    "Min": 1,
                    "Max": 3
                }
            },
            "IRReceive": {
                "Type": "bool",
                "Readonly": false,
                "Description": "IRReceive"
            },
            "CommType": {
                "Type": "enum",
                "Readonly": true,
                "Description": "CommType",
                "Data": [
                    {
                        "Value": 1,
                        "Description": "RS422"
                    }
                ]
            },
            "BaudRate": {
                "Type": "enum",
                "Readonly": false,
                "Description": "BaudRate",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "2400"
                    },
                    {
                        "Value": 1,
                        "Description": "4800"
                    },
                    {
                        "Value": 2,
                        "Description": "9600"
                    },
                    {
                        "Value": 3,
                        "Description": "38400"
                    }
                ]
            },
            "DisplayInfo": {
                "Type": "bool",
                "Readonly": false,
                "Description": "DisplayInfo"
            },
            "VideoParametersOSD": {
                "Type": "bool",
                "Readonly": false,
                "Description": "VideoParametersOSD"
            },
            "ColorSpace": {
                "Type": "enum",
                "Readonly": false,
                "Description": "ColorSpace",
                "Data": [
                    {
                        "Value": 1,
                        "Description": "RGB"
                    },
                    {
                        "Value": 2,
                        "Description": "YUV422"
                    }
                ]
            },
            "TallyMode": {
                "Type": "bool",
                "Readonly": false,
                "Description": "TallyMode"
            }
        }
    }
}

Parameters

  • ExposureInfo
    Show properties
    • Modeenum(Optional)
      Description: ExposureMode
      Value: : Auto, 1: Manual, 2: ShutterPri, 3: IrisPri
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • SlowShutterbool(Optional)
      Description: SlowShutter
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • SlowShutterLimitenum(Optional)
      Description: SlowShutterLimit
      Value: 1: 1/30, 2: 1/15, 3: 1/8, 4: 1/4, 5: 1/2, 6: 1/1
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • GainLimitenum(Optional)
      Description: GainLimit,The high sensitivity open state is limited to 10.7dB 14.3dB 17.9dB 21.4dB 25.0dB 28.6dB 32.1dB 35.7dB 39.3dB 42.9dB 46.4dB 50.0dB;The closure status is limited to 15.0dB 20.0dB 25.0dB 30.0dB 35.0dB 40.0dB 45.0dB 50.0dB 55.0dB 60.0dB 65.0dB 70.0dB
      Value: 4: 10.7dB, 5: 14.3dB, 6: 17.9dB, 7: 21.4dB, 8: 25.0dB, 9: 28.6dB, 10: 32.1dB, 11: 35.7dB, 12: 39.3dB, 13: 42.9dB, 14: 46.4dB, 15: 50.0dB
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • Gainenum(Optional)
      Description: Gain High sensitivity off state is limited to 0dB 3.6dB 7.1dB 10.7dB 14.3dB 17.9dB 21.4dB 25.0dB 28.6dB 32.1dB 35.7dB 39.3dB 42.9dB 46.4dB 50.0dB;The high sensitivity open state is limited to 0dB 5.0dB 10.0dB 15.0dB 20.0dB 25.0dB 30.0dB 35.0dB 40.0dB 45.0dB 50.0dB 55.0dB 60.0dB 65.0dB 70.0dB
      Value: 1: 0dB, 2: 3.6dB, 3: 7.1dB, 4: 10.7dB, 5: 14.3dB, 6: 17.9dB, 7: 21.4dB, 8: 25.0dB, 9: 28.6dB, 10: 32.1dB, 11: 35.7dB, 12: 39.3dB, 13: 42.9dB, 14: 46.4dB, 15: 50.0dB
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • Excompbool(Optional)
      Description: Exposure Compensation
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • BackLightbool(Optional)
      Description: BackLight
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • SpotLightbool(Optional)
      Description: SpotLight
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • AESpeedrange(Optional)
      Description: AESpeed
      Value: 1-48
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • ExCompLevelenum(Optional)
      Description: ExCompLevel
      Value: : -10.5, 1: -9, 2: -7.5, 3: -6, 4: -4.5, 5: -3, 6: -1.5, 7, 8: +1.5, 9: +3, 10: +4.5, 11: +6, 12: +7.5, 13: +9, 14: +10.5
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • HighSensitivitybool(Optional)
      Description: HighSensitivity
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • ShutterSpeedenum(Optional)
      Description: ShutterSpeed
      Value: : 1/1, 1: 1/2, 2: 1/4, 3: 1/8, 4: 1/15, 5: 1/30, 6: 1/60, 7: 1/90, 8: 1/100, 9: 1/125, 10: 1/180, 11: 1/250, 12: 1/350, 13: 1/500, 14: 1/725, 15: 1/1000, 16: 1/1500, 17: 1/2000, 18: 1/3000, 19: 1/4000, 20: 1/6000, 21: 1/10000
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • Irisenum(Optional)
      Description: Iris
      Value: 17: F1.6, 16: F2.0, 15: F2.4, 14: F2.8, 13: F3.4, 12: F4.0, 11: F4.8, 10: F5.6, 9: F6.8, 8: F8.0, 7: F9.6, 6: F11, 5: F14
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
  • WhiteBalanceInfo
    Show properties
    • Modeenum(Optional)
      Description: WhiteBalance Mode
      Value: : Auto, 1: Indoor, 2: Outdoor, 3: OPW, 4: ATW, 5: User, 6: OutdoorAuto, 7: SVLAuto, 8: SVL, 9: SVLOutdoorAuto
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • RGainrange(Optional)
      Description: RGain
      Value: 0-255
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • BGainrange(Optional)
      Description: BGain
      Value: 0-255
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
  • PictureInfo
    Show properties
    • Sharpnessrange(Optional)
      Description: Sharpness
      Value: 0-255
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • 2DNRrange(Optional)
      Description: 2DNR
      Value: 0-5
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • 3DNRrange(Optional)
      Description: 3DNR
      Value: 0-5
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • Contrastrange(Optional)
      Description: Contrast
      Value: 0-255
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • ColorGainrange(Optional)
      Description: ColorGain
      Value: 0-255
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • Huerange(Optional)
      Description: Hue
      Value: 0-255
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • ChromaSuppressenum(Optional)
      Description: ChromaSuppress
      Value: : OFF, 1: Low, 2: Middle, 3: High
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • DefogModeenum(Optional)
      Description: DefogMode
      Value: : OFF, 1: Low, 2: Middle, 3: High
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • Sceneenum(Optional)
      Description: Scene
      Value: 1: Standard, 3: Bright, 4: Clarity, 5: Soft
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • HLCModeenum(Optional)
      Description: HLCMode
      Value: : OFF, 1: Low, 2: Middle, 3: High
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • Flipbool(Optional)
      Description: Flip
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • Mirrorbool(Optional)
      Description: Mirror
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • DeFlickerbool(Optional)
      Description: DeFlicker
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • MagentaGainrange(Optional)
      Description: MagentaGain
      Value: 0-255
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • RedGainrange(Optional)
      Description: RedGain
      Value: 0-255
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • YellowGainrange(Optional)
      Description: YellowGain
      Value: 0-255
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • GreenGainrange(Optional)
      Description: GreenGain
      Value: 0-255
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • CyanGainrange(Optional)
      Description: CyanGain
      Value: 0-255
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • BlueGainrange(Optional)
      Description: BlueGain
      Value: 0-255
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • MagentaHuerange(Optional)
      Description: MagentaHue
      Value: 0-255
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • RedHuerange(Optional)
      Description: RedHue
      Value: 0-255
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • YellowHuerange(Optional)
      Description: YellowHue
      Value: 0-255
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • GreenHuerange(Optional)
      Description: GreenHue
      Value: 0-255
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • CyanHuerange(Optional)
      Description: CyanHue
      Value: 0-255
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • BlueHuerange(Optional)
      Description: BlueHue
      Value: 0-255
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • Effectenum(Optional)
      Description: Effect
      Value: : Day, 1: Night
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
  • GammaInfo
    Show properties
    • Modeenum(Optional)
      Description: GammaInfo
      Value: : Standard, 1: Straight
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • Offsetrange(Optional)
      Description: Offset
      Value: -64-64
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • VEorWDRenum(Optional)
      Description: VE or WDR
      Value: : OFF, 1: VE ON, 2: WDR ON
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • Brightrange(Optional)
      Description: Bright Level
      Value: 0-6
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • BrightComprange(Optional)
      Description: BrightComp
      Value: 0-3
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • CompLevelenum(Optional)
      Description: CompLevel
      Value: : Low, 1: Middle, 2: High
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
  • LensInfo
    Show properties
    • FocusModeenum(Optional)
      Description: FocusMode
      Value: : Auto, 1: Manual
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • SpotFocusbool(Optional)
      Description: SpotFocus
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • AFSensitivityenum(Optional)
      Description: AFSensitivity
      Value: : Normal, 1: Low
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • DigitalZoombool(Optional)
      Description: DigitalZoom
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • FocusAreaenum(Optional)
      Description: FocusArea
      Value: 2: All, 4: Center
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • MFSpeedrange(Optional)
      Description: MFSpeed
      Value: 0-7
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • Stabilizerenum(Optional)
      Description: Stabilizer
      Value: : OFF, 1: Super, 2: Super+
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • NearLimitenum(Optional)
      Description: NearLimit
      Value: 1: Over, 2: 12m, 3: 6m, 4: 4m, 5: 3m, 6: 2.4m, 7: 2m, 8: 1.7m, 9: 1.5m, 10: 1.3m, 11: 1.2m, 12: 61cm, 13: 33cm, 14: 20cm, 15: 10cm
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
  • PanTiltInfo
    Show properties
    • AdaptivePTbool(Optional)
      Description: AdaptivePT
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • PanDirectionenum(Optional)
      Description: PanDirection
      Value: : Normal, 1: Invert
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • TiltDirectionenum(Optional)
      Description: TiltDirection
      Value: : Normal, 1: Invert
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • PresetMemoryenum(Optional)
      Description: PresetMemory
      Value: : StandardMode, 1: ExtendedMode
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • PTSpeedrange(Optional)
      Description: PTSpeed
      Value: 0-5
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • PresetSpeedrange(Optional)
      Description: PresetSpeed
      Value: 0-5
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • MotionlessPresetbool(Optional)
      Description: MotionlessPreset
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • ReloadPreset1bool(Optional)
      Description: ReloadPreset1
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
  • GenlockInfo
    Show properties
    • HPhaserange(Optional)
      Description: HPhase
      Value: -127-127
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • GenlockStatusenum(Optional)
      Description: GenlockStatus
      Value: 2: Active, 3: Inactive
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • RefSignalenum(Optional)
      Description: RefSignal
      Value: , 525I29.97: 525I29.97, 625I25: 625I25, 525P59.94: 525P59.94, 625P50: 625P50, 720P60: 720P60, 720P59.94: 720P59.94, 720P50: 720P50, 720P30: 720P30, 720P29.97: 720P29.97, 720P25: 720P25, 720P24: 720P24, 720P23.98: 720P23.98, 1080P60: 1080P60, 1080P59.94: 1080P59.94, 1080P50: 1080P50, 1080P30: 1080P30, 1080P29.97: 1080P29.97, 1080P25: 1080P25, 1080P24: 1080P24, 1080P23.98: 1080P23.98, 1080I30: 1080I30, 1080I29.97: 1080I29.97, 1080I25: 1080I25, 1080I24: 1080I24, 1080I23.98: 1080I23.98
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
  • OSDSystemInfo
    Show properties
    • PelcoIDrange(Optional)
      Description: PelcoID
      Value: 1-255
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • ViscaIDrange(Optional)
      Description: ViscaID
      Value: 1-7
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • IRIDrange(Optional)
      Description: IRID
      Value: 1-3
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • IRReceivebool(Optional)
      Description: IRReceive
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • CommTypeenum(Optional)
      Description: CommType
      Value: 1: RS422
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • BaudRateenum(Optional)
      Description: BaudRate
      Value: : 2400, 1: 4800, 2: 9600, 3: 38400
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • DisplayInfobool(Optional)
      Description: DisplayInfo
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • VideoParametersOSDbool(Optional)
      Description: VideoParametersOSD
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • ColorSpaceenum(Optional)
      Description: ColorSpace
      Value: 1: RGB, 2: YUV422
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • TallyModebool(Optional)
      Description: TallyMode
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)

ReqGetImageInfo

POSTapiv2/image

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetImageInfo\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/image

Sample Request

{
    "Cmd": "ReqGetImageInfo",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetImageInfo",
    "Version": "2.00.000",
    "Content": {
        "ExposureInfo": {
            "Mode": 0,
            "HighSensitivity": false,
            "SlowShutter": false,
            "SlowShutterLimit": 6,
            "GainLimit": 11,
            "BackLight": false,
            "SpotLight": false,
            "AESpeed": 1,
            "ExComp": false,
            "ExCompLevel": 7,
            "Gain": 15,
            "ShutterSpeed": 63,
            "Iris": 5
        },
        "WhiteBalanceInfo": {
            "Mode": 0,
            "RGain": 15,
            "BGain": 15
        },
        "PictureInfo": {
            "Sharpness": 12,
            "2DNR": 3,
            "3DNR": 1,
            "Flip": false,
            "Mirror": false,
            "ChromaSuppress": 0,
            "DefogMode": 0,
            "HLCMode": 0,
            "Scene": 1,
            "Hue": 128,
            "Contrast": 128,
            "DeFlicker": false,
            "Effect": 0,
            "ColorGain": 128,
            "MagentaGain": 128,
            "RedGain": 128,
            "YellowGain": 128,
            "GreenGain": 128,
            "CyanGain": 128,
            "BlueGain": 128,
            "MagentaHue": 128,
            "RedHue": 128,
            "YellowHue": 128,
            "GreenHue": 128,
            "CyanHue": 128,
            "BlueHue": 128
        },
        "GammaInfo": {
            "Mode": 0,
            "Offset": 0,
            "VEorWDR": 0,
            "Bright": 3,
            "BrightComp": 2,
            "CompLevel": 1
        },
        "LensInfo": {
            "FocusMode": 1,
            "AFSensitivity": 1,
            "MFSpeed": 2,
            "NearLimit": 13,
            "Stabilizer": 0,
            "DigitalZoom": false,
            "SpotFocus": true,
            "FocusArea": 4
        },
        "PanTiltInfo": {
            "AdaptivePT": true,
            "PTSpeed": 3,
            "PanDirection": 0,
            "TiltDirection": 0,
            "PresetMemory": 0,
            "PresetSpeed": 5,
            "MotionlessPreset": false,
            "ReloadPreset1": true
        },
        "GenlockInfo": {
            "HPhase": 0,
            "GenlockStatus": 3,
            "RefSignal": "N/A"
        },
        "SystemInfo": {
            "PelcoID": 1,
            "VISCAID": 1,
            "IRID": 3,
            "IRReceive": true,
            "VideoParametersOSD": false,
            "ColorSpace": 1,
            "TallyMode": false,
            "BaudRate": 2,
            "DisplayInfo": true,
            "CommType": 1
        },
        "Status": 0
    }
}

Parameters

  • ExposureInfo
    Show properties
    • Modeenum(Optional)
      Description: ExposureMode
      Value: : Auto, 1: Manual, 2: ShutterPri, 3: IrisPri
    • HighSensitivitybool(Optional)
      Description: HighSensitivity
      Value: true/false
    • SlowShutterbool(Optional)
      Description: SlowShutter
      Value: true/false
    • SlowShutterLimitenum(Optional)
      Description: SlowShutterLimit
      Value: 1: 1/30, 2: 1/15, 3: 1/8, 4: 1/4, 5: 1/2, 6: 1/1
    • GainLimitenum(Optional)
      Description: GainLimit,The high sensitivity open state is limited to 10.7dB 14.3dB 17.9dB 21.4dB 25.0dB 28.6dB 32.1dB 35.7dB 39.3dB 42.9dB 46.4dB 50.0dB;The closure status is limited to 15.0dB 20.0dB 25.0dB 30.0dB 35.0dB 40.0dB 45.0dB 50.0dB 55.0dB 60.0dB 65.0dB 70.0dB
      Value: 4: 10.7dB, 5: 14.3dB, 6: 17.9dB, 7: 21.4dB, 8: 25.0dB, 9: 28.6dB, 10: 32.1dB, 11: 35.7dB, 12: 39.3dB, 13: 42.9dB, 14: 46.4dB, 15: 50.0dB
    • BackLightbool(Optional)
      Description: BackLight
      Value: true/false
    • SpotLightbool(Optional)
      Description: SpotLight
      Value: true/false
    • AESpeedrange(Optional)
      Description: AESpeed
      Value: 1-48
    • ExCompLevelenum(Optional)
      Description: ExCompLevel
      Value: : -10.5, 1: -9, 2: -7.5, 3: -6, 4: -4.5, 5: -3, 6: -1.5, 7, 8: +1.5, 9: +3, 10: +4.5, 11: +6, 12: +7.5, 13: +9, 14: +10.5
    • Gainenum(Optional)
      Description: Gain High sensitivity off state is limited to 0dB 3.6dB 7.1dB 10.7dB 14.3dB 17.9dB 21.4dB 25.0dB 28.6dB 32.1dB 35.7dB 39.3dB 42.9dB 46.4dB 50.0dB;The high sensitivity open state is limited to 0dB 5.0dB 10.0dB 15.0dB 20.0dB 25.0dB 30.0dB 35.0dB 40.0dB 45.0dB 50.0dB 55.0dB 60.0dB 65.0dB 70.0dB
      Value: 1: 0dB, 2: 3.6dB, 3: 7.1dB, 4: 10.7dB, 5: 14.3dB, 6: 17.9dB, 7: 21.4dB, 8: 25.0dB, 9: 28.6dB, 10: 32.1dB, 11: 35.7dB, 12: 39.3dB, 13: 42.9dB, 14: 46.4dB, 15: 50.0dB
    • ShutterSpeedenum(Optional)
      Description: ShutterSpeed
      Value: : 1/1, 1: 1/2, 2: 1/4, 3: 1/8, 4: 1/15, 5: 1/30, 6: 1/60, 7: 1/90, 8: 1/100, 9: 1/125, 10: 1/180, 11: 1/250, 12: 1/350, 13: 1/500, 14: 1/725, 15: 1/1000, 16: 1/1500, 17: 1/2000, 18: 1/3000, 19: 1/4000, 20: 1/6000, 21: 1/10000
    • Irisenum(Optional)
      Description: Iris
      Value: 17: F1.6, 16: F2.0, 15: F2.4, 14: F2.8, 13: F3.4, 12: F4.0, 11: F4.8, 10: F5.6, 9: F6.8, 8: F8.0, 7: F9.6, 6: F11, 5: F14
  • WhiteBalanceInfo
    Show properties
    • Modeenum(Optional)
      Description: WhiteBalance Mode
      Value: : Auto, 1: Indoor, 2: Outdoor, 3: OPW, 4: ATW, 5: User, 6: OutdoorAuto, 7: SVLAuto, 8: SVL, 9: SVLOutdoorAuto
    • RGainrange(Optional)
      Description: RGain
      Value: 0-255
    • BGainrange(Optional)
      Description: BGain
      Value: 0-255
  • PictureInfo
    Show properties
    • Sharpnessrange(Optional)
      Description: Sharpness
      Value: 0-255
    • 2DNRrange(Optional)
      Description: 2DNR
      Value: 0-5
    • 3DNRrange(Optional)
      Description: 3DNR
      Value: 0-5
    • Flipbool(Optional)
      Description: Flip
      Value: true/false
    • Mirrorbool(Optional)
      Description: Mirror
      Value: true/false
    • ChromaSuppressenum(Optional)
      Description: ChromaSuppress
      Value: : OFF, 1: Low, 2: Middle, 3: High
    • DefogModeenum(Optional)
      Description: DefogMode
      Value: : OFF, 1: Low, 2: Middle, 3: High
    • HLCModeenum(Optional)
      Description: HLCMode
      Value: : OFF, 1: Low, 2: Middle, 3: High
    • Sceneenum(Optional)
      Description: Scene
      Value: 1: Standard, 3: Bright, 4: Clarity, 5: Soft
    • Huerange(Optional)
      Description: Hue
      Value: 0-255
    • Contrastrange(Optional)
      Description: Contrast
      Value: 0-255
    • DeFlickerbool(Optional)
      Description: DeFlicker
      Value: true/false
    • Effectenum(Optional)
      Description: Effect
      Value: : Day, 1: Night
    • ColorGainrange(Optional)
      Description: ColorGain
      Value: 0-255
    • MagentaGainrange(Optional)
      Description: MagentaGain
      Value: 0-255
    • RedGainrange(Optional)
      Description: RedGain
      Value: 0-255
    • YellowGainrange(Optional)
      Description: YellowGain
      Value: 0-255
    • GreenGainrange(Optional)
      Description: GreenGain
      Value: 0-255
    • CyanGainrange(Optional)
      Description: CyanGain
      Value: 0-255
    • BlueGainrange(Optional)
      Description: BlueGain
      Value: 0-255
    • MagentaHuerange(Optional)
      Description: MagentaHue
      Value: 0-255
    • RedHuerange(Optional)
      Description: RedHue
      Value: 0-255
    • YellowHuerange(Optional)
      Description: YellowHue
      Value: 0-255
    • GreenHuerange(Optional)
      Description: GreenHue
      Value: 0-255
    • CyanHuerange(Optional)
      Description: CyanHue
      Value: 0-255
    • BlueHuerange(Optional)
      Description: BlueHue
      Value: 0-255
  • GammaInfo
    Show properties
    • Modeenum(Optional)
      Description: GammaInfo
      Value: : Standard, 1: Straight
    • Offsetrange(Optional)
      Description: Offset
      Value: -64-64
    • VEorWDRenum(Optional)
      Description: VE or WDR
      Value: : OFF, 1: VE ON, 2: WDR ON
    • Brightrange(Optional)
      Description: Bright Level
      Value: 0-6
    • BrightComprange(Optional)
      Description: BrightComp
      Value: 0-3
    • CompLevelenum(Optional)
      Description: CompLevel
      Value: : Low, 1: Middle, 2: High
  • LensInfo
    Show properties
    • FocusModeenum(Optional)
      Description: FocusMode
      Value: : Auto, 1: Manual
    • AFSensitivityenum(Optional)
      Description: AFSensitivity
      Value: : Normal, 1: Low
    • MFSpeedrange(Optional)
      Description: MFSpeed
      Value: 0-7
    • NearLimitenum(Optional)
      Description: NearLimit
      Value: 1: Over, 2: 12m, 3: 6m, 4: 4m, 5: 3m, 6: 2.4m, 7: 2m, 8: 1.7m, 9: 1.5m, 10: 1.3m, 11: 1.2m, 12: 61cm, 13: 33cm, 14: 20cm, 15: 10cm
    • Stabilizerenum(Optional)
      Description: Stabilizer
      Value: : OFF, 1: Super, 2: Super+
    • DigitalZoombool(Optional)
      Description: DigitalZoom
      Value: true/false
    • SpotFocusbool(Optional)
      Description: SpotFocus
      Value: true/false
    • FocusAreaenum(Optional)
      Description: FocusArea
      Value: 2: All, 4: Center
  • PanTiltInfo
    Show properties
    • AdaptivePTbool(Optional)
      Description: AdaptivePT
      Value: true/false
    • PTSpeedrange(Optional)
      Description: PTSpeed
      Value: 0-5
    • PanDirectionenum(Optional)
      Description: PanDirection
      Value: : Normal, 1: Invert
    • TiltDirectionenum(Optional)
      Description: TiltDirection
      Value: : Normal, 1: Invert
    • PresetMemoryenum(Optional)
      Description: PresetMemory
      Value: : StandardMode, 1: ExtendedMode
    • PresetSpeedrange(Optional)
      Description: PresetSpeed
      Value: 0-5
    • MotionlessPresetbool(Optional)
      Description: MotionlessPreset
      Value: true/false
    • ReloadPreset1bool(Optional)
      Description: ReloadPreset1
      Value: true/false
  • GenlockInfo
    Show properties
    • HPhaserange(Optional)
      Description: HPhase
      Value: -127-127
    • GenlockStatusenum(Optional)
      Description: GenlockStatus
      Value: 2: Active, 3: Inactive
    • RefSignalenum(Optional)
      Description: RefSignal
      Value: , 525I29.97: 525I29.97, 625I25: 625I25, 525P59.94: 525P59.94, 625P50: 625P50, 720P60: 720P60, 720P59.94: 720P59.94, 720P50: 720P50, 720P30: 720P30, 720P29.97: 720P29.97, 720P25: 720P25, 720P24: 720P24, 720P23.98: 720P23.98, 1080P60: 1080P60, 1080P59.94: 1080P59.94, 1080P50: 1080P50, 1080P30: 1080P30, 1080P29.97: 1080P29.97, 1080P25: 1080P25, 1080P24: 1080P24, 1080P23.98: 1080P23.98, 1080I30: 1080I30, 1080I29.97: 1080I29.97, 1080I25: 1080I25, 1080I24: 1080I24, 1080I23.98: 1080I23.98

ReqSetImageInfo

POSTapiv2/image

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetImageInfo\",\"Version\":\"2.0.000\",\"Content\":{\"ExposureInfo\":{\"Mode\":0,\"HighSensitivity\":false,\"SlowShutter\":false,\"SlowShutterLimit\":6,\"GainLimit\":11,\"BackLight\":false,\"SpotLight\":false,\"AESpeed\":1,\"ExComp\":false,\"ExCompLevel\":7,\"Gain\":15,\"ShutterSpeed\":63,\"Iris\":5},\"WhiteBalanceInfo\":{\"Mode\":0,\"RGain\":15,\"BGain\":15},\"PictureInfo\":{\"Sharpness\":12,\"2DNR\":3,\"3DNR\":1,\"Flip\":false,\"Mirror\":false,\"ChromaSuppress\":0,\"DefogMode\":0,\"HLCMode\":0,\"Scene\":1,\"Hue\":128,\"Contrast\":128,\"DeFlicker\":false,\"Effect\":0,\"ColorGain\":128,\"MagentaGain\":128,\"RedGain\":128,\"YellowGain\":128,\"GreenGain\":128,\"CyanGain\":128,\"BlueGain\":128,\"MagentaHue\":128,\"RedHue\":128,\"YellowHue\":128,\"GreenHue\":128,\"CyanHue\":128,\"BlueHue\":128},\"GammaInfo\":{\"Mode\":0,\"Offset\":0,\"VEorWDR\":0,\"Bright\":3,\"BrightComp\":2,\"CompLevel\":1},\"LensInfo\":{\"FocusMode\":1,\"AFSensitivity\":1,\"MFSpeed\":2,\"NearLimit\":13,\"Stabilizer\":0,\"DigitalZoom\":false,\"SpotFocus\":true,\"FocusArea\":4},\"PanTiltInfo\":{\"AdaptivePT\":true,\"PTSpeed\":3,\"PanDirection\":0,\"TiltDirection\":0,\"PresetMemory\":0,\"PresetSpeed\":5,\"MotionlessPreset\":false,\"ReloadPreset1\":true},\"GenlockInfo\":{\"HPhase\":0},\"SystemInfo\":{\"PelcoID\":1,\"VISCAID\":1,\"IRID\":3,\"IRReceive\":true,\"VideoParametersOSD\":false,\"ColorSpace\":1,\"TallyMode\":false,\"BaudRate\":2,\"DisplayInfo\":true,\"CommType\":1}}}' http://example.com/apiv2/image

Sample Request

{
    "Cmd": "ReqSetImageInfo",
    "Version": "2.0.000",
    "Content": {
        "ExposureInfo": {
            "Mode": 0,
            "HighSensitivity": false,
            "SlowShutter": false,
            "SlowShutterLimit": 6,
            "GainLimit": 11,
            "BackLight": false,
            "SpotLight": false,
            "AESpeed": 1,
            "ExComp": false,
            "ExCompLevel": 7,
            "Gain": 15,
            "ShutterSpeed": 63,
            "Iris": 5
        },
        "WhiteBalanceInfo": {
            "Mode": 0,
            "RGain": 15,
            "BGain": 15
        },
        "PictureInfo": {
            "Sharpness": 12,
            "2DNR": 3,
            "3DNR": 1,
            "Flip": false,
            "Mirror": false,
            "ChromaSuppress": 0,
            "DefogMode": 0,
            "HLCMode": 0,
            "Scene": 1,
            "Hue": 128,
            "Contrast": 128,
            "DeFlicker": false,
            "Effect": 0,
            "ColorGain": 128,
            "MagentaGain": 128,
            "RedGain": 128,
            "YellowGain": 128,
            "GreenGain": 128,
            "CyanGain": 128,
            "BlueGain": 128,
            "MagentaHue": 128,
            "RedHue": 128,
            "YellowHue": 128,
            "GreenHue": 128,
            "CyanHue": 128,
            "BlueHue": 128
        },
        "GammaInfo": {
            "Mode": 0,
            "Offset": 0,
            "VEorWDR": 0,
            "Bright": 3,
            "BrightComp": 2,
            "CompLevel": 1
        },
        "LensInfo": {
            "FocusMode": 1,
            "AFSensitivity": 1,
            "MFSpeed": 2,
            "NearLimit": 13,
            "Stabilizer": 0,
            "DigitalZoom": false,
            "SpotFocus": true,
            "FocusArea": 4
        },
        "PanTiltInfo": {
            "AdaptivePT": true,
            "PTSpeed": 3,
            "PanDirection": 0,
            "TiltDirection": 0,
            "PresetMemory": 0,
            "PresetSpeed": 5,
            "MotionlessPreset": false,
            "ReloadPreset1": true
        },
        "GenlockInfo": {
            "HPhase": 0
        },
        "SystemInfo": {
            "PelcoID": 1,
            "VISCAID": 1,
            "IRID": 3,
            "IRReceive": true,
            "VideoParametersOSD": false,
            "ColorSpace": 1,
            "TallyMode": false,
            "BaudRate": 2,
            "DisplayInfo": true,
            "CommType": 1
        }
    }
}

Response

{
    "Cmd": "AswSetImageInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • ExposureInfo
    Show properties
    • Modeenum(Optional)
      Description: ExposureMode
      Value: : Auto, 1: Manual, 2: ShutterPri, 3: IrisPri
    • HighSensitivitybool(Optional)
      Description: HighSensitivity
      Value: true/false
    • SlowShutterbool(Optional)
      Description: SlowShutter
      Value: true/false
    • SlowShutterLimitenum(Optional)
      Description: SlowShutterLimit
      Value: 1: 1/30, 2: 1/15, 3: 1/8, 4: 1/4, 5: 1/2, 6: 1/1
    • GainLimitenum(Optional)
      Description: GainLimit,The high sensitivity open state is limited to 10.7dB 14.3dB 17.9dB 21.4dB 25.0dB 28.6dB 32.1dB 35.7dB 39.3dB 42.9dB 46.4dB 50.0dB;The closure status is limited to 15.0dB 20.0dB 25.0dB 30.0dB 35.0dB 40.0dB 45.0dB 50.0dB 55.0dB 60.0dB 65.0dB 70.0dB
      Value: 4: 10.7dB, 5: 14.3dB, 6: 17.9dB, 7: 21.4dB, 8: 25.0dB, 9: 28.6dB, 10: 32.1dB, 11: 35.7dB, 12: 39.3dB, 13: 42.9dB, 14: 46.4dB, 15: 50.0dB
    • BackLightbool(Optional)
      Description: BackLight
      Value: true/false
    • SpotLightbool(Optional)
      Description: SpotLight
      Value: true/false
    • AESpeedrange(Optional)
      Description: AESpeed
      Value: 1-48
    • ExCompLevelenum(Optional)
      Description: ExCompLevel
      Value: : -10.5, 1: -9, 2: -7.5, 3: -6, 4: -4.5, 5: -3, 6: -1.5, 7, 8: +1.5, 9: +3, 10: +4.5, 11: +6, 12: +7.5, 13: +9, 14: +10.5
    • Gainenum(Optional)
      Description: Gain High sensitivity off state is limited to 0dB 3.6dB 7.1dB 10.7dB 14.3dB 17.9dB 21.4dB 25.0dB 28.6dB 32.1dB 35.7dB 39.3dB 42.9dB 46.4dB 50.0dB;The high sensitivity open state is limited to 0dB 5.0dB 10.0dB 15.0dB 20.0dB 25.0dB 30.0dB 35.0dB 40.0dB 45.0dB 50.0dB 55.0dB 60.0dB 65.0dB 70.0dB
      Value: 1: 0dB, 2: 3.6dB, 3: 7.1dB, 4: 10.7dB, 5: 14.3dB, 6: 17.9dB, 7: 21.4dB, 8: 25.0dB, 9: 28.6dB, 10: 32.1dB, 11: 35.7dB, 12: 39.3dB, 13: 42.9dB, 14: 46.4dB, 15: 50.0dB
    • ShutterSpeedenum(Optional)
      Description: ShutterSpeed
      Value: : 1/1, 1: 1/2, 2: 1/4, 3: 1/8, 4: 1/15, 5: 1/30, 6: 1/60, 7: 1/90, 8: 1/100, 9: 1/125, 10: 1/180, 11: 1/250, 12: 1/350, 13: 1/500, 14: 1/725, 15: 1/1000, 16: 1/1500, 17: 1/2000, 18: 1/3000, 19: 1/4000, 20: 1/6000, 21: 1/10000
    • Irisenum(Optional)
      Description: Iris
      Value: 17: F1.6, 16: F2.0, 15: F2.4, 14: F2.8, 13: F3.4, 12: F4.0, 11: F4.8, 10: F5.6, 9: F6.8, 8: F8.0, 7: F9.6, 6: F11, 5: F14
  • WhiteBalanceInfo
    Show properties
    • Modeenum(Optional)
      Description: WhiteBalance Mode
      Value: : Auto, 1: Indoor, 2: Outdoor, 3: OPW, 4: ATW, 5: User, 6: OutdoorAuto, 7: SVLAuto, 8: SVL, 9: SVLOutdoorAuto
    • RGainrange(Optional)
      Description: RGain
      Value: 0-255
    • BGainrange(Optional)
      Description: BGain
      Value: 0-255
  • PictureInfo
    Show properties
    • Sharpnessrange(Optional)
      Description: Sharpness
      Value: 0-255
    • 2DNRrange(Optional)
      Description: 2DNR
      Value: 0-5
    • 3DNRrange(Optional)
      Description: 3DNR
      Value: 0-5
    • Flipbool(Optional)
      Description: Flip
      Value: true/false
    • Mirrorbool(Optional)
      Description: Mirror
      Value: true/false
    • ChromaSuppressenum(Optional)
      Description: ChromaSuppress
      Value: : OFF, 1: Low, 2: Middle, 3: High
    • DefogModeenum(Optional)
      Description: DefogMode
      Value: : OFF, 1: Low, 2: Middle, 3: High
    • HLCModeenum(Optional)
      Description: HLCMode
      Value: : OFF, 1: Low, 2: Middle, 3: High
    • Sceneenum(Optional)
      Description: Scene
      Value: 1: Standard, 3: Bright, 4: Clarity, 5: Soft
    • Huerange(Optional)
      Description: Hue
      Value: 0-255
    • Contrastrange(Optional)
      Description: Contrast
      Value: 0-255
    • DeFlickerbool(Optional)
      Description: DeFlicker
      Value: true/false
    • Effectenum(Optional)
      Description: Effect
      Value: : Day, 1: Night
    • ColorGainrange(Optional)
      Description: ColorGain
      Value: 0-255
    • MagentaGainrange(Optional)
      Description: MagentaGain
      Value: 0-255
    • RedGainrange(Optional)
      Description: RedGain
      Value: 0-255
    • YellowGainrange(Optional)
      Description: YellowGain
      Value: 0-255
    • GreenGainrange(Optional)
      Description: GreenGain
      Value: 0-255
    • CyanGainrange(Optional)
      Description: CyanGain
      Value: 0-255
    • BlueGainrange(Optional)
      Description: BlueGain
      Value: 0-255
    • MagentaHuerange(Optional)
      Description: MagentaHue
      Value: 0-255
    • RedHuerange(Optional)
      Description: RedHue
      Value: 0-255
    • YellowHuerange(Optional)
      Description: YellowHue
      Value: 0-255
    • GreenHuerange(Optional)
      Description: GreenHue
      Value: 0-255
    • CyanHuerange(Optional)
      Description: CyanHue
      Value: 0-255
    • BlueHuerange(Optional)
      Description: BlueHue
      Value: 0-255
  • GammaInfo
    Show properties
    • Modeenum(Optional)
      Description: GammaInfo
      Value: : Standard, 1: Straight
    • Offsetrange(Optional)
      Description: Offset
      Value: -64-64
    • VEorWDRenum(Optional)
      Description: VE or WDR
      Value: : OFF, 1: VE ON, 2: WDR ON
    • Brightrange(Optional)
      Description: Bright Level
      Value: 0-6
    • BrightComprange(Optional)
      Description: BrightComp
      Value: 0-3
    • CompLevelenum(Optional)
      Description: CompLevel
      Value: : Low, 1: Middle, 2: High
  • LensInfo
    Show properties
    • FocusModeenum(Optional)
      Description: FocusMode
      Value: : Auto, 1: Manual
    • AFSensitivityenum(Optional)
      Description: AFSensitivity
      Value: : Normal, 1: Low
    • MFSpeedrange(Optional)
      Description: MFSpeed
      Value: 0-7
    • NearLimitenum(Optional)
      Description: NearLimit
      Value: 1: Over, 2: 12m, 3: 6m, 4: 4m, 5: 3m, 6: 2.4m, 7: 2m, 8: 1.7m, 9: 1.5m, 10: 1.3m, 11: 1.2m, 12: 61cm, 13: 33cm, 14: 20cm, 15: 10cm
    • Stabilizerenum(Optional)
      Description: Stabilizer
      Value: : OFF, 1: Super, 2: Super+
    • DigitalZoombool(Optional)
      Description: DigitalZoom
      Value: true/false
    • SpotFocusbool(Optional)
      Description: SpotFocus
      Value: true/false
    • FocusAreaenum(Optional)
      Description: FocusArea
      Value: 2: All, 4: Center
  • PanTiltInfo
    Show properties
    • AdaptivePTbool(Optional)
      Description: AdaptivePT
      Value: true/false
    • PTSpeedrange(Optional)
      Description: PTSpeed
      Value: 0-5
    • PanDirectionenum(Optional)
      Description: PanDirection
      Value: : Normal, 1: Invert
    • TiltDirectionenum(Optional)
      Description: TiltDirection
      Value: : Normal, 1: Invert
    • PresetMemoryenum(Optional)
      Description: PresetMemory
      Value: : StandardMode, 1: ExtendedMode
    • PresetSpeedrange(Optional)
      Description: PresetSpeed
      Value: 0-5
    • MotionlessPresetbool(Optional)
      Description: MotionlessPreset
      Value: true/false
    • ReloadPreset1bool(Optional)
      Description: ReloadPreset1
      Value: true/false
  • GenlockInfo
    Show properties
    • HPhaserange(Optional)
      Description: HPhase
      Value: -127-127

ReqGetExposureInfo

POSTapiv2/image

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetExposureInfo\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/image

Sample Request

{
    "Cmd": "ReqGetExposureInfo",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetExposureInfo",
    "Version": "2.00.000",
    "Content": {
        "ExposureInfo": {
            "Mode": 0,
            "HighSensitivity": false,
            "SlowShutter": false,
            "SlowShutterLimit": 6,
            "GainLimit": 11,
            "BackLight": false,
            "SpotLight": false,
            "AESpeed": 1,
            "ExComp": false,
            "ExCompLevel": 7,
            "Gain": 15,
            "ShutterSpeed": 63,
            "Iris": 5
        },
        "Status": 0
    }
}

Parameters

  • ExposureInfo
    Show properties
    • Modeenum(Optional)
      Description: ExposureMode
      Value: : Auto, 1: Manual, 2: ShutterPri, 3: IrisPri
    • HighSensitivitybool(Optional)
      Description: HighSensitivity
      Value: true/false
    • SlowShutterbool(Optional)
      Description: SlowShutter
      Value: true/false
    • SlowShutterLimitenum(Optional)
      Description: SlowShutterLimit
      Value: 1: 1/30, 2: 1/15, 3: 1/8, 4: 1/4, 5: 1/2, 6: 1/1
    • GainLimitenum(Optional)
      Description: GainLimit,The high sensitivity open state is limited to 10.7dB 14.3dB 17.9dB 21.4dB 25.0dB 28.6dB 32.1dB 35.7dB 39.3dB 42.9dB 46.4dB 50.0dB;The closure status is limited to 15.0dB 20.0dB 25.0dB 30.0dB 35.0dB 40.0dB 45.0dB 50.0dB 55.0dB 60.0dB 65.0dB 70.0dB
      Value: 4: 10.7dB, 5: 14.3dB, 6: 17.9dB, 7: 21.4dB, 8: 25.0dB, 9: 28.6dB, 10: 32.1dB, 11: 35.7dB, 12: 39.3dB, 13: 42.9dB, 14: 46.4dB, 15: 50.0dB
    • BackLightbool(Optional)
      Description: BackLight
      Value: true/false
    • SpotLightbool(Optional)
      Description: SpotLight
      Value: true/false
    • AESpeedrange(Optional)
      Description: AESpeed
      Value: 1-48
    • ExCompLevelenum(Optional)
      Description: ExCompLevel
      Value: : -10.5, 1: -9, 2: -7.5, 3: -6, 4: -4.5, 5: -3, 6: -1.5, 7, 8: +1.5, 9: +3, 10: +4.5, 11: +6, 12: +7.5, 13: +9, 14: +10.5
    • Gainenum(Optional)
      Description: Gain High sensitivity off state is limited to 0dB 3.6dB 7.1dB 10.7dB 14.3dB 17.9dB 21.4dB 25.0dB 28.6dB 32.1dB 35.7dB 39.3dB 42.9dB 46.4dB 50.0dB;The high sensitivity open state is limited to 0dB 5.0dB 10.0dB 15.0dB 20.0dB 25.0dB 30.0dB 35.0dB 40.0dB 45.0dB 50.0dB 55.0dB 60.0dB 65.0dB 70.0dB
      Value: 1: 0dB, 2: 3.6dB, 3: 7.1dB, 4: 10.7dB, 5: 14.3dB, 6: 17.9dB, 7: 21.4dB, 8: 25.0dB, 9: 28.6dB, 10: 32.1dB, 11: 35.7dB, 12: 39.3dB, 13: 42.9dB, 14: 46.4dB, 15: 50.0dB
    • ShutterSpeedenum(Optional)
      Description: ShutterSpeed
      Value: : 1/1, 1: 1/2, 2: 1/4, 3: 1/8, 4: 1/15, 5: 1/30, 6: 1/60, 7: 1/90, 8: 1/100, 9: 1/125, 10: 1/180, 11: 1/250, 12: 1/350, 13: 1/500, 14: 1/725, 15: 1/1000, 16: 1/1500, 17: 1/2000, 18: 1/3000, 19: 1/4000, 20: 1/6000, 21: 1/10000
    • Irisenum(Optional)
      Description: Iris
      Value: 17: F1.6, 16: F2.0, 15: F2.4, 14: F2.8, 13: F3.4, 12: F4.0, 11: F4.8, 10: F5.6, 9: F6.8, 8: F8.0, 7: F9.6, 6: F11, 5: F14

ReqSetExposureInfo

POSTapiv2/image

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetExposureInfo\",\"Version\":\"2.0.000\",\"Content\":{\"ExposureInfo\":{\"Mode\":0,\"HighSensitivity\":false,\"SlowShutter\":false,\"SlowShutterLimit\":6,\"GainLimit\":11,\"BackLight\":false,\"SpotLight\":false,\"AESpeed\":1,\"ExComp\":false,\"ExCompLevel\":7,\"Gain\":15,\"ShutterSpeed\":63,\"Iris\":5}}}' http://example.com/apiv2/image

Sample Request

{
    "Cmd": "ReqSetExposureInfo",
    "Version": "2.0.000",
    "Content": {
        "ExposureInfo": {
            "Mode": 0,
            "HighSensitivity": false,
            "SlowShutter": false,
            "SlowShutterLimit": 6,
            "GainLimit": 11,
            "BackLight": false,
            "SpotLight": false,
            "AESpeed": 1,
            "ExComp": false,
            "ExCompLevel": 7,
            "Gain": 15,
            "ShutterSpeed": 63,
            "Iris": 5
        }
    }
}

Response

{
    "Cmd": "AswSetExposureInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • ExposureInfo
    Show properties
    • Modeenum(Optional)
      Description: ExposureMode
      Value: : Auto, 1: Manual, 2: ShutterPri, 3: IrisPri
    • HighSensitivitybool(Optional)
      Description: HighSensitivity
      Value: true/false
    • SlowShutterbool(Optional)
      Description: SlowShutter
      Value: true/false
    • SlowShutterLimitenum(Optional)
      Description: SlowShutterLimit
      Value: 1: 1/30, 2: 1/15, 3: 1/8, 4: 1/4, 5: 1/2, 6: 1/1
    • GainLimitenum(Optional)
      Description: GainLimit,The high sensitivity open state is limited to 10.7dB 14.3dB 17.9dB 21.4dB 25.0dB 28.6dB 32.1dB 35.7dB 39.3dB 42.9dB 46.4dB 50.0dB;The closure status is limited to 15.0dB 20.0dB 25.0dB 30.0dB 35.0dB 40.0dB 45.0dB 50.0dB 55.0dB 60.0dB 65.0dB 70.0dB
      Value: 4: 10.7dB, 5: 14.3dB, 6: 17.9dB, 7: 21.4dB, 8: 25.0dB, 9: 28.6dB, 10: 32.1dB, 11: 35.7dB, 12: 39.3dB, 13: 42.9dB, 14: 46.4dB, 15: 50.0dB
    • BackLightbool(Optional)
      Description: BackLight
      Value: true/false
    • SpotLightbool(Optional)
      Description: SpotLight
      Value: true/false
    • AESpeedrange(Optional)
      Description: AESpeed
      Value: 1-48
    • ExCompLevelenum(Optional)
      Description: ExCompLevel
      Value: : -10.5, 1: -9, 2: -7.5, 3: -6, 4: -4.5, 5: -3, 6: -1.5, 7, 8: +1.5, 9: +3, 10: +4.5, 11: +6, 12: +7.5, 13: +9, 14: +10.5
    • Gainenum(Optional)
      Description: Gain High sensitivity off state is limited to 0dB 3.6dB 7.1dB 10.7dB 14.3dB 17.9dB 21.4dB 25.0dB 28.6dB 32.1dB 35.7dB 39.3dB 42.9dB 46.4dB 50.0dB;The high sensitivity open state is limited to 0dB 5.0dB 10.0dB 15.0dB 20.0dB 25.0dB 30.0dB 35.0dB 40.0dB 45.0dB 50.0dB 55.0dB 60.0dB 65.0dB 70.0dB
      Value: 1: 0dB, 2: 3.6dB, 3: 7.1dB, 4: 10.7dB, 5: 14.3dB, 6: 17.9dB, 7: 21.4dB, 8: 25.0dB, 9: 28.6dB, 10: 32.1dB, 11: 35.7dB, 12: 39.3dB, 13: 42.9dB, 14: 46.4dB, 15: 50.0dB
    • ShutterSpeedenum(Optional)
      Description: ShutterSpeed
      Value: : 1/1, 1: 1/2, 2: 1/4, 3: 1/8, 4: 1/15, 5: 1/30, 6: 1/60, 7: 1/90, 8: 1/100, 9: 1/125, 10: 1/180, 11: 1/250, 12: 1/350, 13: 1/500, 14: 1/725, 15: 1/1000, 16: 1/1500, 17: 1/2000, 18: 1/3000, 19: 1/4000, 20: 1/6000, 21: 1/10000
    • Irisenum(Optional)
      Description: Iris
      Value: 17: F1.6, 16: F2.0, 15: F2.4, 14: F2.8, 13: F3.4, 12: F4.0, 11: F4.8, 10: F5.6, 9: F6.8, 8: F8.0, 7: F9.6, 6: F11, 5: F14

ReqGetWhiteBalanceInfo

POSTapiv2/image

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetWhiteBalanceInfo\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/image

Sample Request

{
    "Cmd": "ReqGetWhiteBalanceInfo",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetWhiteBalanceInfo",
    "Version": "2.00.000",
    "Content": {
        "WhiteBalanceInfo": {
            "Mode": 0,
            "RGain": 15,
            "BGain": 15
        },
        "Status": 0
    }
}

Parameters

  • WhiteBalanceInfo
    Show properties
    • Modeenum(Optional)
      Description: WhiteBalance Mode
      Value: : Auto, 1: Indoor, 2: Outdoor, 3: OPW, 4: ATW, 5: User, 6: OutdoorAuto, 7: SVLAuto, 8: SVL, 9: SVLOutdoorAuto
    • RGainrange(Optional)
      Description: RGain
      Value: 0-255
    • BGainrange(Optional)
      Description: BGain
      Value: 0-255

ReqSetWhiteBalanceInfo

POSTapiv2/image

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetWhiteBalanceInfo\",\"Version\":\"2.0.000\",\"Content\":{\"WhiteBalanceInfo\":{\"Mode\":5,\"RGain\":15,\"BGain\":15}}}' http://example.com/apiv2/image

Sample Request

{
    "Cmd": "ReqSetWhiteBalanceInfo",
    "Version": "2.0.000",
    "Content": {
        "WhiteBalanceInfo": {
            "Mode": 5,
            "RGain": 15,
            "BGain": 15
        }
    }
}

Response

{
    "Cmd": "AswSetWhiteBalanceInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • WhiteBalanceInfo
    Show properties
    • Modeenum(Optional)
      Description: WhiteBalance Mode
      Value: : Auto, 1: Indoor, 2: Outdoor, 3: OPW, 4: ATW, 5: User, 6: OutdoorAuto, 7: SVLAuto, 8: SVL, 9: SVLOutdoorAuto
    • RGainrange(Optional)
      Description: RGain
      Value: 0-255
    • BGainrange(Optional)
      Description: BGain
      Value: 0-255

ReqGetGammaInfo

POSTapiv2/image

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetGammaInfo\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/image

Sample Request

{
    "Cmd": "ReqGetGammaInfo",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetGammaInfo",
    "Version": "2.00.000",
    "Content": {
        "GammaInfo": {
            "Mode": 0,
            "Offset": 0,
            "VEorWDR": 0,
            "Bright": 3,
            "BrightComp": 2,
            "CompLevel": 1
        },
        "Status": 0
    }
}

Parameters

  • GammaInfo
    Show properties
    • Modeenum(Optional)
      Description: GammaInfo
      Value: : Standard, 1: Straight
    • Offsetrange(Optional)
      Description: Offset
      Value: -64-64
    • VEorWDRenum(Optional)
      Description: VE or WDR
      Value: : OFF, 1: VE ON, 2: WDR ON
    • Brightrange(Optional)
      Description: Bright Level
      Value: 0-6
    • BrightComprange(Optional)
      Description: BrightComp
      Value: 0-3
    • CompLevelenum(Optional)
      Description: CompLevel
      Value: : Low, 1: Middle, 2: High

ReqSetGammaInfo

POSTapiv2/image

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetGammaInfo\",\"Version\":\"2.0.000\",\"Content\":{\"GammaInfo\":{\"Mode\":0,\"Offset\":0,\"VEorWDR\":0,\"Bright\":3,\"BrightComp\":2,\"CompLevel\":1}}}' http://example.com/apiv2/image

Sample Request

{
    "Cmd": "ReqSetGammaInfo",
    "Version": "2.0.000",
    "Content": {
        "GammaInfo": {
            "Mode": 0,
            "Offset": 0,
            "VEorWDR": 0,
            "Bright": 3,
            "BrightComp": 2,
            "CompLevel": 1
        }
    }
}

Response

{
    "Cmd": "AswSetGammaInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • GammaInfo
    Show properties
    • Modeenum(Optional)
      Description: GammaInfo
      Value: : Standard, 1: Straight
    • Offsetrange(Optional)
      Description: Offset
      Value: -64-64
    • VEorWDRenum(Optional)
      Description: VE or WDR
      Value: : OFF, 1: VE ON, 2: WDR ON
    • Brightrange(Optional)
      Description: Bright Level
      Value: 0-6
    • BrightComprange(Optional)
      Description: BrightComp
      Value: 0-3
    • CompLevelenum(Optional)
      Description: CompLevel
      Value: : Low, 1: Middle, 2: High

ReqGetPictureInfo

POSTapiv2/image

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetPictureInfo\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/image

Sample Request

{
    "Cmd": "ReqGetPictureInfo",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetPictureInfo",
    "Version": "2.00.000",
    "Content": {
        "PictureInfo": {
            "Sharpness": 12,
            "2DNR": 3,
            "3DNR": 1,
            "Flip": false,
            "Mirror": false,
            "ChromaSuppress": 0,
            "DefogMode": 0,
            "HLCMode": 0,
            "Scene": 1,
            "Hue": 128,
            "Contrast": 128,
            "DeFlicker": false,
            "Effect": 0,
            "ColorGain": 128,
            "MagentaGain": 128,
            "RedGain": 128,
            "YellowGain": 128,
            "GreenGain": 128,
            "CyanGain": 128,
            "BlueGain": 128,
            "MagentaHue": 128,
            "RedHue": 128,
            "YellowHue": 128,
            "GreenHue": 128,
            "CyanHue": 128,
            "BlueHue": 128
        },
        "Status": 0
    }
}

Parameters

  • PictureInfo
    Show properties
    • Sharpnessrange(Optional)
      Description: Sharpness
      Value: 0-255
    • 2DNRrange(Optional)
      Description: 2DNR
      Value: 0-5
    • 3DNRrange(Optional)
      Description: 3DNR
      Value: 0-5
    • Flipbool(Optional)
      Description: Flip
      Value: true/false
    • Mirrorbool(Optional)
      Description: Mirror
      Value: true/false
    • ChromaSuppressenum(Optional)
      Description: ChromaSuppress
      Value: : OFF, 1: Low, 2: Middle, 3: High
    • DefogModeenum(Optional)
      Description: DefogMode
      Value: : OFF, 1: Low, 2: Middle, 3: High
    • HLCModeenum(Optional)
      Description: HLCMode
      Value: : OFF, 1: Low, 2: Middle, 3: High
    • Sceneenum(Optional)
      Description: Scene
      Value: 1: Standard, 3: Bright, 4: Clarity, 5: Soft
    • Huerange(Optional)
      Description: Hue
      Value: 0-255
    • Contrastrange(Optional)
      Description: Contrast
      Value: 0-255
    • DeFlickerbool(Optional)
      Description: DeFlicker
      Value: true/false
    • Effectenum(Optional)
      Description: Effect
      Value: : Day, 1: Night
    • ColorGainrange(Optional)
      Description: ColorGain
      Value: 0-255
    • MagentaGainrange(Optional)
      Description: MagentaGain
      Value: 0-255
    • RedGainrange(Optional)
      Description: RedGain
      Value: 0-255
    • YellowGainrange(Optional)
      Description: YellowGain
      Value: 0-255
    • GreenGainrange(Optional)
      Description: GreenGain
      Value: 0-255
    • CyanGainrange(Optional)
      Description: CyanGain
      Value: 0-255
    • BlueGainrange(Optional)
      Description: BlueGain
      Value: 0-255
    • MagentaHuerange(Optional)
      Description: MagentaHue
      Value: 0-255
    • RedHuerange(Optional)
      Description: RedHue
      Value: 0-255
    • YellowHuerange(Optional)
      Description: YellowHue
      Value: 0-255
    • GreenHuerange(Optional)
      Description: GreenHue
      Value: 0-255
    • CyanHuerange(Optional)
      Description: CyanHue
      Value: 0-255
    • BlueHuerange(Optional)
      Description: BlueHue
      Value: 0-255

ReqSetPictureInfo

POSTapiv2/image

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetPictureInfo\",\"Version\":\"2.0.000\",\"Content\":{\"PictureInfo\":{\"Sharpness\":12,\"2DNR\":3,\"3DNR\":1,\"Flip\":false,\"Mirror\":false,\"ChromaSuppress\":0,\"DefogMode\":0,\"HLCMode\":0,\"Scene\":1,\"Hue\":128,\"Contrast\":128,\"DeFlicker\":false,\"Effect\":0,\"ColorGain\":128,\"MagentaGain\":128,\"RedGain\":128,\"YellowGain\":128,\"GreenGain\":128,\"CyanGain\":128,\"BlueGain\":128,\"MagentaHue\":128,\"RedHue\":128,\"YellowHue\":128,\"GreenHue\":128,\"CyanHue\":128,\"BlueHue\":128}}}' http://example.com/apiv2/image

Sample Request

{
    "Cmd": "ReqSetPictureInfo",
    "Version": "2.0.000",
    "Content": {
        "PictureInfo": {
            "Sharpness": 12,
            "2DNR": 3,
            "3DNR": 1,
            "Flip": false,
            "Mirror": false,
            "ChromaSuppress": 0,
            "DefogMode": 0,
            "HLCMode": 0,
            "Scene": 1,
            "Hue": 128,
            "Contrast": 128,
            "DeFlicker": false,
            "Effect": 0,
            "ColorGain": 128,
            "MagentaGain": 128,
            "RedGain": 128,
            "YellowGain": 128,
            "GreenGain": 128,
            "CyanGain": 128,
            "BlueGain": 128,
            "MagentaHue": 128,
            "RedHue": 128,
            "YellowHue": 128,
            "GreenHue": 128,
            "CyanHue": 128,
            "BlueHue": 128
        }
    }
}

Response

{
    "Cmd": "AswSetPictureInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • PictureInfo
    Show properties
    • Sharpnessrange(Optional)
      Description: Sharpness
      Value: 0-255
    • 2DNRrange(Optional)
      Description: 2DNR
      Value: 0-5
    • 3DNRrange(Optional)
      Description: 3DNR
      Value: 0-5
    • Flipbool(Optional)
      Description: Flip
      Value: true/false
    • Mirrorbool(Optional)
      Description: Mirror
      Value: true/false
    • ChromaSuppressenum(Optional)
      Description: ChromaSuppress
      Value: : OFF, 1: Low, 2: Middle, 3: High
    • DefogModeenum(Optional)
      Description: DefogMode
      Value: : OFF, 1: Low, 2: Middle, 3: High
    • HLCModeenum(Optional)
      Description: HLCMode
      Value: : OFF, 1: Low, 2: Middle, 3: High
    • Sceneenum(Optional)
      Description: Scene
      Value: 1: Standard, 3: Bright, 4: Clarity, 5: Soft
    • Huerange(Optional)
      Description: Hue
      Value: 0-255
    • Contrastrange(Optional)
      Description: Contrast
      Value: 0-255
    • DeFlickerbool(Optional)
      Description: DeFlicker
      Value: true/false
    • Effectenum(Optional)
      Description: Effect
      Value: : Day, 1: Night
    • ColorGainrange(Optional)
      Description: ColorGain
      Value: 0-255
    • MagentaGainrange(Optional)
      Description: MagentaGain
      Value: 0-255
    • RedGainrange(Optional)
      Description: RedGain
      Value: 0-255
    • YellowGainrange(Optional)
      Description: YellowGain
      Value: 0-255
    • GreenGainrange(Optional)
      Description: GreenGain
      Value: 0-255
    • CyanGainrange(Optional)
      Description: CyanGain
      Value: 0-255
    • BlueGainrange(Optional)
      Description: BlueGain
      Value: 0-255
    • MagentaHuerange(Optional)
      Description: MagentaHue
      Value: 0-255
    • RedHuerange(Optional)
      Description: RedHue
      Value: 0-255
    • YellowHuerange(Optional)
      Description: YellowHue
      Value: 0-255
    • GreenHuerange(Optional)
      Description: GreenHue
      Value: 0-255
    • CyanHuerange(Optional)
      Description: CyanHue
      Value: 0-255
    • BlueHuerange(Optional)
      Description: BlueHue
      Value: 0-255

ReqGetLensInfo

POSTapiv2/image

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetLensInfo\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/image

Sample Request

{
    "Cmd": "ReqGetLensInfo",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetLensInfo",
    "Version": "2.00.000",
    "Content": {
        "LensInfo": {
            "FocusMode": 1,
            "FocusArea": 4,
            "AFSensitivity": 1,
            "MFSpeed": 2,
            "NearLimit": 13,
            "Stabilizer": 0,
            "DigitalZoom": false,
            "SpotFocus": true
        },
        "Status": 0
    }
}

Parameters

  • LensInfo
    Show properties
    • FocusModeenum(Optional)
      Description: FocusMode
      Value: : Auto, 1: Manual
    • FocusAreaenum(Optional)
      Description: FocusArea
      Value: 2: All, 4: Center
    • AFSensitivityenum(Optional)
      Description: AFSensitivity
      Value: : Normal, 1: Low
    • MFSpeedrange(Optional)
      Description: MFSpeed
      Value: 0-7
    • NearLimitenum(Optional)
      Description: NearLimit
      Value: 1: Over, 2: 12m, 3: 6m, 4: 4m, 5: 3m, 6: 2.4m, 7: 2m, 8: 1.7m, 9: 1.5m, 10: 1.3m, 11: 1.2m, 12: 61cm, 13: 33cm, 14: 20cm, 15: 10cm
    • Stabilizerenum(Optional)
      Description: Stabilizer
      Value: : OFF, 1: Super, 2: Super+
    • DigitalZoombool(Optional)
      Description: DigitalZoom
      Value: true/false
    • SpotFocusbool(Optional)
      Description: SpotFocus
      Value: true/false

ReqSetLensInfo

POSTapiv2/image

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetLensInfo\",\"Version\":\"2.0.000\",\"Content\":{\"LensInfo\":{\"FocusMode\":1,\"FocusArea\":4,\"AFSensitivity\":1,\"MFSpeed\":2,\"NearLimit\":13,\"Stabilizer\":0,\"DigitalZoom\":false,\"SpotFocus\":true}}}' http://example.com/apiv2/image

Sample Request

{
    "Cmd": "ReqSetLensInfo",
    "Version": "2.0.000",
    "Content": {
        "LensInfo": {
            "FocusMode": 1,
            "FocusArea": 4,
            "AFSensitivity": 1,
            "MFSpeed": 2,
            "NearLimit": 13,
            "Stabilizer": 0,
            "DigitalZoom": false,
            "SpotFocus": true
        }
    }
}

Response

{
    "Cmd": "AswSetLensInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • LensInfo
    Show properties
    • FocusModeenum(Optional)
      Description: FocusMode
      Value: : Auto, 1: Manual
    • FocusAreaenum(Optional)
      Description: FocusArea
      Value: 2: All, 4: Center
    • AFSensitivityenum(Optional)
      Description: AFSensitivity
      Value: : Normal, 1: Low
    • MFSpeedrange(Optional)
      Description: MFSpeed
      Value: 0-7
    • NearLimitenum(Optional)
      Description: NearLimit
      Value: 1: Over, 2: 12m, 3: 6m, 4: 4m, 5: 3m, 6: 2.4m, 7: 2m, 8: 1.7m, 9: 1.5m, 10: 1.3m, 11: 1.2m, 12: 61cm, 13: 33cm, 14: 20cm, 15: 10cm
    • Stabilizerenum(Optional)
      Description: Stabilizer
      Value: : OFF, 1: Super, 2: Super+
    • DigitalZoombool(Optional)
      Description: DigitalZoom
      Value: true/false
    • SpotFocusbool(Optional)
      Description: SpotFocus
      Value: true/false

ReqGetPanTiltInfo

POSTapiv2/image

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetPanTiltInfo\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/image

Sample Request

{
    "Cmd": "ReqGetPanTiltInfo",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetPanTiltInfo",
    "Version": "2.00.000",
    "Content": {
        "PanTiltInfo": {
            "AdaptivePT": true,
            "PTSpeed": 3,
            "PanDirection": 0,
            "TiltDirection": 0,
            "PresetMemory": 0,
            "PresetSpeed": 5,
            "MotionlessPreset": false,
            "ReloadPreset1": true
        },
        "Status": 0
    }
}

Parameters

  • PanTiltInfo
    Show properties
    • AdaptivePTbool(Optional)
      Description: AdaptivePT
      Value: true/false
    • PTSpeedrange(Optional)
      Description: PTSpeed
      Value: 0-5
    • PanDirectionenum(Optional)
      Description: PanDirection
      Value: : Normal, 1: Invert
    • TiltDirectionenum(Optional)
      Description: TiltDirection
      Value: : Normal, 1: Invert
    • PresetMemoryenum(Optional)
      Description: PresetMemory
      Value: : StandardMode, 1: ExtendedMode
    • PresetSpeedrange(Optional)
      Description: PresetSpeed
      Value: 0-5
    • MotionlessPresetbool(Optional)
      Description: MotionlessPreset
      Value: true/false
    • ReloadPreset1bool(Optional)
      Description: ReloadPreset1
      Value: true/false

ReqSetPanTiltInfo

POSTapiv2/image

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetPanTiltInfo\",\"Version\":\"2.0.000\",\"Content\":{\"PanTiltInfo\":{\"AdaptivePT\":true,\"PTSpeed\":3,\"PanDirection\":0,\"TiltDirection\":0,\"PresetMemory\":0,\"PresetSpeed\":5,\"MotionlessPreset\":false,\"ReloadPreset1\":true}}}' http://example.com/apiv2/image

Sample Request

{
    "Cmd": "ReqSetPanTiltInfo",
    "Version": "2.0.000",
    "Content": {
        "PanTiltInfo": {
            "AdaptivePT": true,
            "PTSpeed": 3,
            "PanDirection": 0,
            "TiltDirection": 0,
            "PresetMemory": 0,
            "PresetSpeed": 5,
            "MotionlessPreset": false,
            "ReloadPreset1": true
        }
    }
}

Response

{
    "Cmd": "AswSetPanTiltInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • PanTiltInfo
    Show properties
    • AdaptivePTbool(Optional)
      Description: AdaptivePT
      Value: true/false
    • PTSpeedrange(Optional)
      Description: PTSpeed
      Value: 0-5
    • PanDirectionenum(Optional)
      Description: PanDirection
      Value: : Normal, 1: Invert
    • TiltDirectionenum(Optional)
      Description: TiltDirection
      Value: : Normal, 1: Invert
    • PresetMemoryenum(Optional)
      Description: PresetMemory
      Value: : StandardMode, 1: ExtendedMode
    • PresetSpeedrange(Optional)
      Description: PresetSpeed
      Value: 0-5
    • MotionlessPresetbool(Optional)
      Description: MotionlessPreset
      Value: true/false
    • ReloadPreset1bool(Optional)
      Description: ReloadPreset1
      Value: true/false

ReqGetGenlockInfo

POSTapiv2/image

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetGenlockInfo\",\"Version\":\"2.00.000\"}' http://example.com/apiv2/image

Sample Request

{
    "Cmd": "ReqGetGenlockInfo",
    "Version": "2.00.000"
}

Response

{
    "Cmd": "AswGetGenlockInfo",
    "Version": "2.00.000",
    "Content": {
        "GenlockInfo": {
            "HPhase": 0,
            "GenlockStatus": 3,
            "RefSignal": "N/A"
        },
        "Status": 0
    }
}

Parameters

  • GenlockInfo
    Show properties
    • HPhaserange(Optional)
      Description: HPhase
      Value: -127-127
    • GenlockStatusenum(Optional)
      Description: GenlockStatus
      Value: 2: Active, 3: Inactive
    • RefSignalenum(Optional)
      Description: RefSignal
      Value: , 525I29.97: 525I29.97, 625I25: 625I25, 525P59.94: 525P59.94, 625P50: 625P50, 720P60: 720P60, 720P59.94: 720P59.94, 720P50: 720P50, 720P30: 720P30, 720P29.97: 720P29.97, 720P25: 720P25, 720P24: 720P24, 720P23.98: 720P23.98, 1080P60: 1080P60, 1080P59.94: 1080P59.94, 1080P50: 1080P50, 1080P30: 1080P30, 1080P29.97: 1080P29.97, 1080P25: 1080P25, 1080P24: 1080P24, 1080P23.98: 1080P23.98, 1080I30: 1080I30, 1080I29.97: 1080I29.97, 1080I25: 1080I25, 1080I24: 1080I24, 1080I23.98: 1080I23.98

ReqSetGenlockInfo

POSTapiv2/image

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetGenlockInfo\",\"Version\":\"2.00.000\",\"Content\":{\"GenlockInfo\":{\"HPhase\":0}}}' http://example.com/apiv2/image

Sample Request

{
    "Cmd": "ReqSetGenlockInfo",
    "Version": "2.00.000",
    "Content": {
        "GenlockInfo": {
            "HPhase": 0
        }
    }
}

Response

{
    "Cmd": "AswSetGenlockInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • GenlockInfo
    Show properties
    • HPhaserange(Optional)
      Description: HPhase
      Value: -127-127

ReqGetOSDSystemInfo

POSTapiv2/image

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetOSDSystemInfo\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/image

Sample Request

{
    "Cmd": "ReqGetOSDSystemInfo",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetOSDSystemInfo",
    "Version": "2.00.000",
    "Content": {
        "OSDSystemInfo": {
            "PelcoID": 1,
            "VISCAID": 1,
            "IRID": 3,
            "IRReceive": true,
            "VideoParametersOSD": false,
            "ColorSpace": 1,
            "TallyMode": false,
            "DisplayInfo": true,
            "BaudRate": 2,
            "CommType": 1
        },
        "Status": 0
    }
}

Parameters

  • OSDSystemInfo
    Show properties
    • PelcoIDrange(Optional)
      Description: PelcoID
      Value: 1-255
    • IRIDrange(Optional)
      Description: IRID
      Value: 1-3
    • IRReceivebool(Optional)
      Description: IRReceive
      Value: true/false
    • VideoParametersOSDbool(Optional)
      Description: VideoParametersOSD
      Value: true/false
    • ColorSpaceenum(Optional)
      Description: ColorSpace
      Value: 1: RGB, 2: YUV422
    • TallyModebool(Optional)
      Description: TallyMode
      Value: true/false
    • DisplayInfobool(Optional)
      Description: DisplayInfo
      Value: true/false
    • BaudRateenum(Optional)
      Description: BaudRate
      Value: : 2400, 1: 4800, 2: 9600, 3: 38400
    • CommTypeenum(Optional)
      Description: CommType
      Value: 1: RS422

ReqSetOSDSystemInfo

POSTapiv2/image

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetOSDSystemInfo\",\"Version\":\"2.0.000\",\"Content\":{\"OSDSystemInfo\":{\"PelcoID\":1,\"VISCAID\":1,\"IRID\":3,\"IRReceive\":true,\"VideoParametersOSD\":false,\"ColorSpace\":1,\"TallyMode\":false,\"DisplayInfo\":true,\"BaudRate\":2,\"CommType\":1}}}' http://example.com/apiv2/image

Sample Request

{
    "Cmd": "ReqSetOSDSystemInfo",
    "Version": "2.0.000",
    "Content": {
        "OSDSystemInfo": {
            "PelcoID": 1,
            "VISCAID": 1,
            "IRID": 3,
            "IRReceive": true,
            "VideoParametersOSD": false,
            "ColorSpace": 1,
            "TallyMode": false,
            "DisplayInfo": true,
            "BaudRate": 2,
            "CommType": 1
        }
    }
}

Response

{
    "Cmd": "AswSetOSDSystemInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • OSDSystemInfo
    Show properties
    • PelcoIDrange(Optional)
      Description: PelcoID
      Value: 1-255
    • IRIDrange(Optional)
      Description: IRID
      Value: 1-3
    • IRReceivebool(Optional)
      Description: IRReceive
      Value: true/false
    • VideoParametersOSDbool(Optional)
      Description: VideoParametersOSD
      Value: true/false
    • ColorSpaceenum(Optional)
      Description: ColorSpace
      Value: 1: RGB, 2: YUV422
    • TallyModebool(Optional)
      Description: TallyMode
      Value: true/false
    • DisplayInfobool(Optional)
      Description: DisplayInfo
      Value: true/false
    • BaudRateenum(Optional)
      Description: BaudRate
      Value: : 2400, 1: 4800, 2: 9600, 3: 38400
    • CommTypeenum(Optional)
      Description: CommType
      Value: 1: RS422

ReqGetAVStreamCapabilities

POSTapiv2/av

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetAVStreamCapabilities\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/av

Sample Request

{
    "Cmd": "ReqGetAVStreamCapabilities",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetAVStreamCapabilities",
    "Version": "2.00.000",
    "Content": {
        "EncodeInfo": {
            "Channel": {
                "Type": "enum",
                "Readonly": false,
                "Description": "Encoder Channel",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "Channel 0"
                    },
                    {
                        "Value": 1,
                        "Description": "Channel 1"
                    }
                ]
            },
            "LowLatency": {
                "Enable": {
                    "Type": "bool",
                    "Readonly": false,
                    "Description": "LowLatency Enable"
                }
            },
            "Details": [
                {
                    "Enable": {
                        "Type": "bool",
                        "Readonly": true,
                        "Description": "Channel Trigger"
                    },
                    "StreamType": {
                        "Type": "enum",
                        "Readonly": false,
                        "Description": "StreamType",
                        "Data": [
                            {
                                "Value": 0,
                                "Description": "Normal"
                            },
                            {
                                "Value": 1,
                                "Description": "Hx2"
                            },
                            {
                                "Value": 2,
                                "Description": "Hx3"
                            },
                            {
                                "Value": 3,
                                "Description": "Dante"
                            }
                        ]
                    },
                    "FieldType": {
                        "Type": "enum",
                        "Readonly": true,
                        "Description": "FieldType",
                        "Data": [
                            {
                                "Value": 0,
                                "Description": "Interlaced"
                            },
                            {
                                "Value": 1,
                                "Description": "Progressive"
                            }
                        ]
                    },
                    "VideoCompression": {
                        "Type": "enum",
                        "Readonly": false,
                        "Description": "VideoCompression",
                        "Data": [
                            {
                                "Value": 1,
                                "Description": "H264"
                            },
                            {
                                "Value": 2,
                                "Description": "H265"
                            }
                        ]
                    },
                    "Resolution": {
                        "Type": "enum",
                        "Readonly": false,
                        "Description": "Resolution",
                        "Data": [
                            {
                                "Value": "1920x1080",
                                "Description": "1920x1080"
                            },
                            {
                                "Value": "1280x720",
                                "Description": "1280x720"
                            }
                        ]
                    },
                    "FrameRate": {
                        "Type": "range",
                        "Readonly": false,
                        "Description": "FrameRate",
                        "Data": {
                            "Min": 1,
                            "Max": 60
                        }
                    },
                    "BPFrameType": {
                        "Type": "enum",
                        "Readonly": true,
                        "Description": "BPFrameType",
                        "Data": [
                            {
                                "Value": 0,
                                "Description": "Single P Frame"
                            }
                        ]
                    },
                    "BitrateType": {
                        "Type": "enum",
                        "Readonly": false,
                        "Description": "BitrateType",
                        "Data": [
                            {
                                "Value": 0,
                                "Description": "CBR"
                            },
                            {
                                "Value": 1,
                                "Description": "VBR"
                            }
                        ]
                    },
                    "BitRate": {
                        "Type": "range",
                        "Readonly": false,
                        "Description": "BitRate",
                        "Data": {
                            "Min": 1024,
                            "Max": 101376
                        }
                    },
                    "IFrameInterval": {
                        "Type": "range",
                        "Readonly": false,
                        "Description": "IFrameInterval",
                        "Data": {
                            "Min": 1,
                            "Max": 150
                        }
                    }
                },
                {
                    "Enable": {
                        "Type": "bool",
                        "Readonly": false,
                        "Description": "Channel Trigger"
                    },
                    "StreamType": {
                        "Type": "enum",
                        "Readonly": false,
                        "Description": "StreamType",
                        "Data": [
                            {
                                "Value": 0,
                                "Description": "Normal"
                            },
                            {
                                "Value": 1,
                                "Description": "Hx2"
                            },
                            {
                                "Value": 2,
                                "Description": "Hx3"
                            },
                            {
                                "Value": 3,
                                "Description": "Dante"
                            }
                        ]
                    },
                    "FieldType": {
                        "Type": "enum",
                        "Readonly": true,
                        "Description": "FieldType",
                        "Data": [
                            {
                                "Value": 0,
                                "Description": "Interlaced"
                            },
                            {
                                "Value": 1,
                                "Description": "Progressive"
                            }
                        ]
                    },
                    "VideoCompression": {
                        "Type": "enum",
                        "Readonly": false,
                        "Description": "VideoCompression",
                        "Data": [
                            {
                                "Value": 1,
                                "Description": "H264"
                            },
                            {
                                "Value": 2,
                                "Description": "H265"
                            }
                        ]
                    },
                    "Resolution": {
                        "Type": "enum",
                        "Readonly": false,
                        "Description": "Resolution",
                        "Data": [
                            {
                                "Value": "704x576",
                                "Description": "704x576"
                            },
                            {
                                "Value": "640x480",
                                "Description": "640x480"
                            },
                            {
                                "Value": "640x360",
                                "Description": "640x360"
                            },
                            {
                                "Value": "576x480",
                                "Description": "576x480"
                            },
                            {
                                "Value": "352x288",
                                "Description": "352x288"
                            }
                        ]
                    },
                    "FrameRate": {
                        "Type": "range",
                        "Readonly": false,
                        "Description": "FrameRate",
                        "Data": {
                            "Min": 1,
                            "Max": 30
                        }
                    },
                    "BPFrameType": {
                        "Type": "enum",
                        "Readonly": true,
                        "Description": "BPFrameType",
                        "Data": [
                            {
                                "Value": 0,
                                "Description": "Single P Frame"
                            }
                        ]
                    },
                    "BitrateType": {
                        "Type": "enum",
                        "Readonly": false,
                        "Description": "BitrateType",
                        "Data": [
                            {
                                "Value": 0,
                                "Description": "CBR"
                            },
                            {
                                "Value": 1,
                                "Description": "VBR"
                            }
                        ]
                    },
                    "BitRate": {
                        "Type": "range",
                        "Readonly": false,
                        "Description": "BitRate",
                        "Data": {
                            "Min": 100,
                            "Max": 8192
                        }
                    },
                    "IFrameInterval": {
                        "Type": "range",
                        "Readonly": false,
                        "Description": "IFrameInterval",
                        "Data": {
                            "Min": 1,
                            "Max": 150
                        }
                    }
                }
            ]
        },
        "RTSPInfo": {
            "Channel": {
                "Type": "enum",
                "Readonly": false,
                "Description": "RTSP Channel",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "Channel 0"
                    },
                    {
                        "Value": 1,
                        "Description": "Channel 1"
                    }
                ]
            },
            "Enable": {
                "Type": "bool",
                "Readonly": false,
                "Description": "RTSP Stream Enable"
            },
            "Port": {
                "Type": "range",
                "Readonly": true,
                "Description": "RTSP Port",
                "Data": {
                    "Min": 1,
                    "Max": 65535
                }
            },
            "MaxClientNum": {
                "Type": "range",
                "Readonly": false,
                "Description": "MaxClientNum",
                "Data": {
                    "Min": 1,
                    "Max": 8
                }
            },
            "StreamKey": {
                "Type": "string",
                "Readonly": false,
                "Description": "StreamKey",
                "Data": {
                    "MinLen": 1,
                    "MaxLen": 63
                }
            },
            "AuthEnable": {
                "Type": "bool",
                "Readonly": false,
                "Description": "Auth Enable"
            }
        },
        "RTMPInfo": {
            "Channel": {
                "Type": "enum",
                "Readonly": false,
                "Description": "RTMP Stream Channel",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "Channel 0"
                    },
                    {
                        "Value": 1,
                        "Description": "Channel 1"
                    }
                ]
            },
            "Enable": {
                "Type": "bool",
                "Readonly": false,
                "Description": "RTMP Stream Enable"
            },
            "Port": {
                "Type": "range",
                "Readonly": false,
                "Description": "RTMP Port",
                "Data": {
                    "Min": 1,
                    "Max": 65535
                }
            },
            "VideoTagHeader": {
                "Type": "enum",
                "Readonly": false,
                "Description": "VideoTagHeader",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "codec:12"
                    },
                    {
                        "Value": 1,
                        "Description": "rtmp-enhanced. only for h265"
                    }
                ]
            },
            "Url": {
                "Type": "string",
                "Readonly": false,
                "Description": "Url",
                "Data": {
                    "MinLen": 0,
                    "MaxLen": 253
                }
            },
            "StreamKey": {
                "Type": "string",
                "Readonly": false,
                "Description": "StreamKey",
                "Data": {
                    "MinLen": 0,
                    "MaxLen": 253
                }
            }
        },
        "SRTInfo": {
            "Channel": {
                "Type": "enum",
                "Readonly": false,
                "Description": "SRT Channel Enable",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "Channel 0"
                    },
                    {
                        "Value": 1,
                        "Description": "Channel 1"
                    }
                ]
            },
            "Enable": {
                "Type": "bool",
                "Readonly": false,
                "Description": "SRT Stream  Enable"
            },
            "Mode": {
                "Type": "enum",
                "Readonly": false,
                "Description": "SRT Mode",
                "Data": [
                    {
                        "Value": 1,
                        "Description": "caller"
                    },
                    {
                        "Value": 2,
                        "Description": "listener"
                    }
                ]
            },
            "IPAddress": {
                "Type": "string",
                "Readonly": false,
                "Description": "SRT IPAddress",
                "Data": {
                    "MinLen": 7,
                    "MaxLen": 15
                }
            },
            "Port": {
                "Type": "range",
                "Readonly": false,
                "Description": "SRT Port",
                "Data": {
                    "Min": 1,
                    "Max": 65535
                }
            },
            "StreamID": {
                "Type": "string",
                "Readonly": false,
                "Description": "Stream ID",
                "Data": {
                    "MinLen": 0,
                    "MaxLen": 255
                }
            },
            "Latency": {
                "Type": "range",
                "Readonly": false,
                "Description": "Latency",
                "Data": {
                    "Min": 20,
                    "Max": 5000
                }
            },
            "OverheadBandwidth": {
                "Type": "range",
                "Readonly": false,
                "Description": "OverheadBandwidth",
                "Data": {
                    "Min": 5,
                    "Max": 100
                }
            },
            "Encryption": {
                "Type": "enum",
                "Readonly": false,
                "Description": "Encryption",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "disable"
                    },
                    {
                        "Value": 1,
                        "Description": "aes-128"
                    },
                    {
                        "Value": 2,
                        "Description": "aes-192"
                    },
                    {
                        "Value": 3,
                        "Description": "aes-256"
                    }
                ]
            },
            "Passphrase": {
                "Type": "string",
                "Readonly": false,
                "Description": "Passphrase",
                "Data": {
                    "MinLen": 10,
                    "MaxLen": 32
                }
            }
        },
        "AVOverUDPInfo": {
            "Channel": {
                "Type": "enum",
                "Readonly": false,
                "Description": "UDP Stream Channel",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "Channel 0"
                    },
                    {
                        "Value": 1,
                        "Description": "Channel 1"
                    }
                ]
            },
            "Enable": {
                "Type": "bool",
                "Readonly": false,
                "Description": "UDP Stream Enable"
            },
            "Port": {
                "Type": "range",
                "Readonly": false,
                "Description": "UDP Stream Port",
                "Data": {
                    "Min": 0,
                    "Max": 65535
                }
            },
            "Address": {
                "Type": "string",
                "Readonly": false,
                "Description": "UDP Stream Address Range",
                "Data": {
                    "MinLen": 7,
                    "MaxLen": 15
                }
            }
        },
        "AVOverRTPInfo": {
            "Channel": {
                "Type": "enum",
                "Readonly": false,
                "Description": "RTP Stream Channel",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "Channel 0"
                    },
                    {
                        "Value": 1,
                        "Description": "Channel 1"
                    }
                ]
            },
            "Enable": {
                "Type": "bool",
                "Readonly": false,
                "Description": "RTP Stream Enable"
            },
            "Port": {
                "Type": "range",
                "Readonly": false,
                "Description": "RTP Stream Port",
                "Data": {
                    "Min": 0,
                    "Max": 65535
                }
            },
            "Address": {
                "Type": "string",
                "Readonly": false,
                "Description": "RTP Stream Address Range",
                "Data": {
                    "MinLen": 7,
                    "MaxLen": 15
                }
            }
        },
        "AudioInfo": {
            "Enable": {
                "Type": "bool",
                "Readonly": false,
                "Description": "Audio Enable"
            },
            "Type": {
                "Type": "enum",
                "Readonly": false,
                "Description": "Audio Type",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "Mic"
                    },
                    {
                        "Value": 1,
                        "Description": "Line in"
                    }
                ]
            },
            "Compression": {
                "Type": "enum",
                "Readonly": false,
                "Description": "Compression",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "AAC"
                    }
                ]
            },
            "BitRate": {
                "Type": "enum",
                "Readonly": false,
                "Description": "BitRate",
                "Data": [
                    {
                        "Value": 48000,
                        "Description": "48K"
                    },
                    {
                        "Value": 64000,
                        "Description": "64K"
                    },
                    {
                        "Value": 96000,
                        "Description": "96K"
                    },
                    {
                        "Value": 128000,
                        "Description": "128K"
                    }
                ]
            },
            "SamplingRate": {
                "Type": "enum",
                "Readonly": false,
                "Description": "SamplingRate",
                "Data": [
                    {
                        "Value": 44100,
                        "Description": "44.1KHz"
                    },
                    {
                        "Value": 48000,
                        "Description": "48KHz"
                    }
                ]
            },
            "PhantomPower": {
                "Type": "bool",
                "Readonly": false,
                "Description": "PhantomPower Enable"
            },
            "ChannelNumber": {
                "Type": "range",
                "Readonly": true,
                "Description": "ChannelNumber",
                "Data": {
                    "Min": 1,
                    "Max": 2
                }
            },
            "Volume": {
                "Type": "range",
                "Readonly": false,
                "Description": "Volume",
                "Data": {
                    "Min": 0,
                    "Max": 39
                }
            }
        },
        "NDIInfo": {
            "NDIEnable": {
                "Type": "bool",
                "Readonly": false,
                "Description": "NDI Enable"
            },
            "NDISDKVer": {
                "Type": "string",
                "Readonly": true,
                "Description": "NDISDKVer",
                "Data": {
                    "MinLen": 0,
                    "MaxLen": 254
                }
            },
            "NDIName": {
                "Type": "string",
                "Readonly": false,
                "Description": "NDIName",
                "Data": {
                    "MinLen": 0,
                    "MaxLen": 32
                }
            },
            "NDIChnName": {
                "Type": "string",
                "Readonly": false,
                "Description": "NDIChnName",
                "Data": {
                    "MinLen": 0,
                    "MaxLen": 32
                }
            },
            "NDIHX": {
                "Type": "enum",
                "Readonly": false,
                "Description": "NDIHX Type",
                "Data": [
                    {
                        "Value": 2,
                        "Description": "NDIHX2"
                    },
                    {
                        "Value": 3,
                        "Description": "NDIHX3"
                    }
                ]
            },
            "NDIHXBandwidth": {
                "Type": "range",
                "Readonly": false,
                "Description": "NDI HX Bandwidth",
                "Data": {
                    "Min": 1024,
                    "Max": 101376
                }
            },
            "WebCtrl": {
                "Type": "bool",
                "Readonly": false,
                "Description": "NDI WebCtrl"
            },
            "FailoverEnable": {
                "Type": "bool",
                "Readonly": false,
                "Description": "FailoverEnable"
            },
            "FailoverSourceName": {
                "Type": "string",
                "Readonly": false,
                "Description": "FailoverSourceName",
                "Data": {
                    "MinLen": 0,
                    "MaxLen": 64
                }
            },
            "FailoverIpAddress": {
                "Type": "string",
                "Readonly": false,
                "Description": "FailoverIpAddress",
                "Data": {
                    "MinLen": 7,
                    "MaxLen": 15
                }
            },
            "MulticastEnable": {
                "Type": "bool",
                "Readonly": false,
                "Description": "MulticastEnable"
            },
            "MulticastIP": {
                "Type": "string",
                "Readonly": false,
                "Description": "MulticastIP:224.0.3.1-239.255.255.254",
                "Data": {
                    "MinLen": 7,
                    "MaxLen": 15
                }
            },
            "MulticastMask": {
                "Type": "string",
                "Readonly": false,
                "Description": "MulticastMask",
                "Data": {
                    "MinLen": 7,
                    "MaxLen": 15
                }
            },
            "MulticastTTL": {
                "Type": "range",
                "Readonly": false,
                "Description": "MulticastTTL",
                "Data": {
                    "Min": 1,
                    "Max": 255
                }
            },
            "GroupName": {
                "Type": "string",
                "Readonly": false,
                "Description": "GroupName",
                "Data": {
                    "MinLen": 0,
                    "MaxLen": 32
                }
            },
            "DiscoverServerEnable": {
                "Type": "bool",
                "Readonly": false,
                "Description": "DiscoverServerEnable"
            },
            "DiscoverServerIP": {
                "Type": "string",
                "Readonly": false,
                "Description": "DiscoverServerIP",
                "Data": {
                    "MinLen": 7,
                    "MaxLen": 15
                }
            }
        }
    }
}

Parameters

  • EncodeInfo
    Show properties
    • Channelenum(Optional)
      Description: Encoder Channel
      Value: : Channel 0, 1: Channel 1
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • LowLatency(Optional)
      Show properties
      • Enable(Optional)
        Show properties
        • Type(Optional)
        • Readonly(Optional)
        • Description(Optional)
    • Details(Optional)
      Show properties
      • Enable(Optional)
        Show properties
        • Type(Optional)
        • Readonly(Optional)
        • Description(Optional)
      • StreamType(Optional)
        Show properties
        • Type(Optional)
        • Readonly(Optional)
        • Description(Optional)
        • Data(Optional)
          Show properties
          • Value(Optional)
          • Description(Optional)
      • FieldType(Optional)
        Show properties
        • Type(Optional)
        • Readonly(Optional)
        • Description(Optional)
        • Data(Optional)
          Show properties
          • Value(Optional)
          • Description(Optional)
      • VideoCompression(Optional)
        Show properties
        • Type(Optional)
        • Readonly(Optional)
        • Description(Optional)
        • Data(Optional)
          Show properties
          • Value(Optional)
          • Description(Optional)
      • Resolution(Optional)
        Show properties
        • Type(Optional)
        • Readonly(Optional)
        • Description(Optional)
        • Data(Optional)
          Show properties
          • Value(Optional)
          • Description(Optional)
      • FrameRate(Optional)
        Show properties
        • Type(Optional)
        • Readonly(Optional)
        • Description(Optional)
        • Data(Optional)
          Show properties
          • Min(Optional)
          • Max(Optional)
      • BPFrameType(Optional)
        Show properties
        • Type(Optional)
        • Readonly(Optional)
        • Description(Optional)
        • Data(Optional)
          Show properties
          • Value(Optional)
          • Description(Optional)
      • BitrateType(Optional)
        Show properties
        • Type(Optional)
        • Readonly(Optional)
        • Description(Optional)
        • Data(Optional)
          Show properties
          • Value(Optional)
          • Description(Optional)
      • BitRate(Optional)
        Show properties
        • Type(Optional)
        • Readonly(Optional)
        • Description(Optional)
        • Data(Optional)
          Show properties
          • Min(Optional)
          • Max(Optional)
      • IFrameInterval(Optional)
        Show properties
        • Type(Optional)
        • Readonly(Optional)
        • Description(Optional)
        • Data(Optional)
          Show properties
          • Min(Optional)
          • Max(Optional)
  • RTSPInfo
    Show properties
    • Channelenum(Optional)
      Description: RTSP Channel
      Value: : Channel 0, 1: Channel 1
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • Enablebool(Optional)
      Description: RTSP Stream Enable
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • Portrange(Optional)
      Description: RTSP Port
      Value: 1-65535
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • MaxClientNumrange(Optional)
      Description: MaxClientNum
      Value: 1-8
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • StreamKeystring(Optional)
      Description: StreamKey
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • AuthEnablebool(Optional)
      Description: Auth Enable
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
  • RTMPInfo
    Show properties
    • Channelenum(Optional)
      Description: RTMP Stream Channel
      Value: : Channel 0, 1: Channel 1
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • Enablebool(Optional)
      Description: RTMP Stream Enable
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • Portrange(Optional)
      Description: RTMP Port
      Value: 1-65535
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • VideoTagHeaderenum(Optional)
      Description: VideoTagHeader
      Value: : codec:12, 1: rtmp-enhanced. only for h265
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • Urlstring(Optional)
      Description: Url
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • StreamKeystring(Optional)
      Description: StreamKey
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
  • SRTInfo
    Show properties
    • Channelenum(Optional)
      Description: SRT Channel Enable
      Value: : Channel 0, 1: Channel 1
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • Enablebool(Optional)
      Description: SRT Stream Enable
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • Modeenum(Optional)
      Description: SRT Mode
      Value: 1: caller, 2: listener
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • IPAddressstring(Optional)
      Description: SRT IPAddress
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • Portrange(Optional)
      Description: SRT Port
      Value: 1-65535
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • StreamIDstring(Optional)
      Description: Stream ID
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • Latencyrange(Optional)
      Description: Latency
      Value: 20-5000
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • OverheadBandwidthrange(Optional)
      Description: OverheadBandwidth
      Value: 5-100
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • Encryptionenum(Optional)
      Description: Encryption
      Value: : disable, 1: aes-128, 2: aes-192, 3: aes-256
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • Passphrasestring(Optional)
      Description: Passphrase
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
  • AVOverUDPInfo
    Show properties
    • Channelenum(Optional)
      Description: UDP Stream Channel
      Value: : Channel 0, 1: Channel 1
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • Enablebool(Optional)
      Description: UDP Stream Enable
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • Portrange(Optional)
      Description: UDP Stream Port
      Value: 0-65535
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • Addressstring(Optional)
      Description: UDP Stream Address Range
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
  • AVOverRTPInfo
    Show properties
    • Channelenum(Optional)
      Description: RTP Stream Channel
      Value: : Channel 0, 1: Channel 1
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • Enablebool(Optional)
      Description: RTP Stream Enable
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • Portrange(Optional)
      Description: RTP Stream Port
      Value: 0-65535
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • Addressstring(Optional)
      Description: RTP Stream Address Range
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
  • AudioInfo
    Show properties
    • Enablebool(Optional)
      Description: Audio Enable
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • Typeenum(Optional)
      Description: Audio Type
      Value: : Mic, 1: Line in
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • Compressionenum(Optional)
      Description: Compression
      Value: : AAC
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • BitRateenum(Optional)
      Description: BitRate
      Value: 48000: 48K, 64000: 64K, 96000: 96K, 128000: 128K
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • SamplingRateenum(Optional)
      Description: SamplingRate
      Value: 44100: 44.1KHz, 48000: 48KHz
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • PhantomPowerbool(Optional)
      Description: PhantomPower Enable
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • ChannelNumberrange(Optional)
      Description: ChannelNumber
      Value: 1-2
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • Volumerange(Optional)
      Description: Volume
      Value: 0-39
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
  • NDIInfo
    Show properties
    • NDIEnablebool(Optional)
      Description: NDI Enable
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • NDISDKVerstring(Optional)
      Description: NDISDKVer
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • NDINamestring(Optional)
      Description: NDIName
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • NDIChnNamestring(Optional)
      Description: NDIChnName
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • NDIHXenum(Optional)
      Description: NDIHX Type
      Value: 2: NDIHX2, 3: NDIHX3
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • NDIHXBandwidthrange(Optional)
      Description: NDI HX Bandwidth
      Value: 1024-101376
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • WebCtrlbool(Optional)
      Description: NDI WebCtrl
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • FailoverEnablebool(Optional)
      Description: FailoverEnable
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • FailoverSourceNamestring(Optional)
      Description: FailoverSourceName
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • FailoverIpAddressstring(Optional)
      Description: FailoverIpAddress
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • MulticastEnablebool(Optional)
      Description: MulticastEnable
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • MulticastIPstring(Optional)
      Description: MulticastIP:224.0.3.1-239.255.255.254
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • MulticastMaskstring(Optional)
      Description: MulticastMask
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • MulticastTTLrange(Optional)
      Description: MulticastTTL
      Value: 1-255
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • GroupNamestring(Optional)
      Description: GroupName
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • DiscoverServerEnablebool(Optional)
      Description: DiscoverServerEnable
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • DiscoverServerIPstring(Optional)
      Description: DiscoverServerIP
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)

ReqGetRTSPInfo

POSTapiv2/av

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetRTSPInfo\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/av

Sample Request

{
    "Cmd": "ReqGetRTSPInfo",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetRTSPInfo",
    "Version": "2.00.000",
    "Content": {
        "RTSPInfo": [
            {
                "Channel": 0,
                "Enable": true,
                "Port": 554,
                "TransMode": "TCP",
                "MaxClientNum": 8,
                "StreamKey": "media/video1",
                "AuthEnable": false
            },
            {
                "Channel": 1,
                "Enable": true,
                "Port": 554,
                "Transmode": "TCP",
                "MaxClientNum": 8,
                "StreamKey": "media/video2",
                "AuthEnable": false
            }
        ],
        "Status": 0
    }
}

Parameters

  • RTSPInfo
    Show properties
    • Channelenum(Optional)
      Description: RTSP Channel
      Value: : Channel 0, 1: Channel 1
    • Enablebool(Optional)
      Description: RTSP Stream Enable
      Value: true/false
    • Portrange(Optional)
      Description: RTSP Port
      Value: 1-65535
    • MaxClientNumrange(Optional)
      Description: MaxClientNum
      Value: 1-8
    • StreamKeystring(Optional)
      Description: StreamKey
    • AuthEnablebool(Optional)
      Description: Auth Enable
      Value: true/false

ReqSetRTSPInfo

POSTapiv2/av

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetRTSPInfo\",\"Version\":\"2.00.000\",\"Content\":{\"RTSPInfo\":[{\"Channel\":0,\"Enable\":true,\"MaxClientNum\":8,\"StreamKey\":\"media\\/video1\",\"AuthEnable\":false},{\"Channel\":1,\"Enable\":true,\"MaxClientNum\":8,\"StreamKey\":\"media\\/video2\",\"AuthEnable\":false}]}}' http://example.com/apiv2/av

Sample Request

{
    "Cmd": "ReqSetRTSPInfo",
    "Version": "2.00.000",
    "Content": {
        "RTSPInfo": [
            {
                "Channel": 0,
                "Enable": true,
                "MaxClientNum": 8,
                "StreamKey": "media/video1",
                "AuthEnable": false
            },
            {
                "Channel": 1,
                "Enable": true,
                "MaxClientNum": 8,
                "StreamKey": "media/video2",
                "AuthEnable": false
            }
        ]
    }
}

Response

{
    "Cmd": "AswSetRTSPInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • RTSPInfo
    Show properties
    • Channelenum(Optional)
      Description: RTSP Channel
      Value: : Channel 0, 1: Channel 1
    • Enablebool(Optional)
      Description: RTSP Stream Enable
      Value: true/false
    • MaxClientNumrange(Optional)
      Description: MaxClientNum
      Value: 1-8
    • StreamKeystring(Optional)
      Description: StreamKey
    • AuthEnablebool(Optional)
      Description: Auth Enable
      Value: true/false

ReqGetRTMPInfo

POSTapiv2/av

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetRTMPInfo\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/av

Sample Request

{
    "Cmd": "ReqGetRTMPInfo",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetRTMPInfo",
    "Version": "2.00.000",
    "Content": {
        "RTMPInfo": [
            {
                "Channel": 0,
                "Enable": false,
                "Port": 1935,
                "VideoTagHeader": 0,
                "Url": "",
                "StreamKey": ""
            },
            {
                "Channel": 1,
                "Enable": false,
                "Port": 1935,
                "VideoTagHeader": 0,
                "Url": "",
                "StreamKey": ""
            }
        ],
        "Status": 0
    }
}

Parameters

  • RTMPInfo
    Show properties
    • Channelenum(Optional)
      Description: RTMP Stream Channel
      Value: : Channel 0, 1: Channel 1
    • Enablebool(Optional)
      Description: RTMP Stream Enable
      Value: true/false
    • Portrange(Optional)
      Description: RTMP Port
      Value: 1-65535
    • VideoTagHeaderenum(Optional)
      Description: VideoTagHeader
      Value: : codec:12, 1: rtmp-enhanced. only for h265
    • Urlstring(Optional)
      Description: Url
    • StreamKeystring(Optional)
      Description: StreamKey

ReqSetRTMPInfo

POSTapiv2/av

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetRTMPInfo\",\"Version\":\"2.0.000\",\"Content\":{\"RTMPInfo\":[{\"Channel\":0,\"Enable\":true,\"VideoTagHeader\":1,\"Url\":\"rtmp:\\/\\/192.168.2.177\\/path0\",\"StreamKey\":\"live\\/stream_name=1fd73653a094b877b9bd78468c91adbf\"},{\"Channel\":1,\"Enable\":true,\"VideoTagHeader\":0,\"Url\":\"rtmps:\\/\\/192.168.2.177\\/path1\",\"StreamKey\":\"live\\/stream_name=1fd73653a094b877b9bd78468c91adbf\"}]}}' http://example.com/apiv2/av

Sample Request

{
    "Cmd": "ReqSetRTMPInfo",
    "Version": "2.0.000",
    "Content": {
        "RTMPInfo": [
            {
                "Channel": 0,
                "Enable": true,
                "VideoTagHeader": 1,
                "Url": "rtmp://192.168.2.177/path0",
                "StreamKey": "live/stream_name=1fd73653a094b877b9bd78468c91adbf"
            },
            {
                "Channel": 1,
                "Enable": true,
                "VideoTagHeader": 0,
                "Url": "rtmps://192.168.2.177/path1",
                "StreamKey": "live/stream_name=1fd73653a094b877b9bd78468c91adbf"
            }
        ]
    }
}

Response

{
    "Cmd": "AswSetRTMPInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • RTMPInfo
    Show properties
    • Channelenum(Optional)
      Description: RTMP Stream Channel
      Value: : Channel 0, 1: Channel 1
    • Enablebool(Optional)
      Description: RTMP Stream Enable
      Value: true/false
    • VideoTagHeaderenum(Optional)
      Description: VideoTagHeader
      Value: : codec:12, 1: rtmp-enhanced. only for h265
    • Urlstring(Optional)
      Description: Url
    • StreamKeystring(Optional)
      Description: StreamKey

ReqGetSRTInfo

POSTapiv2/av

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetSRTInfo\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/av

Sample Request

{
    "Cmd": "ReqGetSRTInfo",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetSRTInfo",
    "Version": "2.00.000",
    "Content": {
        "SRTInfo": [
            {
                "Channel": 0,
                "Enable": false,
                "Mode": 2,
                "IPAddress": "",
                "Port": 8001,
                "StreamID": "live/channel/0",
                "Latency": 50,
                "OverheadBandwidth": 25,
                "Encryption": 0,
                "Passphrase": ""
            },
            {
                "Channel": 1,
                "Enable": false,
                "Mode": 2,
                "IPAddress": "",
                "Port": 8002,
                "StreamID": "live/channel/1",
                "Latency": 50,
                "OverheadBandwidth": 25,
                "Encryption": 0,
                "Passphrase": ""
            }
        ],
        "Status": 0
    }
}

Parameters

  • SRTInfo
    Show properties
    • Channelenum(Optional)
      Description: SRT Channel Enable
      Value: : Channel 0, 1: Channel 1
    • Enablebool(Optional)
      Description: SRT Stream Enable
      Value: true/false
    • Modeenum(Optional)
      Description: SRT Mode
      Value: 1: caller, 2: listener
    • IPAddressstring(Optional)
      Description: SRT IPAddress
    • Portrange(Optional)
      Description: SRT Port
      Value: 1-65535
    • StreamIDstring(Optional)
      Description: Stream ID
    • Latencyrange(Optional)
      Description: Latency
      Value: 20-5000
    • OverheadBandwidthrange(Optional)
      Description: OverheadBandwidth
      Value: 5-100
    • Encryptionenum(Optional)
      Description: Encryption
      Value: : disable, 1: aes-128, 2: aes-192, 3: aes-256
    • Passphrasestring(Optional)
      Description: Passphrase

ReqSetSRTInfo

POSTapiv2/av

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetSRTInfo\",\"Version\":\"2.0.000\",\"Content\":{\"SRTInfo\":[{\"Channel\":0,\"Enable\":true,\"Mode\":1,\"IPAddress\":\"192.168.1.222\",\"Port\":5000,\"StreamID\":\"live\\/channel\\/0\",\"Latency\":200,\"OverheadBandwidth\":20,\"Encryption\":0,\"Passphrase\":\"aaaaaaa123456\"},{\"Channel\":1,\"Enable\":true,\"Mode\":2,\"IPAddress\":\"192.168.1.222\",\"Port\":5001,\"StreamID\":\"live\\/channel\\/1\",\"Latency\":200,\"OverheadBandwidth\":20,\"Encryption\":0,\"Passphrase\":\"aaaaaaa123456\"}]}}' http://example.com/apiv2/av

Sample Request

{
    "Cmd": "ReqSetSRTInfo",
    "Version": "2.0.000",
    "Content": {
        "SRTInfo": [
            {
                "Channel": 0,
                "Enable": true,
                "Mode": 1,
                "IPAddress": "192.168.1.222",
                "Port": 5000,
                "StreamID": "live/channel/0",
                "Latency": 200,
                "OverheadBandwidth": 20,
                "Encryption": 0,
                "Passphrase": "aaaaaaa123456"
            },
            {
                "Channel": 1,
                "Enable": true,
                "Mode": 2,
                "IPAddress": "192.168.1.222",
                "Port": 5001,
                "StreamID": "live/channel/1",
                "Latency": 200,
                "OverheadBandwidth": 20,
                "Encryption": 0,
                "Passphrase": "aaaaaaa123456"
            }
        ]
    }
}

Response

{
    "Cmd": "AswSetSRTInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • SRTInfo
    Show properties
    • Channelenum(Optional)
      Description: SRT Channel Enable
      Value: : Channel 0, 1: Channel 1
    • Enablebool(Optional)
      Description: SRT Stream Enable
      Value: true/false
    • Modeenum(Optional)
      Description: SRT Mode
      Value: 1: caller, 2: listener
    • IPAddressstring(Optional)
      Description: SRT IPAddress
    • Portrange(Optional)
      Description: SRT Port
      Value: 1-65535
    • StreamIDstring(Optional)
      Description: Stream ID
    • Latencyrange(Optional)
      Description: Latency
      Value: 20-5000
    • OverheadBandwidthrange(Optional)
      Description: OverheadBandwidth
      Value: 5-100
    • Encryptionenum(Optional)
      Description: Encryption
      Value: : disable, 1: aes-128, 2: aes-192, 3: aes-256
    • Passphrasestring(Optional)
      Description: Passphrase

ReqGetAVOverUDPInfo

POSTapiv2/av

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetAVOverUDPInfo\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/av

Sample Request

{
    "Cmd": "ReqGetAVOverUDPInfo",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetAVOverUDPInfo",
    "Version": "2.00.000",
    "Content": {
        "AVOverUDPInfo": [
            {
                "Channel": 0,
                "Address": "224.0.3.1",
                "Port": 7000,
                "Enable": false
            },
            {
                "Channel": 1,
                "Address": "224.0.3.2",
                "Port": 7002,
                "Enable": false
            }
        ],
        "Status": 0
    }
}

Parameters

  • AVOverUDPInfo
    Show properties
    • Channelenum(Optional)
      Description: UDP Stream Channel
      Value: : Channel 0, 1: Channel 1
    • Addressstring(Optional)
      Description: UDP Stream Address Range
    • Portrange(Optional)
      Description: UDP Stream Port
      Value: 0-65535
    • Enablebool(Optional)
      Description: UDP Stream Enable
      Value: true/false

ReqSetAVOverUDPInfo

POSTapiv2/av

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetAVOverUDPInfo\",\"Version\":\"2.0.000\",\"Content\":{\"AVOverUDPInfo\":[{\"Channel\":0,\"Address\":\"239.255.255.254\",\"Port\":7000,\"Enable\":true},{\"Channel\":1,\"Address\":\"224.0.3.6\",\"Port\":7002,\"Enable\":true}]}}' http://example.com/apiv2/av

Sample Request

{
    "Cmd": "ReqSetAVOverUDPInfo",
    "Version": "2.0.000",
    "Content": {
        "AVOverUDPInfo": [
            {
                "Channel": 0,
                "Address": "239.255.255.254",
                "Port": 7000,
                "Enable": true
            },
            {
                "Channel": 1,
                "Address": "224.0.3.6",
                "Port": 7002,
                "Enable": true
            }
        ]
    }
}

Response

{
    "Cmd": "AswSetAVOverUDPInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • AVOverUDPInfo
    Show properties
    • Channelenum(Optional)
      Description: UDP Stream Channel
      Value: : Channel 0, 1: Channel 1
    • Addressstring(Optional)
      Description: UDP Stream Address Range
    • Portrange(Optional)
      Description: UDP Stream Port
      Value: 0-65535
    • Enablebool(Optional)
      Description: UDP Stream Enable
      Value: true/false

ReqGetAVOverRTPInfo

POSTapiv2/av

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetAVOverRTPInfo\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/av

Sample Request

{
    "Cmd": "ReqGetAVOverRTPInfo",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetAVOverRTPInfo",
    "Version": "2.00.000",
    "Content": {
        "AVOverRTPInfo": [
            {
                "Channel": 0,
                "Address": "224.0.3.3",
                "Port": 7004,
                "Enable": false
            },
            {
                "Channel": 1,
                "Address": "224.0.3.4",
                "Port": 7006,
                "Enable": false
            }
        ],
        "Status": 0
    }
}

Parameters

  • AVOverRTPInfo
    Show properties
    • Channelenum(Optional)
      Description: RTP Stream Channel
      Value: : Channel 0, 1: Channel 1
    • Addressstring(Optional)
      Description: RTP Stream Address Range
    • Portrange(Optional)
      Description: RTP Stream Port
      Value: 0-65535
    • Enablebool(Optional)
      Description: RTP Stream Enable
      Value: true/false

ReqSetAVOverRTPInfo

POSTapiv2/av

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetAVOverRTPInfo\",\"Version\":\"2.0.000\",\"Content\":{\"AVOverRTPInfo\":[{\"Channel\":0,\"Address\":\"239.2.255.254\",\"Port\":7004,\"Enable\":false},{\"Channel\":1,\"Address\":\"239.255.255.250\",\"Port\":7006,\"Enable\":true}]}}' http://example.com/apiv2/av

Sample Request

{
    "Cmd": "ReqSetAVOverRTPInfo",
    "Version": "2.0.000",
    "Content": {
        "AVOverRTPInfo": [
            {
                "Channel": 0,
                "Address": "239.2.255.254",
                "Port": 7004,
                "Enable": false
            },
            {
                "Channel": 1,
                "Address": "239.255.255.250",
                "Port": 7006,
                "Enable": true
            }
        ]
    }
}

Response

{
    "Cmd": "AswSetAVOverRTPInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • AVOverRTPInfo
    Show properties
    • Channelenum(Optional)
      Description: RTP Stream Channel
      Value: : Channel 0, 1: Channel 1
    • Addressstring(Optional)
      Description: RTP Stream Address Range
    • Portrange(Optional)
      Description: RTP Stream Port
      Value: 0-65535
    • Enablebool(Optional)
      Description: RTP Stream Enable
      Value: true/false

ReqGetEncodeCapabilities

POSTapiv2/av

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetEncodeCapabilities\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/av

Sample Request

{
    "Cmd": "ReqGetEncodeCapabilities",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetEncodeCapabilities",
    "Version": "2.00.000",
    "Content": {
        "EncodeInfo": {
            "Channel": {
                "Type": "enum",
                "Readonly": false,
                "Description": "Encoder Channel",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "Channel 0"
                    },
                    {
                        "Value": 1,
                        "Description": "Channel 1"
                    }
                ]
            },
            "LowLatency": {
                "Enable": {
                    "Type": "bool",
                    "Readonly": false,
                    "Description": "LowLatency Enable"
                }
            },
            "Details": [
                {
                    "Enable": {
                        "Type": "bool",
                        "Readonly": true,
                        "Description": "Channel Trigger"
                    },
                    "StreamType": {
                        "Type": "enum",
                        "Readonly": true,
                        "Description": "StreamType",
                        "Data": [
                            {
                                "Value": 0,
                                "Description": "Normal"
                            },
                            {
                                "Value": 1,
                                "Description": "Hx2"
                            },
                            {
                                "Value": 2,
                                "Description": "Hx3"
                            },
                            {
                                "Value": 3,
                                "Description": "Dante"
                            }
                        ]
                    },
                    "FieldType": {
                        "Type": "enum",
                        "Readonly": true,
                        "Description": "FieldType",
                        "Data": [
                            {
                                "Value": 0,
                                "Description": "Interlaced"
                            },
                            {
                                "Value": 1,
                                "Description": "Progressive"
                            }
                        ]
                    },
                    "VideoCompression": {
                        "Type": "enum",
                        "Readonly": false,
                        "Description": "VideoCompression",
                        "Data": [
                            {
                                "Value": 1,
                                "Description": "H264"
                            },
                            {
                                "Value": 2,
                                "Description": "H265"
                            }
                        ]
                    },
                    "Resolution": {
                        "Type": "enum",
                        "Readonly": false,
                        "Description": "Resolution",
                        "Data": [
                            {
                                "Value": "1920x1080",
                                "Description": "1920x1080"
                            },
                            {
                                "Value": "1280x720",
                                "Description": "1280x720"
                            }
                        ]
                    },
                    "FrameRate": {
                        "Type": "range",
                        "Readonly": false,
                        "Description": "FrameRate",
                        "Data": {
                            "Min": 1,
                            "Max": 59.93999999999999772626324556767940521240234375
                        }
                    },
                    "BPFrameType": {
                        "Type": "enum",
                        "Readonly": true,
                        "Description": "BPFrameType",
                        "Data": [
                            {
                                "Value": 0,
                                "Description": "Single P Frame"
                            }
                        ]
                    },
                    "BitrateType": {
                        "Type": "enum",
                        "Readonly": true,
                        "Description": "BitrateType",
                        "Data": [
                            {
                                "Value": 0,
                                "Description": "CBR"
                            },
                            {
                                "Value": 1,
                                "Description": "VBR"
                            }
                        ]
                    },
                    "BitRate": {
                        "Type": "range",
                        "Readonly": false,
                        "Description": "BitRate",
                        "Data": {
                            "Min": 1024,
                            "Max": 101376
                        }
                    },
                    "IFrameInterval": {
                        "Type": "range",
                        "Readonly": true,
                        "Description": "IFrameInterval",
                        "Data": {
                            "Min": 1,
                            "Max": 150
                        }
                    }
                },
                {
                    "Enable": {
                        "Type": "bool",
                        "Readonly": true,
                        "Description": "Channel Trigger"
                    },
                    "StreamType": {
                        "Type": "enum",
                        "Readonly": true,
                        "Description": "StreamType",
                        "Data": [
                            {
                                "Value": 0,
                                "Description": "Normal"
                            },
                            {
                                "Value": 1,
                                "Description": "Hx2"
                            },
                            {
                                "Value": 2,
                                "Description": "Hx3"
                            },
                            {
                                "Value": 3,
                                "Description": "Dante"
                            }
                        ]
                    },
                    "FieldType": {
                        "Type": "enum",
                        "Readonly": true,
                        "Description": "FieldType",
                        "Data": [
                            {
                                "Value": 0,
                                "Description": "Interlaced"
                            },
                            {
                                "Value": 1,
                                "Description": "Progressive"
                            }
                        ]
                    },
                    "VideoCompression": {
                        "Type": "enum",
                        "Readonly": false,
                        "Description": "VideoCompression",
                        "Data": [
                            {
                                "Value": 1,
                                "Description": "H264"
                            },
                            {
                                "Value": 2,
                                "Description": "H265"
                            }
                        ]
                    },
                    "Resolution": {
                        "Type": "enum",
                        "Readonly": false,
                        "Description": "Resolution",
                        "Data": [
                            {
                                "Value": "704x576",
                                "Description": "704x576"
                            },
                            {
                                "Value": "640x480",
                                "Description": "640x480"
                            },
                            {
                                "Value": "640x360",
                                "Description": "640x360"
                            },
                            {
                                "Value": "576x480",
                                "Description": "576x480"
                            },
                            {
                                "Value": "352x288",
                                "Description": "352x288"
                            }
                        ]
                    },
                    "FrameRate": {
                        "Type": "range",
                        "Readonly": false,
                        "Description": "FrameRate",
                        "Data": {
                            "Min": 1,
                            "Max": 30
                        }
                    },
                    "BPFrameType": {
                        "Type": "enum",
                        "Readonly": true,
                        "Description": "BPFrameType",
                        "Data": [
                            {
                                "Value": 0,
                                "Description": "Single P Frame"
                            }
                        ]
                    },
                    "BitrateType": {
                        "Type": "enum",
                        "Readonly": true,
                        "Description": "BitrateType",
                        "Data": [
                            {
                                "Value": 0,
                                "Description": "CBR"
                            },
                            {
                                "Value": 1,
                                "Description": "VBR"
                            }
                        ]
                    },
                    "BitRate": {
                        "Type": "range",
                        "Readonly": false,
                        "Description": "BitRate",
                        "Data": {
                            "Min": 100,
                            "Max": 8192
                        }
                    },
                    "IFrameInterval": {
                        "Type": "range",
                        "Readonly": true,
                        "Description": "IFrameInterval",
                        "Data": {
                            "Min": 1,
                            "Max": 150
                        }
                    }
                }
            ]
        }
    }
}

Parameters

  • EncodeInfo
    Show properties
    • Channelenum(Optional)
      Description: Encoder Channel
      Value: : Channel 0, 1: Channel 1
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • LowLatency(Optional)
      Show properties
      • Enable(Optional)
        Show properties
        • Type(Optional)
        • Readonly(Optional)
        • Description(Optional)
    • Details(Optional)
      Show properties
      • Enable(Optional)
        Show properties
        • Type(Optional)
        • Readonly(Optional)
        • Description(Optional)
      • StreamType(Optional)
        Show properties
        • Type(Optional)
        • Readonly(Optional)
        • Description(Optional)
        • Data(Optional)
          Show properties
          • Value(Optional)
          • Description(Optional)
      • FieldType(Optional)
        Show properties
        • Type(Optional)
        • Readonly(Optional)
        • Description(Optional)
        • Data(Optional)
          Show properties
          • Value(Optional)
          • Description(Optional)
      • VideoCompression(Optional)
        Show properties
        • Type(Optional)
        • Readonly(Optional)
        • Description(Optional)
        • Data(Optional)
          Show properties
          • Value(Optional)
          • Description(Optional)
      • Resolution(Optional)
        Show properties
        • Type(Optional)
        • Readonly(Optional)
        • Description(Optional)
        • Data(Optional)
          Show properties
          • Value(Optional)
          • Description(Optional)
      • FrameRate(Optional)
        Show properties
        • Type(Optional)
        • Readonly(Optional)
        • Description(Optional)
        • Data(Optional)
          Show properties
          • Min(Optional)
          • Max(Optional)
      • BPFrameType(Optional)
        Show properties
        • Type(Optional)
        • Readonly(Optional)
        • Description(Optional)
        • Data(Optional)
          Show properties
          • Value(Optional)
          • Description(Optional)
      • BitrateType(Optional)
        Show properties
        • Type(Optional)
        • Readonly(Optional)
        • Description(Optional)
        • Data(Optional)
          Show properties
          • Value(Optional)
          • Description(Optional)
      • BitRate(Optional)
        Show properties
        • Type(Optional)
        • Readonly(Optional)
        • Description(Optional)
        • Data(Optional)
          Show properties
          • Min(Optional)
          • Max(Optional)
      • IFrameInterval(Optional)
        Show properties
        • Type(Optional)
        • Readonly(Optional)
        • Description(Optional)
        • Data(Optional)
          Show properties
          • Min(Optional)
          • Max(Optional)

ReqGetEncodeInfo

POSTapiv2/av

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetEncodeInfo\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/av

Sample Request

{
    "Cmd": "ReqGetEncodeInfo",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetEncodeInfo",
    "Version": "2.00.000",
    "Content": {
        "EncodeInfo": [
            {
                "Channel": 0,
                "StreamType": 0,
                "Enable": true,
                "VideoCompression": 1,
                "Resolution": "1920x1080",
                "FieldType": 1,
                "BPFrameType": 0,
                "FrameRate": 60,
                "BitrateType": 0,
                "BitRate": 60000,
                "IFrameInterval": 20
            },
            {
                "Channel": 1,
                "StreamType": 0,
                "Enable": true,
                "VideoCompression": 1,
                "Resolution": "640x360",
                "FieldType": 1,
                "BPFrameType": 0,
                "FrameRate": 30,
                "BitrateType": 0,
                "BitRate": 3072,
                "IFrameInterval": 20
            }
        ],
        "LowLatency": {
            "Enable": false
        },
        "Status": 0
    }
}

Parameters

  • EncodeInfo
    Show properties
    • Channelenum(Optional)
      Description: Encoder Channel
      Value: : Channel 0, 1: Channel 1

ReqSetEncodeInfo

POSTapiv2/av

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetEncodeInfo\",\"Version\":\"2.0.000\",\"Content\":{\"EncodeInfo\":[{\"Channel\":0,\"VideoCompression\":1,\"Resolution\":\"1920x1080\",\"FrameRate\":20,\"BitrateType\":1,\"BitRate\":18192,\"IFrameInterval\":30},{\"Channel\":1,\"Enable\":true,\"VideoCompression\":2,\"Resolution\":\"704x576\",\"FrameRate\":20,\"BitrateType\":1,\"BitRate\":6000,\"IFrameInterval\":30}],\"LowLatency\":{\"Enable\":false}}}' http://example.com/apiv2/av

Sample Request

{
    "Cmd": "ReqSetEncodeInfo",
    "Version": "2.0.000",
    "Content": {
        "EncodeInfo": [
            {
                "Channel": 0,
                "VideoCompression": 1,
                "Resolution": "1920x1080",
                "FrameRate": 20,
                "BitrateType": 1,
                "BitRate": 18192,
                "IFrameInterval": 30
            },
            {
                "Channel": 1,
                "Enable": true,
                "VideoCompression": 2,
                "Resolution": "704x576",
                "FrameRate": 20,
                "BitrateType": 1,
                "BitRate": 6000,
                "IFrameInterval": 30
            }
        ],
        "LowLatency": {
            "Enable": false
        }
    }
}

Response

{
    "Cmd": "AswSetEncodeInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • EncodeInfo
    Show properties
    • Channelenum(Optional)
      Description: Encoder Channel
      Value: : Channel 0, 1: Channel 1

ReqGetAudioInfo

POSTapiv2/av

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetAudioInfo\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/av

Sample Request

{
    "Cmd": "ReqGetAudioInfo",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetAudioInfo",
    "Version": "2.00.000",
    "Content": {
        "AudioInfo": {
            "Enable": false,
            "Compression": 0,
            "BitRate": 128000,
            "SamplingRate": 48000,
            "ChannelNumber": 2,
            "Volume": 20,
            "Type": 1,
            "PhantomPower": false
        },
        "Status": 0
    }
}

Parameters

  • AudioInfo
    Show properties
    • Enablebool(Optional)
      Description: Audio Enable
      Value: true/false
    • Compressionenum(Optional)
      Description: Compression
      Value: : AAC
    • BitRateenum(Optional)
      Description: BitRate
      Value: 48000: 48K, 64000: 64K, 96000: 96K, 128000: 128K
    • SamplingRateenum(Optional)
      Description: SamplingRate
      Value: 44100: 44.1KHz, 48000: 48KHz
    • ChannelNumberrange(Optional)
      Description: ChannelNumber
      Value: 1-2
    • Volumerange(Optional)
      Description: Volume
      Value: 0-39
    • Typeenum(Optional)
      Description: Audio Type
      Value: : Mic, 1: Line in
    • PhantomPowerbool(Optional)
      Description: PhantomPower Enable
      Value: true/false

ReqSetAudioInfo

POSTapiv2/av

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetAudioInfo\",\"Version\":\"2.0.000\",\"Content\":{\"AudioInfo\":{\"Enable\":false,\"Type\":0,\"BitRate\":96000,\"SamplingRate\":48000,\"ChannelNumber\":2,\"Volume\":37,\"PhantomPower\":false}}}' http://example.com/apiv2/av

Sample Request

{
    "Cmd": "ReqSetAudioInfo",
    "Version": "2.0.000",
    "Content": {
        "AudioInfo": {
            "Enable": false,
            "Type": 0,
            "BitRate": 96000,
            "SamplingRate": 48000,
            "ChannelNumber": 2,
            "Volume": 37,
            "PhantomPower": false
        }
    }
}

Response

{
    "Cmd": "AswSetAudioInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • AudioInfo
    Show properties
    • Enablebool(Optional)
      Description: Audio Enable
      Value: true/false
    • Typeenum(Optional)
      Description: Audio Type
      Value: : Mic, 1: Line in
    • BitRateenum(Optional)
      Description: BitRate
      Value: 48000: 48K, 64000: 64K, 96000: 96K, 128000: 128K
    • SamplingRateenum(Optional)
      Description: SamplingRate
      Value: 44100: 44.1KHz, 48000: 48KHz
    • ChannelNumberrange(Optional)
      Description: ChannelNumber
      Value: 1-2
    • Volumerange(Optional)
      Description: Volume
      Value: 0-39
    • PhantomPowerbool(Optional)
      Description: PhantomPower Enable
      Value: true/false

ReqGetNetworkCapabilities

POSTapiv2/network

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -d '{\"Cmd\":\"ReqGetNetworkCapabilities\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/network

Sample Request

{
    "Cmd": "ReqGetNetworkCapabilities",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetNetworkCapabilities",
    "Version": "2.00.000",
    "Content": {
        "NetworkInfo": {
            "Pattern": {
                "Type": "enum",
                "Readonly": false,
                "Description": "Mode",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "Static"
                    },
                    {
                        "Value": 1,
                        "Description": "DHCP"
                    }
                ]
            },
            "IPVersion": {
                "Type": "enum",
                "Readonly": true,
                "Description": "IPVersion",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "IPV4"
                    },
                    {
                        "Value": 1,
                        "Description": "IPV6"
                    }
                ]
            },
            "IPAddress": {
                "Type": "string",
                "Readonly": false,
                "Description": "IPAddress",
                "Data": {
                    "MinLen": 7,
                    "MaxLen": 15
                }
            },
            "SubnetMask": {
                "Type": "string",
                "Readonly": false,
                "Description": "SubnetMask",
                "Data": {
                    "MinLen": 7,
                    "MaxLen": 15
                }
            },
            "Gateway": {
                "Type": "string",
                "Readonly": false,
                "Description": "Gateway",
                "Data": {
                    "MinLen": 7,
                    "MaxLen": 15
                }
            },
            "DNS1": {
                "Type": "string",
                "Readonly": false,
                "Description": "DNS1",
                "Data": {
                    "MinLen": 7,
                    "MaxLen": 15
                }
            },
            "DNS2": {
                "Type": "string",
                "Readonly": false,
                "Description": "DNS2",
                "Data": {
                    "MinLen": 7,
                    "MaxLen": 15
                }
            },
            "NetMAC": {
                "Type": "string",
                "Readonly": true,
                "Description": "MAC",
                "Data": {
                    "MinLen": 17,
                    "MaxLen": 17
                }
            }
        },
        "PortInfo": {
            "TCPPort": {
                "Type": "range",
                "Readonly": true,
                "Description": "TCP Port",
                "Data": {
                    "Min": 1,
                    "Max": 65535
                }
            },
            "UDPPort": {
                "Type": "range",
                "Readonly": true,
                "Description": "UDP Port",
                "Data": {
                    "Min": 1,
                    "Max": 65535
                }
            },
            "RTSPPort": {
                "Type": "range",
                "Readonly": false,
                "Description": "RTSP Port",
                "Data": {
                    "Min": 1,
                    "Max": 65535
                }
            },
            "ONVIFPort": {
                "Type": "range",
                "Readonly": false,
                "Description": "ONVIF Port",
                "Data": {
                    "Min": 1,
                    "Max": 65535
                }
            },
            "VISCAPort": {
                "Type": "range",
                "Readonly": false,
                "Description": "VISCA Port",
                "Data": {
                    "Min": 1,
                    "Max": 65535
                }
            },
            "HTTPPort": {
                "Type": "range",
                "Readonly": false,
                "Description": "HTTP Port",
                "Data": {
                    "Min": 1,
                    "Max": 65535
                }
            }
        },
        "FTPInfo": {
            "Enable": {
                "Type": "bool",
                "Readonly": false,
                "Description": "FTP Enable"
            },
            "ServerIP": {
                "Type": "string",
                "Readonly": false,
                "Description": "ServerIP",
                "Data": {
                    "MinLen": 7,
                    "MaxLen": 15
                }
            },
            "ServerPort": {
                "Type": "range",
                "Readonly": false,
                "Description": "ServerPort",
                "Data": {
                    "Min": 1,
                    "Max": 65535
                }
            },
            "Username": {
                "Type": "string",
                "Readonly": false,
                "Description": "Username",
                "Data": {
                    "MinLen": 0,
                    "MaxLen": 31
                }
            },
            "Password": {
                "Type": "string",
                "Readonly": false,
                "Description": "Password",
                "Data": {
                    "MinLen": 0,
                    "MaxLen": 31
                }
            },
            "PathType": {
                "Type": "enum",
                "Readonly": false,
                "Description": "PathType",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "DefaultRoot"
                    },
                    {
                        "Value": 1,
                        "Description": "Assign"
                    }
                ]
            },
            "Path": {
                "Type": "string",
                "Readonly": false,
                "Description": "Path",
                "Data": {
                    "MinLen": 0,
                    "MaxLen": 63
                }
            }
        },
        "SnapInfo": {
            "Channel": {
                "Type": "enum",
                "Readonly": false,
                "Description": "SnapInfo",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "Channel 0"
                    }
                ]
            },
            "Enable": {
                "Type": "bool",
                "Readonly": false,
                "Description": "Snap Enable"
            },
            "Level": {
                "Type": "enum",
                "Readonly": false,
                "Description": "Level",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "Lower"
                    },
                    {
                        "Value": 1,
                        "Description": "Medium"
                    },
                    {
                        "Value": 2,
                        "Description": "High"
                    }
                ]
            },
            "Interval": {
                "Type": "range",
                "Readonly": false,
                "Description": "Snapshot Interval",
                "Data": {
                    "Min": 500,
                    "Max": 86400000
                }
            }
        },
        "FreeDInfo": {
            "Enable": {
                "Type": "bool",
                "Readonly": false,
                "Description": "FreeD Enable"
            },
            "Address": {
                "Type": "string",
                "Readonly": false,
                "Description": "FreeD Date received IP Address",
                "Data": {
                    "MinLen": 7,
                    "MaxLen": 15
                }
            },
            "Port": {
                "Type": "range",
                "Readonly": false,
                "Description": "FreeD Port",
                "Data": {
                    "Min": 1025,
                    "Max": 65535
                }
            },
            "CameraID": {
                "Type": "range",
                "Readonly": false,
                "Description": "Camera ID",
                "Data": {
                    "Min": 0,
                    "Max": 255
                }
            },
            "TransferMode": {
                "Type": "enum",
                "Readonly": false,
                "Description": "TransferMode",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "Always"
                    },
                    {
                        "Value": 1,
                        "Description": "OnDemand"
                    }
                ]
            }
        },
        "Status": 0
    }
}

Parameters

  • NetworkInfo
    Show properties
    • Patternenum(Optional)
      Description: Mode
      Value: : Static, 1: DHCP
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • IPVersionenum(Optional)
      Description: IPVersion
      Value: : IPV4, 1: IPV6
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • IPAddressstring(Optional)
      Description: IPAddress
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • SubnetMaskstring(Optional)
      Description: SubnetMask
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • Gatewaystring(Optional)
      Description: Gateway
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • DNS1string(Optional)
      Description: DNS1
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • DNS2string(Optional)
      Description: DNS2
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • NetMACstring(Optional)
      Description: MAC
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
  • PortInfo
    Show properties
    • TCPPortrange(Optional)
      Description: TCP Port
      Value: 1-65535
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • UDPPortrange(Optional)
      Description: UDP Port
      Value: 1-65535
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • RTSPPortrange(Optional)
      Description: RTSP Port
      Value: 1-65535
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • ONVIFPortrange(Optional)
      Description: ONVIF Port
      Value: 1-65535
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • VISCAPortrange(Optional)
      Description: VISCA Port
      Value: 1-65535
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • HTTPPortrange(Optional)
      Description: HTTP Port
      Value: 1-65535
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
  • FTPInfo
    Show properties
    • Enablebool(Optional)
      Description: FTP Enable
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • ServerIPstring(Optional)
      Description: ServerIP
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • ServerPortrange(Optional)
      Description: ServerPort
      Value: 1-65535
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • Usernamestring(Optional)
      Description: Username
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • Passwordstring(Optional)
      Description: Password
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • PathTypeenum(Optional)
      Description: PathType
      Value: : DefaultRoot, 1: Assign
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • Pathstring(Optional)
      Description: Path
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
  • SnapInfo
    Show properties
    • Channelenum(Optional)
      Description: SnapInfo
      Value: : Channel 0
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • Enablebool(Optional)
      Description: Snap Enable
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • Levelenum(Optional)
      Description: Level
      Value: : Lower, 1: Medium, 2: High
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • Intervalrange(Optional)
      Description: Snapshot Interval
      Value: 500-86400000
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
  • FreeDInfo
    Show properties
    • Enablebool(Optional)
      Description: FreeD Enable
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • Addressstring(Optional)
      Description: FreeD Date received IP Address
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • Portrange(Optional)
      Description: FreeD Port
      Value: 1025-65535
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • CameraIDrange(Optional)
      Description: Camera ID
      Value: 0-255
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • TransferModeenum(Optional)
      Description: TransferMode
      Value: : Always, 1: OnDemand
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)

ReqGetNetworkInfo

POSTapiv2/network

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetNetworkInfo\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/network

Sample Request

{
    "Cmd": "ReqGetNetworkInfo",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetNetworkInfo",
    "Version": "2.00.000",
    "Content": {
        "NetworkInfo": {
            "Pattern": 1,
            "IPAddress": "192.168.3.213",
            "IPVersion": 0,
            "SubnetMask": "255.255.255.0",
            "NetMAC": "44:03:77:E0:6D:29",
            "Gateway": "192.168.3.1",
            "DNS1": "192.168.3.1",
            "DNS2": "192.168.3.1"
        },
        "Fallback": {
            "IPAddress": "192.168.0.13",
            "Gateway": "192.168.0.254",
            "SubnetMask": "255.255.255.0",
            "Timeout": 60
        },
        "Status": 0
    }
}

Parameters

  • NetworkInfo
    Show properties
    • Patternenum(Optional)
      Description: Mode
      Value: : Static, 1: DHCP
    • IPAddressstring(Optional)
      Description: IPAddress
    • IPVersionenum(Optional)
      Description: IPVersion
      Value: : IPV4, 1: IPV6
    • SubnetMaskstring(Optional)
      Description: SubnetMask
    • NetMACstring(Optional)
      Description: MAC
    • Gatewaystring(Optional)
      Description: Gateway
    • DNS1string(Optional)
      Description: DNS1
    • DNS2string(Optional)
      Description: DNS2

ReqSetNetworkInfo

POSTapiv2/network

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetNetworkInfo\",\"Version\":\"2.0.000\",\"Content\":{\"NetworkInfo\":{\"Pattern\":0,\"IPAddress\":\"192.168.3.213\",\"SubnetMask\":\"255.255.255.0\",\"Gateway\":\"192.168.3.1\",\"DNS1\":\"192.168.3.1\",\"DNS2\":\"8.8.4.4\"},\"Fallback\":{\"IPAddress\":\"192.168.3.225\",\"Gateway\":\"192.168.3.1\",\"SubnetMask\":\"255.255.255.0\",\"Timeout\":20}}}' http://example.com/apiv2/network

Sample Request

{
    "Cmd": "ReqSetNetworkInfo",
    "Version": "2.0.000",
    "Content": {
        "NetworkInfo": {
            "Pattern": 0,
            "IPAddress": "192.168.3.213",
            "SubnetMask": "255.255.255.0",
            "Gateway": "192.168.3.1",
            "DNS1": "192.168.3.1",
            "DNS2": "8.8.4.4"
        },
        "Fallback": {
            "IPAddress": "192.168.3.225",
            "Gateway": "192.168.3.1",
            "SubnetMask": "255.255.255.0",
            "Timeout": 20
        }
    }
}

Response

{
    "Cmd": "AswSetNetworkInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 1
    }
}

Parameters

  • NetworkInfo
    Show properties
    • Patternenum(Optional)
      Description: Mode
      Value: : Static, 1: DHCP
    • IPAddressstring(Optional)
      Description: IPAddress
    • SubnetMaskstring(Optional)
      Description: SubnetMask
    • Gatewaystring(Optional)
      Description: Gateway
    • DNS1string(Optional)
      Description: DNS1
    • DNS2string(Optional)
      Description: DNS2

ReqGetPortInfo

POSTapiv2/network

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetPortInfo\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/network

Sample Request

{
    "Cmd": "ReqGetPortInfo",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetPortInfo",
    "Version": "2.00.000",
    "Content": {
        "PortInfo": {
            "TCPPort": 36666,
            "UDPPort": 37778,
            "RTSPPort": 554,
            "ONVIFPort": 2000,
            "VISCAPort": 52381,
            "HTTPPort": 80
        },
        "Status": 0
    }
}

Parameters

  • PortInfo
    Show properties
    • TCPPortrange(Optional)
      Description: TCP Port
      Value: 1-65535
    • UDPPortrange(Optional)
      Description: UDP Port
      Value: 1-65535
    • RTSPPortrange(Optional)
      Description: RTSP Port
      Value: 1-65535
    • ONVIFPortrange(Optional)
      Description: ONVIF Port
      Value: 1-65535
    • VISCAPortrange(Optional)
      Description: VISCA Port
      Value: 1-65535
    • HTTPPortrange(Optional)
      Description: HTTP Port
      Value: 1-65535

ReqSetPortInfo

POSTapiv2/network

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetPortInfo\",\"Version\":\"2.00.000\",\"Content\":{\"PortInfo\":{\"RTSPPort\":554,\"ONVIFPort\":2000,\"VISCAPort\":52381,\"HTTPPort\":80}}}' http://example.com/apiv2/network

Sample Request

{
    "Cmd": "ReqSetPortInfo",
    "Version": "2.00.000",
    "Content": {
        "PortInfo": {
            "RTSPPort": 554,
            "ONVIFPort": 2000,
            "VISCAPort": 52381,
            "HTTPPort": 80
        }
    }
}

Response

{
    "Cmd": "AswSetPortInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • PortInfo
    Show properties
    • RTSPPortrange(Optional)
      Description: RTSP Port
      Value: 1-65535
    • ONVIFPortrange(Optional)
      Description: ONVIF Port
      Value: 1-65535
    • VISCAPortrange(Optional)
      Description: VISCA Port
      Value: 1-65535
    • HTTPPortrange(Optional)
      Description: HTTP Port
      Value: 1-65535

ReqGetFreeDInfo

POSTapiv2/network

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetFreeDInfo\",\"Version\":\"2.00.000\"}' http://example.com/apiv2/network

Sample Request

{
    "Cmd": "ReqGetFreeDInfo",
    "Version": "2.00.000"
}

Response

{
    "Cmd": "AswGetFreeDInfo",
    "Version": "2.00.000",
    "Content": {
        "FreeDInfo": {
            "Enable": false,
            "Address": "0.0.0.0",
            "Port": 40000,
            "CameraID": 255,
            "TransferMode": 0
        },
        "Status": 0
    }
}

Parameters

  • FreeDInfo
    Show properties
    • Enablebool(Optional)
      Description: FreeD Enable
      Value: true/false
    • Addressstring(Optional)
      Description: FreeD Date received IP Address
    • Portrange(Optional)
      Description: FreeD Port
      Value: 1025-65535
    • CameraIDrange(Optional)
      Description: Camera ID
      Value: 0-255
    • TransferModeenum(Optional)
      Description: TransferMode
      Value: : Always, 1: OnDemand

ReqSetFreeDInfo

POSTapiv2/network

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetFreeDInfo\",\"Version\":\"2.00.000\",\"Content\":{\"FreeDInfo\":{\"Enable\":false,\"Address\":\"192.168.3.138\",\"Port\":15000,\"CameraID\":255,\"TransferMode\":0}}}' http://example.com/apiv2/network

Sample Request

{
    "Cmd": "ReqSetFreeDInfo",
    "Version": "2.00.000",
    "Content": {
        "FreeDInfo": {
            "Enable": false,
            "Address": "192.168.3.138",
            "Port": 15000,
            "CameraID": 255,
            "TransferMode": 0
        }
    }
}

Response

{
    "Cmd": "AswSetFreeDInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • FreeDInfo
    Show properties
    • Enablebool(Optional)
      Description: FreeD Enable
      Value: true/false
    • Addressstring(Optional)
      Description: FreeD Date received IP Address
    • Portrange(Optional)
      Description: FreeD Port
      Value: 1025-65535
    • CameraIDrange(Optional)
      Description: Camera ID
      Value: 0-255
    • TransferModeenum(Optional)
      Description: TransferMode
      Value: : Always, 1: OnDemand

ReqGetFTPInfo

POSTapiv2/network

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetFTPInfo\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/network

Sample Request

{
    "Cmd": "ReqGetFTPInfo",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetFTPInfo",
    "Version": "2.00.000",
    "Content": {
        "FTPInfo": {
            "Enable": false,
            "ServerIP": "192.168.1.1",
            "ServerPort": 21,
            "Username": "admin",
            "Password": "admin",
            "PathType": 0,
            "Path": "picture"
        },
        "Status": 0
    }
}

Parameters

  • FTPInfo
    Show properties
    • Enablebool(Optional)
      Description: FTP Enable
      Value: true/false
    • ServerIPstring(Optional)
      Description: ServerIP
    • ServerPortrange(Optional)
      Description: ServerPort
      Value: 1-65535
    • Usernamestring(Optional)
      Description: Username
    • Passwordstring(Optional)
      Description: Password
    • PathTypeenum(Optional)
      Description: PathType
      Value: : DefaultRoot, 1: Assign
    • Pathstring(Optional)
      Description: Path

ReqSetFTPInfo

POSTapiv2/network

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetFTPInfo\",\"Version\":\"2.0.000\",\"Content\":{\"FTPInfo\":{\"Enable\":true,\"ServerIP\":\"192.168.1.1\",\"ServerPort\":21,\"Username\":\"admin\",\"Password\":\"1234567\",\"PathType\":1,\"Path\":\"picture\"}}}' http://example.com/apiv2/network

Sample Request

{
    "Cmd": "ReqSetFTPInfo",
    "Version": "2.0.000",
    "Content": {
        "FTPInfo": {
            "Enable": true,
            "ServerIP": "192.168.1.1",
            "ServerPort": 21,
            "Username": "admin",
            "Password": "1234567",
            "PathType": 1,
            "Path": "picture"
        }
    }
}

Response

{
    "Cmd": "AswSetFTPInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • FTPInfo
    Show properties
    • Enablebool(Optional)
      Description: FTP Enable
      Value: true/false
    • ServerIPstring(Optional)
      Description: ServerIP
    • ServerPortrange(Optional)
      Description: ServerPort
      Value: 1-65535
    • Usernamestring(Optional)
      Description: Username
    • Passwordstring(Optional)
      Description: Password
    • PathTypeenum(Optional)
      Description: PathType
      Value: : DefaultRoot, 1: Assign
    • Pathstring(Optional)
      Description: Path

ReqGetSnapInfo

POSTapiv2/network

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetSnapInfo\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/network

Sample Request

{
    "Cmd": "ReqGetSnapInfo",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetSnapInfo",
    "Version": "2.00.000",
    "Content": {
        "SnapInfo": [
            {
                "Channel": 0,
                "Enable": false,
                "Level": 1,
                "Interval": 1000
            }
        ],
        "Status": 0
    }
}

Parameters

  • SnapInfo
    Show properties
    • Channelenum(Optional)
      Description: SnapInfo
      Value: : Channel 0
    • Enablebool(Optional)
      Description: Snap Enable
      Value: true/false
    • Levelenum(Optional)
      Description: Level
      Value: : Lower, 1: Medium, 2: High
    • Intervalrange(Optional)
      Description: Snapshot Interval
      Value: 500-86400000

ReqSetSnapInfo

POSTapiv2/network

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetSnapInfo\",\"Version\":\"2.0.000\",\"Content\":{\"SnapInfo\":[{\"Channel\":0,\"Enable\":false,\"Level\":2,\"Interval\":500}]}}' http://example.com/apiv2/network

Sample Request

{
    "Cmd": "ReqSetSnapInfo",
    "Version": "2.0.000",
    "Content": {
        "SnapInfo": [
            {
                "Channel": 0,
                "Enable": false,
                "Level": 2,
                "Interval": 500
            }
        ]
    }
}

Response

{
    "Cmd": "AswSetSnapInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • SnapInfo
    Show properties
    • Channelenum(Optional)
      Description: SnapInfo
      Value: : Channel 0
    • Enablebool(Optional)
      Description: Snap Enable
      Value: true/false
    • Levelenum(Optional)
      Description: Level
      Value: : Lower, 1: Medium, 2: High
    • Intervalrange(Optional)
      Description: Snapshot Interval
      Value: 500-86400000

CGI Commmand

 Fast-CGI can easily provide some simple and quick http commands to users, with limited functions and limited support.

Protocol:

HTTP protocol, port 80, shares port with Web GUI, and does not require authentication
Return Data with HTML:
 
Noted:

CGI Command List
FunctionCommandsNoted
Powerhttp://192.168.2.207/cgi-bin/set.cgi?pelco.controller.power=0Power OFF
http://192.168.2.207/cgi-bin/set.cgi?pelco.controller.power=1Power ON
Menuhttp://192.168.2.207/cgi-bin/set.cgi?pelco.controller.menu=0Menu ON
http://192.168.2.207/cgi-bin/set.cgi?pelco.controller.menu=1Menu OFF
Set Presethttp://192.168.2.207/cgi-bin/set.cgi?pelco.ptz.preset.set=1Set Camera Preset, from preset 1-128
http://192.168.2.207/cgi-bin/set.cgi?pelco.ptz.preset.set=2
http://192.168.2.207/cgi-bin/set.cgi?pelco.ptz.preset.set=3
http://192.168.2.207/cgi-bin/set.cgi?pelco.ptz.preset.set=4
http://192.168.2.207/cgi-bin/set.cgi?pelco.ptz.preset.set=5
http://192.168.2.207/cgi-bin/set.cgi?pelco.ptz.preset.set=6
http://192.168.2.207/cgi-bin/set.cgi?pelco.ptz.preset.set=7
http://192.168.2.207/cgi-bin/set.cgi?pelco.ptz.preset.set=8
http://192.168.2.207/cgi-bin/set.cgi?pelco.ptz.preset.set=9
http://192.168.2.207/cgi-bin/set.cgi?pelco.ptz.preset.set=10
Call Presethttp://192.168.2.207/cgi-bin/set.cgi?
pelco.ptz.preset.goto=1		Call Camera Preset, from preset 1-128
http://192.168.2.207/cgi-bin/set.cgi?
pelco.ptz.preset.goto=2
http://192.168.2.207/cgi-bin/set.cgi?
pelco.ptz.preset.goto=3
http://192.168.2.207/cgi-bin/set.cgi?
pelco.ptz.preset.goto=4
http://192.168.2.207/cgi-bin/set.cgi?
pelco.ptz.preset.goto=5
http://192.168.2.207/cgi-bin/set.cgi?
pelco.ptz.preset.goto=6
http://192.168.2.207/cgi-bin/set.cgi?
pelco.ptz.preset.goto=7
http://192.168.2.207/cgi-bin/set.cgi?
pelco.ptz.preset.goto=8
http://192.168.2.207/cgi-bin/set.cgi?
pelco.ptz.preset.goto=9
http://192.168.2.207/cgi-bin/set.cgi?
pelco.ptz.preset.goto=10
http://192.168.2.207/cgi-bin/set.cgi?
pelco.ptz.preset.goto=128
Pan Speedhttp://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.pan_speed=1		Adjust Pan Motor speed (1-24 Steps)
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.pan_speed=10
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.pan_speed=24
Tilt Speedhttp://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.tilt_speed=1		Adjust Tilt Motor speed (1-24 Steps)
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.tilt_speed=10
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.tilt_speed=18
Controllerhttp://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.action=23		(HOME)
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.action=24		(UP)
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.action=25		(Down)
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.action=26		(Right)
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.action=27		(Left)
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.action=0		(Stop)
Mutehttp://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.mute=0		Microphone Open
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.mute=1		Microphone Mute
Zoom_speedhttp://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.zoom_accelerate=0		slow
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.zoom_accelerate=1		fast
Zoomhttp://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.action=12		teleZoom in
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.action=13		wideZoom out
Focus modehttp://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.focus=0		manual
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.focus=1		auto
Focushttp://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.action=14		Far
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.action=15		Near
Snapshothttp://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.snapshot=1		Snapshot
Wiperhttp://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.snglwiper=1		Sngl.Wiper ON
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.contwiper=1		Cont.Wiper ON
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.wiper=0		Wiper OFF
BackLighthttp://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.backlight=0		OFF
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.backlight=1		ON
WhiteBalancehttp://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.wb=0		auto
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.wb=1		indoor
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.wb=2		outdoor
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.wb=3		one push WB mode
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.wb=4		ATW
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.wb=5		manual
System formathttp://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=24		3840*2160/60System Format
{"pelco.controller.format":
["faied,mismatch
with system
format","-1"]}
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=25		3840*2160/59.94
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=26		3840*2160/50
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=28		3840*2160/30
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=29		3840*2160/29.97
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=30		3840*2160/25
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=23		3840*2160/24
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=27		3840*2160/23.98
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=18		1920*1080/60
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=19		1920*1080/59.94
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=20		1920*1080/50
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=1		1920*1080i/59.94
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=4		1920*1080i/50
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=11		1920*1080/23.98
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=10		1280*720/60
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=9		1280*720/59.94
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=12		1280*720/50
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=7		1280*720/30
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.systemformat=6		1280*720/25
SDI formathttp://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=24		3840*2160/60SDI
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=25		3840*2160/59.94
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=26		3840*2160/50
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=28		3840*2160/30
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=29		3840*2160/29.97
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=30		3840*2160/25
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=23		3840*2160/24
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=27		3840*2160/23.98
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=18		1920*1080/60
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=19		1920*1080/59.94
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=20		1920*1080/50
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=17		1920*1080/24
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=11		1920*1080/23.98
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=2		1920*1080i/60
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=1		1920*1080i/59.94
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=4		1920*1080i/50
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=10		1280*720/60
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=9		1280*720/59.94
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=12		1280*720/50
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=7		1280*720/30
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.sdiformat=6		1280*720/25
HDMI formathttp://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=24		3840*2160/60HDMI
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=25		3840*2160/59.94
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=26		3840*2160/50
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=28		3840*2160/30
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=29		3840*2160/29.97
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=30		3840*2160/25
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=23		3840*2160/24
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=27		3840*2160/23.98
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=18		1920*1080/60
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=19		1920*1080/59.94
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=20		1920*1080/50
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=17		1920*1080/24
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=11		1920*1080/23
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=2		1920*1080i/60
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=1		1920*1080i/59.94
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=4		1920*1080i/50
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=10		1280*720/60
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=9		1280*720/59.94
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=12		1280*720/50
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=7		1280*720/30
http://192.168.2.207/cgi-bin/set.cgi?
pelco.controller.format=6		1280*720/25

ReqGetGeneralCapabilities

POSTapiv2/general

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetGeneralCapabilities\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/general

Sample Request

{
    "Cmd": "ReqGetGeneralCapabilities",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetGeneralCapabilities",
    "Version": "2.00.000",
    "Content": {
        "OverlayInfo": {
            "Channel": {
                "Type": "range",
                "Readonly": false,
                "Description": "Channel No.,Channel No.5 is fixed as logo overlay channel, Channel No.8 is fixed as date overlay channel, other channels are text overlay channel.",
                "Data": {
                    "Min": 1,
                    "Max": 8
                }
            },
            "Type": {
                "Type": "enum",
                "Readonly": false,
                "Description": "Overlay Type",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "text"
                    },
                    {
                        "Value": 1,
                        "Description": "date"
                    },
                    {
                        "Value": 2,
                        "Description": "logo"
                    }
                ]
            },
            "Enable": {
                "Type": "bool",
                "Readonly": false,
                "Description": "Overlay Enable"
            },
            "Text": {
                "Type": "string",
                "Readonly": false,
                "Description": "Contents of the overlay text",
                "Data": {
                    "MinLen": 1,
                    "MaxLen": 32
                }
            },
            "PosX": {
                "Type": "range",
                "Readonly": false,
                "Description": "Upper left corner x-coordinate",
                "Data": {
                    "Min": 0,
                    "Max": 1920
                }
            },
            "PosY": {
                "Type": "range",
                "Readonly": false,
                "Description": "Upper right corner x-coordinate",
                "Data": {
                    "Min": 0,
                    "Max": 1080
                }
            },
            "Transparency": {
                "Type": "range",
                "Readonly": false,
                "Description": "Logo opacity adjustment",
                "Data": {
                    "Min": 0,
                    "Max": 100
                }
            },
            "Color": {
                "Type": "string",
                "Readonly": false,
                "Description": "Color",
                "Data": [
                    {
                        "Value": "red",
                        "Description": "red"
                    },
                    {
                        "Value": "yellow",
                        "Description": "yellow"
                    },
                    {
                        "Value": "white",
                        "Description": "white"
                    },
                    {
                        "Value": "blue",
                        "Description": "blue"
                    },
                    {
                        "Value": "black",
                        "Description": "black"
                    }
                ]
            },
            "TranslateH": {
                "Type": "range",
                "Readonly": false,
                "Description": "Horizontal translation of pixel points",
                "Data": {
                    "Min": -1920,
                    "Max": 1920
                }
            },
            "TranslateV": {
                "Type": "range",
                "Readonly": false,
                "Description": "Vertical translation of pixel points",
                "Data": {
                    "Min": -1080,
                    "Max": 1080
                }
            }
        },
        "VideoOutputInfo": {
            "SystemFormat": {
                "Type": "string",
                "Readonly": false,
                "Description": "SystemFormat",
                "Data": [
                    {
                        "Value": "1920x1080P60",
                        "Description": "1920x1080P60"
                    },
                    {
                        "Value": "1920x1080P59.94",
                        "Description": "1920x1080P59.94"
                    },
                    {
                        "Value": "1920x1080P50",
                        "Description": "1920x1080P50"
                    },
                    {
                        "Value": "1920x1080P24",
                        "Description": "1920x1080P24"
                    },
                    {
                        "Value": "1920x1080P23.98",
                        "Description": "1920x1080P23.98"
                    }
                ]
            },
            "HDMIResolution": {
                "Type": "string",
                "Readonly": false,
                "Description": "HDMIResolution",
                "Data": [
                    {
                        "Value": "1920x1080P60",
                        "Description": "1920x1080P60"
                    },
                    {
                        "Value": "1920x1080P30",
                        "Description": "1920x1080P30"
                    },
                    {
                        "Value": "1920x1080I60",
                        "Description": "1920x1080I60"
                    },
                    {
                        "Value": "1280x720P60",
                        "Description": "1280x720P60"
                    }
                ]
            },
            "SDIResolution": {
                "Type": "string",
                "Readonly": false,
                "Description": "SDIResolution",
                "Data": [
                    {
                        "Value": "1920x1080P60",
                        "Description": "1920x1080P60"
                    },
                    {
                        "Value": "1920x1080P30",
                        "Description": "1920x1080P30"
                    },
                    {
                        "Value": "1920x1080I60",
                        "Description": "1920x1080I60"
                    },
                    {
                        "Value": "1280x720P60",
                        "Description": "1280x720P60"
                    }
                ]
            },
            "HDMIColorSpace": {
                "Type": "enum",
                "Readonly": false,
                "Description": "HDMIColorSpace",
                "Data": [
                    {
                        "Value": 1,
                        "Description": "RGB"
                    },
                    {
                        "Value": 2,
                        "Description": "YUV422"
                    }
                ]
            },
            "HDMIBitDepth": {
                "Type": "enum",
                "Readonly": false,
                "Description": "HDMIBitDepth",
                "Data": [
                    {
                        "Value": 8,
                        "Description": "8Bit"
                    },
                    {
                        "Value": 10,
                        "Description": "10Bit"
                    },
                    {
                        "Value": 12,
                        "Description": "12Bit"
                    }
                ]
            },
            "SDIColorSpace": {
                "Type": "enum",
                "Readonly": true,
                "Description": "SDIColorSpace",
                "Data": [
                    {
                        "Value": 2,
                        "Description": "YUV422"
                    }
                ]
            },
            "SDIBitDepth": {
                "Type": "enum",
                "Readonly": true,
                "Description": "SDIBitDepth",
                "Data": [
                    {
                        "Value": 8,
                        "Description": "8Bit"
                    },
                    {
                        "Value": 10,
                        "Description": "10Bit"
                    },
                    {
                        "Value": 12,
                        "Description": "12Bit"
                    }
                ]
            }
        },
        "MonitorInfo": {
            "OutputChannel": {
                "Type": "enum",
                "Readonly": false,
                "Description": "MonitorChannel",
                "Data": [
                    {
                        "Value": 0,
                        "Description": "OFF"
                    },
                    {
                        "Value": 4,
                        "Description": "SDI-2"
                    },
                    {
                        "Value": 5,
                        "Description": "IP&HDMI"
                    },
                    {
                        "Value": 6,
                        "Description": "IP&HDMI+SDI-2"
                    }
                ]
            },
            "TemperatureDegree": {
                "Type": "enum",
                "Readonly": false,
                "Description": "TemperatureDegree",
                "Data": [
                    {
                        "Value": 2,
                        "Description": "Fahrenheit"
                    },
                    {
                        "Value": 3,
                        "Description": "Celsius"
                    }
                ]
            }
        },
        "UploadLogoFile": {
            "Type": "file",
            "Readonly": false,
            "Description": "UploadLogoFile",
            "Size": "The size of the logo image is within the range of 32KB to 1MB.",
            "BitDepth": "The logo image must be in 32-bit depth.",
            "Format": "The logo image format is PNG format and it has an Alpha channel.",
            "Pixel": "The width of the pixel of this logo image should not exceed 1920"
        },
        "Status": 0
    }
}

Parameters

  • OverlayInfo
    Show properties
    • Channelrange(Optional)
      Description: Channel No.,Channel No.5 is fixed as logo overlay channel, Channel No.8 is fixed as date overlay channel, other channels are text overlay channel.
      Value: 1-8
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • Typeenum(Optional)
      Description: Overlay Type
      Value: : text, 1: date, 2: logo
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • Enablebool(Optional)
      Description: Overlay Enable
      Value: true/false
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
    • Textstring(Optional)
      Description: Contents of the overlay text
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • MinLen(Optional)
        • MaxLen(Optional)
    • PosXrange(Optional)
      Description: Upper left corner x-coordinate
      Value: 0-1920
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • PosYrange(Optional)
      Description: Upper right corner x-coordinate
      Value: 0-1080
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • Transparencyrange(Optional)
      Description: Logo opacity adjustment
      Value: 0-100
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • Colorstring(Optional)
      Description: Color
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • TranslateHrange(Optional)
      Description: Horizontal translation of pixel points
      Value: -1920-1920
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
    • TranslateVrange(Optional)
      Description: Vertical translation of pixel points
      Value: -1080-1080
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Min(Optional)
        • Max(Optional)
  • VideoOutputInfo
    Show properties
    • SystemFormatstring(Optional)
      Description: SystemFormat
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • HDMIResolutionstring(Optional)
      Description: HDMIResolution
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • SDIResolutionstring(Optional)
      Description: SDIResolution
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • HDMIColorSpaceenum(Optional)
      Description: HDMIColorSpace
      Value: 1: RGB, 2: YUV422
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • HDMIBitDepthenum(Optional)
      Description: HDMIBitDepth
      Value: 8: 8Bit, 10: 10Bit, 12: 12Bit
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • SDIColorSpaceenum(Optional)
      Description: SDIColorSpace
      Value: 2: YUV422
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • SDIBitDepthenum(Optional)
      Description: SDIBitDepth
      Value: 8: 8Bit, 10: 10Bit, 12: 12Bit
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
  • MonitorInfo
    Show properties
    • OutputChannelenum(Optional)
      Description: MonitorChannel
      Value: : OFF, 4: SDI-2, 5: IP&HDMI, 6: IP&HDMI+SDI-2
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
    • TemperatureDegreeenum(Optional)
      Description: TemperatureDegree
      Value: 2: Fahrenheit, 3: Celsius
      Show properties
      • Type(Optional)
      • Readonly(Optional)
      • Description(Optional)
      • Data(Optional)
        Show properties
        • Value(Optional)
        • Description(Optional)
  • UploadLogoFile
    Show properties
    • Type(Optional)
    • Readonly(Optional)
    • Description(Optional)
    • Size(Optional)
    • BitDepth(Optional)
    • Format(Optional)
    • Pixel(Optional)

ReqGetOverlayInfo

POSTapiv2/general

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetOverlayInfo\",\"Version\":\"2.00.000\"}' http://example.com/apiv2/general

Sample Request

{
    "Cmd": "ReqGetOverlayInfo",
    "Version": "2.00.000"
}

Response

{
    "Cmd": "AswGetOverlayInfo",
    "Content": {
        "OverlayInfo": [
            {
                "Channel": 1,
                "Type": 0,
                "Enable": false,
                "Text": "",
                "PosX": 0,
                "PosY": 0,
                "Color": "white"
            },
            {
                "Channel": 2,
                "Type": 0,
                "Enable": false,
                "Text": "",
                "PosX": 0,
                "PosY": 0,
                "Color": "white"
            },
            {
                "Channel": 3,
                "Type": 0,
                "Enable": false,
                "Text": "",
                "PosX": 0,
                "PosY": 0,
                "Color": "white"
            },
            {
                "Channel": 4,
                "Type": 0,
                "Enable": false,
                "Text": "",
                "PosX": 0,
                "PosY": 0,
                "Color": "white"
            },
            {
                "Channel": 5,
                "Type": 2,
                "Enable": false,
                "PosX": 40,
                "PosY": 40
            },
            {
                "Channel": 6,
                "Type": 0,
                "Enable": false,
                "Text": "",
                "PosX": 0,
                "PosY": 0,
                "Color": "white"
            },
            {
                "Channel": 7,
                "Type": 0,
                "Enable": false,
                "Text": "",
                "PosX": 0,
                "PosY": 0,
                "Color": "white"
            },
            {
                "Channel": 8,
                "Type": 1,
                "Enable": false,
                "PosX": 0,
                "PosY": 0,
                "Color": "white"
            }
        ],
        "Status": 0
    }
}

Parameters

  • OverlayInfo
    Show properties
    • Channelrange(Optional)
      Description: Channel No.,Channel No.5 is fixed as logo overlay channel, Channel No.8 is fixed as date overlay channel, other channels are text overlay channel.
      Value: 1-8
    • Typeenum(Optional)
      Description: Overlay Type
      Value: : text, 1: date, 2: logo
    • Enablebool(Optional)
      Description: Overlay Enable
      Value: true/false
    • Textstring(Optional)
      Description: Contents of the overlay text
    • PosXrange(Optional)
      Description: Upper left corner x-coordinate
      Value: 0-1920
    • PosYrange(Optional)
      Description: Upper right corner x-coordinate
      Value: 0-1080
    • Colorstring(Optional)
      Description: Color

ReqSetOverlayInfo

POSTapiv2/general

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetOverlayInfo\",\"Version\":\"2.00.000\",\"Content\":{\"OverlayInfo\":[{\"Channel\":1,\"Enable\":true,\"TranslateH\":190,\"TranslateV\":100,\"PosX\":990,\"PosY\":860,\"color\":\"red\",\"text\":\"sdjhk\"},{\"Channel\":3,\"Enable\":true,\"TranslateH\":1920,\"TranslateV\":1080,\"PosX\":990,\"PosY\":860,\"color\":\"blue\",\"text\":\"sdjhkik\"}]}}' http://example.com/apiv2/general

Sample Request

{
    "Cmd": "ReqSetOverlayInfo",
    "Version": "2.00.000",
    "Content": {
        "OverlayInfo": [
            {
                "Channel": 1,
                "Enable": true,
                "TranslateH": 190,
                "TranslateV": 100,
                "PosX": 990,
                "PosY": 860,
                "color": "red",
                "text": "sdjhk"
            },
            {
                "Channel": 3,
                "Enable": true,
                "TranslateH": 1920,
                "TranslateV": 1080,
                "PosX": 990,
                "PosY": 860,
                "color": "blue",
                "text": "sdjhkik"
            }
        ]
    }
}

Response

{
    "Cmd": "AswSetOverlayInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • OverlayInfo
    Show properties
    • Channelrange(Optional)
      Description: Channel No.,Channel No.5 is fixed as logo overlay channel, Channel No.8 is fixed as date overlay channel, other channels are text overlay channel.
      Value: 1-8
    • Enablebool(Optional)
      Description: Overlay Enable
      Value: true/false
    • TranslateHrange(Optional)
      Description: Horizontal translation of pixel points
      Value: -1920-1920
    • TranslateVrange(Optional)
      Description: Vertical translation of pixel points
      Value: -1080-1080
    • PosXrange(Optional)
      Description: Upper left corner x-coordinate
      Value: 0-1920
    • PosYrange(Optional)
      Description: Upper right corner x-coordinate
      Value: 0-1080

ReqGetMonitorInfo

POSTapiv2/general

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetMonitorInfo\",\"Version\":\"2.00.000\"}' http://example.com/apiv2/general

Sample Request

{
    "Cmd": "ReqGetMonitorInfo",
    "Version": "2.00.000"
}

Response

{
    "Cmd": "AswGetMonitorInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 0,
        "MonitorInfo": {
            "OutputChannel": 0,
            "TemperatureDegree": 2
        }
    }
}

Parameters

  • MonitorInfo
    Show properties
    • OutputChannelenum(Optional)
      Description: MonitorChannel
      Value: : OFF, 4: SDI-2, 5: IP&HDMI, 6: IP&HDMI+SDI-2
    • TemperatureDegreeenum(Optional)
      Description: TemperatureDegree
      Value: 2: Fahrenheit, 3: Celsius

ReqSetMonitorInfo

POSTapiv2/general

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetMonitorInfo\",\"Version\":\"2.00.000\",\"Content\":{\"MonitorInfo\":{\"OutputChannel\":0,\"TemperatureDegree\":2}}}' http://example.com/apiv2/general

Sample Request

{
    "Cmd": "ReqSetMonitorInfo",
    "Version": "2.00.000",
    "Content": {
        "MonitorInfo": {
            "OutputChannel": 0,
            "TemperatureDegree": 2
        }
    }
}

Response

{
    "Cmd": "AswSetMonitorInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • MonitorInfo
    Show properties
    • OutputChannelenum(Optional)
      Description: MonitorChannel
      Value: : OFF, 4: SDI-2, 5: IP&HDMI, 6: IP&HDMI+SDI-2
    • TemperatureDegreeenum(Optional)
      Description: TemperatureDegree
      Value: 2: Fahrenheit, 3: Celsius

ReqGetVideoOutputInfo

POSTapiv2/general

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqGetVideoOutputInfo\",\"Version\":\"2.0.000\"}' http://example.com/apiv2/general

Sample Request

{
    "Cmd": "ReqGetVideoOutputInfo",
    "Version": "2.0.000"
}

Response

{
    "Cmd": "AswGetVideoOutputInfo",
    "Version": "2.00.000",
    "Content": {
        "VideoOutputInfo": {
            "SystemFormat": "1920x1080P60",
            "HDMIResolution": "1920x1080P60",
            "HDMIColorSpace": 1,
            "HDMIBitDepth": 8,
            "SDIColorSpace": 2,
            "SDIResolution": "1920x1080P60",
            "SDIBitDepth": 10
        },
        "Status": 0
    }
}

Parameters

  • VideoOutputInfo
    Show properties
    • SystemFormatstring(Optional)
      Description: SystemFormat
    • HDMIResolutionstring(Optional)
      Description: HDMIResolution
    • HDMIColorSpaceenum(Optional)
      Description: HDMIColorSpace
      Value: 1: RGB, 2: YUV422
    • HDMIBitDepthenum(Optional)
      Description: HDMIBitDepth
      Value: 8: 8Bit, 10: 10Bit, 12: 12Bit
    • SDIColorSpaceenum(Optional)
      Description: SDIColorSpace
      Value: 2: YUV422
    • SDIResolutionstring(Optional)
      Description: SDIResolution
    • SDIBitDepthenum(Optional)
      Description: SDIBitDepth
      Value: 8: 8Bit, 10: 10Bit, 12: 12Bit

ReqSetVideoOutputInfo

POSTapiv2/general

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' -d '{\"Cmd\":\"ReqSetVideoOutputInfo\",\"Version\":\"2.00.000\",\"Content\":{\"VideoOutputInfo\":{\"SystemFormat\":\"1920x1080P60\",\"HDMIResolution\":\"1920x1080P60\",\"SDIResolution\":\"1920x1080P60\",\"HDMIColorSpace\":2}}}' http://example.com/apiv2/general

Sample Request

{
    "Cmd": "ReqSetVideoOutputInfo",
    "Version": "2.00.000",
    "Content": {
        "VideoOutputInfo": {
            "SystemFormat": "1920x1080P60",
            "HDMIResolution": "1920x1080P60",
            "SDIResolution": "1920x1080P60",
            "HDMIColorSpace": 2
        }
    }
}

Response

{
    "Cmd": "AswSetVideoOutputInfo",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Parameters

  • VideoOutputInfo
    Show properties
    • SystemFormatstring(Optional)
      Description: SystemFormat
    • HDMIResolutionstring(Optional)
      Description: HDMIResolution
    • SDIResolutionstring(Optional)
      Description: SDIResolution
    • HDMIColorSpaceenum(Optional)
      Description: HDMIColorSpace
      Value: 1: RGB, 2: YUV422

UploadOverlayFile

POSTapiv2/general

Usage and SDK Samples

curl -X POST -H 'Content-Type: application/json' -H 'Cookie:Username=admin;Token=F5535072B11023F6CCD3AEFDB4FAED1D' --form 'logofile=@"path/to/file"' http://example.com/apiv2/general

Response

{
    "Cmd": "AswUploadOverlayFile",
    "Version": "2.00.000",
    "Content": {
        "Status": 0
    }
}

Have a Question?

  • Found a problem or a bug? Submit a support ticket.
  • Have a project/product idea or request? Share it with us.