get-info

Use the interface to obtain device information, including product and manufacture information, MAC address of the network card, and the ranges of video and audio settings.

HTTP Request

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

Response Body

JSON structure is as follows:

{
  "result": 0,                 // returned Status
  "mac-addr": {},              // MAC address
  "snapshot": "",              // snapshot saved path 
  "product": {},               // product information
  "nosignal": {},              // resolution and file size ranges of no signal image 
  "audio-range": {             // the ranges of audio parameters
    "hdmi": {},
    "mic": {},
    "phone": {}
  },
  "codec-cap": {               // the ranges of encoding parameters
    "resolutions": [],
    "durations": [],
    "profile": [],
    "hevc-profile": [],
    "video-kbps": [],
    "audio-kbps": [],
    "gop-sec": [],
    "video-range": [],
    "stat-sec": [],
    "video-codec": []
  },
  "rec-control": {},            // the ranges of recording parameters
  "color-range": {              // the ranges of color adjustments
    "contrast": {},
    "brightness": {},
    "saturation": {},
    "hue": {}    
  },             
  "video-format": {             // the ranges of video formats
    "input-color-fmt": {},
    "output-color-fmt": {},
    "quant-range": {},
    "sat-range": {}    
  }, 
  "send-file": {                // the ranges of upload servers
    "server": {},
    "ftp-proto": {},
    "ftp-encryption": {},
    "ftp-transfer-mode": {}
  }       
}

Request Body

