Device Information
You can perform the following operations to pending devices.
You can perform the following operations to rejected devices.
You can perform the following operations to appoved devices for remote management.
- To move a device to a specified group
- To upgrade, reboot, or delete a device.
- To access to WebGUI of a device, for detailed configurations.
Global Configurations for Device Connection
| Parameter | Description | |
|---|---|---|
| input | Global default configurations for input devices. | |
| protocol | Default protocol, refer to Protocol Type Definition. | |
| latency | Available when the protocol is srt, used to configure the delay of srt. | |
| stream-index | Selection of mainstream or substream. | |
| output | Global default configurations for output devices. | |
| protocol | Default protocol, refer to Protocol Type Definition. | |
| latency | Available when the protocol is srt, used to configure the delay of srt. | |
| buffer-ms | Device buffer time, in milliseconds. |
Device
| Parameter | Description |
|---|---|
| id | Global unique ID. |
| name | Device name. |
| apply-date | Registered/approved time. |
| catalog-id | Device Group ID |
| config | Device configuration information. If not exist, represents the global configuration is used. Refer to the device connection configuration |
| dev-warns | If the value is greater than 0, it indicates an abnormal device. Refer to Device Warning Status Mask. |
| dir | Device Node Stream Direction |
| firmware-ver | Firmware version |
| group-mask | The visible user group mask set, when selecting all visible, sets the value to 0xFFFFFFFF (4294967295). |
| hardware-ver | Hardware version |
| is-favorite | the user's ID of Favourites list, whether the device is added to Favourites by the current user, and use the value and user ID for binary AND operation. |
| is-inherit | Whether to inherit the visibility configuration, value, if not 0, indicating that the group and user mask configurations are inherited values. |
| module | Product Family Index |
| module-name | Device model name, which can be found in the product model list via the product-id field, refer to Product model name. |
| online-date | Device online time. Greater than 0: device online, less than or equal to 0: device offline. |
| owner-i | As the input, the array type stores the names of the associated channels, which are not fixed fields. |
| owner-o | String type, holds the name of the owning channel, non-fixed field |
| preview_id | Preview image ID, only exists on devices that support previews |
| pro-feature | Specific information for different types of devices, data structure varies based on the module |
| product-id | Device model ID, see Product Model Index |
| reg-state | Registration status, see Registration Status |
| sn | Serial number |
| status | Device Status Information |
| type | Node Type |
| usr-mask | The set of visible user group masks. |
| warns | The value greater than 0 indicates a problem with the device on ControlHub. Please refer to the section "Device Exception Definition on ControlHub Platform" for more details. |
Device Warning Definition on ControlHub
MH_DEV_WARN_UNSUPPORTED_VER = 0x01, // Unsupported device firmware version.
MH_DEV_WARN_VER_TOO_LOW = 0x02, // Device version is too old.
Config
| Parameter | Description |
|---|---|
| input | As a configuration for input, if it does not exist, it adopts the global configuration, refer to Input Device Connection Configuration. |
| output | As a configuration for output, if it does not exist, it adopts the global configuration, refer to Output Device Connection Configuration. |
status
| Parameter | Description |
|---|---|
| name | Device Name |
| cur-status | Device Status Mask, different devices have different processing, the definition of the value needs to refer to the interface document of the device. |
| eth | If exists, it indicates the Ethernet IP |
| firmware-ver | Firmware version. |
| hardware-ver | Hardware version |
| is-online | Boolean type, whether online. |
| module-name | Product model name. |
| rndis | If exists, it indicates the USB RNDIS IP. |
| up-time | Power-on time of the device, unit: seconds. |
| wifi | If exists, it indicates the WI-FI IP. |
| upgrade-status | Device Upgrade Status |
Device Upgrade Status
| Parameter | Description |
|---|---|
| step | Current stage, refer to Device Upgrade Step |
| percent | Progress of the current stage |
| ret | If failed, you can get the error code here |
Device Upgrade Process
| Parameter | Description |
|---|---|
| -1 | Failed |
| 0 | No upgrade task |
| 1 | Waiting for upgrade |
| 2 | Uploading file |
| 3 | Installing |
| 4 | Restarting |
Device Information
UltraStream
| Parameter | Description |
|---|---|
| input | Input Signal 1920x1080p, 60.00 Hz |
| rec-sec | Recording Time (ms) |
| live-sec | Live Time (ms) |
| usb-option | 0: not enabled; i.e., USB recording is off |
| usb-status | USB status |
| usb-used | Used size |
| usb-total | Total size |
| sd-status | SD status |
| sd-used | Used size |
| sd-total | Total size |
UltraEncoder
| Parameter | Description |
|---|---|
| input | Input signal |
ProConvertEncoder
| Parameter | Description |
|---|---|
| input | Input signal, for example: 1920x1080p, 60.00 Hz |
| output | Output signal. Product 0x405 and 0x406 have no output. |
| ndi-enabled | NDI® enable status |
| ndi-video-width | Video width |
| ndi-video-height | Video height |
| ndi-video-scan | Video scanning mode |
| ndi-video-field-rate | Video field frequency |
| ndi-audio-channels | Number of audio channels |
| ndi-audio-sample-rate | Audio sampling Rate |
| ndi-audio-bit-count | Audio bit rates, including 16, 20, 24, etc. |
ProConvertDecoder
| Parameter | Description |
|---|---|
| ndi-name | Signal source |
| ndi-connected | true: connected; false: disconnected |
| ndi-video-width | Video width |
| ndi-video-height | Video height |
| ndi-video-scan | Video scanning mode |
| ndi-video-field-rate | Video field frequency |
| ndi-audio-channels | Number of audio channels |
| ndi-audio-sample-rate | Audio sampling rate |
| ndi-audio-bit-count | Audio bit rates, including 16, 20, 24, etc. |