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": "",              // path of snapshot
  "product": {},               // product information
  "nosignal": {},              // resolutions and size of no-signal image 
  "audio-range": {             // audio parameters
    "hdmi": {},
    "mic": {},
    "phone": {}
  },
  "codec-cap": {               // encoding parameters
    "main-stream": {},         // encoding parameters of main stream
    "sub-stream": {},          // encoding parameters of sub stream
    "ndi-sub-stream": {},      // encoding parameters of NDI sub stream
    "resolutions": [],
    "durations": [],
    "profile": [],
    "hevc-profile": [],
    "video-kbps": [],
    "audio-kbps": [],
    "gop-sec": [],
    "video-range": [],
    "stat-sec": [],
    "video-codec": [],
    "video-ar-convert-mode": []
  },
  "color-range": {            // color parameters 
    "contrast": {},
    "brightness": {},
    "saturation": {},
    "hue": {}
  }            
"video-format": {             // video input and output parameters
    "input-color-fmt": [],
    "output-color-fmt": [],
    "quant-range": [],
    "sat-range": []
  }
  "living": {               // live stream parameters
    "max-bandwidth": 16384,
    "ttl": {},
    "conn-timeout": {},
    "retry-duration": {},
    "srt": {
      "latency": [],
      "bandwidth": [],
      "aes": [],
      "mtu": {}
    },
    "ndi": {},
    "udp": {},
  }
}

Example

{
    "result": 0,
    "mac-addr": {
        "eth": "d0:c8:57:80:3a:70",
        "wifi": "d0:c8:57:80:3a:71",
        "blue": "d0:c8:57:80:3a:72"
    },
    "snapshot": "/tmp/sbox-snapshot/sbox-quarter.jpg",
    "product": {
        "sn": "A305200908002",
        "product-id": 773,
        "hardware-ver": "A",
        "firmware-id": 1,
        "firmware-ver-s": "1.3.540",
        "factory-firmware-ver-s": "1.3.275",
        "product-name": "Ultra Encode",
        "module-name": "Ultra Encode SDI",
        "manu-name": "MAGEWELL",
        "features": 1,
        "max-lock-count": 2,
        "live-support": 2047,
        "cloud-support": 1
    },
    "nosignal": {
        "max-count": 4,
        "max-width": 1920,
        "max-height": 1080,
        "max-size-kb": 512
    },
    "audio-range": {
        "spi": {
            "max": 6.00,
            "min": -100.00,
            "def": 0.00
        },
        "linein": {
            "max": 6.00,
            "min": -100.00,
            "def": -12.00
        },
        "lineout": {
            "max": 6.00,
            "min": -57.00,
            "def": 0.00
        }
    },
    "codec-cap": {
        "main-stream": {
            "max-video-kbps": 20480,
            "max-video-kbps-ratio": 125,
            "min-video-kbps-ratio": 5,
            "min-duration": 166667,
            "max-duration": 2000000
        },
        "sub-stream": {
            "max-width": 1280,
            "max-height": 768,
            "min-duration": 333333,
            "max-duration": 2000000,
            "max-video-kbps": 4096
        },
        "ndi-sub-stream": {
            "max-width": 640,
            "max-height": 480,
            "min-duration": 166667,
            "max-duration": 2000000,
            "max-video-kbps": 4096
        },
        "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": 1200
            },
            {
                "w": 1920,
                "h": 1080
            }
        ],
        "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
            }
        ],
        "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": "0.5 sec",
                "value": 128
            },
            {
                "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
            }
        ]
    },
    "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
            }
        ],
        "sdi-anc-trigger": [
            {
                "name": "None",
                "value": 0
            },
            {
                "name": "RED Epic",
                "value": 1
            },
            {
                "name": "Sony",
                "value": 2
            },
            {
                "name": "ARRI",
                "value": 3
            }
        ]
    },
    "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
            }
        }
    }
}

results matching ""

    No results matching ""

    results matching ""

      No results matching ""