Pixel Streaming リファレンス

Signaling Server host

• 80 - クライアントから受信するすべての HTTP リクエスト用。
  この値を変更するには、Signaling サーバーに対して --httpPort パラメータを設定します。

• 443 - クライアントから受信するすべての HTTPS リクエスト用 (Signaling サーバーが HTTPS モードで動作している場合)。
  この値を変更するには、Signaling サーバーに対して --httpsPort パラメータを設定します。

• 8888 - WebRTC Proxy サーバーから受信するすべての接続リクエスト用。
  この値を変更するには、Signaling サーバーに対する --streamerPort パラメータ と UE4 アプリケーションに対する -PixelStreamingPort パラメータの 両方 を設定します。

Matchmaker Server host

• 90 - クライアントから受信するすべての HTTP リクエスト用。
  この値を変更するには、Matchmaker サーバーに対して --httpPort パラメータを使用します。

• 9999 - Signaling サーバーによって送信されるすべてのメッセージ用。
  この値を変更するには、Matchmaker サーバーに対する --matchmakerPort パラメータ と Signaling サーバーに対する --matchmakerPort パラメータの 両方 を設定します。

-PixelStreamingIP=<value> or <domain>

Signaling and Web サーバーを実行しているコンピュータの IP アドレスまたはドメイン名を指定します。

-PixelStreamingPort=<value>

Signaling and Web サーバーが Unreal Engine アプリケーションから受信する通信をリッスンするポートを指定します。Signaling and Web サーバーは、デフォルト値 8888 を使用します。

-PixelStreamingURL=<value>

-PixelStreamingIP および -PixelStreamingPort が存在しない場合にのみ必要。使用すると、 -PixelStreamingIP と -PixelStreamingPort の両方が置き換えられます。

-RenderOffscreen

Unreal Engine アプリケーションをヘッドレス (ローカル コンピュータで表示されるレンダリングが何もない状態) で実行します。アプリケーションはウィンドウを表示せず、全画面でのレンダリングもありません。 このパラメータを -ForceRes とともに使用すると、Unreal Engine はメイン ディスプレイの解像度に基づいて解像度を自動的に調整することができなくなります。

このパラメータを省略すると、Unreal Engine アプリケーションのウィンドウは通常どおりレンダリングされます。このアプリケーション ウィンドウが最小化されると、Pixel Streaming ビデオと入力の取り込みは停止します。したがって、このパラメータを常に含めることをお勧めします。ただし、同じコンピュータで実行時に、Unreal Engine アプリケーションからのレンダリング出力をローカルで確認する必要がある場合は除きます。

-ForceRes

これを -ResX および -ResY と組み合わせると、Unreal Engine に指定した解像度を強制します。これは、表示解像度が通常ないクラウドでのデプロイに便利です。

-ResX <value>

Unreal Engine アプリケーション起動時の解像度の幅コンポーネントを設定します。

-ResY <value>

Unreal Engine アプリケーション起動時の解像度の高さコンポーネントを設定します。

-AudioMixer

Unreal Engine でオーディオにソフトウェア ミキシングを使用するようにします。したがって Pixel Streaming プラグインでオーディオをキャプチャできます。

-Unattended

エラーが生じた場合にダイアログ ボックスの生成を抑制します。これは、Unreal Engine をオフスクリーンで実行する場合や、コンテナ内で実行し、メッセージ ボックスがそれらのシナリオにおいて恒久的にハングする可能性がある場合に役立ちます。

-StdOut および -FullStdOutLogOutput

これら 2 つのフラグを組み合わせると、最大のログ出力が生成されます。これは、SSH ターミナルでライブ ログのデバッグまたは表示を実行する場合に便利です。

PixelStreaming.DisableLatencyTester

-PixelStreamingDisableLatencyTester

false

インゲーム HUD に PixelStreaming の統計情報を表示するかどうか。

PixelStreaming.DisableLatencyTester

-PixelStreamingDisableLatencyTester

false

Pixel Streaming プラグイン パイプラインをパス スルーするレイテンシー テストのトリガーを無効にします。

PixelStreaming.KeyFilter

-PixelStreamingKeyFilter=<values>

""

ストリーミング中のクライアントからの無視するキーのコンマ区切りリスト。たとえば、「W,A,S,D」はデフォルトの移動キーをフィルタによって除外する場合に使用できます。

該当なし

-AllowPixelStreamingCommands

false

ユーザーが emitConsoleCommand javascript を使用してコンソール コマンドを送信できるようにするかどうか。

該当なし

-PixelStreamingHideCursor

false

UE アプリケーションのカーソルを非表示にするかどうか。

PixelStreaming.Encoder.TargetBitrate

-PixelStreamingEncoderTargetBitrate=<value>

-1

