[DOC] Added FAQ Page by karasusan · Pull Request #65 · Unity-Technologies/UnityRenderStreaming · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Render Steraming パッケージには以下の内容が含まれています。

### WebRTC パッケージ

WebRTC の C# API を提供します。 API の詳細は WebRTCパッケージのドキュメントを参照してください
WebRTC の C# API を提供します。 API の詳細は `com.unity.webrtc` のドキュメントを参照してください

<img src="../images/webrtc_package_manager.png" width=500 align=center>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,4 +71,5 @@ Web サーバのアドレスにアクセスしてください。以下のよう
- **Safari** 及び **iOS Safari** は、 **http** では WebRTC の機能を利用できません。 **https** を利用する必要があります。
- ブラウザの動作が確認できない場合、ブラウザのバージョンが古い可能性があります。最新のバージョンをインストールしてください。
- **Nvcodec** が利用可能なグラフィックボードが利用可能であることを確認してください。また、グラフィックドライバは最新のバージョンをインストールしてください。
- `com.unity.webrtc` のドキュメントも確認してください。

4 changes: 4 additions & 0 deletions Packages/com.unity.template.renderstreaming/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,7 @@

- [LICENSE.md](Packages/com.unity.template.renderstreaming/LICENSE.md)

## Change log

- [CHANGELOG.md](CHANGELOG.md)

14 changes: 8 additions & 6 deletions Packages/com.unity.webrtc/Documentation~/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,17 @@ WebRTC for Unity は、 [WebRTC](https://webrtc.org) を Unity で利用可能

## Sample
パッケージでは以下の3つのサンプルを用意しています。
| シーン名 | 説明 |
|----------------|-------------------------------------|
| PeerConnection | ピアを接続する手続きを確認するシーン |
| DataChannel | テキスト送受信を確認するシーン |
| MediaStream | ビデオ/音声送受信を確認するシーン |

| シーン名 | 説明 |
|---|---|
| PeerConnection | ピアを接続する手続きを確認するシーン |
| DataChannel | テキスト送受信を確認するシーン |
| MediaStream | ビデオ/音声送受信を確認するシーン |

## Limitation

ビデオエンコーディングにGPUハードウェアアクセラレーションを使用しているため、NVCodec 対応のグラフィックボードにのみ動作しています。
- Windows x64 でのみ動作します
- NVCodec 対応のグラフィックボードにのみ動作しています

## 更新履歴

Expand Down
3 changes: 3 additions & 0 deletions Packages/com.unity.webrtc/Documentation~/jp/datachannel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# データチャネル

作成中
2 changes: 2 additions & 0 deletions Packages/com.unity.webrtc/Documentation~/jp/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ WebRTC for Unity は、 [WebRTC](https://webrtc.org) を Unity で利用可能
## ガイド

* [チュートリアル](tutorial.md)
* [データチャネル](datachennel.md)
* [メディアストリーム](mediastream.md)

## インストール方法
パッケージをインストールするためには、パッケージマネージャから WebRTC for Unity を検索しインストールします。パッケージマネージャの利用方法は[ドキュメント](https://docs.unity3d.com/Packages/com.unity.package-manager-ui@latest/index.html)を参照してください。
Expand Down
3 changes: 3 additions & 0 deletions Packages/com.unity.webrtc/Documentation~/jp/mediastream.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# メディアストリーム

作成中
7 changes: 2 additions & 5 deletions Packages/com.unity.webrtc/Documentation~/jp/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,9 @@ localConnection.OnIceConnectionChange = state => {
}
```

### DataChannel の接続
### データチャネルの接続

ICE の交換が完了すると、`OnDataChannel` が呼び出され、他方のピアの DataChannel が生成されます
ICE の交換が完了すると、`OnDataChannel` が呼び出され、他方のピアのデータチャネルが生成されます
`OnMessage` コールバックを登録して、メッセージ受信時の処理を記述します。

```CSharp
Expand Down Expand Up @@ -153,6 +153,3 @@ private void OnDestroy()
}
```

### ビデオストリーム

ビデオストリームを取得するためには`Camera`の `CaptureStream()` を利用して `MediaStream` を利用します。
21 changes: 12 additions & 9 deletions Plugin/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# プラグインのビルド方法
# プラグイン

`com.unity.webrtc` が依存するネイティブプラグインのビルド及び配置の方法について説明します。

### libwebrtc の組み込み

Expand All @@ -9,18 +11,19 @@ zip ファイルを展開後、Plugin フォルダ直下に配置します。

<img src="../Packages/com.unity.webrtc/Documentation~/images/deploy_libwebrtc.png" width=500 align=center>

### ビルド
### 開発環境

version 1.0 現在、ビルドは **Visual Studio 2017** を利用しています。

version 1.0 現在、ビルドは **Visual Studio 2017** を利用しています。version 1.2 以降は **CMake** への移行を検討しています。
### プロジェクトの設定

### デバッグ
プラグインの開発を行うためには、個別の環境に合わせて`WebRTCPlugin` プロジェクトのプロパティを変更する必要があります。

プラグインのランタイムデバッグを行うためには、WebRTCPlugin プロジェクトのプロパティを変更する必要があります
`Command` に Unity の実行ファイルパス、`Command Arguments` にプロジェクトパスを指定してください。この設定を行うことで、デバッグ実行時に Unity エディタが起動し、ブレークポイントが有効になります

Output Directory を `Packages\com.unity.webrtc\Runtime\Plugins\x86_64` に指定します。
<img src="../Packages/com.unity.webrtc/Documentation~/images/command_config_vs2017.png" width=600 align=center>

<img src="../Packages/com.unity.webrtc/Documentation~/images/outputdirectory_config_vs2017.png" width=600 align=center>
### プラグインの配置

Command に Unity の実行ファイルパス、Command Arguments にプロジェクトパスを指定してください
ビルド実行すると、`webrtc.dll` が `Packages\com.unity.webrtc\Runtime\Plugins\x86_64` に配置されます。このとき Unity のインスペクタ上で以下の設定になっていることを確認してください

<img src="../Packages/com.unity.webrtc/Documentation~/images/command_config_vs2017.png" width=600 align=center>
25 changes: 14 additions & 11 deletions WebApp/README.md