.. _Omniverse Kit Remote Linux Client: https://developer.nvidia.com/nvidia-isaac-sim-20211-omniverse-kit-remote-client-linux
.. _Omniverse Kit Remote Windows Client: https://developer.nvidia.com/nvidia-isaac-sim-20211-omniverse-kit-remote-client-windows
.. _Nucleus Linux Installer: https://developer.nvidia.com/nvidia-isaac-sim-20211-omniverse-nucleus-linux
.. _Cache Linux Installer: https://developer.nvidia.com/nvidia-isaac-sim-20211-omniverse-nucleus-linux
.. _NVIDIA Omniverse Pre-Release Evaluation License Agreement: https://developer.nvidia.com/Omniverse/downloads/NVIDIA_Omniverse_Pre-Release_Evaluation_License
.. _Omniverse Launcher: https://www.nvidia.com/en-us/design-visualization/omniverse/download

.. _Nucleus Overview: ../../prod_nucleus/prod_nucleus/overview/description.html
.. _Nucleus Docker: ../../prod_nucleus/prod_nucleus/installation/docker.html
.. _Nucleus Web Service: ../../prod_nucleus/prod_nucleus/usage/navigator.html
.. _Cache Overview: ../../prod_nucleus/prod_utilities/cache/overview.html
.. _Nucleus Workstation: ../../prod_nucleus/prod_nucleus/installation/workstation.html#installing-using-omniverse-launcher
.. _Cache Workstation: ../../prod_nucleus/prod_utilities/cache/installation/workstation.html#install-cache-with-launcher
.. _Livestream WebSocket: ../../prod_extensions/prod_extensions/ext_livestream/websocket.html

.. _Key Pair Guide: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/get-set-up-for-amazon-ec2.html#create-a-key-pair
.. _Connecting to Your Linux Instance from Windows Using PuTTY: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/putty.html
.. _Visual Studio Code: https://code.visualstudio.com/download
.. _Remote-SSH extension: https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh
.. _Create a Linux virtual machine in the Azure portal: https://docs.microsoft.com/en-us/azure/virtual-machines/linux/quick-create-portal

.. _kaolin_manual_livestream_client:

===================================
Livestream Clients
===================================

This section shows you the two different methods of livestreaming |kaolin|. Two modes are available: `Kaolin Headless Websocket` (recommended) and `Kaolin Headless Kit Remote`.

.. image:: /content/images/kaolin_launcher.png

Before running a livestream client, make sure that the Kaolin app is loaded and ready. To confirm this, look out for this line in the console or the logs:

    .. code-block:: console

        Kaolin Headless Websocket App is loaded.
        
.. note::

    * If running Kaolin on Windows, the `Kaolin Headless Websocket` option is recommended. You may encounter an error launching with Kit Remote. :ref:`kaolin_known-limits`
    * To cleanly exit the app. Click the **File** menu then click **Exit**.



.. _kaolin_setup_livestream_websocket:

Livestream WebSocket
------------------------------------------------------------------------------------------------

This is a Livestream extension using the WebSocket protocol. 

The WebSocket client can be accessed using the browser at this URL:

**http://<ip address>:8311/streaming/client**

* Click on the red Play button to begin live streaming

.. image:: /content/images/kaolin_streaming_red-play-btn.png

.. note::

    * To cleanly exit the app. Click the **File** menu then click **Exit**.
    * See `Livestream WebSocket`_ for more information.


.. _kaolin_setup_kit_remote:

Omniverse Kit Remote Client
------------------------------------------------------------------------------------------------

This is a streaming client to view |kaolin| remotely on your desktop or workstation without a powerful GPU.

.. _kaolin_setup_kit_remote_requirements:

Kit Remote Client Requirements
############################################

**Ubuntu 18.04**

    Download the `Omniverse Kit Remote Linux Client`_

    Please install these packages to run the streaming client:

        .. code-block:: console

            $ sudo apt-get install libavcodec57 libavformat57 libavutil55 libsdl2-dev libsdl2-2.0-0

.. note::

    * Kit Remote Client is not supported on Ubuntu 20.04.

**Windows 10/11**

    Download the `Omniverse Kit Remote Windows Client`_

.. _kaolin_setup_kit_remote_connection:

Connect to |kaolin|
############################################

Below are steps to live-stream a remote deployment of |kaolin| to you local Linux or Windows workstation using Omniverse Kit Remote Client:

#. Get the IP address of your |kaolin| instance.

    * On a remote Linux machine, run:

        .. code-block:: console

            $ ifconfig

#. Run :ref:`kaolin_setup_kit_remote`

    * On Linux:

        .. code-block:: console

            $ ./kit-remote.sh -s <remote_ip_address>

    * On Windows:

        .. code-block:: console

            > kit-remote.exe -s <remote_ip_address>

    .. note::

        * Replace <remote_ip_address> above with your |kaolin| instance Public IP.
        * To connect to a local headless instance of |kaolin|, use IP **127.0.0.1**.
        * Each |kaolin| instance can only connect to one Omniverse Kit Remote Client. Connecting to an |kaolin| instance that is currently serving a Omniverse Kit Remote Client will result in an error for the second user.
        * The Omniverse Kit Remote Client will create a window of resolution 1280x720 by default. It is recommended to set your display resolution to 1080p(1920x1080). Use flag **-w 1920 -h 1080** to set the Kit Remote windows resolution to 1080p.

.. Differences Between WebSocket and Kit Remote
.. ------------------------------------------------------------------------------------------------