udStream Quick Start Guide

udStream Quick Start Guide

Registering an account

Before downloading and installing udStream you will need to go to  https://udstream.euclideon.com to register an account.

  1. When you navigate to the site, click  Register .
  2. Enter your name and email.
  3. You will be sent an email with further instructions on how to choose a password and activate your account.
  4. Once this is complete, log back into  https://udstream.euclideon.com

Downloading the udStream software

After registering, log into  https://udstream.euclideon.com and choose the correct udStream software for your respective operating system. Alternatively, if you are using the Chrome, you can run udStream right in the browser without having to download or install anything!

Minimum Tech Specifications


    • CPU: Minimum: 2 cores over 1.7GHz, Recommended: 8+ cores over 2.0GHz
    • RAM: Minimum: 2GB, Recommended: >4GB


      • MacOS X 10.13 High Sierra or later

(Note: udStream is not yet available on the Mac App Store. Some security steps are required to run. See Installing below for more information.)


    • CPU: Minimum: 2 cores over 1.7GHz, Recommended: 8+ cores over 2.0GHz
    • RAM: Minimum: 2GB, Recommended: >4GB



Recommended download speeds: 3 MB/s

Minimum download speeds: 128KB/s (will notice slow rendering speed below approx. 512KB/s)



  1. Locate and run the downloaded udStreamSetup.exe installer. If a window pops up asking  Do you want to allow this app to make changes to your device click  Yes .
  2. In the next window, be sure to read the license agreement, then click  I Agree
  3. Next, choose the items you wish to install and click next. By default, all are selected.
  4. Choose a destination to install to and click  Install .


  1. Locate the  udStream DMG package
  2. Open the DMG and drag the “udStream” icon onto the provided “Applications” icon.
  3. Open  System Preferences,  then click "Security & Privacy".
  4. Under the General, tab locate "Allow apps downloaded from" and choose  Anywhere .
  5. Run the “udStream” application from “Applications”.

Ubuntu Linux Distributions

  1. Using this package requires a desktop environment.
  2. Use your package manager to install the following:
  1. SDL2 (Minimum version 2.0.5)
  2. libCURL (Version 3)
  1. Locate the udStream tar.gz package that you  downloaded   previously.
  2. Unpack the entire contents of the tar.gz
  3. Double-click on  udStream  to start the udStream application.

Logging into udStream

After the application has started, it will present either the login screen (for standard users) or will skip straight to the scene view (for users with offline dongles). If neither of these occur, please contact  support@euclideon.com   for assistance.

After you have entered your credentials, click  Login  and you should see an empty scene in the viewport like the image below.

Login Errors

The following errors may appear if login is not successful.

  • Could not connect to server.
  • There are several possible causes for this message. The most common is the server address entered into the field is not correct. The system is case- and space-sensitive. Ensure there are no spaces before or after the Server URL.
  • Email or Password incorrect
  • This could mean any of the following:
  • The email or password is incorrect
  • The email is not registered
  • The account registered with this email has been banned
  • Ensure there are no spaces before or after the Email or Password.
  • Your clock does not match the remote server clock.
  • In order to maintain system security, the client and server must agree on the time to within 5 minutes. Having the server and client both set to synchronize with "universal" NTP time is preferable. This error will occur if the time zone of either the server or the client is not set correctly.
  • Could not open a secure channel to the server.
  • The client was able to connect to the server, but an error occurred while verifying the server was the intended target or negotiating an encrypted connection.
  • Unable to negotiate with the server, please confirm the server address.
  • The client was able to connect to the server provided in the server URL field, but the server did not respond as expected. This usually occurs if the server is not a Euclideon Vault Server.
  • Unable to negotiate with proxy server, please confirm the proxy server address
  • This occurs when the proxy information is partially correct. Further details may be required before the connection through the proxy is correct (usually proxy authentication details).
  • Unknown error occurred, please try again later.

TIP:  If  an error occurs and the above troubleshooting doesn’t help-  Email  support@euclideon.com , giving the udStream version number and the  error message so they can help you resolve the problem .  

udStream Interface

The most used tools are on the left side of the screen. The bottom right side contains useful tools to traverse the scene.

Getting around in the scene

You can move the camera in the scene using the mouse, the keyboard, or a gamepad. The controls can be configured in the settings. 

The default mouse controls:

  • Holding the Left-Mouse button and moving the mouse will look around (Tumble)
  • Holding the Right-Mouse button and moving the mouse will keep the point that you initially clicked on under the mouse (Pan)
  • Holding the Middle-Mouse button and moving the mouse will Orbit the camera around the point initially under the mouse
  • Scrolling In will move you closer to a point and Scrolling out will move you further away

The default keyboard controls:

  • W & S move forwards and backwards
  • A & D strafe left and right
  • R & F move the camera vertically
  • Spacebar locks the altitude which will cause Pan (right-mouse button) and the W, A, S & D keys to not move the camera vertically
  • The keypad 3 & 5 keys also slow the camera down and speed the camera up respectively

Loading a Project

Load one of the sample projects by clicking the   button in the top left corner of the scene and choosing  Euclideon Samples . Alternatively, drag and drop a UDP or udStream JSON project file onto the udStream interface to load  that project.

Turning Layers and Items on and off

