get-settings

Use this interface to obtain the device settings.

HTTP Request

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

Response Body

JSON structure is as follows:

{
  "result": 0,                       // returned status
  "name": "Ultra...",                // device name
  "is-check-update": 1,              // enable status of auto-check online update
  "audio-sync-offset": 0,            // audio offset in ms
  "udp-mtu": 1496,                   // UDP MTU
  "enable-ndi-hx3": 0,               // NDI|HX3 enable status 
  "softap": {},                      // AP settings
  "date-time": {},                   // value of date and time 
  "input-source": {},                // input source value
  "video-color": {},                 // video information
  "volume": {},                      // audio information                       
  "enable-deinterlace": 1,           // deinterlace enable status     
  "main-stream": {},                 // main stream settings
  "sub-stream": {},                  // sub stream settings
  "audio": {},                       // audio settings
  "audio-streams": [...],            // ÒôƵÂëÁ÷Áбí
  "eth": {},                         // Ethernet information
  "wifi": {},                        // Wi-Fi information
  "rndis": {},                       // USB NET information
  "stream-server": [...],            // streaming server 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": [...]            // no signal images list
  "nas": [...]                       // NAS list
  "send-file-cloud": [...],          // Upload server list
  "web": {},                         // Web security management and theme configuration information
  "rec": {},                         // record settings 
  "living": {},                      // live settings 
  "lcd-control": {}                  // LCD screen settings          
}

Example

{
  "result": 0,
  "name": "Ultra Encode B313220727002",
  "is-check-update": 1,
  "living-kbps": 32768,
  "audio-sync-offset": 0,
  "enable-advanced-pcr": 0,
  "udp-mtu": 1496,
  "enable-ndi-hx3": 0,
  "softap": {
    "is-softap": 1,
    "is-visible": 1,
    "softap-ssid": "B313220727002",
    "softap-passwd": "20727002"
  },
  "date-time": {
    "timezone": "Asia/Shanghai",
    "is-auto": 1,
    "ntp-server": "0.pool.ntp.org",
    "ntp-server-backup": "1.pool.ntp.org"
  },
  "input-source": {
    "source": 1,
    "mixer": {
    "input-device": 2,
    "is-hdmi-top": 0,
    "type": 0,
    "location": 2
  }
  },
  "video-color": {
    "hdmi": {
    "contrast": 100,
    "brightness": 0,
    "saturation": 100,
    "hue": 0
  },
  "sdi": {
    "contrast": 100,
    "brightness": 0,
    "saturation": 100,
    "hue": 0
  }
  },
  "volume": {
    "is-spi": 1,
    "spi-gain": 0,
    "is-linein": 1,
    "linein-gain": 127,
    "is-lineout": 1,
    "lineout-gain": 0,
    "enable-mic-bias": 0
  },
  "enable-deinterlace": 1,
  "main-stream": {
    "is-auto": 0,
    "codec": 1,
    "cx": 1920,
    "cy": 1080,
    "duration": 0,
    "kbps": 8192,
    "gop": 60,
    "fourcc": 0,
    "profile": 0,
    "cbrstat": 60,
    "fullrange": 0,
    "is-vbr": 0,
    "min-vbr-qp": 0,
    "max-vbr-qp": 0,
    "is-time-code-sei": 1,
    "is-closed-caption-sei": 0,
    "ar-convert-mode": 2,
    "rotation": 0,
    "mirroring": 0
  },
  "sub-stream": {
    "enable": 1,
    "codec": 1,
    "cx": 1920,
    "cy": 1080,
    "duration": 333333,
    "kbps": 4096,
    "gop": 60,
    "fourcc": 0,
    "profile": 0,
    "cbrstat": 60,
    "fullrange": 0,
    "is-vbr": 0,
    "min-vbr-qp": 0,
    "max-vbr-qp": 0,
    "is-time-code-sei": 1,
    "is-closed-caption-sei": 0,
    "ar-convert-mode": 2,
    "rotation": 0,
    "mirroring": 0
  },
  "audio": {
  "sample-rate": 48000,
    "channels": 0,
    "kbps": 256,
    "ch0": 0,
    "ch1": 1,
    "ch2": 1,
    "ch3": 3
  },
  "audio-streams": [
    {
     "sample-rate": 48000,
      "channels": 0,
      "kbps": 256,
      "ch0": 0,
      "ch1": 1,
      "ch2": 1,
      "ch3": 3
    },
    {
      "sample-rate": 48000,
      "channels": 2,
      "kbps": 32,
      "ch0": 2,
      "ch1": 1,
      "ch2": 2,
      "ch3": 3
    },
    {
      "sample-rate": 48000,
      "channels": 2,
      "kbps": 128,
      "ch0": 3,
      "ch1": 1,
      "ch2": 2,
      "ch3": 3
    },
    {
      "sample-rate": 48000,
      "channels": 2,
      "kbps": 192,
      "ch0": 3,
      "ch1": 1,
      "ch2": 2,
      "ch3": 3
    }
  ],
  "eth": {
    "is-dhcp": 1,
    "ip": "",
    "mask": "",
    "router": "",
    "dns": ""
  },
  "wifi": {
    "is-dhcp": 1,
    "ip": "",
    "mask": "",
    "router": "",
    "dns": ""
  },
  "rndis": {
    "ip": "192.168.66.1",
    "mask": "255.255.255.0"
  },
  "stream-server": [
    {
      "id": 0,
      "type": 130,
      "name": "NDI HX",
      "is-use": 0,
      "source-name": "#serial-no#",
      "group-name": "public",
      "enable-discovery": 0,
      "discovery-server": "",
      "transport-mode": 3,
      "mcast-addr": "",
      "mcast-mask": "",
      "mcast-ttl": 0,
      "enable-fail-over": 0,
      "fail-over-ndi-name": "",
      "fail-over-ip-addr": "",
      "enable-web-control": 0,
      "enable-ptz-control": 0,
      "main-stream": 0,
      "prvw-stream": 1,
      "audio": 2,
      "opt": 0,
      "is-media-hub": 0
    }
  ],
  "video-input-format": {
    "hdmi": {
    "is-color-fmt": 0,
    "color-fmt": 1,
    "is-quant-range": 0,
    "quant-range": 1
  },
  "sdi": {
    "is-color-fmt": 0,
    "color-fmt": 1,
    "is-quant-range": 0,
    "quant-range": 1
  }
  },
  "video-output-format": {
    "hdmi": {
    "is-color-fmt": 0,
    "color-fmt": 3,
    "is-quant-range": 0,
    "quant-range": 2,
    "is-sat-range": 0,
    "sat-range": 2
    },
    "sdi": {
      "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
    },
    {
      "id": 2,
      "is-use": 0,
      "is-edit": 1,
      "file-path": "/no-signal/default2.jpg",
      "time": 16687566986732126
    }
  ],
  "nas": [
    {
      "id": 0,
      "type": 2,
      "proto": 0,
      "is-use": 1,
      "addr": "10.10.14.193",
      "mount": "/home/magewell/nfs"
    }
  ], 
  "send-file-cloud": [
  ],
  "web": {
    "is-http": 1,
    "http-port": 80,
    "is-https": 0,
    "https-port": 443,
    "is-cert-valid": 0,
    "is-cert-key-valid": 0,
    "theme": 0
  },
  "rec": {
    "is-auto": 0,
    "trigger-mode": 0
  },
  "living": {
    "ts": {
      "mtu": 1497
    },
    "hls-push": {
      "seg-count": 3,
      "seg-duration": 3
    }
  },
  "lcd-control": {
    "no-touch": 0,
    "page-idx": 3,
    "no-flip": 0
  }
}