{
  "result": 0,
  "mac-addr": {
    "eth": "70:b3:d5:75:d5:fc",
    "wifi": "70:b3:d5:75:d5:fd",
    "blue": "70:b3:d5:75:d5:fe"
  },
  "snapshot": "/tmp/sbox-snapshot/sbox-quarter.jpg",
  "product": {
    "sn": "C301181214002",
    "product-id": 769,
    "hardware-ver": "C",
    "firmware-id": 0,
    "firmware-ver-s": "1.2.122",
    "factory-firmware-ver-s": "1.2.115",
    "product-name": "Ultra Stream",
    "module-name": "Ultra Stream HDMI",
    "manu-name": "MAGEWELL",
    "features": 1,
    "max-lock-count": 2
  },
  "nosignal": {
    "max-count": 4,
    "max-width": 1920,
    "max-height": 1080,
    "max-size-kb": 512
  },
  "audio-range": {
    "hdmi": {
      "max": 6.00,
      "min": -100.00,
      "def": 0.00
    },
    "mic": {
      "max": 55.25,
      "min": -12.00,
      "def": 0.00
    },
    "phone": {
      "max": 6.00,
      "min": -57.00,
      "def": 0.00
    }
  },
  "codec-cap": {
    "resolutions": [
      {
        "w": 480,
        "h": 360
      },
      {
        "w": 640,
        "h": 360
      },
      {
        "w": 640,
        "h": 480
      },
      {
        "w": 720,
        "h": 480
      },
      {
        "w": 720,
        "h": 576
      },
      {
        "w": 768,
        "h": 576
      },
      {
        "w": 800,
        "h": 600
      },
      {
        "w": 960,
        "h": 540
      },
      {
        "w": 1024,
        "h": 768
      },
      {
        "w": 1280,
        "h": 720
      },
      {
        "w": 1280,
        "h": 800
      },
      {
        "w": 1280,
        "h": 960
      },
      {
        "w": 1280,
        "h": 1024
      },
      {
        "w": 1440,
        "h": 900
      },
      {
        "w": 1440,
        "h": 1080
      },
      {
        "w": 1600,
        "h": 1200
      },
      {
        "w": 1920,
        "h": 1080
      }
    ],
    "durations": [
      {
        "name": "15 FPS",
        "value": 666667
      },
      {
        "name": "24 FPS",
        "value": 416667
      },
      {
        "name": "25 FPS",
        "value": 400000
      },
      {
        "name": "29.97 FPS",
        "value": 333667
      },
      {
        "name": "30 FPS",
        "value": 333333
      },
      {
        "name": "50 FPS",
        "value": 200000
      },
      {
        "name": "59.94 FPS",
        "value": 166833
      },
      {
        "name": "60 FPS",
        "value": 166667
      }
    ],
    "profile": [
      {
        "name": "Baseline",
        "value": 0
      },
      {
        "name": "Main profile",
        "value": 1
      },
      {
        "name": "High profile",
        "value": 2
      }
    ],
    "hevc-profile": [
      {
        "name": "Main profile",
        "value": 0
      }
    ],
    "video-kbps": [
      {
        "name": "256 Kbps",
        "value": 256
      },
      {
        "name": "512 Kbps",
        "value": 512
      },
      {
        "name": "768 Kbps",
        "value": 768
      },
      {
        "name": "1 Mbps",
        "value": 1024
      },
      {
        "name": "1.5 Mbps",
        "value": 1536
      },
      {
        "name": "2 Mbps",
        "value": 2048
      },
      {
        "name": "3 Mbps",
        "value": 3072
      },
      {
        "name": "4 Mbps",
        "value": 4096
      },
      {
        "name": "8 Mbps",
        "value": 8192
      }
    ],
    "audio-kbps": [
      {
        "name": " 16 Kbps",
        "value": 16
      },
      {
        "name": " 32 Kbps",
        "value": 32
      },
      {
        "name": " 48 Kbps",
        "value": 48
      },
      {
        "name": " 64 Kbps",
        "value": 64
      },
      {
        "name": " 96 Kbps",
        "value": 96
      },
      {
        "name": "128 Kbps",
        "value": 128
      }
    ],
    "gop-sec": [
      {
        "name": " 1 sec",
        "value": 1
      },
      {
        "name": " 2 sec",
        "value": 2
      },
      {
        "name": " 5 sec",
        "value": 5
      },
      {
        "name": "10 sec",
        "value": 10
      },
      {
        "name": "30 sec",
        "value": 30
      },
      {
        "name": "60 sec",
        "value": 60
      }
    ],
    "video-range": [
      {
        "name": "Full range (0-255)",
        "value": 1
      },
      {
        "name": "Limited range (16-235)",
        "value": 0
      }
    ],
    "stat-sec": [
      {
        "name": " 1 sec",
        "value": 1
      },
      {
        "name": " 5 sec",
        "value": 5
      },
      {
        "name": "10 sec",
        "value": 10
      },
      {
        "name": "30 sec",
        "value": 30
      },
      {
        "name": "60 sec",
        "value": 60
      }
    ],
    "video-codec": [
      {
        "name": "H.264",
        "value": 0
      },
      {
        "name": "HEVC",
        "value": 1
      }
    ]
  },
    "rec-control": {
    "usb-option": [
      {
        "name": "Don't record",
        "value": 0
      },
      {
        "name": "Ordinary recording",
        "value": 1
      }
    ],
    "sd-option": [
      {
        "name": "Don't record",
        "value": 0
      },
      {
        "name": "Ordinary recording",
        "value": 1
      },
      {
        "name": "Loop recording",
        "value": 2
      }
    ],
    "time-unit": [
      {
        "name": "5 minutes",
        "value": 5
      },
      {
        "name": "10 minutes",
        "value": 10
      },
      {
        "name": "30 minutes",
        "value": 30
      },
      {
        "name": "40 minutes",
        "value": 40
      },
      {
        "name": "50 minutes",
        "value": 50
      },
      {
        "name": "60 minutes",
        "value": 60
      },
      {
        "name": "90 minutes",
        "value": 90
      },
      {
        "name": "120 minutes",
        "value": 120
      }
    ],
    "file-ext": [
      {
        "name": "mp4",
        "value": 0
      },
      {
        "name": "mov",
        "value": 1
      }
    ]
  }, 
  "color-range": {
    "contrast": {
      "max": 200,
      "min": 50,
      "def": 100
    },
    "brightness": {
      "max": 100,
      "min": -100,
      "def": 0
    },
    "saturation": {
      "max": 200,
      "min": 0,
      "def": 100
    },
    "hue": {
      "max": 90,
      "min": -90,
      "def": 0
    }
  },
  "video-format": {
    "input-color-fmt": [
      {
        "name": "RGB",
        "value": 1
      },
      {
        "name": "YUV BT.601",
        "value": 2
      },
      {
        "name": "YUV BT.709",
        "value": 3
      },
      {
        "name": "YUV BT.2020",
        "value": 4
      }
    ],
    "output-color-fmt": [
      {
        "name": "YUV BT.601",
        "value": 2
      },
      {
        "name": "YUV BT.709",
        "value": 3
      }
    ],
    "quant-range": [
      {
        "name": "Full range (0-255)",
        "value": 1
      },
      {
        "name": "Limited range (16-235)",
        "value": 2
      }
    ],
    "sat-range": [
      {
        "name": "Full range (0-255)",
        "value": 1
      },
      {
        "name": "Limited range (16-235)",
        "value": 2
      },
      {
        "name": "Extended GAMUT range (1-254)",
        "value": 3
      }
    ]
  },
  "send-file": {
    "server": [
      {
        "name": "FTP Server",
        "value": 0
      },
      {
        "name": "Google Drive",
        "value": 1
      },
      {
        "name": "Dropbox",
        "value": 2
      }
    ],
    "ftp-proto": [
      {
        "name": "FTP - File Transfer Protocol",
        "value": 0
      },
      {
        "name": "SFTP - SSH File Transfer Protocol",
        "value": 1
      }
    ],
    "ftp-encryption": [
      {
        "name": "Only use plain FTP (insecure)",
        "value": 0
      },
      {
        "name": "Require explicit FTP over TLS",
        "value": 1
      },
      {
        "name": "Require implicit FTP over TLS",
        "value": 2
      }
    ],
    "ftp-transfer-mode": [
      {
        "name": "Active",
        "value": 0
      },
      {
        "name": "Passive",
        "value": 1
      }
    ]
  }
}