Getting Started
Official Site
Getting Started
Official Site
  • Document description
  • Read before you start

  • Light application development guide

  • Mobile application development guide

  • Cloud live development guide

  • Desktop application development guide

  • Third party development guide

  • Message push development guide

  • IoT things data model

  • HTTP interface

    • Development specification
    • API privacy policy
    • Postman interface simulation call
    • accessToken: Get administrator token
    • API request example
    • Account docking
    • Push configuration
    • Cloud storage service
    • Equipment management

    • Device configurat

      • Device wifi configuration
      • Equipment dynamic inspection configuration
      • Device storage configuration
      • Device enable configuration
      • Device collection point configuration
      • Device cruise configuration
      • Device video screen configuration
        • setDeviceOsd: Set Device OSD Configuration
        • queryDeviceOsd: Get device OSD configuration
        • frameReverseStatus: Get device flip status
        • modifyFrameReverseStatus: Set device flip status
        • getZoomFocus: Get the optical zoom factor of the device
        • setZoomFocus: Set the optical zoom factor of the device
        • setNightVisionMode: Set the night vision mode of the device
        • getNightVisionMode: Get device night vision mode configuration
        • setFillLightSensitivity: Set device fill light sensitivity
        • getFillLightSensitivity: Query the sensitivity of the device fill light
      • Device recording configuration
      • Device Operation
      • Daylight saving time configuration
    • Video equipment

    • Device message
    • Device live broadcast
    • Device lock access
  • Reference documents

On this page
Function details
Request address
The minimum permissions required for the sub-account token request
Incoming parameter description
Sample input
Return data field description
Sample output

setNightVisionMode: Set the night vision mode of the device

setNightVisionMode: Set the night vision mode of the device

Function details

Set the night vision mode of the device.

Note: Night vision mode requires the device to have NVM capability set

Request address

https://openapi-[DataCenter].easy4ip.com/openapi/setNightVisionMode

The minimum permissions required for the sub-account token request

"Permission":"Config" "Resource":"cam:serial number:channel number"

Incoming parameter description

Parameter nameParameter typeRequired or notDefault valueLegal valueParameter description
tokenStringYesAdministrator or sub-account accessToken
deviceIdStringYesDevice serial number
channelIdStringYesChannel ID
modeStringYesNight vision mode, you need to use the getNightVisionMode protocol to query the night vision mode supported by the device before setting it

Sample input

{
    "id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af",
    "system":{
        "ver":"1.0",
        "appId":"lcdxxxxxxxxx",
        "sign":"74bc756ebd53e9eef2836f8cf1730c10",
        "time":1599031074,
        "nonce":"8ec8a7bd1d1c95420de20d92422d457d"
    },
    "params":{
        "token":"At_00006acr3456d12312d3grf60147de7ec",
        "deviceId":"TESTQWERXXXX",
        "channelId":"0",
        "mode":"LowLight"
    }
}

Return data field description

No data return field

Sample output

{
  "result":{
    "msg":"The operation was successful.",
    "code":"0"
  },
  "id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af"
}
setZoomFocus: Set the optical zoom factor of the device
getNightVisionMode: Get device night vision mode configuration