Skip to content

Latest commit

 

History

History
134 lines (74 loc) · 5.42 KB

File metadata and controls

134 lines (74 loc) · 5.42 KB

Tutorial

In this page, we introduce the way to use samples published on Package Manager.

Install package

Note

In Unity 2020.2 and 2019.4, there are differences about how to install Unity Render Streaming package so please pay attention to the Unity version you are using and follow the instructions below.

Case of Unity 2019.4

Select Window/Package Manager in the menu bar.

Install Package Manager from menu bar

Check Package Manager window, Click Advanced button and enable Show preview packages.

Select show preview packages on advanced options

Input renderstreaming to the search box at the top of the Package Manager window.

Search renderstreaming package

Click Install button at the bottom left of the window, and will start install the package.

If an input system dialog box appears, click Yes

Input system backend

Case of Unity 2020.2

Select Window/Package Manager in the menu bar.

Install Package Manager from menu bar

Check Package Manager window, Click + button and select Add package from git URL....

Select add package from git url

Input the string below to the input field.

com.unity.renderstreaming@3.1.0-exp.1

The list of version string is here. In most cases, the latest version is recommended to use.

Click Add button, and will start install the package.

If an input system dialog box appears, click Yes

Input system backend

Install web application

Click on Edit/Render Streaming/Download web app menu item to download the application from this page.

Download webapp

When the select download folder window appears, click on Select Folder to download the file to the default folder

Select Download folder

After the download is finished and a powershell or cmd window is opened, and run webserver.exe with -w option. Please refer to this page for commandline options.

.\webserver.exe -w

You can see logs on the commandline like below.

Launch web server

If you use it on macOS or Linux, please run the command below to give the execute permission.

# for Linux
chmod a+x ./webserver

# for macOS
chmod a+x ./webserver_mac

Install samples

You can import Samples from the bottom of the com.unity.renderstreaming package in the PackageManager Window.

Sample List

Play Unity

Open WebBrowserInput scene.

Open WebBrowserInput scene

Enter play mode in Unity Editor.

Play mode

Open your web browser and access http://localhost. You can see the top page. Click a VideoPlayer Sample link.

Main page on the browser

You can see the Unity scene on the browser, and control a camera in the Unity scene.

Video player sample on the browser

Deploy to Furioos

As you may already know, Unity Render Streaming has a Furioos-compatible signaling option. This means that you can build a dedicated version of your application, host it on Furioos, and share it with thousands of customers who will enjoy all the features of Unity Render Streaming. But you will not have to deal with any of the difficulties of setting up a private server, a machine in the cloud or manage the scalability of your solution.

To do so, the requirement is to select "FurioosSignaling" in the "Signaling server type" parameter of the RenderStreaming component. This allow your application to connect to Furioos services when running on the managed virtual machines.

Selecting FurioosSignaling

Then just build a standalone Windows version of your application, and zip it! Don't try to build iOS, Android, linux or whatever version of your app, Furioos only support Windows applications. Also, be sure to zip the whole exported folder with all files and sub-folders, not just the ".exe" file.

Selecting FurioosSignaling

Finally just upload it on your account at https://portal.furioos.com/ . If you need futher help to upload your application on Furioos, please follow this tutorial.

You can check the stream type on https://portal.furioos.com/ by clicking to the "more options" button in the toolbar.

Selecting FurioosSignaling

After tutorial

About general questions, please see FAQ page. And you are available for discussions about Unity Render Streaming on Unity Forum.

About the operation of inspectors, please see Components settings page. About options of web application, please see The web application page. You can see more details for samples on the Samples page.