ターゲット ビットレート (bps)。これを設定すると、WebRTC が必要とするビットレートが無視されます (非推奨)。無効にするには -1 に設定します。

PixelStreaming.Encoder.MaxBitrateVBR

-PixelStreamingEncoderMaxBitrate=<value>

20000000

最大ビットレート (bps)。

PixelStreaming.Encoder.DumpDebugFrames

-PixelStreamingDebugDumpFrame=<value>

false

デバッグの目的で、エンコーダからディスク上のファイルにフレームをダンプします。

PixelStreaming.Encoder.MinQP

-PixelStreamingEncoderMinQP=<value>

-1

0 ～ 51。値が小さいほど品質は向上しますが、ビットレートが高くなります。注記：-1 にすると、最小 QP のすべてのハード リミットが無効化されます。

PixelStreaming.Encoder.MaxQP

-PixelStreamingEncoderMaxQP=<value>

-1

0 ～ 51。値が小さいほど品質は向上しますが、ビットレートが高くなります。注記：-1 にすると、最大 QP のすべてのハード リミットが無効化されます。

PixelStreaming.Encoder.RateControl

-PixelStreamingEncoderRateControl=<value>

「CBR」

PixelStreaming ビデオ エンコーダの RateControl のモード。サポートされるモードは、「ConstQP」、「VBR」、「CBR」です。注記：注記：CBR のみが推奨されます。

PixelStreaming.Encoder.EnableFillerData

-PixelStreamingEnableFillerData=<value>

false

ジャンク データを入力することで、一定のビットレートを維持します。注記：CBR で MinQP が -1 の場合は必要ありません。

PixelStreaming.Encoder.Multipass

-PixelStreamingEncoderMultipass=<value>

「FULL」

エンコーダによるフレームあたりのパス数。詳細については、NVENC のドキュメントを参照してください。サポートされるモードは、 「DISABLED」 、 「QUARTER」 、 「FULL」 です。

PixelStreaming.Encoder.H264Profile

-PixelStreamingH264Profile=<value>

"BASELINE"

エンコーダによって使用される H264 プロファイル。サポートされるモードは、 「AUTO」 、 「BASELINE」 、 「MAIN」 、 「HIGH」 、 「HIGH444」 、 STEREO 、 SVC_TEMPORAL_SCALABILITY 、 PROGRESSIVE_HIGH 、 CONSTRAINED_HIGH です。

PixelStreaming.Capturer.UseBackBufferSize

-PixelStreamingUseBackBufferSize

true

PixelStreaming.Capturer.CaptureSize で指定するバックバッファ サイズまたはカスタム サイズを使用するかどうか

PixelStreaming.Capturer.CaptureSize

-PixelStreamingCaptureSize=<value>

1920x1080

PixelStreaming.Capturer.UseBackBufferSize が false の場合に使用するカスタム キャプチャ サイズ。

PixelStreaming.Capturer.MaxNumBackBuffers

-PixelStreamingMaxNumBackBuffers=<value>

8

使用するバックバッファの最大数。値が 0 の場合は、バックバッファの数を制限しません。

該当なし

-LogCmds=PixelStreamingWebRTC <LogLevel> ここで、役立つログ レベルは次のとおりです。Log、Verbose、VeryVerbose

Log

WebRTC のログ レベルを指定します。これは、WebRTC のデバッグに便利です。

PixelStreaming.WebRTC.DegradationPreference

-PixelStreamingWebRTCDegradationPreference=<value>

"MAINTAIN_FRAMERATE"

PixelStreaming.WebRTC.MaxFps

-PixelStreamingWebRTCMaxFps=<value>

60

FPS WebRTC を最大にすると、キャプチャ/エンコード/送信を実行しようとします。

PixelStreaming.WebRTC.StartBitrate

-PixelStreamingWebRTCStartBitrate=<value>

10000000

WebRTC がストリーミング開始を試みる開始ビットレート (bps)。

PixelStreaming.WebRTC.MinBitrate

-PixelStreamingWebRTCMinBitrate=<value>

100000

最小ビットレート (bps)。これを下回ると WebRTC でリクエストを行いません。

PixelStreaming.WebRTC.MaxBitrate

-PixelStreamingWebRTCMaxBitrate=<value>

20000000

最大ビットレート (bps)。これを上回ると WebRTC でリクエストを行いません。

PixelStreaming.WebRTC.LowQpThreshold

-PixelStreamingWebRTCLowQpThreshold=<value>

25

PixelStreaming.Encoder.LowQP=-1 の場合にのみ使用されます。値は 1 ～ 51 です。WebRTC でこの QP 未満のフレームを取得した場合、劣化の環境設定に基づいて適合の決定を試みます。

PixelStreaming.WebRTC.HighQpThreshold

-PixelStreamingWebRTCHighQpThreshold=<value>

37

PixelStreaming.WebRTC.DisableReceiveAudio

