get-settings

Use the interface to obtain the configurations of device.

HTTP Request

GET http://ip/usapi?method=get-settings

Response Body

JSON structure is as follows:

{
  "result": 0,                       // returned Status
  "name": "Ultra...",                // device name
  "passwd": 1,                       // whether a password is needed for mobile app
  "is-settings": 0,                  // whether modifications of device can be made using mobile app
  "is-ssdp": 1,                      // whether to enable UPNP
  "is-startup-rec": 1,               // whether to start recording when device is boot up
  "is-startup-live": 1,              // whether to start broadcasting when device is boot up
  "is-signal-lost": 0,               // whether to stop recording and broadcasting when signal is lost
  "is-hdmi-rec-ctrl": 0,             // whether to allow that digital cameral or other device can control the streamer to start/stop recording by the feeding HDMI signal.
  "is-auto-send-file": 0,            // whether to upload files in SD card automatically
  "is-check-update": 0,              // whether to check new firmware automatically
  "is-auto-rec": 0,                  // whether to start recording automatically when input signal is locked
  "is-auto-live": 0,                 // whether to lock live streaming
  "is-low-latency" 0,                // whether to use low latency during live streaming
  "enable-key-reset": 0,             // whether to use the "LIVE" key to reset all settings to default values
  "enable-key-reboot": 0,            // whether to use the "REC" key to rebooting
  "audio-sync-offset": 20,           // audio offset   
  "softap": {},                      // AP configurations
  "date-time": {},                   // time zone and date
  "rec-control": {},                 // recording configurations
  "video-color": {},                 // video information
  "volume": {},                      // audio information                       
  "rec-stream": 0,                   // type of recording streams
  "live-stream": 0,                  // type of live streams
  "mws-stream": 1,                   // type of preview stream in app client
  "main-stream": {},                 // configurations of the main stream
  "sub-stream": {},                  // configurations of the sub stream
  "audio": {},                       // configurations of audio
  "eth": {},                         // Ethernet information
  "wifi": {},                        // Wi-Fi information
  "stream-server": [...]             // streaming server list
  "send-file-cloud": [...],          // upload servers list
  "video-input-format": {},          // input video format
  "video-output-format": {},         // output video format
  "use-nosignal-file": 1,            // whether to show an image when there is no input signal
  "nosignal-files": [...]            // list of no signal images 
}

Request Body:

{
  "result": 0,
  "name": "Ultra Stream C301191111100",
  "passwd": 0,
  "is-settings": 1,
  "is-ssdp": 1,
  "is-signal-lost": 0,
  "is-hdmi-rec-ctrl": 0,
  "is-auto-send-file": 0,
  "is-auto-rec": 0,
  "is-low-latency": 0,
  "is-auto-live": 0,
  "is-check-update": 1,
  "audio-sync-offset": 0,
  "enable-key-reset": 1,
  "enable-key-reboot": 1,
  "softap": {
    "is-softap": 1,
    "is-visible": 1,
    "softap-ssid": "C301181214002",
    "softap-passwd": "81214002"
  },
  "date-time": {
    "timezone": "UTC",
    "is-auto": 1
  },
  "rec-control": {
    "mime-type": 0,
    "usb-option": 1,
    "sd-option": 1,
    "root-folder": "REC_Folder",
    "file-prefix": "VID",
    "time-unit": 5,
  },
  "video-color": {
    "contrast": 100,
    "brightness": 0,
    "saturation": 100,
    "hue": 0
  },
  "volume": {
    "is-mic": 1,
    "mic-gain": 0,
    "is-spi": 1,
    "spi-gain": 0,
    "is-phone": 1,
    "phone-gain": 0
  },
  "rec-stream": 0,
  "live-stream": 0,
  "mws-stream": 1,
  "main-stream": {
    "is-auto": 0,
    "codec": 0,
    "cx": 1920,
    "cy": 1080,
    "duration": 166667,
    "kbps": 4096,
    "gop": 1,
    "fourcc": 0,
    "profile": 2,
    "cbrstat": 60,
    "fullrange": 0
  },
  "sub-stream": {
    "cx": 1024,
    "cy": 768,
    "duration": 333333,
    "kbps": 1024,
    "gop": 1,
    "fourcc": 0,
    "profile": 2,
    "cbrstat": 60,
    "fullrange": 1
  },
  "audio": {
    "sample-rate": 48000,
    "channels": 2,
    "kbps": 128
  },
  "eth": {
    "is-dhcp": 1,
    "ip": "",
    "mask": "",
    "router": "",
    "dns": ""
  },
  "wifi": {
    "is-dhcp": 1,
    "ip": "",
    "mask": "",
    "router": "",
    "dns": ""
  },
  "stream-server": [
    {
      "id": 0,
      "type": 0,
      "url": "192.168.1.123:345/live",
      "key": "aa",
      "is-auth": 0,
      "user": "",
      "passwd": "",
      "is-use": 0,
      "token": "",
      "net-mode": 1,
      "name": "192.168.1.123"
    }
  ],
  "send-file-cloud": [
    {
      "id": 0,
      "is-use": 1,
      "type": 2,
      "account-id":  "dbid:AABnr7BK6RO5Plz5qH2508Eu95LI2-Lpcsc",
      "photo-path": "",
      "user-name": "qin qiu",
      "access-token": "",
      "refresh-token": ",
      "dir-name": "()",
      "net-mode": 2
    }
  ],
  "video-input-format": {
    "is-color-fmt": 0,
    "color-fmt": 1,
    "is-quant-range": 0,
    "quant-range": 1
  },
  "video-output-format": {
    "is-color-fmt": 0,
    "color-fmt": 3,
    "is-quant-range": 0,
    "quant-range": 2,
    "is-sat-range": 0,
    "sat-range": 2
  },
  "use-nosignal-file": 1,
  "nosignal-files": [
    {
      "id": 0,
      "is-use": 0,
      "is-edit": 0,
      "file-path": "/no-signal/default0.jpg",
      "time": 0
    },
    {
      "id": 1,
      "is-use": 1,
      "is-edit": 0,
      "file-path": "/no-signal/default1.jpg",
      "time": 0
    }
  ]
}