nexgentec technical documentation

Routing

routing.Get

rxchannels

Get all received channels from a Dante™ device

Request

Method Param Value Comment Supported Versions
routing.Get name string Name of the device >v1.8.50
component rxchannels >v1.8.50
domain ADHOC Dante domain, may be used in future versions 
{"jsonrpc":"2.0","id":2,"method":"routing.Get","params":{"name":"SDM-DEV-DSP1-4","domain":"ADHOC","component":"rxchannels"}}

Reply

Result Key Comment
channels (map) Receiving channels 1-x
canonicalName Channel canonical name
label Channel label name
subscriptedLabel Channel label from channel that is received
subscriptedDevice Device name from which the channel is received
Name Device name 
{
	"jsonrpc": "2.0",
	"id": 2,
	"result": {
		"channels": {
			"1": {
				"canonicalName": "Zone_Channels-Ch1",
				"label": "Zone_Channels-Ch1",
				"subscriptedLabel": "NONE",
				"subscriptedDevice": "NONE"
			},
			"21": {
				"canonicalName": "Zone_Channels-Ch21",
				"label": "Zone_Channels-Ch21",
				"subscriptedLabel": "Source_Channels-Ch45",
				"subscriptedDevice": "SDM-DEV-DSP1-4"
			}
		},
		"Name": "SDM-DEV-DSP1-4"
	}
}

routing.Get

txchannels

Get all sent channels from a Dante™ device

Request

Method Param Value Comment Supported Versions
routing.Get name string Name of the device >v1.8.50
component txchannels >v1.8.50
domain ADHOC Dante domain, may be used in future versions 
 {"jsonrpc": "2.0","id":2,"method": "routing.Get","params":{"name":"SDM-DEV-DSP1-4","domain":"ADHOC","component":"txchannels"}}

Reply

Result Key Comment
channels (map) Transmitting channels 1-x
canonicalName Channel canonical name
labels Channel labels (map)
Name Device name 
{
	"jsonrpc": "2.0",
	"id": 2,
	"result": {
		"channels": {
			"1": {
				"canonicalName": "01",
				"labels": {
					"0": "Source_Channels-Ch1"
				}
			},
			"10": {
				"canonicalName": "10",
				"labels": {
					"0": "Source_Channels-Ch10"
				}
			}
		},
		"Name": "SDM-DEV-DSP1-4"
	}
}

txflows

Get all sent flows from a Dante™ device

Request

Method Param Value Comment Supported Versions
routing.Get name string Name of the device >v1.8.50
component txflows >v1.8.50
domain ADHOC Dante domain, may be used in future versions 
{"jsonrpc": "2.0","id":2,"method": "routing.Get","params":{"name":"SDM-DEV-DSP1-4","domain":"ADHOC","component":"txflows"}}

Reply

Result Key Sub Comment
flows (map) Transmitting flows 1-x
name Flow name
Slots Flow slots (map)
ChannelName Name of the channel
ChannelID Channel ID
ID Flow ID
Interfaces How many interfaces are used for this flow
Addresses Flow Addresses (map)
Addr Multicast IP Address
Port Port
FlowClass 1=Dante&trade, 2,3=AES67, 4=RTP
Aes67OrigAddress AES67 original address if AES67
Transport AES67 or Dante
DestDevice Destination device the flow flows to if unicast
Flow ID Destination flow name on the device the flow flows to if unicast
Name Device name 
{
	"jsonrpc": "2.0",
	"id": 2,
	"result": {
		"flows": {
			"0": {
				"name": "Source_Channels",
				"indexes": null,
				"Slots": {
					"0": {
						"ChannelName": "Source_Channels-Ch1",
						"ChannelID": 1
					},
					"1": {
						"ChannelName": "Source_Channels-Ch2",
						"ChannelID": 2
					}
				},
				"ID": 1,
				"Interfaces": 1,
				"Addresses": {
					"0": {
						"Addr": "239.255.105.118",
						"Port": 4321
					}
				},
				"FlowClass": 1,
				"Aes67OrigAddress": "",
				"Transport": "DANTE",
				"DestDevice": "",
				"DestFlow": ""
			}

		},
		"Name": "SDM-DEV-DSP1-4"
	}
}

rxflows

Get all received flows from a Dante™ device

Request

Method Param Value Comment Supported Versions
routing.Get name string Name of the device >v1.8.50
component rxflows >v1.8.50
domain ADHOC Dante domain, may be used in future versions 
{"jsonrpc": "2.0","id": 2,"method": "routing.Get","params":{"name":"SDM-DEV-DSP1-4","domain": "ADHOC","component":"rxflows"}}

Reply