-PixelStreamingWebRTCDisableReceiveAudio

false

ブラウザから UE へのオーディオ受信を無効化します。

PixelStreaming.WebRTC.DisableTransmitAudio

-PixelStreamingWebRTCDisableTransmitAudio

false

ブラウザに対する UE のオーディオの送信を無効化します。

PixelStreaming.WebRTC.DisableAudioSync

-PixelStreamingWebRTCDisableAudioSync

true

WebRTC でオーディオ トラックとビデオ トラックの同期を無効化します。

--publicIp <value>

Signaling and Web サーバーを実行しているコンピュータのパブリック IP 。

--httpPort <value>

クライアント ブラウザとの HTTP 接続に Signaling and Web サーバが使用するポート。

--streamerPort <value>

Signaling and Web サーバーが Unreal Engine アプリケーションから受信する接続をリッスンするポート。

--peerConnectionOptions <value>

Unreal Engine アプリケーションおよびブラウザが自身の外部 IP アドレスを発見する必要がある場合に、クエリを実行する任意の STUN サーバーおよび TURN サーバーのホスト名または IP アドレスを指定します。
STUN サーバーおよび TURN サーバーの詳細については、「 ホスティングおよびネットワーキング ガイド 」を参照してください。
このパラメータは、通信する順序通りにサーバー URL をリストした文字列である必要があります。次の形式で作成する必要があります。
"{ \"iceServers\": [{\"urls\": [<url1>,<url2>,<url3>,...]}] }"
例：
"{ \"iceServers\": [{\"urls\": [\"stun:34.250.222.95:19302\"]}] }"
または
"{ \"iceServers\": [{\"urls\": [\"stun:34.250.222.95:19302\",\"turn:34.250.222.95:19312\"]}] }"
Unreal Engine 出荷時の TURN サーバーの実装では、以下のようにユーザー名とパスワードが必要です。
"{\"iceServers\":[{\"urls\":[\"stun: 34.250.222.95:19302\",\"turn: 34.250.222.95:19312\"],\"username\":\"<TURN_Username>\",\"credential\":\"<TURN_Password>\"}]}"
その他の STUN の実装と TURN の実装では、認証情報の要件が異なる可能性があります。

--HomepageFile <value>

特定の URL をリクエストせずに接続するクライアント ブラウザに対し、サーバーが提供するデフォルト ページのファイル名。
デフォルト値は player.htm です。

--AdditionalRoutes <value>

Signaling and Web サーバーがサービスを提供する追加フォルダを指定します。
このパラメータは、JSON オブジェクトである必要があります。つまり、コマンドラインではなく、JSON コンフィギュレーション ファイルでのみ設定できます。
各キーは URL の一部になっているオブジェクトでなくてはなりません。また、各キーは、リクエストを行うクライアントに対し、サーバーがサービスを提供するローカル パスでなくてはなりません。たとえば、以下のように設定したとします。
"AdditionalRoutes" = { "/myfolder", "C:\some_local_path" }
この場合、クライアントが http://server-name/myfolder/index.html をリクエストすると、サーバーは C:\some_local_path\index.html という名前のファイルを提供します。

--LogToFile <value>

Signaling and Web サーバーが ./logs フォルダ内のファイルにログ メッセージを書き込むかどうかを決定します。
デフォルト値は「 true 」です。

--UseHttps <value>

Signaling サーバーが httpsPort で HTTPS 接続のみを受け入れるようにするには、このパラメータを true に設定します。
また、Signaling and Web サーバーのルート フォルダ内の certificates フォルダに、 client-key.pem ファイルおよび client-cert.pem ファイルを配置する必要があります。

--httpsPort <value>

HTTPS 接続でリッスンするポート。 UseHttps が有効な場合にのみ使用されます。
デフォルト値は 443 です。

--UseMatchmaker <value>

Signaling and Web サーバーが現在のステータスを Matchmaker サーバーに送信するかどうかを決定します。これは、現在使用されていない Signaling サーバーと Unreal Engine アプリケーションをクライアント ブラウザで見つけやすくするためのものです。

--matchmakerAddress <value>

Signaling and Web サーバーが通信する Matchmaker サーバーの IP アドレス。

--matchmakerAddress <value>

Signaling and Web サーバーから受信するメッセージを Matchmaker サーバーがリッスンするポート。

--configFile <value>

上記プロパティの値を取得するために Signaling サーバーが使用するコンフィギュレーション ファイルのパスとファイル名を指定します。コマンドラインでのみ設定できます。

--httpPort <value>

クライアントからの HTTP 接続を Matchmaker がリッスンするポート番号を設定します。
デフォルト値は 90 です。

--matchmakerPort <value>

Cirrus シグナリング サーバーから受信するメッセージを Matchmaker がリッスンするポート番号を設定します。
デフォルト値は 9999 です。