get-info

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

HTTP Request

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

Response Body

JSON structure is as follows:

{
  "result": 0,                 // returned status
  "mac-addr": {},              // MAC address
  "snapshot": "",              // snapshot location of the input 
  "main-snapshot": "",   // snapshot location of the main stream
  "main-crop-snapshot": "",    //crop thumbnails location of the main stream cropped
  "sub-snapshot": "",       // snapshot location of the sub stream 
  "sub-crop-snapshot": "",     // crop thumbnails location of the sub stream 
  "product": {},               // product information
  "nosignal": {},              // resolutions and size of no-signal image 
  "input-source": {},           // parameter values of input and video mixer
  "audio-range": {             // range of audio parameters
    "hdmi": {},
    "linein": {},
    "lineout": {}
  },
  "codec-cap": {               // encoding parameters
    "main-stream": {},         // encoding parameters of the main stream
    "sub-stream": {},          // encoding parameters of the sub stream
    "ndi-sub-stream": {},      // reserved
    "ndi-hx3-main-stream": {}, // parameter ranges of main stream of NDI|HX3 protocol
    "ndi-hx3-duration": {},    // frame rate range of main stream of NDI|HX3 protocol
    "resolutions": [],
    "durations": [],
    "profile": [],
    "hevc-profile": [],
    "video-kbps": [],
    "audio-streams": [],        // range of audio streams
    "audio-channels": [],        // range of audio channels
    "audio-chmap": [],            // range of audio channel mapping relationships
    "audio-kbps": [],
    "gop-sec": [],
    "video-range": [],
    "stat-sec": [],
    "video-codec": [],
    "video-ar-convert-mode": [],
    "video-rotation": [],
    "rc": {}
  },
  "rec": {
    "mode": [],                    //values of record mode 
    "file-prefix": [],            // values of file prefix
    "file-suffix": [],            // values of fils suffix
    "time-unit": [],            
    "trigger-mode": []         // values of auto-upload mode
  },
  "nas": {
    "proto": []                    // values of NAS protocol
  },
  "color-range": {            //values of color adjustment and correction 
    "contrast": {},
    "brightness": {},
    "saturation": {},
    "hue": {}
  }            
"video-format": {             // values of video input and output 
    "input-color-fmt": [],
    "output-color-fmt": [],
    "quant-range": [],
    "sat-range": []
  }
  "living": {               // values of live stream 
    "max-bandwidth": 16384,
    "ttl": {},
    "conn-timeout": {},
    "retry-duration": {},
    "srt": {
      "latency": [],
      "bandwidth": [],
      "aes": [],
      "mtu": {}
    },
    "ndi": {},
    "udp": {},
    "hls-push": {}
  },
  "surface": {
    "image": {},
    "type":[],
    "image-type": [],
    "condition": [],
    "position": [],
    "font-family":[],
    "font-style": [],
    "font-weight": [],
    "time-format": []
  },
  "web": {
    "theme": []             // light/dֵark mode
  }, 
  "send-file": {            // file upload parameters
    "server": [],           // server parameters for file upload
    "ftp-proto": {},
    "ftp-encryption": {},
    "ftp-transfer-mode": {}
  },
  "lcd": {
    "page": []              // LCD display           
  }
}

Example

