未验证 提交 adb29c76 编写于 作者: K Kazuki Matsumoto 提交者: GitHub

fix documents (#348)

上级 82a06d39
......@@ -88,7 +88,7 @@ Then just build a standalone Windows version of your application, zip it and upl
## FAQ
Read [this page](com.unity.renderstreaming/Documentation~/en/faq.md) and [Unity Forum](https://forum.unity.com/forums/unity-render-streaming.413/)
Read [this page](com.unity.renderstreaming/Documentation~/faq.md) and [Unity Forum](https://forum.unity.com/forums/unity-render-streaming.413/)
## Contributors
......
# Render Streaming WebApp
### Web アプリケーションの実行
Web アプリケーションのソースコードは `WebApp` フォルダに配置しています。ソースコードを利用するには [Node.js](https://nodejs.org/) をインストールする必要があります。
**Node.js** を利用してWeb アプリケーションを起動するには、以下のコマンドを実行します。
```shell
npm run build
npm run start
```
以下のコマンドでヘルプを表示します。
```shell
npm run start -- -h
```
オプションの詳細については[ドキュメント](../com.unity.renderstreaming/Documentation~/jp/webapp.md)を参照してください。
また、以下のコマンドで `ts-node` を利用してサーバを起動します。
```shell
npm run dev
```
### Web アプリケーションの配布
Web アプリケーションを配布する際、環境構築の手間を省略するために、Web アプリケーションを実行可能なバイナリに変換することが可能です。以下コマンドでバイナリに変換します。
```shell
npm run pack
```
### Web API の確認
Render Streaming のシグナリングはシンプルな Web API で実現しています。API の確認には [Postman](https://www.getpostman.com/) が利用できます。
Postman で `WebApp/test/renderstreaming.postman_collection.json` をインポートすると、API の一覧を確認することができます。また、Web サーバを起動した状態であれば API の動作テストを行うことができます。
<img src="../com.unity.renderstreaming/Documentation~/images/postman_example.png" width=600 align=center>
......@@ -7,5 +7,6 @@
* [Configure Self-Signed Credentials for https](https.md)
* [Setting for TURN Server](turnserver.md)
* [About Signaling Protocol](signalingprotocol.md)
* [Customize Web Application](customize_webapp.md)
* [Components Settings](components.md)
* [FAQ](faq.md)
\ No newline at end of file
......@@ -21,7 +21,7 @@
| *Credencial* | The credential to use when logging into the TURN server | |
| *Credencial Type* | This attribute specifies what kind of `credential` is to be used when connecting to the TURN server | Password |
| **Interval** | Set the polling frequency (in seconds) to the signaling server <br>Valid only if you are using Http as the signaling protocol. | 5 (sec) |
| **Hardware Encoder Support** | Enable the checkbox to make this video encoding replace values that use a [hardware encoder](../index.md#hardware-encoder) | Enabled |
| **Hardware Encoder Support** | Enable the checkbox to make this video encoding replace values that use a [hardware encoder](index.md#hardware-encoder) | Enabled |
| **Array Button Click Event** | Register browser button click events | |
| *Element Id* | Set an ID that is sent from browsers | |
| *Click* | Set button click event | |
......
# Render Streaming WebApp
# Customize web application
### Implementing the Web Application
## Implementing the Web Application
The web application source code can be found in the `WebApp` folder. [Node.js](https://nodejs.org/) must also be installed to use the source code.
The web application source code can be found in the `WebApp` folder on [GitHub](https://github.com/Unity-Technologies/UnityRenderStreaming). You can clone the repository using the command below:
Use the following commands to start the web app through **Node.js**:
```shell
git clone https://github.com/Unity-Technologies/UnityRenderStreaming
```
The directory structure under the WebApp folder is given below:
```shell
WebApp
├─index.html
├─public
│ ├─images
│ ├─scripts
│ └─stylesheets
├─src
│ └─class
└─test
```
If you want to change the user interface on the browser, you need to customize scripts in the `public` folder.
While you want to change the signaling process, please check under the `src` folder. This source code is written `TypeScript`.
## Building the Web Application
[Node.js](https://nodejs.org/) must also be installed to use the source code.
Use the following commands to start the web app through **npm** command:
```shell
cd WebApp
npm install
npm run build
npm run start
```
......@@ -17,7 +43,7 @@ Use this command to display the help guide:
npm run start -- -h
```
See [the documentation](../com.unity.renderstreaming/Documentation~/en/webapp.md) for details on the options.
See [the documentation](webapp.md) for details on the options.
This command will start the server using `ts-node`:
......@@ -25,18 +51,10 @@ This command will start the server using `ts-node`:
npm run dev
```
### Distributing the web app
## Distributing the web application
When distributing the web app, the app can be converted into executable binary in order to cut the effort required to set up the environment. Use the following command:
```shell
npm run pack
```
### Checking the web API
Render Streaming uses a simple web API for signaling. [Postman](https://www.getpostman.com/) can be used to check the API.
View a summary of the API by importing `WebApp/test/renderstreaming.postman_collection.json` in Postman. Operation tests can also be run on the API while the web server is active.
<img src="../com.unity.renderstreaming/Documentation~/images/postman_example.png" width=600 align=center>
```
\ No newline at end of file
......@@ -15,7 +15,7 @@ Also, **iOS Safari** does not support WebSocket signaling if the server uses a s
### Unity's initial startup fails
Confirm you're using a `Graphics API` and compare [requirements](https://docs.unity3d.com/Packages/com.unity.webrtc@latest/en/overview.html) of `com.unity.webrtc`.
Confirm you're using a `Graphics API` and compare [requirements](https://docs.unity3d.com/Packages/com.unity.webrtc@2.2/overview.html) of `com.unity.webrtc`.
If you use the hardware encoder, Make sure you're using a graphics card that supports **Nvcodec**. Also confirm that the latest graphics driver version is installed. See also: `com.unity.webrtc` documentation.
### Web server fails to run
......
......@@ -23,7 +23,7 @@ This package enables streaming sounds generated on Unity. And it can cast to mul
### Remote control
It is possible to send input messages to Unity from the browser, and sending inputs from multiple browsers is supported. Mouse, keyboard, touch, and gamepad are supported as input devices on the browser. For more information, please see the [Browser input process](en/input.md) page.
It is possible to send input messages to Unity from the browser, and sending inputs from multiple browsers is supported. Mouse, keyboard, touch, and gamepad are supported as input devices on the browser. For more information, please see the [Browser input process](input.md) page.
## Requirements
......@@ -38,13 +38,12 @@ This version of Render Streaming is compatible with the following versions of th
| Windows x64 | DirectX11 | :white_check_mark: (Require [NVIDIA Graphics card](https://developer.nvidia.com/video-encode-decode-gpu-support-matrix)) | :white_check_mark: |
| Windows x64 | DirectX12 | :white_check_mark: (Require [NVIDIA Graphics card](https://developer.nvidia.com/video-encode-decode-gpu-support-matrix)) | :white_check_mark: |
| Windows x64 | OpenGL | | |
| Windows x64 | Vulkan | | |
| Windows x64 | Vulkan | :white_check_mark: (Require [NVIDIA Graphics card](https://developer.nvidia.com/video-encode-decode-gpu-support-matrix)) | :white_check_mark: |
| Linux x64 | OpenGL | :white_check_mark: (Require [NVIDIA Graphics card](https://developer.nvidia.com/video-encode-decode-gpu-support-matrix)) | |
| Linux x64 | Vulkan | | |
| MacOS | Metal | | :white_check_mark: |
> [!WARNING]
> In the current version, The combination of Linux and HDRP is not supported. Need to select`OpenGL` in "Graphics API" and use `Legacy` rendering pipeline.
| Linux x64 | Vulkan | :white_check_mark: (Require [NVIDIA Graphics card](https://developer.nvidia.com/video-encode-decode-gpu-support-matrix)) | :white_check_mark: |
| MacOS | Metal | :white_check_mark: | :white_check_mark: |
| iOS | Metal | | |
| Android | Vulkan | | |
> [!NOTE]
> Supporting OpenGL API on MacOS is not planned.
......@@ -81,6 +80,10 @@ Then just build a standalone Windows version of your application, zip it and upl
Currently, there are three samples:
- HDRP sample
- URP sample
- Legacy pipeline sample
### HDRP sample
Importing this sample will automatically install and setup our HDRP sample assets along with the [HDRP](https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@latest) *(com.unity.render-pipelines.high-definition)* package.
......@@ -91,8 +94,4 @@ Importing this sample will automatically install and setup our URP sample assets
### Legacy pipeline sample
This is the simplest sample with legacy pipeline.
## Other Languages
- [Japanese](./jp/index.md)
This is the simplest sample with legacy pipeline.
\ No newline at end of file
......@@ -48,7 +48,7 @@ The Render Steraming package includes the following.
### WebRTC Package
This provides the WebRTC C# API. See the [WebRTC package documentation](https://docs.unity3d.com/Packages/com.unity.webrtc@latest/manual/en/index.html) for details on the API.
This provides the WebRTC C# API. See the [WebRTC package documentation](https://docs.unity3d.com/Packages/com.unity.webrtc@latest) for details on the API.
![WebRTC package manager](images/webrtc_package_manager.png)
......
......@@ -47,7 +47,7 @@ Use the following command to start the server as http. Port 80 will be used.
.\webserver
```
This command will run the server as https. Port 443 will be used. A certificate (`server.cert`) and a key (`server.key`) must also be set up ([details](../en/https.md)).
This command will run the server as https. Port 443 will be used. A certificate (`server.cert`) and a key (`server.key`) must also be set up ([details](https.md)).
```shell
.\webserver -s -p 443
......@@ -65,3 +65,7 @@ Use this command to display the help guide.
```shell
.\webserver -h
```
## How to custmize web application
Please see the page [Customize Web Application](customize_webapp.md).
\ No newline at end of file
......@@ -2,7 +2,7 @@
**Unity Render Streaming** は、ブラウザー上で Unity の高品位なレンダリングを実現するためのソリューションです。カーコンフィギュレーターや建築モデルをスマートデバイスで閲覧するニーズを想定しています。
このパッケージは、HDRP のシーンに対して Unity Render Streaming の利用に必要な設定を加えたテンプレートパッケージです。すぐに試してみたい方は[チュートリアルドキュメント](tutorial.md)をご覧ください。より技術的な詳細は Unity Render Streaming の[パッケージドキュメント](https://docs.unity3d.com/Packages/com.unity.renderstreaming@latest/jp/index.html)をご覧ください。
このパッケージは、HDRP のシーンに対して Unity Render Streaming の利用に必要な設定を加えたテンプレートパッケージです。すぐに試してみたい方は[チュートリアルドキュメント](tutorial.md)をご覧ください。より技術的な詳細は Unity Render Streaming の[パッケージドキュメント](https://docs.unity3d.com/Packages/com.unity.renderstreaming@latest)をご覧ください。
![Browser HDRP scene](../images/browser_hdrpscene.png)
......@@ -10,7 +10,7 @@
> [!NOTE]
> 既存のプロジェクトに対してストリーミング機能を追加する場合は、テンプレートではなく、Package Manager から `Unity Render Streaming` パッケージをインストールしてください。
> 詳細は[パッケージのドキュメント](https://docs.unity3d.com/Packages/com.unity.renderstreaming@latest/jp/index.html)を確認してください。
> 詳細は[パッケージのドキュメント](https://docs.unity3d.com/Packages/com.unity.renderstreaming@latest)を確認してください。
## 動作環境
......
......@@ -38,7 +38,7 @@ Web アプリケーションは メニューから **Edit / Render Streaming / D
![Menu download webapp](../images/menu_download_webapp.png)
このファイルを実行するとコマンドプロンプトが表示されます。下記のログがコマンドプロンプトに表示されます。Web アプリケーションのアドレスもここに表示されています。コマンドオプションは [パッケージのドキュメント](https://docs.unity3d.com/Packages/com.unity.renderstreaming@latest/jp/webserver.html) を確認してください。
このファイルを実行するとコマンドプロンプトが表示されます。下記のログがコマンドプロンプトに表示されます。Web アプリケーションのアドレスもここに表示されています。コマンドオプションは [パッケージのドキュメント](https://docs.unity3d.com/Packages/com.unity.renderstreaming@2.2/manual/webapp.html) を確認してください。
![Launch Web Server command](../images/launch_webserver_cmd.png)
......
......@@ -2,7 +2,7 @@
**Unity Render Streaming** は、ブラウザー上で Unity の高品位なレンダリングを実現するためのソリューションです。カーコンフィギュレーターや建築モデルをスマートデバイスで閲覧するニーズを想定しています。
このパッケージは、HDRP のシーンに対して Unity Render Streaming の利用に必要な設定を加えたテンプレートパッケージです。すぐに試してみたい方は[チュートリアルドキュメント](tutorial.md)をご覧ください。より技術的な詳細は Unity Render Streaming の[パッケージドキュメント](https://docs.unity3d.com/Packages/com.unity.renderstreaming@latest/jp/index.html)をご覧ください。
このパッケージは、HDRP のシーンに対して Unity Render Streaming の利用に必要な設定を加えたテンプレートパッケージです。すぐに試してみたい方は[チュートリアルドキュメント](tutorial.md)をご覧ください。より技術的な詳細は Unity Render Streaming の[パッケージドキュメント](https://docs.unity3d.com/Packages/com.unity.renderstreaming@latest)をご覧ください。
![Browser HDRP scene](../images/browser_hdrpscene.png)
......@@ -10,7 +10,7 @@
> [!NOTE]
> 既存のプロジェクトに対してストリーミング機能を追加する場合は、テンプレートではなく、Package Manager から `Unity Render Streaming` パッケージをインストールしてください。
> 詳細は[パッケージのドキュメント](https://docs.unity3d.com/Packages/com.unity.renderstreaming@latest/jp/index.html)を確認してください。
> 詳細は[パッケージのドキュメント](https://docs.unity3d.com/Packages/com.unity.renderstreaming@latest)を確認してください。
## 動作環境
......
......@@ -38,7 +38,7 @@ Web アプリケーションは メニューから **Edit / Render Streaming / D
![Menu download webapp](../images/menu_download_webapp.png)
このファイルを実行するとコマンドプロンプトが表示されます。下記のログがコマンドプロンプトに表示されます。Web アプリケーションのアドレスもここに表示されています。コマンドオプションは [パッケージのドキュメント](https://docs.unity3d.com/Packages/com.unity.renderstreaming@latest/jp/webserver.html) を確認してください。
このファイルを実行するとコマンドプロンプトが表示されます。下記のログがコマンドプロンプトに表示されます。Web アプリケーションのアドレスもここに表示されています。コマンドオプションは [パッケージのドキュメント](https://docs.unity3d.com/Packages/com.unity.renderstreaming@2.2/manual/webapp.html) を確認してください。
![Launch Web Server command](../images/launch_webserver_cmd.png)
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册