Result Key Sub Comment
flows (map) Transmitting flows 1-x
name Flow name
Slots Flow slots (map)
Channels (map) Map of the channels received in this flow slot
ID Flow ID
Interfaces How many interfaces are used for this flow
Addresses Flow Addresses (map)
Addr Multicast IP Address
Port Port
FlowClass 1=Dante&trade, 2,3=AES67, 4=RTP
Aes67OrigAddress AES67 original address if AES67
Transport AES67 or Dante
Name Device name 
{
	"jsonrpc": "2.0",
	"id": 2,
	"result": {
		"flows": {
			"0": {
				"name": "",
				"Slots": {
					"0": {
						"Channels": {
							"0": "Zone_Channels-Ch51"
						}
					},
					"1": {
						"Channels": {
							"0": "Zone_Channels-Ch52"
						}
					}
				},
				"ID": 1,
				"Interfaces": 1,
				"Addresses": {
					"0": {
						"Addr": "239.69.40.217",
						"Port": 5004
					}
				},
				"FlowClass": 1,
				"Aes67OrigAddress": "",
				"Transport": "Dante"
			},

			"2": {
				"name": "",
				"Slots": {
					"0": {
						"Channels": {
							"0": "Zone_Channels-Ch1"
						}
					},
					"1": {
						"Channels": {
							"0": "Zone_Channels-Ch2"
						}
					}
				},
				"ID": 3,
				"Interfaces": 1,
				"Addresses": {
					"0": {
						"Addr": "239.69.2.156",
						"Port": 5004
					}
				},
				"FlowClass": 2,
				"Aes67OrigAddress": "239.69.2.156",
				"Transport": "AES67"
			}
		},
		"Name": "SDM-DEV-DSP1-4"
	}
}

routing.Create

Create a new routing from a Dante™ or AES67 device to a a Dante™ device

Request

Method Param Sub-table key Comment Supported Versions
routing.Create tx channelName Source channel label/name/canonical name >v1.8.50
nodeName Source node name >v1.8.50
aesFlowName Source flow name >v1.8.67
aesFlowSlotID Slot ID of flow >v1.8.67
rx destination Destination channel label/name/canonical name >v1.8.50
nodeName Destination node name >v1.8.50

Include node name to create a new routing

Even if it is allowed to create a new routing only based on the channel name, it is better to include the device name. The changeover is done more quickly 
{
   "jsonrpc":"2.0",
   "id":1,
   "method":"routing.Create",
   "params":[
      {
         "rx":{
            "channelName":"Zone_Channels-Ch10"
         },
         "tx":{
            "channelName":"Source_Channels-Ch10"
         }
      }
   ]
}
{
   "jsonrpc":"2.0",
   "id":1,
   "method":"routing.Create",
   "params":[
      {
         "rx":{
            "nodeName":"SDM-DEV-DSP1-4",
            "channelName":"Zone_Channels-Ch10"
         },
         "tx":{
            "nodeName":"SDM-DEV-DSP1-4",
            "channelName":"Source_Channels-Ch10"
         }
      }
   ]
}
{
   "jsonrpc":"2.0",
   "id":1,
   "method":"routing.Create",
   "params":[
      {
         "tx":{
            "nodeName":"",
            "channelName":"Zone_Channels-Ch10"
         },
         "tx":{
            "aesFlowName":"239.69.40.217@Test-BTI",
            "aesFlowSlotID":1
         }
      },
      {
         "rx":{
            "nodeName":"",
            "channelName":"Zone_Channels-Ch11"
         },
         "rx":{
            "aesFlowName":"239.69.40.217@Test-BTI",
            "aesFlowSlotID":2
         }
      }
   ]
}

Reply

Result
null null means acknowledged, no error 
{"jsonrpc":"2.0","id":1,"result":null}

routing.Delete

Delete a routing from a Dante™ or AES67 device to a a Dante™ device

Request

Method Param Sub-table key Comment Supported Versions
routing.Delete rx Destination Destination channel label/name/canonical name >v1.8.50
nodeName Destination node name >v1.8.50

Include node name to delete routing

Even if it is allowed to delete a routing only based on the channel name, it is better to include the device name. The disconnect is done more quickly 
{
   "jsonrpc":"2.0",
   "id":1,
   "method":"routing.Delete",
   "params":[
      {
         "RX":{
            "ChannelName":"Zone_Channels-Ch11"
         }
      }
   ]
}
{
   "jsonrpc":"2.0",
   "id":1,
   "method":"routing.Delete",
   "params":[
      {
         "RX":{
            "NodeName":"SDM-DEV-DSP1-4",
            "ChannelName":"Zone_Channels-Ch11"
         }
      }
   ]
}

Reply

Result
null null means acknowledged, no error 
{"jsonrpc": "2.0","id": 1,"result": null}
Last updated on 20 Mar 2021
Published on 20 Mar 2021