{
  "result": 0,
  "mac-addr": {
    "eth": "d0:c8:57:81:02:2d",
    "wifi": "d0:c8:57:81:02:2e",
    "softap": "d0:c8:57:81:02:2f"
  },
  "snapshot": "/tmp/sbox-snapshot/sbox-quarter.jpg",
  "main-snapshot": "/tmp/sbox-snapshot/mainstream.jpg",
  "main-crop-snapshot": "/tmp/sbox-snapshot/crop-mainstream.jpg",
  "sub-snapshot": "/tmp/sbox-snapshot/substream.jpg",
  "sub-crop-snapshot": "/tmp/sbox-snapshot/crop-substream.jpg",
  "product": {
    "sn": "B313220727002",
    "product-id": 787,
    "hardware-ver": "B",
    "firmware-id": 1,
    "firmware-ver-s": "2.0.312",
    "factory-firmware-ver-s": "2.0.283",
    "product-name": "Ultra Encode",
    "module-name": "Ultra Encode AIO",
    "manu-name": "MAGEWELL",
    "features": 1,
    "max-lock-count": 2,
    "live-support": 4095,
    "cloud-support": 1,
    "record-support": 1,
    "scheduler-support": 1,
    "nas-support": 1,
    "multi-audio-support": 1
  },
  "nosignal": {
    "max-count": 4,
    "max-width": 1920,
    "max-height": 1080,
    "max-size-kb": 1024
  },
  "input-source": {
    "sources": [
      {
        "name": "Auto Scan",
        "value": 3
      },
      {
        "name": "SDI Input",
        "value": 1
      },
      {
        "name": "HDMI Input",
        "value": 2
      },
      {
        "name": "Mixer",
        "value": 4
      }
    ],
    "video-mixer": {
      "types": [
        {
          "name": "Picture in Picture",
          "value": 0
        },
        {
          "name": "Side by Side",
          "value": 1
        }
      ],
      "pip": [
        {
          "name": "Left Top Corner",
          "value": 1
        },
        {
          "name": "Top Right Corner",
          "value": 2
        },
        {
          "name": "Left Bottom Corner",
          "value": 3
        },
        {
          "name": "Bottom Right Corner",
          "value": 4
        }
      ],
      "sbs": [
        {
          "name": "Half",
          "value": 1
        },
        {
          "name": "One Third",
          "value": 2
        },
        {
          "name": "Two Thirds",
          "value": 3
        },
        {
          "name": "One Fourth",
          "value": 4
        },
        {
          "name": "Three Fourths",
          "value": 5
        }
      ]
    }
  },
  "audio-range": {
    "spi": {
    "max": 600,
    "min": -10000,
    "def": 0
    },
    "linein": {
      "max": 5525,
      "min": -13900,
      "def": 0
    },
    "lineout": {
      "max": 600,
      "min": -5700,
      "def": 0
    }
  },
  "codec-cap": {
    "main-stream": {
      "max-video-kbps": 32768,
      "min-video-kbps-ratio": 5,
      "max-video-kbps-ratio": 100,
      "def-video-kbps-ratio": 20,
      "min-duration": 166667,
      "max-duration": 2000000,
      "min-gop-size": 15,
      "max-gop-size": 300
    },
    "sub-stream": {
      "max-width": 1920,
      "max-height": 1200,
      "max-duration": 2000000,
      "min-duration": 166667,
      "max-video-kbps": 32768,
      "reserved": [
        {
        "w": 1920,
        "h": 1200
        }
      ]
    },
    "ndi-sub-stream": {
      "max-width": 1920,
      "max-height": 1200,
      "max-duration": 2000000,
      "min-duration": 166667,
      "max-video-kbps": 32768
    },
    "ndi-hx3-main-stream": {
      "max-width": 1920,
      "max-height": 1200,
      "max-duration": 2000000,
      "min-duration": 166667,
      "max-video-kbps": 63488,
      "min-video-kbps-ratio": 10,
      "max-video-kbps-ratio": 156,
      "def-video-kbps-ratio": 155,
      "hevc-min-video-kbps-ratio": 10,
      "hevc-max-video-kbps-ratio": 126,
      "hevc-def-video-kbps-ratio": 125,
      "min-gop-size": 2,
      "max-gop-size": 120,
      "reserved": [
        {
        "w": 1920,
        "h": 1200
        }
      ]
    },
    "ndi-hx3-durations": [
      {
        "name": "25 FPS",
        "value": 400000
      },
      {
        "name": "30 FPS",
        "value": 333333
      },
      {
        "name": "50 FPS",
        "value": 200000
      },
      {
        "name": "60 FPS",
        "value": 166667
      },
      {
        "name": "Follow Input",
        "value": 0
      }
    ],
    "resolutions": [
      {
        "w": 480,
        "h": 270
      },
      {
        "w": 480,
        "h": 360
      },
      {
        "w": 640,
        "h": 360
      },
      {
        "w": 640,
        "h": 480
      },
      {
        "w": 720,
        "h": 480
      },
      {
        "w": 720,
        "h": 540
      },
      {
        "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": 900
      },
      {
        "w": 1600,
        "h": 1200
      },
      {
        "w": 1664,
        "h": 936
      },
      {
        "w": 1920,
        "h": 1080
      },
      {
        "w": 1920,
        "h": 1200
      },
      {
        "w": 2048,
        "h": 1080
      },
      {
        "w": 3840,
        "h": 2160
      },
      {
        "w": 4096,
        "h": 2160
      }
    ],
    "durations": [
      {
        "name": "5 FPS",
        "value": 2000000
      },
      {
        "name": "10 FPS",
        "value": 1000000
      },
      {
        "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
      },
      {
        "name": "Follow Input",
        "value": 0
      }
    ],
    "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": "5 Mbps",
        "value": 5120
      },
      {
        "name": "6 Mbps",
        "value": 6144
      },
      {
        "name": "8 Mbps",
        "value": 8192
      },
      {
        "name": "10 Mbps",
        "value": 10240
      },
      {
        "name": "12 Mbps",
        "value": 12288
      },
      {
        "name": "16 Mbps",
        "value": 16384
      },
      {
        "name": "20 Mbps",
        "value": 20480
      },
      {
        "name": "24 Mbps",
        "value": 24576
      },
      {
        "name": "25 Mbps",
        "value": 25600
      },
      {
        "name": "26 Mbps",
        "value": 26624
      },
      {
        "name": "31 Mbps",
        "value": 31744
      },
      {
        "name": "32 Mbps",
        "value": 32768
      },
      {
        "name": "41 Mbps",
        "value": 41984
      },
      {
        "name": "50 Mbps",
        "value": 51200
      },
      {
        "name": "52 Mbps",
        "value": 53248
      },
      {
        "name": "62 Mbps",
        "value": 63488
      }
    ],
    "audio-streams": [
      {
        "name": "Audio stream 1",
        "value": 0
      },
      {
        "name": "Audio stream 2",
        "value": 1
      },
      {
        "name": "Audio stream 3",
        "value": 2
      },
      {
        "name": "Audio stream 4",
        "value": 3
      }
    ],
    "audio-channels": [
      {
        "name": "Follow Input",
        "value": 0
      },
      {
        "name": "2 Channels",
        "value": 2
      },
      {
        "name": "4 Channels",
        "value": 4
      },
      {
        "name": "6 Channels",
        "value": 6
      },
      {
        "name": "8 Channels",
        "value": 8
      }
    ],
    "audio-chmap": [
      {
        "name": "Source channels 1/2",
        "value": 0
      },
      {
        "name": "Source channels 3/4",
        "value": 1
      },
      {
        "name": "Source channels 5/6",
        "value": 2
      },
      {
        "name": "Source channels 7/8",
        "value": 3
      }
    ],
    "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
      },
      {
        "name": "192 Kbps",
        "value": 192
      },
      {
        "name": "256 Kbps",
        "value": 256
      }
    ],
    "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": "H.265 (HEVC)",
        "value": 1
      }
    ],
    "video-ar-convert-mode": [
      {
        "name": "Ignore",
        "value": 0
      },
      {
        "name": "Cropping",
        "value": 1
      },
      {
        "name": "Padding",
        "value": 2
      }
    ],
    "video-rotation": [
      {
        "name": "Off",
        "value": 0
      },
      {
        "name": "90",
        "value": 1
      },
      {
        "name": "180",
        "value": 2
      },
      {
        "name": "270",
        "value": 3
      }
    ],
    "rc": {
      "mim-qp": 0,
      "max-qp": 51,
      "def-h264-min-qp": 10,
      "def-h264-max-qp": 48,
      "def-hevc-min-qp": 12,
      "def-hevc-max-qp": 51
    }
  },
  "rec": {
    "mode": [
      {
        "name": "Ordinary recording",
        "value": 0
      },
      {
        "name": "Loop recording",
        "value": 1
      }
    ],
    "file-prefix": [
      {
        "name": "Custom prefix",
        "value": 0
      },
      {
        "name": "Creation time",
        "value": 1
      }
    ],
    "file-suffix": [
      {
        "name": "mp4",
        "value": 0
      },
      {
        "name": "mov",
        "value": 1
      }
    ],
    "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
      }
    ],
    "trigger-mode": [
      {
        "name": "Signal locked",
        "value": 0
      },
      {
        "name": "USB drive detected",
        "value": 1
      }
    ]
  },
  "nas": {
    "proto": [
      {
        "name": "NFS - Network File System",
        "value": 0
      },
      {
        "name": "CIFS - Common Internet File System",
        "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
      }
    ]
  },
  "living": {
    "max-bandwidth": 16384,
    "ttl": {
      "max": 255,
      "min": 0,
      "def": 0
    },
    "conn-timeout": {
      "max": 30000,
      "min": 1000
    },
    "retry-duration": {
      "max": 10000,
      "min": 0
    },
    "rtmp": {
      "def-conn-timeout": 10000,
      "def-retry-duration": 10000
    },
    "srt": {
      "def-conn-timeout": 3000,
      "def-retry-duration": 10000,
      "latency": {
        "max": 8000,
        "min": 30,
        "def": 120
      },
      "bandwidth": {
        "max": 100,
        "min": 5,
        "def": 25
      },
      "aes": [
        {
          "name": "Not Used",
          "value": 0
        },
        {
          "name": "AES-128",
          "value": 16
        },
        {
          "name": "AES-192",
          "value": 24
        },
        {
          "name": "AES-256",
          "value": 32
        }
      ],
      "mtu": {
        "max": 1500,
        "min": 232,
        "def": 1496
      }
    },
    "ndi": {
      "transport-mode": [
        {
          "name": "UDP (Unicast)",
          "value": 0
        },
        {
          "name": "UDP (Multicast)",
          "value": 1
        },
        {
          "name": "RUDP (Unicast)",
          "value": 2
        },
        {
          "name": "TCP (Uni-Connection)",
          "value": 3
        },
        {
          "name": "TCP (Multi-Connection)",
          "value": 4
        }
      ]
    },
    "udp": {
      "mtu": {
        "max": 1500,
        "min": 228,
        "def": 1496
      }
    },
    "hls-push": {
      "seg-count": {
        "max": 5,
        "min": 1,
        "def": 3
      },
      "seg-duration": {
        "max": 4,
        "min": 1,
        "def": 3
      }
    }
  },
  "surface": {
    "image": {
    "max-count": 8,
    "max-width": 1920,
    "max-height": 1080,
    "max-size-kb": 512
    },
    "type": [
      {
        "name": "Text",
        "value": 0
      },
      {
        "name": "System Time",
        "value": 1
      },
      {
        "name": "Image",
        "value": 2
      }
    ],
    "image-type": [
      {
        "name": "JPEG",
        "value": 0
      },
      {
        "name": "PNG",
        "value": 1
      }
    ],
    "condition": [
      {
        "name": "Always",
        "value": 0
      }
    ],
    "position": [
      {
        "name": "Custom",
        "value": 0
      },
      {
        "name": "Left Top Corner",
        "value": 1
      },
      {
        "name": "Top Right Corner",
        "value": 2
      },
      {
        "name": "Top Center",
        "value": 5
      },
      {
        "name": "Left Bottom Corner",
        "value": 3
      },
      {
        "name": "Bottom Right Corner",
        "value": 4
      },
      {
        "name": "Bottom Center",
        "value": 6
      },
      {
        "name": "Center",
        "value": 7
      }
    ],
    "font-family": [
      {
        "name": "Source Han Sans",
        "value": 0
      },
      {
        "name": "Lato",
        "value": 1
      }
    ],
    "font-style": [
      {
        "name": "Normal",
        "value": 0
      },
      {
        "name": "Italic",
        "value": 1
      },
      {
        "name": "Oblique",
        "value": 2
      }
    ],
    "font-weight": [
      {
        "name": "Normal",
        "value": 0
      },
      {
        "name": "Bold",
        "value": 1
      }
    ],
    "time-format": [
      {
        "name": "YYYY-MM-DD hh:mm:ss",
        "value": 0
      },
      {
        "name": "MM/DD/YYYY hh:mm:ss",
        "value": 1
      },
      {
        "name": "DD/MM/YYYY hh:mm:ss",
        "value": 2
      },
      {
        "name": "YYYY-MM-DD",
        "value": 3
      },
      {
        "name": "MM/DD/YYYY",
        "value": 4
      },
      {
        "name": "DD/MM/YYYY",
        "value": 5
      },
      {
        "name": "hh:mm:ss",
        "value": 6
      },
      {
        "name": "hh:mm",
        "value": 7
      }
    ]
  },
  "web": {
    "theme": [
      {
        "name": "Light",
        "value": 0
      },
      {
        "name": "Dark",
        "value": 1
      }
    ]
  },
  "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
      }
    ]
  },
  "lcd": {
    "page": [
      {
        "name": "Preview",
        "value": 0
      },
      {
        "name": "Live",
        "value": 1
      },
      {
        "name": "Record",
        "value": 2
      },
      {
        "name": "QR Code",
        "value": 3
      }
    ]
  }
}

results matching ""

    No results matching ""

    results matching ""

      No results matching ""