Public Definition

Node Type Definition

Value Description
257 Indicates this is an input device
258 Indicates that this is a custom input source (created in the input page) and that the attribute config is used to describe the source information
260 Indicates that this is a dynamically connected input source, the attribute config is used to describe the target protocol name, consistent with the node type 258
323 Indicates that this is a dynamically discovered NDI source, and the attribute config is used to describe the source information
513 Indicates that this is an output device
514 Indicates that this is a custom output object (created in the output page) and the attribute config is used to describe the destination protocol name
516 Indicates that this is a dynamically connected output object, the attribute config is used to describe the target protocol name, consistent with the node type 514
769 Reserved, indicates that this is a device which can be used as an IO device.

Device Registration Status

value Description
103 Pending
102 Rejected
101 Accepted

Protocol Type Definition

Value Protocol Type
1 RTMP
2 TS_OVER_SRT
4 TS_OVER_UDP
8 TS_OVER_RTP
16 RTSP
32 HTTP/HLS
64 NDI

Node Stream Direction

Value Protocol Type
0 Not an input or output, cannot be added to a channel, this is usually the case when a device only provides remote management
256 Can be used as the input device for a channel
512 Can be used as the output device for a channel
768 Can be used as an IO device

When the node stream direction is 256 or 768, the presence of the field preview means that the node contains a previewable image or video.

Output Configurations

RTMP output configuration
Field name Definition
url RTMP URL without key, for example: rtmp://xxx.xxx.xxx.xxx:port/live
key Push-stream key
enable-auth Enable login, optional, bool type
username Username, optional, cannot be omitted when enable-auth is true
password Password, optional, cannot be omitted when enable-auth is true
RTSP Output ConfigurationS
Field name Definition
port Bind port, optional
key Stream name
enable-auth Authentication enable status, optional, bool type
username Username, optional, cannot be omitted when enable-auth is true
password Password, optional, cannot be omitted when enable-auth is true
max-client-num Maximum number of clients, optional, default is 4
TS over SRT output configurations
Field-name Definition
mode Indicates SRT mode. Options are caller, listener.
stream-id Stream ID, optional, with max length 512 bytes
latency Latency, optional, in milliseconds, default is 125, range is from 20 to 8000.
overhead Redundancy bandwidth ratio, optional, range is from 0 to 100, default is 25
mtu MTU, optional, default is 1500, range is from 232 to 1500
encryption Encryption algorithms, optional, options are disable, aes-128, aes-192, aes-256
passphrase Keyphrase, optional, cannot be omitted if encryption is enabled, max length is 80 bytes
dst-ip Caller-specific, destination address
dst-port Caller-specific, destination port
bind-port Listener-specific, binding port
max-client-num Listener-specific, optional, maximum number of clients
TS over RTP/UDP Output Configurations
Field-name Definition
dst-ip Destination address
dst-port Destination port
transport-type Transport type, options are unicast, multicast
mtu MTU, optional, default is 1496, range is 228 to 1500

Node State Definition

Value definition
1 Being added to a channel
2 Proper functioning
3 Failed to be added to a channel
4 Configuring a device
5 Failed to configure a device due to unsupported versions
6 Failed to configure device, insufficient space for device configuration, recommend upgrading firmware version or contacting the support team.
7 Configuration failed, the device is offline
8 Configuration failed, the device does not exist (internal debugging)

Node Connection Status Definition

  MH_CONN_STATE_WAIT = 0,                
  MH_CONN_STATE_CONNECTING = 1,
  MH_CONN_STATE_WAIT_DATA = 2,
  MH_CONN_STATE_CONNECTED = 10,          
  MH_CONN_STATE_CONNECT_FAILED = 20,     
  MH_CONN_STATE_FAILED_BROKEN = 21,
  MH_CONN_STATE_FAILED_REJECT = 22,
  MH_CONN_STATE_FAILED_DNS_RESOLVE = 23,
  MH_CONN_STATE_FAILED_TCP_CONNECT = 24,
  MH_CONN_STATE_FAILED_HANDSHAKE = 25,
  MH_CONN_STATE_FAILED_CONNECT_STREAM = 26,
  MH_CONN_STATE_FAILED_AUTH = 27,
  MH_CONN_STATE_CREATE_FAILED = 28,
  MH_CONN_STATE_BIND_FAILED = 29,

results matching ""

    No results matching ""