Ultragrid_GUI - telemersion/telemersive-gateway GitHub Wiki
Ultragrid is a CLI app that allows to send and receive video and audio streams with low latency over the network. telemersive-gateway provides a GUI to conveniently configure ultragrid-commands.
Inside each channel you can send and/or recieve individual ultragrid streams.
When you click the monitor button, the device window expands and shows the log printout of the ultragrid instance. This is provided for remote debugging and should be kept closed if not used.
If you click on the CLI-button, this will write the CLI-command, that started the ultragrid instance, into the Max console; this might help for trouble shooting.
Overview
This is how the device looks when you just created it:
The first choice to make, is what kind of network architecture you want to use:
- You either want to send from one peer to many different peers. Then you select
- send to router - if this device should be a sender
- receive from router - if this device should be a receiver
- Or you want to setup a peer to peer connection. Then you select
- peer to peer (automatic) - if you want to attempt to connect peers that are in different networks. This solution has the lowest latencies, but depending of the network topology of your organization this might not work.
- peer to peer (manual) - if you want to connect peers inside the same local network
- Or you want to capture a video on your local machine and transform it into a different format.
- capture to local
Once you made your network decision, you need to decide what kind of connection you want to make:
You either want to
- send,
- receive or
- do both.
And then you choose what transmission mode you want to use:
- video
- audio
- both
Be aware: Depending on you network selection, some choices are not available and are grayed out.
send ultragrid streams to router
Makes this stream available for receivers on this channel.
receive ultragrid from router
Receives the provided stream from a sender on this channel.
With the gateway in general, it is only possible to receive the data from the channel the device is attached to. When receiving there is an exception to this rule: it is possible to get the stream from another channel, too. This way you can send a stream to the router (lets say on channel #1) and receive it again from the router for your local use on channel #2.
create an automatic peer to peer connection
If you want to connect two remote machines with each other for a true peer to peer connection this network type promises the lowest possible latencies. If you want to share the stream with multiple machines, or you have problems connecting, use the network topology that goes via the router.
create a manual peer to peer connection
If you want to send the stream directly to a local machine you need to enter the machines LAN IP. This setup allows only to connect one machine with another.
capture local devices for local usage
you can also capture local sources (textures, NDI, attached cameras) and send them to spout/syphon.
spout / syphon
press the little refresh button next to the menu to refresh the content of the menu. select an available texture to send.
NDI
press the little refresh button next to thh menu to refresh the content of the menu. select an available ndi stream to send.
Custom
You can also enter some custom settings.
Press the 'help:'-button to see a series of options.
By clicking one, the text is automatically entered into the custom text field.
spout / syphon
If you want to make the received stream available as spout or syphon. Use the default name or enter your own.
NDI
If you want to make the received stream available as MDI. Use the default name or enter your own.
custom
If you want to do something custom with the received stream.