Choose your operating system:
Windows
macOS
Linux
このページでは、Pixel Streaming システムの各部で公開されているコマンドライン パラメータ、設定、オプションについて説明します。
サポートされるグラフィック ハードウェア
Pixel Streaming プラグインを使う Unreal Engine アプリケーションを実行するコンピュータでは、ハードウェアアクセラレート ビデオ エンコーディング (NVENC) をサポートする NVIDIA GPU ハードウェアを使用する必要があります。
-
Hardware-Accelerated Video Encoding (NVENC) をサポートする NVIDIA GPU ハードウェアNVIDIA 社の matrix of supported devices を参照してください。
-
Advanced Media Framework (AMF) をサポートする AMD GPU ハードウェア
Pixel Streaming プラグインを使用した際に、エラー メッセージ「 Failed to load NvEncode dll (NvEncode dll をロードできない) 」が表示された場合は、使用している GPU が NVENC をサポートしていない可能性があります。
サポートされるオペレーティング システム
Pixel Streaming プラグイン、WebRTC Proxy サーバー、Signalling and Web サーバーは、Windows 8 および Windows 10 でテスト済みです。
Windows 7 など他のオペレーティング システムではテストされていません。
サポートされるクライアント ブラウザ
Pixel Streaming の再生は、WebRTC プロトコルをサポートする最新のブラウザで動作します。例えば、次のブラウザの最新バージョン (2、3 のバージョン) はテスト済みで、追加設定なしで動作することが確認されています。
-
Google Chrome (デスクトップ版とモバイル版)
-
Mozilla Firefox (デスクトップ版とモバイル版)
-
Apple Safari (デスクトップ版とモバイル版)
Microsoft Edge や Opera など他のブラウザは、アドオンやプラグインが必要になることがあり、さらにシステムによっては動作しない可能性があります。
デフォルトのネットワーク ポート
Pixel Streaming システムの各コンポーネントは、以下に指定したデフォルト ポートを使用して通信します。これらのコンポーネントが動作するホストで、それぞれのポートがオープンであることを確認する必要があります。
コンポーネント |
ポート |
---|---|
|
|
|
|
Unreal Engine コンソール コマンド
Encoder コマンドでは、Pixel Streaming プラグインで Unreal Engine からのレンダリングされたフレームをビデオ イメージにエンコードする方法をコントロールします。
コマンド |
説明 |
---|---|
|
許容される最大ビットレート |
|
エンコーダのターゲット解像度サイズ (
|
|
Encoder.TargetSize で設定されたカスタム サイズではなく、バック バッファ サイズ (レンダリング ゲーム ビューポートのサイズ) を使用するようにエンコーダを設定します。 |
Unreal Engine コマンドライン パラメータ
Unreal Engine アプリケーションを起動する際に、コマンドラインで以下のプロパティを設定します。
パラメータ |
説明 |
---|---|
|
プレイヤー Web ページが
|
|
Unreal Engine でオーディオにソフトウェア ミキシングを使用するようにします。したがって Pixel Streaming プラグインでオーディオをキャプチャできます。
|
|
必須。 Signaling and Web サーバーを実行するコンピュータの IP アドレスまたはドメイン名を指定します。 |
|
必須。
*Unreal Engine アプリケーションから受信する通信を Signaling and Web Server がリッスンするポートを指定します。
|
|
WebRTC Proxy が入力から除外するキーを記載した、キーボードのキーのコンマ区切りリストです。この入力は、WebRTC Proxy によりプレイヤー Web ページから Unreal Engine に中継されます。ユーザーがブラウザでこれらのキーのいずれかを押した場合、そのイベントは Unreal Engine の入力コントローラーに中継されません。
|
|
Unreal Engine アプリケーションが Signaling and Web サーバーから受け取るメッセージの最大長をバイトで設定します。
|
|
Unreal Engine アプリケーションをヘッドレス (ローカル コンピュータで表示されるレンダリングが何もない状態) で実行します。アプリケーションはウィンドウを表示せず、全画面でのレンダリングもありません。
|
|
指定した場合、デフォルトのエンコーダ フレーム レートをオーバーライドします。
|
|
エンコーダによるエンコードが可能な、フレームの最大幅。
|
|
エンコーダによるエンコードが可能な、フレームの最大高さ。
|
|
指定した場合、エンコーダのデフォルト平均ビットレートをオーバーライドします。 |
|
H.264 の圧縮レベルを 5.2 または 5.1 に定義します。このパラメータを設定しないと、エンコーダは 3840x2160 (4K) などの解像度でのエンコードが可能なレベル 5.2 を使用します。
低めの解像度でエンコードを行う場合は、レベル 5.1 に切り替えて帯域幅を節約できる場合があります。切り替える方法は、このパラメータを
|
Signaling サーバーのコンフィギュレーション パラメータ
これらのパラメータを設定するには 2 つの方法があります。
-
run.bat
またはnode cirrus.js
を実行して Signaling and Web サーバーを起動する際は、コマンドラインで設定します。この場合、各パラメータにプレフィックス--
(2 つのダッシュ) を付け、スペースを入力してから設定する値を続けます。例:--httpPort 81
-
コンフィギュレーション ファイルで設定します。デフォルトでは、Signaling and Web サーバー (
cirrus.js
) は同じフォルダで、「config.json
」というファイルを探します。この場合、ファイルで定義された JSON オブジェクトのキーと値のペアとして、必要な各パラメータと値を設定します。Signaling and Web サーバーを少なくとも 1 回起動したことがある場合は、例の「Engine/Source/Programs/PixelStreaming/WebServers/SignallingWebServer/config.json
」ファイルにリストされているパラメータを確認します。
パラメータ |
説明 |
---|---|
|
Signaling and Web サーバーが動作しているコンピュータのパブリック IP。 |
|
クライアント ブラウザとの HTTP 接続に Signaling and Web サーバーが使用するポート番号。 |
|
Signaling and Web サーバーが WebRTC Proxy サーバーからの受信接続をリッスンするポート番号。 |
|
Unreal Engine アプリケーションとブラウザが、それぞれの外部 IP アドレスを把握する必要がある場合にクエリするための STUN および TURN サーバーのホスト名または IP アドレスを指定します。
JSON コンフィギュレーション ファイルでパラメータを指定する場合でも、この値は文字列形式であることが必要です。常に二重引用符 (") で囲み、前に示したように、文字列内ではバックスラッシュ () を使用して引用符をエスケープします。 |
|
特定の URL をリクエストしていないクライアント ブラウザが接続したときに、サーバーが提供するデフォルト ページのファイル名。
|
|
Signaling and Web サーバーがサービスを提供する追加フォルダを指定します。
|
|
Signaling and Web サーバーがログ メッセージを「
|
|
このパラメータを「
true
」に設定すると、Signaling サーバーは HTTPS 接続のみを
httpsPort
で受け入れるようになります。
|
|
HTTPS 接続をリッスンするポート番号。
UseHttps
が有効な場合にのみ使用されます。
|
|
クライアント ブラウザが、その時点で使用されていない Signaling サーバーと Unreal Engine アプリケーションを検出できるように、Signaling and Web サーバーが現在のステータスを Matchmaker サーバーに送信するかどうかを指定します。 |
|
Signaling and Web サーバーが問い合わせる Matchmaker サーバーの IP アドレス。 |
|
Signaling and Web サーバーからの受信メッセージを Matchmaker サーバーがリッスンするポート番号。 |
|
Signaling サーバーが前に示した各プロパティの値を取得するために使用する、コンフィギュレーション ファイルのパスとファイル名を指定します。コマンドラインでのみ設定できます。 |
Matchmaker サーバー コマンドライン パラメータ
Matchmaker サーバーを「
run.bat
」ファイルを実行して起動するとき、または「
node.exe matchmaker.js
」を実行して起動するときに、コマンドラインで以下のパラメータを指定します。
パラメータ |
説明 |
---|---|
|
クライアントからの HTTP接続を Matchmaker がリッスンするポート番号を設定します。
|
|
Cirrus Signaling サーバーからの受信メッセージを Matchmaker がリッスンするポート番号を設定します。
|