The Scene Explorer window lists the assets currently in your scene. By default, this panel is hidden and must be enabled by clicking the  button in the top left.

If you have a project loaded or have added items to the scene, they will appear here and can be toggled on or off (indicated by the check mark beside each item).

Changing the Base Map and Toggling Terrain Elevation

In the bottom-right corner of the screen there is a button that opens the quick settings for the base map.

Toggling the Digital Elevation Model will disable terrain height and several base maps options are available to be selected.  Custom Slippy map servers are also supported. For more information, see the udStream User Guide.

Here you will also find the Earth Centred Earth Fixed (ECEF) toggle button, to change between spherical and flat projections.

Changing Settings

You can customise settings such as speed of movement, panel brightness, camera lens, and many more. To open the settings, press the  located at the top.

We recommend familiarising yourself with each setting by altering the parameters individually to see how they affect the display and operation of the application.

Each section of the settings can be restored by using the “Restore Defaults” button for that section.

Loading existing UDS models

The easiest way to load a model into the udStream is to  DRAG  a UDS file from your file explorer and  DROP

it in the udStream Scene window to add the model to the scene (please note that this does not work with the browser version).

UDS files can be stored on your local hard drive, on a network drive, on the internet or in the cloud and only parts of the file will be loaded or streamed to your computer.

Another way is to use the  Add UDS  button at top of the Scene Explorer which opens the “Add Scene Item” panel.

The “…” opens the modal to select a file. Alternatively, in the text input field it is possible to enter a URL for a file stored on the internet or in the cloud.

udStream supports loading local and network files as well as streaming files over the HTTP, HTTPS, FTP and FTPS protocols.

Creating new UDS models

In the menu in the top left, the Convert panel can be opened. On this panel, you can add input files that will be converted to a new UDS model.

Supported file types include LAS, LAZ, PTS, PTX, TXT/CSV, E57, XYZ, OBJ, ASC (Esri ASCII) & SLPK.

The system will try and determine ideal default settings based on the input files, but these can be overridden. It is also worthwhile to complete the metadata fields (particularly Copyright as this will be displayed in the scene later).

If you are unsure of the quality of the data, the flag to continue processing may be worthwhile, it will cause the system to attempt to handle invalid or corrupt data as best it can and continue processing.

Once files have been added and the desired settings and metadata have been set you can click “Begin Conversion” to kick off the conversion.

This may take a long time depending on the size, type and number of input files. While the conversion is running you can queue more conversion jobs or just wait for it to complete. There is a progress indicator in the top left of the scene and the convert panel.

It is not recommended to run multiple converts at the same time. Converting is a memory and processor intensive process and it is almost always faster to have a single convert running at a time. The UI enables you to queue multiple jobs to run one after another.

udStream Development Kit

The udStream Development Kit (udSDK) allows developers to utilise the features of the udStream ecosystem to enhance existing products or create new ones. Information created via udSDK can be accessed through other enhanced products allowing seamless integration across multiple products.

The SDK provides access to the patented Unlimited Detail renderer, approved through the udSDK Server licenses for 3rd party applications.

You can request software developer-level technical information from Euclideon via email at  sales@euclideon.com .  or access samples online at  https://euclideon.com/vaultsdk  

Contact Us

To learn more about udStream and other Euclideon solutions, please email  sales@euclideon.com  or visit us at  https://euclideon.com/vault

Special Acknowledgements

We would like to thank Aerometrex for supplying the Gosses Bluff, Gold Coast and Brisbane City sample models.

Aerometrex provides aerial mapping services and products to our clients by exploiting both existing and emerging air and ground imaging technologies.

The award-winning company specialises in aerial photogrammetry and offers a growing range of aerial orthophotography products, precision digital surface and terrain modelling, 3D models and value-added geospatial services.

Schlenker Mapping was established in 1984 with the objective of providing service oriented, specialised digital photogrammetric and terrestrial surveys, as well as conventional aerial surveys. Today, Schlencker Mapping operates softcopy photogrammetric workstations providing one of the largest photogrammetric production capacities of any mapping organisation in Australia.

    • Related Articles

    • udStream Browser: Guide to Getting Started

      Getting Started with udStream - Browser udStream can run in a Browser with the ability to view hosted Projects and already-converted .uds models anywhere in the world, on any machine. We currently support Google Chrome, Microsoft Edge and Mozilla ...
    • HOW TO: Unpacking and Installing udStream

      Unpacking and Installing Windows If you haven’t already, change to the directory where you downloaded udStream. Right-click on the udStream\_OS\_version.zip  file and select Extract Here to unpack the files to the current directory. If you have a ...
    • udStream Desktop: Common Connection Issues

      Common Connection Issues Incorrect username or password You can change your password once logged in however if you have forgotten your account password, please go to https://udstream.euclideon.com/login.html and select 'Reset Password'. Advanced ...
    • How to Geolocate A 3D Model Using udStream

       OVERVIEW This guide provides the steps to geolocate a 3D polygon (OBJ or FBX) model so that is appears in the correct location within a larger point cloud model, eg. Placing an .obj building within a geolocated city model. udStream is a dynamic ...
    • HOW TO: Downloading udStream

      Downloading udStream To use  udStream, you will need to download the udStream software for your respective operating system. Visit www.euclideon.com/udstream to register for an account. Once logged into the portal, select the relevant package for ...