Running UltraGrid

Ultragrid is a command line application, run either via command uv (if you installed it) or manually from the folder /ultragrid/ultragrid/bin.

./uv

On Mac OS X, you can also run UltraGrid from the application bundle. Bundle creation is described here. If running from bundle, use whole path to the binary inside the bundle:

<path_to>/uv.app/Contents/MacOS/uv

where <path_to> may be '.' (a dot) only or any absolute/relative path to the bundle.

Any specific sender-receiver connection can be established by appending parameters to the ./uv command.

To establish a connection between two remote machines you need to run a 'Sender' and a 'Receiver' Ultragrid on the respective machines.

Basics

Help for print help dialogue

./uv --help 

Help for video capture and then e.g., uv -t testcard:help for particular parameters

./uv -t help

Help for displaying and then e.g., uv -d gl:help for particular parameters

./uv -d help

Help for compression and then e.g., uv -c libavcodec:help

./uv -c help 

Help for audio capture and playback

./uv -s help (capture) or ./uv -r help (playback)

You may also care about:

traffic shaping -l, FEC -f, jumbo frames -m and port usage -P

Sending/receiving

Sender settings

A command to start the sender version of ultragrid should look something like this:

./uv -t somecard:0:4:RGB example.com

Now this command can be split into three parts. -t is a parameter that tells ultragrid you are setting the sender (capTure). example.com here represents the IP of the receiver. Finally, the cryptic colon separated command is the sender card setting.

To determine your sender card setting, first use:

./uv -t help

To get a list of devices. After choosing a device, you can obtain further device options by:

./uv -t :help

You can now fill the rest of the information according to the list recieved. Note that different cards require different numbers of parameters.

Reciever settings

You can now apply almost the same procedure to set the receiver, the difference is that you use -d (Display) parameter instead of -t e.g.:

./uv -d decklink example.com

Note that on sender, you are required to fill in less options.

If you want to use gl, run this command

./uv -d gl 

Advanced sender/reciever settings

• Duplex
• Bidirectional simplex

Advanced Settings

You should now be able to establish a basic non-HD connection. For Audio, HD, 4K, Stereoscopic 3D ... and other features, please consult the corresponding sections: