Documentation
ProductsLearnBlogCreative CommunityGet Depthkit

Remote livestreaming with WebRTC

Suggest Edits

While the ultimate goal and solution to livestreaming will be a more direct integration with WebRTC within Depthkit and Unity, in the mean time you can use the prototype workflows below.

These workflows are designed for a unidirectional stream of video, but could be extended to be bidirectional by duplicating the workflow for the opposite direction. At a high level, they leverage existing technologies and services built on WebRTC to transport a Depthkit livestream over the internet or a local network very quickly and with very low latency.

In this page

Relaying Depthkit Livestreams with OBS and VDO.ninja →
Unity Render Streaming →

Relaying Depthkit Livestreams with OBS and VDO.ninja

The main components of this workflow are the Depthkit capture app, OBS, Spout, OBS Ninja, Unity, and the Depthkit Studio Expansion packages for Unity.

VDO.Ninja

VDO.Ninja, formerly known as OBS.ninja, is a web application created specifically to facilitate low latency, high quality, peer-to-peer video streaming using WebRTC and make those streams available within software like OBS.

At its core, VDO.Ninja is like a Zoom or Google Meet built for video engineers. It supports video chat rooms, but more importantly for our purposes it supports unidirectional video streaming with lots of options to control quality, and is easy to integrate into OBS.

Sending peer setup

To set up the sending side of the workflow, follow these steps:

  1. Installation.
  2. Launch Depthkit and start the livestream.
    • Send the livestream_multicam_meta.txt file to the receiver.
  3. Launch OBS and create a new scene.
    - Go to Settings → Video.
    - Set the Base (Canvas) Resolution to the same resolution as the spout stream being sent out of Depthkit. This can be found within the livestream_multicam_meta.txt file that Depthkit produces in the export folder.
    - Set the Output (Scaled) Resolution to the same as the Base (Canvas) Resolution.
    - Add a Spout2 Capture source for the Depthkit livestream.
    - If you would like to embed audio into your Depthkit live stream, add an Audio Input capture source to the scene.
    - Start the virtual camera.
    - Go to vdo.ninja and click on Add Your Camera to OBS. Choose the OBS virtual camera as the video source.
    - Click Start, and send the generated link to the receiver.
    Note: the default settings on OBS Ninja have a max resolution of 1920x1080. To use a custom resolution append the following string to the URL and reload the page: &w=2256&h=1184 where 2256 and 1184 are the width and height of the actual source video being sent. IF you do not do this, the receiver may have a cropped or distorted image which will not reconstruct in Unity.

Receiving peer setup

To set up the receiving side of the workflow, follow these steps:

  1. Installation.
  2. Launch OBS and create a new scene.
    • Go to Settings → Video.
      • Set the Base (Canvas) Resolution to the same resolution as the spout stream being sent out of Depthkit.
      • Set the Output (Scaled) Resolution to the same as the Base (Canvas) Resolution.
    • Add a Browser source.
      • Enter the same resolution as the Video Base (Canvas) Resolution.
      • Use the link generated by the sender as the URL for the Browser source.
      • Click OK.
      • The texture should appear in OBS momentarily as long as the sender is still active.
    • Go to Tools → Spout Output Settings and configure the spout output to be used by Unity.
    • Obtain the metadata file from the sender and configure a Unity clip to use the OBS spout output via the Live player.

VDO.Ninja advanced configuration options

To automate and customize this workflow more, additional URL parameters may be added.

Sender:

  • w=<width>, h=<height> Use this to set the max video resolution to be sent. Importantly this also controls the aspect ratio of any scaled resolution that may be sent due to bandwidth constraints. This is very important to set accurately.
  • ovb=20000 sets the Outbound Video Bitrate to a target of 20 mbps (20,000 kbps). Higher values will produce better quality, but lower values will make the connections more stable.
  • mfr=30 Sets the max frame rate to 30FPS, which is the maximum Depthkit will ever provide. You can set this lower if you are bandwidth constrained.
  • ad=0 disables audio, eliminating the need to choose a microphone.
  • vd=OBS will attempt to find a video camera device that contains the string 'OBS' in the name, eliminating the need to choose a camera.
  • push=<id> uses a custom stream ID. 1 to 49-characters long: aLphaNumEric-characters; case sensitive.
  • pw=<password> Optionally define a password that is used to encrypt the stream.
  • autostart Skips some set up options to get to streaming faster.

Receiver:

  • view=<id> must match sender's push parameter.
  • pw=<password> must match sender's.
  • vb=5000 Video bitrate in kbps. This is the maximum bit rate that will be used for video. Lower rates will be used if necessary to maintain a good connection.
    • codec=h264 You can define the video codec to use. Available options are h264, vp8, vp9, and av1 though on windows it appears that only h264 is hardware accelerated encode & decode. vp8 is the default, so this should always be set to h264 if you want to use HW acceleration.

VDO Ninja allows you to craft URLs to be used and re-used without any registration step. Using unique push/view parameters for each use case allows you to set up a configuration in OBS and leave it that way, so next time it is needed there are no configuration steps.

For example:

Utilizing a Local Area Network for higher video bandwidth and quality

WebRTC does not technically require any internet connection, although in the examples above there are aspects of this system that are hosted on the publicly available internet. An important part of this system is a STUN server, which determines how to route the video stream from the sender to receiver. If the STUN server is not accessible on your LAN, then the IP addresses that it gives to each peer are going to be public IP addresses, meaning your video will be going over the internet, even if your computers are on the same LAN.

To allow WebRTC to discover local network IP addresses of each peer, a locally hosted STUN server must be used. The open source STUN server STUNTMAN is simple to set up and run:

  • Download the zip file for windows, extract it, and open a command prompt (cmd.exe) inside the directory where the stunserver.exe is located.
  • To start the server, use the following command:
    stunserver.exe --verbosity 3 --protocol udp
  • To use this stun server with VDO Ninja, add the following parameters to the URL of both the sender and receiver:
    &stun=stun:<IP address or hostname of local STUN server>:3478

If you've successfully used the local STUN server, you should see some output in the command prompt window once you establish a connection between the sender and receiver.

At this point you should be able to set the vb option significantly higher (up to 60000) to take advantage of the increased bandwidth available on the LAN.

Even when running a local STUN server, there are still other parts of this system (VDO Ninja itself) that are using the internet. Luckily VDO Ninja is also open source, and can be locally hosted as well for a more secure and reliable set up, but that is outside the scope of this document for now.

Resources — Running 2x instances of OBS is necessary for receiving a local stream as well as a remote.
How to run multiple instances of OBS on Windows 10 →

Unity Render Streaming

Unity Render Streaming is an experimental package that enables Unity apps to communicate over WebRTC. This can be used for webcams, microphones, and arbitrary data channels, as well as sending any unity textures you want. Recently support has been added for hardware decoding across a variety of platforms which finally enables sufficient performance for use with Depthkit.

Setting up Unity Render Streaming

Follow these steps to get your project set up with all of the dependent packages required for a simple test.

  1. Create a new Unity 2022.3.x (LTS) project using the Built-in Render Pipeline.
  2. Add the Unity Render Streaming package 3.1.0-exp.7 - Follow the instructions here to install the package.
  3. Download and launch the signaling server which facilitates the connection between Render Streaming applications. Previous versions of this guide required the option -w (websocket server mode), however this is now the default mode, so the -w flag is unnecessary. The Bidirectional example also requires that the server start in private mode - You can do this with the -m private option, making the complete command webserver.exe -m private
    1. Note the IP addresses that the server reports upon startup. You should see at least one that is not 127.0.0.1:
$ ./webrtc-utils/webserver.exe
start websocket signaling server ws://192.168.0.214
start as public mode
http://192.168.0.214:80
http://127.0.0.1:80

Take note of this address, as we will need it when testing on different devices.

After doing this, make a build and distribute it on two computers running on the same local network as the webserver. You should be able to set up a two-way call between these computers using the Bidirectional example.

Integrating Depthkit

Now that you have the Unity Render Streaming up and running and have played with the Bidirectional example, it's time to add Depthkit to our project and start streaming some holograms!

  • Start by adding the Depthkit Studio packages (available to download from the Depthkit website).

At first we will be sending a pre-recorded Depthkit clip.

  • Add a Depthkit Studio video, poster, and metadata to your project’s Assets folder as well. (Demo assets will work fine, or you can make your own recording.)

🚧

Unity Render Streaming Resolution Constraints

In our testing, the maximum resolution we've been able to send over Unity's Render Streaming connection is 3840x2160 (UHD). When exporting or livestreaming from Depthkit, set the output width and height constraints within these limits.

Create the Sender scene

  • Create a new scene in the project called “Sender”
  • Create supporting assets
    • Create a RenderTexture asset in your project called “SenderRT”
      • Configure the RenderTexture as follows:
      • Size → whatever the resolution of your CPP video is. This can be a scaled resolution but the aspect ratio must be the same.
      • Depth Stencil → None

The next step is to create a game object to construct the Depthkit asset which will be sent over WebRTC. For more information on constucting a Depthkit object, see this documentation .

  • Create an empty game object.
  • Add a Depthkit Clip component
  • Add a Depthkit Studio Built-In Look component
  • Configure your clip with the Depthkit Studio assets you imported into the project
  • Set your clip’s bounding box and reconstruction settings
  • Set the Video Player component to render to the SenderRT:
    • Render Mode → Render Texture
    • Target Texture → SenderRT

  • Click Play and ensure that your Depthkit clip plays normally

Next, we'll set up the Render Streaming components:

  • Download and copy the scripts in this snippet to your project’s Assets directory
    • SimpleConnection.cs - This script is used to manage the connection to other remote peers, and defines the connection ID to use for the WebRTC connections.
    • DepthkitMetadataChannel.cs - Handles sending and receiving Depthkit metadata for a Depthkit Clip
    • WebrtcPlayer.cs - Implements the Depthkit ClipPlayer interface and links to a Video Stream Receiver to provide the Depthkit CPP texture
    • BitrateOverride.cs - Overrides the constraints of the Unity Video sender component’s bitrate, enabling higher bitrates for better quality. Note: Increasing the bitrate may introduce additional latency.
  • Create a new empty game object and name it “Sender”
  • To the Sender object, add the following components from the Unity Render Streaming package:
    • Signaling Manager
    • Single Connection
    • Video Stream Sender
    • Audio Stream Sender
  • Also add to the Sender object the following Depthkit code snippet components you downloaded earlier:
    • SimpleConnection
    • DepthkitMetadataChannel
    • BitrateOverride.cs

  • Configure component references and settings within the Sender game object:

    • Simple Connection:

      • Render Streaming → Sender (Render Streaming)
      • Single Connection → Sender (Single Connection)
      • Connection Id → depthkit - Note this can be anything, it just has to match on the receiver side. This is the “room name” for the connection.

    • Signaling Manager:

      • In recent versions of Unity's Render Streaming packages, server settings are now handled in Unity's Project Settings > Render Streaming section. You can either set the server settings there by clicking the 'Open Project Settings' button, or override the project settings in the Signaling Manager component by unticking 'Use Default Settings in Project Settings'.

        • Set Signaling Type to 'WebSocket'
        • Set URL to the IP address of your signaling server. If the URL begins with http://, don’t forget to change it to ws://

      • Back in the Sender game object’s Signaling Manager Component, under Signaling Handler List:

        • Add an element to the list
        • Link to the Single Connection component of the Sender object.

    • Single Connection:

      • Under Streams, add three (3) elements and link to the following components in this order by dragging the components from elsewhere in the Inspector onto the elements in the list:
        • Sender (Video Stream Sender)
        • Sender (Audio Stream Sender)
        • Sender (Depthkit Metadata Channel)

    • Video Stream Sender:

      • Video Source Type → Texture
      • Texture → SenderRT
      • Streaming Size: Custom
      • Custom Value: The exact dimensions of your Depthkit clip & render texture. In our testing, the maximum resolution we've been able to send over Unity's Render Streaming connection is 3840x2160 (UHD), so ensure your asset/livestream is compatible with this.
      • Video Codec → Default
      • Framerate → 30
      • Bitrate can be ignored, as we will set it in a different component.

    • Audio Stream Sender:

      • Audio Source Type → Audio Source
      • Audio Source → Depthkit (Audio Source) - This will send whatever audio is embedded into the Depthkit asset if using the Unity Video Player, which by default is configured to output to an Audio Source on the same object as the Clip.
      • Audio Codec → Default
      • Bitrate
        • Min → 64
        • Max → 256

    • Depthkit Metadata Channel

      • Local → Checked
      • Label → dkmeta - Note: This can be anything, it just has to match on the receiver side.
      • Clip → Depthkit (Clip)

    • Video Sender Bitrate Override

      • Video Stream Sender → Sender (Video Stream Sender)
      • Min Bitrate → 5000
      • Max Bitrate → 30000 - Note: These values may need to be adjusted based on the connection between your sender and receiver.

Create the Receiver scene

  1. Create a new scene in the project called “Receiver”

  2. Create supporting assets

    1. Create a RenderTexture asset in your project called ReceiverRT

      Configure the RenderTexture as follows:

      • Size → whatever the resolution of your CPP video is. This can also be a scaled resolution for performance reasons. Aspect ratio on the receiver end does not seem to matter, but ideally it is the same as the sender.
      • Depth Buffer → No depth buffer

  3. Create a new empty game object called Receiver

    1. Add the following components to the Receiver game object
      1. Simple Connection
      2. Signaling Manager
      3. Single Connection
      4. Video Stream Receiver
      5. Audio Stream Receiver
      6. DepthkitMetadataChannel
  1. Create a new empty game object for the Depthkit asset being sent over WebRTC
    1. Add a Depthkit Clip component
      • Change Player → WebRTC Player
        Configure the Depthkit WebRTC Player component
        • Video Receiver → Receiver (Video Stream Receiver)
    2. Add a Depthkit Studio Built-In Look component
  2. In the Receiver object, configure the components:
    1. Simple Connection:
      • Signaling Manager → Receiver (Render Streaming)
      • Single Connection → Receiver (Single Connection)
      • Connection Id → depthkit
        • Note this can be anything, it just has to match on the sender side. This is the “room name” for the connection.
    2. Signaling Manager:
      • As mentioned in the Sender section, in recent versions of Unity's Render Streaming packages, server settings are now handled in Unity's Project Settings > Render Streaming section. You can either set the server settings there by clicking the 'Open Project Settings' button, or override the project settings in the Signaling Manager component by unticking 'Use Default Settings in Project Settings'.
      • Signaling URL → If testing the connection between a sender and receiver on the same computer, this value is localhost. If you are testing over LAN, this value is the LAN IP address of the sender machine hosting the signaling server. If the signaling server is set up remotely, use the remote IP address - If you leave this set to localhost, it will not work if you test this on another computer or device.
        • If the URL begins with http://, don’t forget to change it to ws://
      • Under Signaling Handler List:
        • Add an element to the list
        • Link to the Single Connection component of the Receiver object
    3. Single Connection:
      • Under Streams, add three (3) elements and link to the following components in this order by dragging the components from elsewhere in the Inspector onto the elements in the list:
        • Receiver (Video Stream Receiver)
        • Receiver (Audio Stream Receiver)
        • Receiver (Depthkit Metadata Channel)
    4. Video Stream Receiver:
      • Render Mode → Render Texture
      • Target Texture → ReceiverRT
      • Video Codec → Default
    5. Audio Stream Receiver:
      • Target Audio Source → Depthkit (Audio Source)
      • Audio Codec → Default
    6. Depthkit Metadata Channel
      1. Local → Unchecked
      2. Label → dkmeta- Note this can be anything, it just has to match on the sender side.
      3. Clip → Depthkit (Clip)

Test Your Project

  1. Go to File → Build Settings…
  2. Click Player Settings…
    1. Go to Resolution and Presentation
      • Change Fullscreen Mode → Windowed
      • Default Screen Width and Height → 800
        • Make this small enough to fit two windows side by side
  3. Back in Build Settings…

Add the Sender and Receiver scenes and make a build for each one:

a. Open the Sender scene, click Add Open Scenes
- Click Build and save your build to its own folder named Sender
- Ensure only the Sender scene is checked in the Scenes In Build list
b. Open the Receiver scene and repeat the above steps
  1. Open both executables and see that both Depthkit clips are playing the same thing, with a minor delay
2188

Sender on the left, Receiver on the right

Using a Depthkit Live Stream

The following steps describe how to modify the scenes set up in the previous section to support a running Depthkit Live stream. For more information on this, read the Depthkit Livestreaming documentation.

  1. Add the Depthkit Spout Livestream Player Package to your project. Don’t forget to add Keijiro’s repository first as this package relies on KlakSpout.
  2. Start your Depthkit live stream under Edit → Preferences
    1. Use the maximum width and height values to limit the live stream resolution to something reasonable for webrtc streaming, like 2048x2048
    2. Copy the livestream_multicam_meta.txt file that Depthkit writes to the Exports directory into your project’s Assets folder
  3. Modify the SenderRT & ReceiverRT’s sizes to match that of the Depthkit spout stream. Note that this may not be exactly equal to the limit you set in Depthkit. Look at the textureWidth and textureHeight within the livestream_multicam_meta.txt file.
  4. In Unity, open the Sender Scene
  5. Choose the Depthkit object in your scene’s hierarchy
    1. Modify the Depthkit Clip settings:
      • Player → Livestream Player (Spout)
      • Metadata: livestream_multicam_meta.txt
      • Poster → None
    2. Spout Receiver Settings:
      1. Target Texture → SenderRT
  6. Optional: Audio
    1. If you want to send live audio from the sender PC to the remote receiver device, you’ll need to use a microphone or other audio input device connected to the sender PC.
      • Select the Sender object, and modify the Audio Stream Sender component:
        • Audio Source → Microphone
        • Microphone Device Index → Choose the device index you want to send audio from.
          The device index can be found by iterating over Unity’s Microphone.devices list.
          Note that the Azure Kinect microphone arrays are not supported by the Audio Stream Sender, so if you choose one of these microphones, it will produce an error upon attempting to stream from the device.
  7. That's it! Test it out, the receiver app you built previously should still work without modification (unless the livestream resolution has changed - Then you need to update the ReceiverRT resolution and build a new receiver).

Streaming over the Internet

In order to stream over the internet, you’ll need to host the signaling server so that it is publicly available.

A simple way to do this is to use the source code for the web app in the Unity Render Streaming repo directly. If you need any additional features like security, those will have to be added manually, using their codebase as a starting point.

Clone the repo and find the NodeJS web app source code in the WebApp subdirectory.

Unity has a guide on customizing the web app here

To set up the node.js app on AWS EC2, start an EC2 instance

  • SSH into the instance
  • Clone the Unity Render Streaming Repo: https://github.com/Unity-Technologies/UnityRenderStreaming
    • Check out to appropriate tag for whatever version you're using in unity (for example 3.1.0-exp.7)
  • Install the npm dependencies for the signaling server
    • cd WebApp
    • npm i
  • Build & Run the server
    • npm run build
    • npm run start
  • Note that if you receive a permission denied error, you may need to run the server as root, or some other user that has access to listen on port 80, for example:
    • sudo npm run start
  • Note that you may want to start it in the background so the server stays up if your terminal disconnects:
    • npm run start &

Once the web app is hosted, it should work the same way as it does on the local network. You can use either HTTP or websocket mode, and use the public IP or domain name of the server in your Sender and Receiver object’s configuration.

Updated 5 months ago